[LIB] WootConfig - Easy config and data saving for your plugin, without yml!

Hello everyone! A day ago I started working on my own configuration class. Why? I didn't like the Configuration method bukkit provided. That's just my opinion, no hating please

This configuration class is very easy to use and allows you to save the most important things you will most likely need to save for Bukkit plugins. It uses the .properties file format, just like the standard server.properties.

How to use it?

1. Create an instance of my WootConfig class.
   Code:java

   WootConfig config = new WootConfig(new File("config.properties"));

2. Try to load the current config file, in case it exists.
   
   Code:java

   try
   {
   config.loadFile();
   } catch (IOException e) {
   //Something went wrong while loading the file.
   }

3. Save some settings to memory.
   
   Code:java

   config.setString("test", "name");
   config.setInteger("int", 1548748);
   config.setDouble("double", 4984.468);

4. Save the settings in memory to the file.
   
   Code:java

   try {
   config.saveFile("Test config file by WootConfig");
   } catch (IOException e){
   //Something went wrong while saving the file. 
   }

5. Your file is now saved and ready to be loaded!
6. To load the file into memory again use the code from step 1 again.
7. Retrieve some settings from the config using:
   
   Code:java

   int oldInt = config.getInteger("int");
   Location savedLocation = config.getLocation("spawnloc");

Completed code:

Code:java

WootConfig config = new WootConfig(new File("config.properties"));
try {
config.loadFile();
} catch (IOException e) {
}
config.setString("name", "test");
config.setString("test", "name");
config.setInteger("int", 1548748);
config.setDouble("double", 4984.468);
try {
config.saveFile("Test config file by WootConfig");
} catch (IOException e) {
}
int oldInt = config.getInteger("int");
Location savedLocation = config.getLocation("spawnloc");
//Do stuff using the settings you just loaded.

Features

• Save double, int, String, boolean
• Save arrays, lists and maps
• Save ItemStacks, Locations, Inventorys
• more soon!

Download
Regular download: http://woutwoot.com/download/
GitHub gist: https://gist.github.com/woutwoot/9758674
If you use my class, it would be nice if you give me credit somewhere, and like this post if you want to

Note: I know the methods don't have to return booleans right now, but I might be using that later.

 

woutwoot Looks cool, any change to github?

 

Thanks! I'll put it on gitHub once I can. I'm currently using my mobile phone, so probably later today.

 

woutwoot Okay
EDIT: Thanks! , this question is kinda out of topic, but do you think I should create 1 file per player? or 1 file for all? (I will have to store quite a bit of data)...

 

Sure, just create a WootConfig instance for every player using their name or something unique. Pseudo-code example:

Code:java

List<WootConfig> configs = new ArrayList<WootConfig>();
for(Player p : playersToSave){
configs.add(new WootConfig(new File(this.getDataFolder() + File.separator + p.getName())));
}

After that you can loop through the configs and access the one with the right file.

But, if the player doen't have to edit the config, and it's only saving data, I'd use one file.

 

woutwoot Will multiple configs cause lags/memory leaks? (theres gonna be LOTS of players,) the config itself will save 1 inventory for the player, and few integers..

 

Well, there is going to be some lag, whatever you do, but If you really need it very very optimized, I suggest you make your own config class that just saves it to text files with as least byes as possible. Memory leaks shouldn't happen with my class.

 

woutwoot How can I check if X config alredy exists?

 

If you're having problems with stuff like this, you should ask in the plugin development forum. But, just because I'm a nice guy :

Code:java

if(file.exists()){
  //File exists, do stuff
}else{
  //File does not exist, create one or show message
}

Note that my class already checks if a file exists when you call the load method, if it does not exist, it doesn't do anything.

 

Something along

File file = new File("MyFile.properties");

if (file.exist() {
// your file exists
} else {
new WoolConfig(file);
}

edit ninja'd

 

woutwoot I have yet to use configs since I do not like bukkit config system (looks too complicated for me.), therefore I had to store the data on the player inventory itself (like maybe item lore) , thanks tho
Edit: well, again, havent really used configs... how can I set something to something? so like when player login, Il set the first line of the config to player name and integer..

 

You could make one config per var you're storing and use the player name as the key. For example:

Code:java

WootConfig confNumberOfJoins = new WootConfig(new File(this.getDataFolder() + File.separator + "confNumberOfJoins.properties"));
confNumberOfJoins.loadFile();
@EventHandler
public void onPlayerJoin(PlayerJoinEvent event){
  confNumberOfJoins.setInteger(event.getPlayer.getName(), confNumberOfJoins.getInteger(event.getPlayer.getName())+1);
}

 

woutwoot Thanks

 

Quite interesting

 

Thanks! I'll be uploading an improved version soon.

Update! You can now also save hashmaps, and load the entire config as a hashmap!

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

how to do defaultConfigfiles

 

How do you mean? Having settings already present? I might be implementing some code for that, but for now, I tink you should just save the defaults to the config file if the file does not exist yet.

 

I love this! However, I was having massive issues using this with file paths, much like the other Java noobs such as myself. I learned some stuff and then I edited the constructor of your awesome library to correctly create file paths and the file that goes inside!

Code:java

package com.woutwoot.wootconf;
 
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
 
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.ItemStack;
import org.bukkit.util.io.BukkitObjectInputStream;
import org.bukkit.util.io.BukkitObjectOutputStream;
import org.yaml.snakeyaml.external.biz.base64Coder.Base64Coder;
 
/**
* Configuration class that uses .properties file format to store various settings and data.
*
* @author woutwoot
*/
public class WootConfig {
 
    private File configFile;
    private Properties props = new Properties();
 
    /**
    * @param configFile
    */
    public WootConfig(File file) {
        this.configFile = file;
        this.setConfigFile(configFile);
 
        String s = file.getPath();
        int index = s.lastIndexOf(File.separator);
        String path = s.substring(0, index);
        File folder = new File(path);
 
        if(!folder.exists()){
            folder.mkdir();
        }
        if(!file.exists()){
            try {
                file.createNewFile();
            } catch (IOException e) {
            }
        }
    }
 
    /**
    * Loads the actual config file in memory.
    *
    * @throws IOException
    */
    public void loadFile() throws IOException {
....
........
............ rest of class

After replacing your original constructor with mine... to use this to make a new fire path/folders and a file inside, do the following:

Code:java

File file = new File("plugins" + File.separator + "AwesomePluginName" + File.separator + "data" + File.separator + "data.txt");
    WootConfig config = new WootConfig(file); //Creates the file ".../plugins/AwesomePluginName/data/data.txt"

And then you just use your wootconfig as you outlined before

 

Nice addition However, I do like to keep a little more control over files and folders being created. I'll consider updating my code! (You could have also used folder.mkdirs() )