Merge branch 'master' of https://github.com/klashdevelopment/Caramel

Author: GavinGoGaming

.github/workflows/build.yml

@@ -0,0 +1,37 @@
+name: Java CI with Maven
+
+concurrency: 
+  group: "maven-build"
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - '*.md'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up JDK 17
+      uses: actions/setup-java@v2
+      with:
+        java-version: 17
+        distribution: 'zulu'
+        cache: maven
+    - name: Build with Maven
+      run: mvn -B package --file pom.xml
+    - name: Release
+      uses: softprops/action-gh-release@v2
+      with:
+        tag_name: "latest"
+        name: "Automatic Build"
+        body: "Automatically released build for Maven"
+        prerelease: true
+        files: |
+              ./target/*.jar

docs/currencies.md

@@ -0,0 +1,31 @@
+# Currencies
+
+### Create the class
+```java
+public static class MyCurrency extends CaramelCurrency {
+    public MyCurrency() {
+        super(Plugin, "Name", "id", 10); // Plugin, Name, ID, Default amount
+    }
+}
+```
+### Register
+```java
+CaramelCurrency currency;
+
+public void onEnable() {
+    Caramel.getInstance().currencies.register(currency = new MyCurrency());
+}
+public void onDisable() {
+    Caramel.getInstance().currencies.getCurrencyList().remove(currency);
+}
+```
+
+### Using it
+Simply use the instance you've set up with these functions:
+```java
+// Currency methods
+currency.setValue(UUID, double) -> double
+currency.addValue(UUID, double) -> double
+currency.getValue(UUID) -> double
+currency.getSaveDataFile() -> CaramelBlankConfig
+```

docs/index.md

@@ -30,6 +30,6 @@ Caramel has a few main features.
 - [Commands](https://pages.klash.dev/Caramel/commands)
 - [Items](https://pages.klash.dev/Caramel/items) - Docs incomplete
 - [Guis](https://pages.klash.dev/Caramel/guis)
-- [Currencies](https://pages.klash.dev/Caramel/currencies) - Docs incomplete
+- [Currencies](https://pages.klash.dev/Caramel/currencies)
 - [Recipes](https://pages.klash.dev/Caramel/recipes) - Docs incomplete
 - [Configs](https://pages.klash.dev/Caramel/configs) - Docs incomplete