Getting Started: Part 1

This is part of the getting started guide.

If you haven't already seen the introduction page you can return to it by clicking here.

Important files and directories

There are files you should be aware of!

LegacyFactions/database/ - this is a no-touch zone! The database is held here. To avoid corruption, do not modify these files.
LegacyFactions/commandAliases.js - to modify how the commands are present to the player, you can change their aliases here.
LegacyFactions/config.js - this is the main configuration file. You can change how your plugin operates in here. If you make a change to it, type /f reload after!
LegacyFactions/tags.js - this is the tags file. You can change the colours of tags used in messages here. (e.g. <b> is set to <rose> (red) and <i> is set to <yellow> (gold)
LegacyFactions/locale.yml - this is the language file. You can modify strings used in LegacyFactions here.

When modifying a JSON file it is best to make sure that it is a valid JSON format by putting it through a JSON validator - www.jsonlint.com is a great free service for this. If it is wrong, the line number and column number will be put into the server console. Although our JSON interpreter is set to lenient it will not be able to get around all errors.

Part 1: Lets talk commands.

LegacyFactions comes with a lot of commands. Players can view these commands (if you let them - you should - but you could deny this with the help command permission!) at any time by typing /f help

The Help Menu

By default we enable a nice looking help menu! This is call the JSON Help Menu because it makes use of Minecrafts JSON format to create buttons.

The [<] and [>] icons are buttons that can be used to switch between pages. Or, you can just type /f help 2, /f help 3, etc. It's very flexible!

This menu is automatically generated based on the players permissions. So they only see the commands they are allowed to use!

Some servers may not want this - and thats ok! You can switch to the older 1.6 style help menu by switching useOldHelp in your config.js file to true.

But maybe some servers want to write their own help, or simply change it to link users to their wiki!

You can do this too. Change useCustomHelp to true. You can the modify the values under helpPages in the config.js file to however you want - add and remove as many pages as you want! Just use the following format:

  "helpPages": {
    "1": [
      "&e&m----------------------------------------------",
      "\t\t\t\t  &c&lFactions Help\t\t\t   ",
      "&e&m----------------------------------------------",
      "&3/f create  &e>>  &7Create your own faction",
      "&3/f who\t  &e>>  &7Show factions info",
      "&3/f tag\t  &e>>  &7Change faction tag",
      "&3/f join\t &e>>  &7Join faction",
      "&3/f list\t  &e>>  &7List all factions",
      "&e&m--------------&r &2/f help 2 for more &e&m--------------"
    ],
    "2": [
      "&e&m------------------&r&c&l Page 2 &e&m--------------------",
      "&3/f home\t &e>>  &7Teleport to faction home",
      "&3/f sethome &e>>  &7Set your faction home",
      "&3/f leave\t&e>>  &7Leave your faction",
      "&3/f invite\t&e>>  &7Invite a player to your faction",
      "&3/f deinvite &e>>  &7Revoke invitation to player",
      "&e&m--------------&r &2/f help 3 for more &e&m--------------"
    ],
    "3": [
      "&e&m------------------&r&c&l Page 3 &e&m--------------------",
      "&3/f claim\t &e>>  &7Claim land",
      "&3/f unclaim  &e>>  &7Unclaim land",
      "&3/f kick\t  &e>>  &7Kick player from your faction",
      "&3/f mod\t  &e>>  &7Set player role in faction",
      "&3/f coleader\t  &e>>  &7Set player role in faction",
      "&e&m--------------&r &2/f help 4 for more &e&m--------------"
    ],
    "4": [
      "&e&m------------------&r&c&l Page 4 &e&m--------------------",
      "&3/f chat\t &e>>  &7Switch to faction chat",
      "&3/f version &e>>  &7Display version information",
      "&e&m--------------&r&2 End of /f help &e&m-----------------"
    ]
  },

You could change this to a simple 1 page notice if you wanted! Not recommended - but everything is how you want your server to be experienced!

  "helpPages": {
    "1": [
      "&e&m----------------------------------------------",
      "                      &c&lFactions Help         ",
      "&e&m----------------------------------------------",
      "&7   For help please see our wiki page",
      "&7   www.myserver.com/wiki",
      "&e&m----------------------------------------------"
    ]
  },

The basics

Using commands required permissions! To simplify this some kits have been created, but you may just want to specify the commands yourself.

factions.kit.halfplayer: Can do all but create factions.
factions.kit.fullplayer: Can do all, including create factions.
factions.kit.halfmod: Zones, bypassing, kicking, and chatspy
factions.kit.mod: All faction permissions but configuration and persistance.
factions.kit.admin: All faction permissions.

If you are an admin and want to be able to bypass permission you can use the /f bypass command. Which will enable bypass mode.

You should read the Permissions page for a full overview of the permissions and the Commands page for a full overview of the commands.