ConfigPlus

ConfigPlus

ConfigPlus is a library which allows other plugins to have better Config files.
With it, plugins can change, add and remove values and comments in config files, without all the comments disappearing, like they do if plugins use the default Bukkit config system.

With ConfigPlus, other plugins could make commands to change config settings, so you don't have to edit the files manually. They also don't have to reset the config on every update, since they can now simply change/add/fix some stuff.

Why use ConfigPlus?

• Easy to use
• You can modify the config with your plugin without losing all the comments!
• Easily have multiple configs
• Preserves comments and empty lines (even mid lists)!
• Preserves the complete format of comments (leading/trailing whitespace is preserved).
• Does not use a YAML dependency (In fact, does not use YAML at all)
• Quotes are only added when really necessary (strings with leading/trailing whitespace, with quotes or with colons)
• Mixed lists (list with integers, doubles and strings for example)
• If you want to change a list to the short format, thats totally possible
• You can add/remove elements and sections easily.
• You can add comments above and below entries, above and below existing comments.
• You can remove comments
• Implements Bukkit's ConfigurationSection –> Very little work to switch from the Bukkit system
• Thread-safe concurrent read access (config.getX() will always work without blocking, synchronous and asynchronous, for unlimited threads)
• Thread-safe concurrent alteration of the config (config.set() will not interfere with asynchronous tasks/threads)
• You can add save/load implementation for other Objects

Things to note:

• ConfigPlus does NOT support comments on the same line as entries! (Hello: "value" #comment will be interpeted as a String "\"value\" #comment")
• ConfigPlus can be used standalone, without any dependencies (Just Java 7), by referencing Config instead of BukkitConfig

How to use?

Maven

1. Add ConfigPlus as a maven dependency:

   
<repository>
  <id>configplus-repo</id>
  <name>ConfigPlus Repo</name>
  <url>http://www.taico.nl/configplus/maven&lt;/url&gt;
</repository>

   <dependency>
     <groupId>nl.taico</groupId>
     <artifactId>configplus</artifactId>
     <version>1.2.0</version>
     <scope>provided</scope>
   </dependency>

   
   NOTE: Javadocs are available.

2. Add ConfigPlus as a dependency in plugin.yml (depend: [ConfigPlus])
3. Add ConfigPlus as a "Required Dependency" on BukkitDev (see http://wiki.bukkit.org/BukkitDev:Project_Submission_Guidelines#Relationships)
4. Tell users of your plugin to download ConfigPlus from this page

Non Maven

1. Download the latest version of configplus
2. Add it as a dependency to your project
3. Add ConfigPlus as a dependency in plugin.yml (depend: [ConfigPlus])
4. Add ConfigPlus as a "Required Dependency" on BukkitDev (see http://wiki.bukkit.org/BukkitDev:Project_Submission_Guidelines#Relationships)
5. Tell users of your plugin to download ConfigPlus from this page