Initial commit

.gitignore

@@ -0,0 +1,166 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/intellij+all,macos,java,gradle
+# Edit at https://www.toptal.com/developers/gitignore?templates=intellij+all,macos,java,gradle
+
+### Intellij+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Gradle ###
+.gradle
+build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Cache of project
+.gradletasknamecache
+
+# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
+# gradle/wrapper/gradle-wrapper.properties
+
+### Gradle Patch ###
+**/build/
+
+# End of https://www.toptal.com/developers/gitignore/api/intellij+all,macos,java,gradle

README.MD

@@ -0,0 +1,193 @@
+# ConfigAPI
+Config API for Bukkit 1.8 - 1.16 based on Dynamic Proxies
+
+## Features:
+ - Create config via Interface with `default` getters and setters
+ - Automatic generation of YAML files based on Java code
+ - Automatic updates of YAML file after adding new field to config
+ - Support of comments in YAML files
+ - Support of multiple config files
+ - System of serializers for custom objects (e.g. ItemStack, Location)
+ - Automatic translation of `&` based colors 
+
+## Import
+#### Gradle
+```groovy
+maven {
+    url = 'https://repo.mikigal.pl/releases'
+}
+
+compile group: 'pl.mikigal', name: 'ConfigAPI', version: '1.0'
+```
+
+#### Maven
+```xml
+<repository>
+    <id>mikigal-repo</id>
+    <url>https://repo.mikigal.pl/releases</url>
+</repository>
+
+<dependency>
+    <groupId>pl.mikigal</groupId>
+    <artifactId>ConfigAPI</artifactId>
+    <version>1.0</version>
+    <scope>compile</scope>
+</dependency>
+```
+
+## How to use?
+#### Java code
+```java
+public class TestPlugin extends JavaPlugin {
+
+    private static TestConfig testConfig;
+
+    @Override
+    public void onEnable() {
+        testConfig = ConfigAPI.init(
+            TestConfig.class, // Class of config's interface
+            NameStyle.UNDERSCORE, // Style of fields' name in YAML file
+            CommentStyle.INLINE, // Style of comments in YAML file
+            true, // Automatic translation of '&' based colors
+            this // Instance of plugin
+        );
+
+        // You can simply access data from the config by getters
+        System.out.println(testConfig.getExampleMessage());
+        Bukkit.getPlayer("mikigal").getInventory().addItem(testConfig.getAward());
+
+        // After calling setter new data are automatically saved to file
+        testConfig.setAward(new ItemStack(Material.DIRT));
+
+        // If you want to do something manually you can access instance of YamlConfiguration
+        testConfig.getBukkitConfiguration();
+    }
+
+    public static TestConfig getTestConfig() {
+        return testConfig;
+    }
+}
+
+@ConfigName("test.yml") // Name of YAML file
+public interface TestConfig extends Config {
+
+    @Comment("This comment will be saved to YAML file!")
+    default String getExampleMessage() {
+        // Getter method should return default value of the field
+        return "&cIt's default value of example message";
+    }
+
+    default ItemStack getAward() {
+        return Item.of(Material.DIAMOND_SWORD) 
+            .name("&cAward")
+            .lore("&aFirst line", "&cSecond line")
+            .toItem();
+    }
+
+    public void setAward(ItemStack award);
+
+    // Key of Map must be String
+    default Map<String, Integer> getValues() {
+        Map<String, Integer> map = new HashMap<>();
+        map.put("a", 1);
+        map.put("b", 2);
+
+        return map;
+    }
+
+    default List<Location> getSpawnPoints() {
+        World world = Bukkit.getWorld("world");
+        return Arrays.asList(
+            new Location(world, 0, 100, 0),
+            new Location(world, 10, 90, 10, 90f, 0f),
+            new Location(world, 20, 80, 20, 0f, 180f)
+        );
+    }
+}
+```
+
+#### Automatic generated YAML from above Java code
+```yaml
+values:
+  a: 1
+  b: 2
+example_message: '&cIt''s default value of example message' # This comment will be saved to YAML file!
+spawn_points:
+  type: org.bukkit.Location
+  '0':
+    world: world
+    x: 0.0
+    y: 100.0
+    z: 0.0
+    yaw: 0.0
+    pitch: 0.0
+  '1':
+    world: world
+    x: 10.0
+    y: 90.0
+    z: 10.0
+    yaw: 90.0
+    pitch: 0.0
+  '2':
+    world: world
+    x: 20.0
+    y: 80.0
+    z: 20.0
+    yaw: 0.0
+    pitch: 180.0
+award:
+  material: DIAMOND_SWORD
+  amount: 1
+  name: '&cAward'
+  lore:
+  - '&aFirst line'
+  - '&cSecond line'
+
+```
+
+## Serializers
+### API has built-in serializers for: 
+ - ItemStack
+ - Location
+ - PotionEffect
+ - ShapedRecipe
+ - UUID
+
+#### You can also make your own serializers
+```java
+public class PotionEffectSerializer extends Serializer<PotionEffect> {
+
+    @Override
+    protected void saveObject(String path, PotionEffect object, BukkitConfiguration configuration) {
+        // In saveObject() method you have to set data of object to config. You can use set() method to set another object which need serialization too 
+        configuration.set(path + ".type", object.getType().getName());
+        configuration.set(path + ".duration", object.getDuration());
+        configuration.set(path + ".amplifier", object.getAmplifier());
+    }
+
+    @Override
+    public PotionEffect deserialize(String path, BukkitConfiguration configuration) {
+        // In deserialize() method you have to load data from config and return instance of object
+        PotionEffectType type = PotionEffectType.getByName(configuration.getString(path + ".type"));
+        int duration = configuration.getInt(path + ".duration");
+        int amplifier = configuration.getInt(path + ".amplifier");
+
+        if (type == null) {
+            throw new InvalidConfigFileException("Invalid PotionEffect type (path: " + path + ")");
+        }
+
+        return new PotionEffect(type, duration, amplifier);
+    }
+}
+
+public class TestPlugin extends JavaPlugin {
+
+    @Override
+    public void onEnable() {
+        // Remember to register you Serializer before use!
+        ConfigAPI.registerSerializer(PotionEffect.class, new PotionEffectSerializer());
+
+        // Init your configs...
+
+    }
+}