Bukkit

Overview

ScrollingMenuSign uses a config file in the plugin data directory: plugins/ScrollingMenuSign/config.yml. This is a YAML file and can be edited directly if you want. If you do edit it while the server is running, it's strongly recommended to reload your changes immediately with /sms reload - any server reload/restart or /sms setcfg command will cause unreloaded changes to be overwritten.

If config.yml doesn't exist when the plugin starts up, a default one will be written (see below for list of defaults).

Managing Config

To view or change configuration settings from within the game, you can use /sms getcfg and /sms setcfg (either from the Minecraft client or the CraftBukkit console). These can be shortened to /sms get and /sms set. Tab completion is also supported, e.g. you can type /sms get actions.<Tab> and the plugin will give you a choice of the possible config items starting with actions. .

Example:

/sms get
-------|18 lines (page 1/1)|----------
sms.actions.leftclick.normal = execute
sms.actions.leftclick.sneak = none
....
--------------------------------------

To update a setting, use /sms set <key> <value>. Example:

/sms set actions.leftclick.sneak execute

Configuration Reference

Valid actions for configuration keys under actions.* are:

• none - as name suggests, do nothing
• execute - execute the currently selected menu item
• scrollup - scroll the menu up
• scrolldown - scroll the menu down

Prefix strings for item_prefix.* can include colour codes, but be aware that this will further reduce the number of displayable characters on a menu item.

Sign Protection

Having menu signs destroyed can be an irritation, so ScrollingMenuSign offers a couple of configuration items to mitigate this.

no_physics

If this is true, then any physics events relating to a menu sign will be cancelled. To see the effect of this, create a sign and add it to a menu. Then destroy the wall the sign is attached to (or the floor it's on if it's a floor sign). With no_physics set to true, the sign will be left floating in mid-air, with the menu still usable. With no_physics set to false, the sign will "pop off", and be quietly removed from the menu it belonged to.

no_explosions

If this is true, then any explosions (creeper or TNT) that would have broken a view block (sign or redstone view) will leave that block intact (surrounding blocks can still be destroyed, though). Damage to entities from the explosion will not be cancelled (so no standing beside signs to avoid death by creeper!). If set to false, the sign may be destroyed, but will not be removed from its menu. In this case, running /sms list will show missing signs (such locations will be suffixed with [NO SIGN]). You can then either rebuild and replace the sign in the right location, or cleanly remove the sign with /sms break -loc <x,y,z,world> - this is best done from the console, where the location can be cut & pasted.

no_destroy_signs

If this is true, it will be impossible to destroy any menu signs by normal means. This is mainly for the benefit of creative mode in Minecraft 1.8+, where a single click destroys blocks - it's annoying to accidentally destroy a menu sign you're trying to use. To destroy such a sign, first use /sms break on it to remove it from its menu, and then destroy it as normal. (This does not - and cannot - protect against "special" means, such as the super pickaxe in WorldEdit).

List Values

Some keys in the configuration hold list values. These can store multiple items. E.g. elevation.nodes stores a list of permission nodes to add to a user when running elevated commands.

To add an item to a node, just use /sms setcfg <key> <value> as normal. E.g.

/sms setcfg elevation.nodes abc.def
elevation.nodes is now set to "[general.give.any, general.give, abc.def, general.time.set]"

"abc.def" was added to the existing list.

To remove an item, put a '-' in front of the list:

/sms setcfg elevation.nodes - abc.def
elevation.nodes is now set to "[general.give.any, general.give, general.time.set]"

To set the item to a new list, put an '=' in front of the list:

/sms setcfg elevation.nodes = abc.def ghi.jkl
elevation.nodes is now set to "[abc.def, ghi.jkl]"

You can clear the list entirely with /sms setcfg elevation.nodes =

/sms setcfg elevation.nodes =
elevation.nodes is now set to "[]"