Configuration

The default configuration file is heavily commented and should be self explanitory, however here are all the options as of the latest build:

settingdefaultdescription
excludedWorldsemptya list of worlds that the rules do not apply. e.g. excludedWorlds: [worldname, worldname_nether]
defaultMinMessageYou cannot use %m until level %minThe default message shown to player if they do not meet the minimum level of rule (if specified)
defaultMaxMessageYou cannot use %m past level %maxThe default message shown to player if they exceed the maximum level of rule (if specified)
defaultOtherMessageYou cannot use %mDefault message shown when rule fails for unspecified reason
defaultDisplayCurrentRestrictionstrueWhen restrictions are displayed, only show current applicable ones
displayPlayerCanDoOnJointrueWhen a player joins, show them what they can do
displayPlayerCantDoOnJointrueWhen a player joins, show them what they cant do
displayPlayerCanDoOnLevelChangetrueWhen player levels up, show them what they can do
displayPlayerCantDoOnLevelChangefalseWhen player levels up, show them what they cant do
displayPlayerCanDoNowOnLevelChangetrueWhen player levels up, show them anything new that they can do
displayPlayerCanDoNextOnLevelChangetrueWhen player levels up, show them anything new that they can do at the next level
playerKeepItemLevelOnXPLossfalseWhen a player loses xp (e.g. they die), do not reduce their item level and keep their restrictions as they were when they died
defaultDenyUnlistedfalseSet 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:

settingoptionalexampledescription
descriptionyesdescription: '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.
minLevelyesminLevel: 3If 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
maxLevelyesmaxLevel: 5If set, the player cannot pass this rule if their level is higher than this setting
factionsyesfactions: [Red, Blue]A list of Factions that this rule applies to. Note that Factions must be installed and running on your server
actionsnoactions: [use, craft]One or more actions that this rule applies to. Options are: use, break, place, craft and pickup.
itemsyesitems: [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

Posts Quoted:
Reply
Clear All Quotes