Welcome to ConfigAPI's Spigot page! You can include the JAR file in your project as compile, this means that server owners and admins won't have to install any extra dependencies to get ConfigAPI working with your plugin. This API provides all YamlConfiguration functionality but adds some interesting features while simplifying the usage. A full guide on how to use this API has been created (see the wiki on GitHub)
- Easily work with several config (YAML) files
- Report missing options in the admin's config file (and automatically give their default value)
- A missing option can automatically be substituted by its default value so that your plugin will work just fine after adding a new option or when an admin accidentally deletes an option
- Copy a config file from your JAR file to the server with only one line of code
- Automatically copy the config file if that file is not yet present on the server
- This API works out of the box but you can easily tweak its settings
It does come with a few limitations which you should consider before using the API.
- This API is focused on reading settings. So storing data or editing settings is not possible through this API with the exception of copying over a config file
- Only YAML files are supported. This is not the right address if you are using a different type of file.
Happy coding!
Quick facts
- Edition: Minecraft Java
- File type: .jar
- Minecraft versions listed: 1.12, 1.13, 1.14
- How to install: Install the matching mod loader (Forge, Fabric or NeoForge) for your Minecraft version. → Download the .jar. → Put it in the .minecraft/mods folder and launch that loader profile.
- Where to get it: Opens on Spigot — not every file is mirrored on our own servers.
Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.
ConfigAPI [1.12 - 1.15] is a free Minecraft Java mod. Compatible with Minecraft 1.12, 1.13, 1.14, 1.15. Downloaded 140 times (via Spigot). Download it and open it directly in the game.