[Tutorial] Custom .yml files

First, set File and FileConfiguration:

Code:java

File customYml = new File(plugin.getDataFolder()+"/customYmlFile.yml");
FileConfiguration customConfig = YamlConfiguration.loadConfiguration(customYml);

Then create a function to save this config:

Code:java

 public void saveCustomYml(FileConfiguration ymlConfig, File ymlFile) {
try {
ymlConfig.save(ymlFile);
} catch (IOException e) {
e.printStackTrace();
}
}

Okay, this created a custom config.
To save this, use:

Code:java

saveCustomYml(customConfig, customYml);

Now you can use the custom config as a default config.
Ex:

Code:java

customConfig.getString("path");

How to use custom config:

Setting a fields value (open) Setting a fields value (close)

Set a boolean value:

Code:java

plugin.customConfig.set("path.to.boolean", true);

Would produce:

Code:

path:
  to:
    boolean: true

Set a string value:

Code:java

plugin.customConfig.set("path.to.string", "This is a custom yml file :D");

Would produce

Code:

path:
  to:
    string: This is a custom yml file :D

Set a int value:

Code:java

plugin.customConfig.set("path.to.int", 10);

Would produce

Code:

path:
  to:
    int: 10

Getting a fields value (open) Getting a fields value (close)

Get a boolean value:

Code:java

plugin.customConfig.getBoolean("path.to.boolean");

So if had:

Code:

path:
  to:
    boolean: true

It's get true

Get a string value:

Code:java

plugin.customConfig.getString("path.to.string");

So if had:

Code:

path:
  to:
    string: This is a custom yml file :D

It's get This is a custom yml file

Get a int value:

Code:java

plugin.customConfig.getInt("path.to.int");

So if had:

Code:

path:
  to:
    int: 10

It's get 10

 

This should be better suited in the Resources subsection.

 

Moved to plugin dev resources.