Skyoconfig - Create configurations with ease !

​

​

What is it ?​

Skyoconfig is a class used to simplify the creation and the management of plugins' configurations.​

​

How to use ?​

First, you have to download the class here.​

Then, create a new class named "PluginConfig" which extends Skyoconfig, It will be our configuration's class.​

For the moment copy-paste the following code (do not worry, you will understand) :​

Code:java

public class PluginConfig extends Skyoconfig {
 
    @ConfigOptions(name = "configurable.string.1")
    public String configurableString = "This String is configurable like others fields below ;)";
    @ConfigOptions(name = "configurable.int.1")
    public int configurableInt1 = 1;
    @ConfigOptions(name = "configurable.int.2")
    public int configurableInt2 = 0;
    @ConfigOptions(name = "configurable.list.1")
    public List<String> configurableList = Arrays.asList("YAML list...", "So awesome !");
    @ConfigOptions(name = "configurable.map.1")
    public HashMap<String, String> configurableMap = new HashMap<String, String>() {
        private static final long serialVersionUID = 1L; {
            put("key1", "value1");
            put("key2", "value2");
        }
    };
 
    public String configurable_string_2 = "This one does not needs the annotation but the field's name looks so bad !";
 
    public PluginConfig(final File configFile) {
        super(configFile, Arrays.asList("This is an header...", "...Which looks more than one line !"));
    }
 
}

This is how looks a configuration class, now we have to create the plugin :​

Code:java

public class AwesomePlugin extends JavaPlugin {
 
    private PluginConfig config; //Can be static too !
 
    @Override
    public final void onEnable() {
        final Logger logger = getLogger();
        try {
            config = new PluginConfig(new File(this.getDataFolder(), "config.yml"));
            config.load(); //Load the config.
            logger.log(Level.INFO, "Voici le champ \"configurableString\" : \"" + config.configurableString + "\".");
        }
        catch(final InvalidConfigurationException ex) {
            ex.printStackTrace();
            logger.log(Level.SEVERE, "Oooops ! Something went wrong while loading the configuration !");
            Bukkit.getPluginManager().disablePlugin(this);
        }
    }
 
    @Override
    public final void onDisable() {
        try {
            config.save(); //Save the config.
        }
        catch(final InvalidConfigurationException ex) {
            ex.printStackTrace();
            getLogger().log(Level.SEVERE, "Oooops ! Something went wrong while saving the configuration !");
        }
    }
 
}

Okay, now, export your plugin, place it into your "plugins" folder and start your server.​

Open the configuration file (usually .../plugins/NameOfYourPlugin/config.yml) and you will see something like that :​

​

​

Finished ! You have created your configuration in an easy way ​

​

If you have any question or bug report, feel free to post it here.​

 

hi can you pleas help me with my config this is my first time making a config.yml

 

sheeprgrate Yes ?

 

saveConfig();

 

Phasesaber Not with Skyoconfig

 

BOGUS! And do you have configs in other folders? Like, I have a plugin that I'm working on right now that has the plugin folder in the same directory as the plugins folder & bukkit.jar. It's really neat.

 

Phasesaber That's not false, you do not have to call saveConfig() with Skyoconfig.
And yes, because you choose the folder

 

Very nice Skyost
Really improves your code.

 

I see! I love that!

 

lenis0012 Thank you
Phasesaber Thanks too

 

So, how do you access the config? (noobish question, new with bukkit yaml config system xD)

edit: Also thanks for the manager class! great work man

 

ARCT3CK Create a config variable. I have included an example on Github

 

private PluginConfig config;
Sorry i didn't read that variable
Thanks for the resource!
A cake for you

 

ARCT3CK Thanks

 

Only one question, i need to write some coords on the config

I'm trying to do something like this »

Code:java

getConfig().set("Location.x", p.getLocation().getX());

Can i do this with Skyoconfig? using your v.0.6 version

Thanks

 

ARCT3CK Yes, you put a Location in the config's class

 

Haha this has made my plugin config creation a lot easier, this resource should be on Sticky