Skip to content
Crypto Morin edited this page Jun 28, 2020 · 144 revisions

Most of the config options are explained in their file. Please read those explanations there instead.
There are some useful methods you can use in the config files.

  • Setting a message option to ~ or null will not send that message, if you set it to "" it'll still send an empty line.
  • You can use \n line break to break lines for messages.
  • All the Minecraft materials that can be used can be found here.
  • All the Minecraft sounds that can be used can be found here. Minecraft volumes start from 0.0 to 1.0 Any number higher than that will just increase the radius the player can hear the sound from, normal is 1.0. Pitch starts from 0.5 to 2.0 normal is 1.0
  • Surprisingly one thing that some people don't know, is that you can use Ctrl + F to search for something in a file. This is useful for searching for config options or language entries. If you didn't know this, Google Ctrl + Z and Ctrl + R as well.
  • All the config options in the config that represent a time, support time suffixes. The default time suffix is seconds. Some time suffixes:
    • s, sec, secs, second, seconds
    • m, min, mins, minutes, minutes
    • h, hr, hrs, hour, hours
    • d, day, days
    • Example: time-limit: 10days
  • Math Equations
    • All the math equations support all the math operators such as +, -, /, *, %, (), ^ etc...
    • They also support all the Java Math functions.

1.16 Hex Colors

You can use the new 1.16 custom hex colors. It's quite easy but can be messy sometimes.
The format to do this is &<hex> the <hex> is a hex 6-character code for RGB colors. You can pick one from here
Example: &2The &#6bffa5quick &l&#754646brown &#c48d20fox &rjumped over the lazy &kdog

Complex Messages (Hover Messages)

The feature that doesn't work on Bukkit servers (it works on Spigot, Paper and etc...)
To use a message as a complex message, add COMPLEX: at the beginning of that message.
Now you can use hover:{} anywhere in the message. The default format for hover is hover:{chat message; hover (lore) message; action} they all support color codes and placeholders inside.

  • Chat Message: The message shown in the chat like the normal messages.
  • Hover Message: The message shown when you hover on Chat Message in the chat using your cursor.
  • Action: The action performed when you click on Chat Message in the chat.

Actions:

  • Commands: Execute a command or send a message in chat. Not using a / slash will send a chat message instead.
  • Suggestions: Put a text in player's chat box. Instead of / you have to use |
  • URL: Open an URL in player's browser. Instead of / you have to use url:

Example: COMPLEX:&2Hey hello hover:{&cthis;&2Jeff;Hello Jeff!} &2is my name.\nCome hover:{&emeet;&2Click To Meet;/tp Jeff} &2me here.\nHere, copy my hover:{&lphone number;&2Click to copy;|911} &2or just go to my hover:{&9website;&cClick To Open;url:https://www.nasa.gov/}

Main

Plugin configuration files are split into separate files to organize options. The main config is config.yml for sure.
All the config files are automatically reloaded, please read here.
Config files are not translatable but the language file and all the GUIs are.
Config files don't automatically add new options for outdated configs, they use the default option if an option is missing.

Language File

The default language file is en.yml which is not saved in the plugin, it's generated automatically.
Language files automatically add new entries to their list, however they don't remove any old ones. If a translated language file is missing an entry, it'll copy one from the original (English) version into the file instead.

When translating language files, you shouldn't translate placeholders of course. And you should not change how the sentence is worded (except if it makes it easier in that particular language)
You can change the colors if you want.

After translating your language file, place your translated file in the plugin's folder. The file's name should be the same as the option below without the .yml file extension. Some of these language files are outdated. Standard way of naming this is to follow IETF language tags from IETF use ISO-639-1 codes. All the language files are made by the community, they're not guaranteed to be 100% accurate and complete. If you translated the plugin, you can contact me and I'll add it to the plugin.

GUIs

GUIs are the same a language files except they don't automatically add new options since their 100% customizable.
If your conditional GUI options are not changing that means your Java version is JRE instead of JDK.

Main Options

  • title: The title of the GUI.
  • rows: The rows of the GUI, it can be from 1 to 9
  • type: If no rows is specified, a type will be used. You can see all the types here.
  • sound: Sound when the GUI opens. Format is sound: <type>, [volume], [pitch]
  • message: Message when the GUI opens.
  • commands: Commands executed when the GUI opens.
  • interactable: Interactable slots of this GUI. If it only contains one slot and that number is lower than zero, then the list will act as a blacklist.

Item Options

Coming soon...

Basics

Advanced

Others

Clone this wiki locally