Skip to content

Configuration

Jump to bottom
MylesMor edited this page Feb 26, 2021 · 10 revisions

signs.yml

The main configuration file for this plugin is signs.yml.

It is not recommended to edit this file directly in case you may a mistake, as this would render all signs invalid until fixed again (meaning they could be broken in-game and their configuration would then be lost).

However, if you do decide to edit this, use /ss reload in-game. This will either tell you if the whole configuration file is invalid or display which signs have an invalid configuration so that they can be purged or fixed (more information on this below).

DO NOT TOUCH THE VERSION: X.X.X ENTRY.

Errors

  • If the whole file is invalid due to a YML syntax error, a message will be displayed stating that There was an error with the SudoSigns Config!. This should be fixed before the next server reload/restart.

  • If an individual sign is invalid (often caused by a wrong location or a sign is no longer present on that block), it will say Config successfully reloaded! Found 2 invalid sign(s): followed by a list of the invalid signs. This can be fixed using one of two methods:

    • FIXING THE SIGN: To do this, run /ss fix <name> or click [FIX] on the reload message. This will attempt to replace the sign in the correct position (with the previous sign text/messages/commands/permissions), so that it will work normally again.
    • PURGING THE SIGN: To do this, run /ss purge <name> or click [PURGE] on the reload message. This will remove the sign's entry from signs.yml and it can no longer be recovered.

Example

An example of how the signs.yml file might look with 1 sign is provided below:

Config example

This sign has:

  • The name: hub.
  • The text specified under the text key (with colour codes).
  • The cost of 5 currency (Vault + Vault-compatible economy plugin required)
  • The exact location and rotation of the sign.
  • The sign's material.
  • No specific permissions required to run the sign.
  • One message: &2Teleporting to spawn... with a delay of 3000 milliseconds (which is 3 seconds).
  • One player command with a delay of 3000 milliseconds (3 seconds):
    • /warp hub
    • Since it's a player command, the player running the sign must have the permission for the command (in this case essentials.warp).
  • No console commands
  • VERSION - DO NOT TOUCH

SudoSigns - MylesMor https://mylesmor.dev

Clone this wiki locally