Home
Dieter Nuytemans edited this page Dec 21, 2019
·
7 revisions
ConfigAPI is an API for Spigot plugins. Its main goal is to allow a developer to introduce new options in the config file more easily and make sure they also don't have to worry about managing multiple configuration files. Missing options can be retreived and/or reported to the console.
Some prominent features of this API are:
- Easily create and manage several configuration files simultaneously
- Reporting all missing (and/or redundant) options to the console to help server admins track down issues
- Works out of the box but more precise settings are available
- Reloading a config file by just calling a single method after which all values are refreshed
This API was created with a very specific goal in mind so there are some limitations:
- ConfigAPI is for reading only with the exception of copying a file from the jar file to the server
-
In order to read an option, you need to know its exact path (eg. you can't get a list of keys through this API)- This is now possible through ConfigAPI#getConfiguration() which will provide a
YamlConfiguration
- This is now possible through ConfigAPI#getConfiguration() which will provide a
- Only YAML files are supported
If either one of these limitations bother you, this API is not for you. Download any version from the versions folder.
Proceed to the next page by clicking here
(still easy, don't worry)