-
Notifications
You must be signed in to change notification settings - Fork 63
Config
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
~ornullwill not send that message, if you set it to""it'll still send an empty line. - You can use
\nline break to break lines for messages. - All the Minecraft materials can be found here.
- All the Minecraft sounds can be found here. Minecraft volumes start from
0.0to1.0Any number higher than that will just increase the radius the player can hear the sound from, normal is1.0. Pitch starts from0.5to2.0normal is1.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.
- All the math equations support all the math operators such as
You can use the new 1.16 custom hex colors. It's quite easy but can be messy sometimes. Some formats such as bold and italic formats might not work correctly if you use them before these codes.
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 bffa5quick &l򸏖brown &#c48d20fox &rjumped over the lazy &kdog
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 Messagein the chat using your cursor. -
Action: The action performed when you click on
Chat Messagein the chat.
-
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 useurl:
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/}
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.
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. Language entries don't have any explanation, they're mostly easy to understand. If you couldn't find the usage for an entry, you can always ask.
The language entry format for all the commands are commands -> [groups...] -> <name> where [groups...] are the main command names of that command and <name> is the main command name of that command. The group and names are explained in the permissions section.
All the language entries support:
- Chat Colors
- Line Breaks \n (It also keeps the color for the next line.)
- Complex Messages
- Internal & External Placeholders
- Complete Removal (by setting it to an empty text string '' or "")
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.
Each GUI uses an entire YAML file to parse its settings from the guis -> <lang> folder.
Unlike language files, 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.
-
title:The title of the GUI. -
rows:The rows of the GUI, it can be from1to9 -
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 issound: <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.
These options are used under the item names which is under options entry of GUIs. Option names are really important for some GUIs. They define what an option does from the code. If an option name doesn't have any actions attached to it, it'll not do anything when clicked on. This is where conditional GUIs come to use.
All the text options in items support color codes and placeholders.
-
name:The name of the item. -
lore:The lore of the item. You can use this differently. Either by using yaml lists or using strings and\n. You can also use\nif you're using a list. -
material:The material if the item. -
amount:The item amount. -
damage:The item's damage (durability). -
skull:The item's skull texture. This can be a player's name, UUID, a textures.minecraft.com link or a Base64. The recommended value is always Base64 as it doesn't require encoding and connections. A good website to get skull textures from that also supports Base64 is minecraft-heads.com. The value preference for this option from best to worst is as follows:base64->textures link->UUID->NameNote that you need to set the material toPLAYER_HEADfor this to work. -
unbreakable:true or false. Whether this item should have an unbreakable attribute. -
model-data:The 1.14 custom data models feature. -
enchants:Item's enchantments. It's a yaml entry with entry keys as the enchantment name and the entry value as the enchantment level. Example:
enchants:
ARROW_FIRE: 2
DURABILITY: 3-
flags:The item flags. Item flags in Minecraft are badly named, so it might not do the exact thing you're looking for. In this case, you might want to try other flags. Example:
flags: [HIDE_ATTRIBUTES, HIDE_POTION_EFFECTS]-
attributes:Item attributes are the numbers shown in the bottom of the item's description under the item's lore. You can hide these with item flags but you can also change them with attributes.
Format:
attributes:
Attribute: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html
name: https://minecraft.gamepedia.com/Attribute
amount: The modifier's number.
operation: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/AttributeModifier.Operation.html
slot: `HEAD` - `CHEST` - `LEGS` - `FEET` - `HAND` - `OFF_HAND`Terminology - Spigot - Discord - History - Other Info
- ๐ Home
- ๐ฐ Features
- ๐ฅ Installation
- ๐ Setup
- ๐ Compatibility
- โ FAQ
โ๏ธ NFAQ- โ๏ธ Addons
- ๐ฉ Outposts
- โฎ๏ธ Peace Treaties
- ๐บ๏ธ Map Viewers
- ๐ฌ EngineHub
- ๐ Admin Tools
- โ๏ธ Introduction
- โจ๏ธ Commands
- ๐ Permissions
- ๐ฃ Placeholders
- ๐ Config
- ๐ Protection Signs
- โ๏ธ Mails
- ๐ Mechanics
- ๐งฐ Troubleshooting
- ๐ป API
๐น Basics
๐น Turrets & Structures
๐น Metadata
๐น Events
๐น Examples
๐น Addons