Configuration

From ServerSigns
Jump to: navigation, search

Config.yml


# Don't touch this! It might wipe your entire config!!
config-version: 2
 
# A list of material names (should be in the Bukkit/Spigot Material enum form)
# These materials define the blocks which can be used with ServerSigns
# Refer to this page for the list: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html
blocks:
- SIGN_POST
- WALL_SIGN
 
# Whether or not any block can be used with ServerSigns (overrides 'blocks' list)
any_block: true
 
# The language key which should be used to find the languages file
# For example, 'en' will resolve to the 'ServerSigns/translations/en.yml' file
language: 'en'
 
# The prefix used in most ServerSigns messages
message_prefix: '&2[ServerSigns]'
 
# The colour for most ServerSigns messages
message_colour: '&e'
 
# Whether or not Vault should be used for permissions granting
vault_grant: true
 
# The command to execute from console for setting permissions without Vault
permission_add_command: 'pex user <player> add <permission>'
 
# The command to execute from console for removing permissions without Vault
permission_remove_command: 'pex user <player> remove <permission>'
 
# Whether or not admins must be sneaking to destroy ServerSigns
sneak_to_destroy: true
 
# Whether or not to display a message to players when funds are removed from account
show_funds_removed_message: true
 
# The currency string or symbol for use in messages
currency_string: 'dollars'
 
# Whether or not the plugin should announce ServerSigns developers joining your server
broadcast_developers: true
 
# Whether or not the plugin should automatically check for the latest version and download it
check_for_updates: true
 
# Whether command logging to the console should be disabled
disable_command_logging: false
 
# Whether the plugin should listen for left clicks as well as right clicks for ServerSign activation
# This option must be enabled to allow ServerSigns to execute different commands for left & right clicks
allow_left_clicking: false
 
# Whether funds remove via /svs setprice should be sent to a server bank
send_payments_to_bank: false
 
# The server bank name (used if send_payments_to_bank is set to true)
deposit_bank_name: 'server'
 
# Whether the Player#chat() function should be used instead of Player#performCommand() for commands
# If enabled, this means commands executed through ServerSigns will fire the command pre-process event
alternate_command_dispatching: false
 
# Whether or not you want to opt-out of Metrics statistic gathering through www.mcstats.org
metrics_opt_out: false
 
# A list of commands which cannot be attached to ServerSigns (to prevent console-only command exploits)
blocked_commands:
- 'op'
- 'deop'
- 'stop'
 
# Defines the task delay threshold (in seconds) above which tasks will be persisted to disk
task_persist_threshold: 10

Most Common Block Values


blocks: 
# Default:
- SIGN_POST
- WALL_SIGN
# Redstone activators:
- STONE_BUTTON
- WOOD_BUTTON
- LEVER
# Pressure plates
- GOLD_PLATE
- IRON_PLATE
- STONE_PLATE
- WOODEN_PLATE
# Doors and Gates
- ACACIA_DOOR
- BIRCH_DOOR
- DARK_OAK_DOOR
- JUNGLE_DOOR
- SPRUCE_DOOR
- TRAP_DOOR
- WOODEN_DOOR
- ACACIA_FENCE_GATE
- BIRCH_FENCE_GATE
- FENCE_GATE
- DARK_OAK_FENCE_GATE
- JUNGLE_FENCE_GATE
- SPRUCE_FENCE_GATE
# Chests
- TRAPPED_CHEST
- ENDER_CHEST
- CHEST
# Miscellaneous 
- BREWING_STAND
- ENCHANTMENT_TABLE
- CAULDRON
- ANVIL

Translations

The translations folder (located at plugins/ServerSigns/translations) contains all the language files used in the translations system for ServerSigns messages. ServerSigns will load the language file that corresponds with the language value defined in the config.yml.

Defaults

The plugin will generate (and overwrite) the supported default translation files ending in _default.yml on each server restart. Any unsupported languages with an _default.yml file present will be discarded. You should never alter the default files.

Custom Translation Files

It is very easy to create a custom translation file for ServerSigns to use - all you need to do is create a copy of en_default.yml (or any other default file) and rename the file to <language>.yml (for example, en.yml de.yml fr.yml etc). Now simply edit the newly copied file and change any messages you wish; colour codes are fully supported, and leaving a message blank will cause it to be skipped when sending messages to clients.

The following translations have been created by the community:

External Dependencies

Although ServerSigns does not explicitly require any other plugins to use, it is highly recommended to install Vault and one of the supported Permission/Economy plugins shown. By having Vault on your server it enables ServerSigns to become even more powerful & allows you to manipulate player permissions, groups & economy balances with a variety of tools and functions.

See Also