https://github.com/nlfmt/bukkitconfigfilehelper

Provides easy access to YAML files using the Bukkit API
https://github.com/nlfmt/bukkitconfigfilehelper

bukkit papermc spigot yaml

Last synced: 21 days ago
JSON representation

Provides easy access to YAML files using the Bukkit API

• Host: GitHub
• URL: https://github.com/nlfmt/bukkitconfigfilehelper
• Owner: nlfmt
• Created: 2022-08-19T17:47:04.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-19T17:47:11.000Z (over 2 years ago)
• Last Synced: 2025-01-13T01:44:22.410Z (30 days ago)
• Topics: bukkit, papermc, spigot, yaml
• Language: Java
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ConfigFile - YAML Helper class for Bukkit/Spigot/Paper/...

This wrapper class allows easy access to YAML files from your Bukkit/Spigot/Paper/... plugin.\

Every method is well-documented so you should be able to get started quickly

## Setup

The only thing you need to get started is calling `setPlugin()` in your `onEnable` method.

```java

ConfigFile.setPlugin(this);

```

The ConfigFile needs the plugin to know where it can load resources from.

## Config Types

ConfigFiles can have 3 types, `LOAD_AND_SAVE`, `LOAD_ONLY` and `SAVE_ONLY`. \

**"Loading"** means, that it is looking for default values in your plugin resource folder. \

**"Saving"** means, that you can call `save()` to write all values to a file in the plugin data folder.

## Examples

```java

// Loads a config.yml datei from the folder "folder"

// This constructor sets the type to ConfigFile.Type.LOAD_AND_SAVE

ConfigFile config = new ConfigFile("folder/config");

// Using the config works as always, since its just a YamlConfiguration underneath.

config.set("Test", 4);

String test = config.getString("SomeDefaultValue");

// Save your changes to the data folder (the resource in you plugin's jar is not modified)

config.save();

// Delete the file from the plugin data folder

config.delete();

// If you dont have default values, you can change the type to SAVE_ONLY

ConfigFile data = new ConfigFile("data", ConfigFile.Type.SAVE_ONLY);

data.set("data1", "test");

data.save();

// if you only want to load the defaults from the resource folder

// and never save changes to the data folder, use LOAD_ONLY

ConfigFile defaults = new ConfigFile("defaults", ConfigFile.Type.LOAD_ONLY);

String value = defaults.getString("SomeValue");

```

## Bugs & Improvements

If you found a bug, please open an Issue, explain it in detail and ideally add source code or error messages.

If you think this class can be improved, send me an email at [email protected], or submit a pull request.

## License

You're free to use the code in any way you want, altough I'd appreciate it if you mentioned me :)