Configuration
The default configuration file is heavily commented and should be self explanitory, however here are all the options as of the latest build:
setting | default | description |
---|---|---|
excludedWorlds | empty | a list of worlds that the rules do not apply. e.g. excludedWorlds: [worldname, worldname_nether] |
defaultMinMessage | You cannot use %m until level %min | The default message shown to player if they do not meet the minimum level of rule (if specified) |
defaultMaxMessage | You cannot use %m past level %max | The default message shown to player if they exceed the maximum level of rule (if specified) |
defaultOtherMessage | You cannot use %m | Default message shown when rule fails for unspecified reason |
defaultDisplayCurrentRestrictions | true | When restrictions are displayed, only show current applicable ones |
displayPlayerCanDoOnJoin | true | When a player joins, show them what they can do |
displayPlayerCantDoOnJoin | true | When a player joins, show them what they cant do |
displayPlayerCanDoOnLevelChange | true | When player levels up, show them what they can do |
displayPlayerCantDoOnLevelChange | false | When player levels up, show them what they cant do |
displayPlayerCanDoNowOnLevelChange | true | When player levels up, show them anything new that they can do |
displayPlayerCanDoNextOnLevelChange | true | When player levels up, show them anything new that they can do at the next level |
playerKeepItemLevelOnXPLoss | false | When a player loses xp (e.g. they die), do not reduce their item level and keep their restrictions as they were when they died |
defaultDenyUnlisted | false | Set to true if you want players to be restricted to everything apart from rules they explicitly pass. |
Rules.
You can have as many rules as you want though each rule needs to have a unique name and look like this in your config:
rules: UniqueNameOfYourRule: ... settings here (see below) .... YourNextUniqueRuleName: ... settings here ...
Rule options:
setting | optional | example | description |
---|---|---|---|
description | yes | description: 'wood tools/swords' | Text displayed to the player when summarising rules. If no text is set, nothing gets displayed in the summary for this rule. |
minLevel | yes | minLevel: 3 | If set and greater than 0, the player must be a higher level than this number to pass the rule. Make this number higher than the maximum amount of levels (e.g. 100) to prevent anyone from ever passing this rule |
maxLevel | yes | maxLevel: 5 | If set, the player cannot pass this rule if their level is higher than this setting |
factions | yes | factions: [Red, Blue] | A list of Factions that this rule applies to. Note that Factions must be installed and running on your server |
actions | no | actions: [use, craft] | One or more actions that this rule applies to. Options are: use, break, place, craft and pickup. |
items | yes | items: [268, 269] | One or more itemIDs that this rule applies to. Optionally seperate data values with a "." e.g. 5 = all wood planks, 5.0 = oak planks, 5.2 = ash planks |
Comments