-
Notifications
You must be signed in to change notification settings - Fork 5
Using The Config
SimpleCore API and all official plugins use the Configuration system included in the API. This system allows XML config files to be created for each plugin.
The files are located in the config/AleXndr folder of your Minecraft install directory (%appdata%/.minecraft on Windows). They can be opened with any text editor, however Notepad++ is recommended.
Once you open a config file, you will see lots of different entries under different categories. For example, "Copper Ore" is an entry under the "Ores" category in the SimpleOres 2 Settings.xml file. Within each entry, there are a number of different values. These values can be configured to change how the plugin works. For example, "Hardness" and "Resistance" are both values of "Copper Ore".
One of the most important things to remember when editing the config files is to ensure you get the correct data types for each value. The data types are included at the top of each config file, with a brief description of each. Please ensure you understand the importance of data types. Each value will tell you which data type it requires. Using an incorrect data type will often result in crashing.
- Boolean (@B) Booleans are true or false values. They are often used to toggle certain options on or off, such as enabling the update checker.
- Integer (@I) Integers are whole numbers, such as 1, 2, 8, 90, etc. They cannot have decimal values in them. Integers must also not be higher than about 32000, or lower than -32000.
- Float (@F) Floats are decimal numbers, such as 2.5 or 10.7. They can also be whole numbers.
- Double (@D Doubles are similar to floats, accepting decimal numbers or whole numbers.
- String (@S) Strings accept letters, numbers and characters such as abcdefg or 9jkadn28da(*
Finally, the Configuration system includes a number of Config types. There are types for Blocks, Items, Tools, Armor, and a generic type. Each different type, with the exception of the generic type, includes some built in values. Not all of these values will be present in the config file for each entry, as they might not be enabled by the plugin by default. They can be enabled by adding them to the config file, however.
For the different values built in to each Config type, see the respective pages below.