feat: initial works for economy api

Author: smartcmd

.github/workflows/gradle.yml

@@ -5,35 +5,50 @@ on:
     branches: [ "master" ]
     paths:
       - .github/workflows/gradle.yml
+      - gradle.properties
+      - build.gradle.kts
       - src/**
   pull_request:
     paths:
       - .github/workflows/gradle.yml
+      - gradle.properties
+      - build.gradle.kts
       - src/**
 
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v4
-      - run: chmod +x gradlew
-      - uses: actions/setup-java@v4
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup Java
+        uses: actions/setup-java@v5
         with:
           java-version: '21'
           distribution: 'zulu'
-      - name: Setup gradle
-        uses: gradle/actions/setup-gradle@v4
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
         with:
           gradle-version: wrapper
           cache-overwrite-existing: true
           cache-read-only: false
           build-scan-publish: true
           build-scan-terms-of-use-url: "https://gradle.com/terms-of-service"
           build-scan-terms-of-use-agree: "yes"
+
       - name: Build
-        run: ./gradlew shadowJar
-      - name: Upload Artifact
-        uses: actions/upload-artifact@v4
-        if: success() && contains(github.ref_name, 'master')
-        with:
-          path: build/libs/*.jar
+        run: |
+          chmod +x gradlew
+          ./gradlew build
+
+      - name: Publish to Maven Central
+        if: success() && github.event_name == 'push' && github.repository == 'AllayMC/EconomyAPI' && contains(github.ref_name, 'master')
+        run: ./gradlew publishToMavenCentral
+        env:
+          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }}
+          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SONATYPE_SECRET_KEY }}
+          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SONATYPE_SECRET_KEY_PASSWORD }}

README.md

@@ -1,56 +1,112 @@
-# Allay Java Plugin Template
+# EconomyAPI
 
-Welcome to the java plugin template for allay.
+![Maven Central Version](https://img.shields.io/maven-central/v/org.allaymc/economyapi?label=economyapi)
 
-## Prerequisites
+EconomyAPI is a plugin that unifies all economy plugins under one single API. The API can be used by both economy plugins
+providing the API, and other plugins using the API (i.e. shop plugins). This allows for all plugins that require an economy
+to work with any economy plugin.
+
+## Usages
+
+```kts
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    compileOnly(group = "org.allaymc", name = "economyapi", version = "0.1.0")
+}
+```
+
+WIP
+
+## Install
+
+
+- Download .jar file from [release](https://github.com/AllayMC/PlaceholderAPI/releases) or [action](https://github.com/AllayMC/PlaceholderAPI/actions/workflows/gradle.yml)
+
+- Put it into `plugins` folder
+
+- Restart the server, enjoy!
 
-- Java21 or higher.
-- Allay installed.
 
 ## Getting Started
 
+
 1. **Clone this Repository**
 
+
 ```bash
+
 git clone https://github.com/AllayMC/JavaPluginTemplate.git
+
 ```
+
 
 2. **Navigate to the Cloned Directory**
 
+
 ```bash
+
 cd JavaPluginTemplate
+
 ```
+
 
 3. **Change Plugin Information**
 
+
 - Rename package name from `org.allaymc.javaplugintemplate` to `your.group.name.and.pluginname`
+
 - Update [build.gradle.kts](build.gradle.kts) and [settings.gradle.kts](settings.gradle.kts)
+
 - Reload gradle
+
 
 4. **Build and Run Your Plugin**
 
+
 ```bash
+
 gradlew shadowJar
+
 ```
+
 
 This command will produce a `.jar` file in the `build/libs` directory. 
+
 Copy the `.jar` file to the `plugins` directory of your allay server.
+
 Start the allay server and check the logs to ensure your plugin loads and operates
+
 as expected.
 
+
 5. **Test Your Plugin in Gradle**
 
+
 ```bash
+
 gradlew runServer
+
 ```
 
+
 This command will start an allay server with your plugin loaded.
+
 Then close allay server by clicking `X` in the dashboard window.
 
-## Documentation
+## Requirement
+
+Java: 21+
+
+Allay: 0.17.0+
+
+## Contributing
 
-For a deeper dive into the Allay API and its functionalities, please refer to our [documentation](https://docs.allaymc.org) (WIP).
+Contributions are welcome! Feel free to fork the repository, improve the code, and submit pull requests with your
+changes.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the LGPL v3 License - see the [LICENSE](LICENSE) file for details.

build.gradle.kts

@@ -1,38 +1,89 @@
+import com.vanniktech.maven.publish.MavenPublishBaseExtension
+
 plugins {
     id("java-library")
+    id("com.vanniktech.maven.publish") version "0.34.0"
     id("org.allaymc.gradle.plugin") version "0.1.2"
 }
 
-// TODO: Update the group to yours (should be same to the package of the plugin main class)
-group = "org.allaymc.javaplugintemplate"
-// TODO: Update the description to yours
-description = "Java plugin template for allay server"
-version = "0.1.0"
-
-java {
-    toolchain {
-        languageVersion = JavaLanguageVersion.of(21)
-    }
-}
+group = "org.allaymc"
+version = "0.1.0-SNAPSHOT"
+description = "EconomyAPI is a plugin that unifies all economy plugins under one single API"
 
-// See also https://github.com/AllayMC/AllayGradle
 allay {
-    // TODO: Update the api version to the latest
-    // You can find the latest version here: https://central.sonatype.com/artifact/org.allaymc.allay/api
     api = "0.17.0"
 
     plugin {
-        // TODO: Update the entrance when you change your plugin main class
-        // Same to `org.allaymc.javaplugintemplate.JavaPluginTemplate`
-        entrance = ".JavaPluginTemplate"
-        // TODO: Use your handsome name here
-        authors += "YourNameHere"
-        // TODO: Update the website to yours
-        website = "https://github.com/AllayMC/JavaPluginTemplate"
+        entrance = "org.allaymc.economyapi.Entrance"
+        authors += "daoge_cmd"
+        website = "https://github.com/AllayMC/EconomyAPI"
     }
 }
 
 dependencies {
     compileOnly(group = "org.projectlombok", name = "lombok", version = "1.18.34")
     annotationProcessor(group = "org.projectlombok", name = "lombok", version = "1.18.34")
 }
+
+tasks {
+    withType<JavaCompile> {
+        options.encoding = "UTF-8"
+        configureEach {
+            options.isFork = true
+        }
+    }
+
+    // We already have sources jar, so no need to build Javadoc, which would cause a lot of warnings
+    withType<Javadoc> {
+        enabled = false
+    }
+
+    withType<Copy> {
+        duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+    }
+}
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(21)
+    }
+}
+
+repositories {
+    mavenCentral()
+}
+
+configure<MavenPublishBaseExtension> {
+    publishToMavenCentral()
+    signAllPublications()
+
+    coordinates(project.group.toString(), project.name, project.version.toString())
+
+    pom {
+        name.set(project.name)
+        description.set("EconomyAPI is a plugin that unifies all economy plugins under one single API")
+        inceptionYear.set("2025")
+        url.set("https://github.com/AllayMC/EconomyAPI")
+
+        scm {
+            connection.set("scm:git:git://github.com/AllayMC/EconomyAPI.git")
+            developerConnection.set("scm:git:ssh://github.com/AllayMC/EconomyAPI.git")
+            url.set("https://github.com/AllayMC/EconomyAPI")
+        }
+
+        licenses {
+            license {
+                name.set("LGPL 3.0")
+                url.set("https://www.gnu.org/licenses/lgpl-3.0.en.html")
+            }
+        }
+
+        developers {
+            developer {
+                name.set("AllayMC Team")
+                organization.set("AllayMC")
+                organizationUrl.set("https://github.com/AllayMC")
+            }
+        }
+    }
+}

settings.gradle.kts

@@ -1,2 +1,2 @@
-rootProject.name = "JavaPluginTemplate"
+rootProject.name = "EconomyAPI"
 

src/main/java/org/allaymc/economyapi/Account.java

@@ -0,0 +1,97 @@
+package org.allaymc.economyapi;
+
+import org.allaymc.economyapi.event.BalanceChangeEvent;
+import org.allaymc.economyapi.event.BalanceTransferEvent;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.math.BigDecimal;
+import java.util.Map;
+import java.util.UUID;
+
+/**
+ * Represents an account, which stores amounts of various {@link Currency currencies}.
+ * <p>
+ * Every account is bound to a {@link UUID}, it usually should be same to the player's
+ * uuid if the account belongs to a player, or a random uuid in other cases.
+ *
+ * @author daoge_cmd
+ */
+public interface Account {
+
+    /**
+     * Gets the unique id of this account.
+     *
+     * @return the unique id of this account
+     */
+    UUID getUniqueId();
+
+    /**
+     * Gets the name of this account.
+     *
+     * @return the name of this account
+     */
+    String getName();
+
+    /**
+     * Gets a {@link BigDecimal} representative of the balance for the given {@link Currency}.
+     *
+     * @param currency the currency to get the balance for
+     * @return the balance of the currency
+     */
+    BigDecimal getBalance(Currency currency);
+
+    /**
+     * Retrieves an unmodifiable map of all balances associated with this account. Each entry
+     * in the map represents a {@link Currency} and its corresponding balance as a {@link BigDecimal}.
+     *
+     * @return an unmodifiable map containing currencies as keys and their respective balances as values
+     */
+    @Unmodifiable
+    Map<Currency, BigDecimal> getBalances();
+
+    /**
+     * Sets the balance for the given currency to the specified amount. Event {@link BalanceChangeEvent}
+     * will be called when this method is called.
+     *
+     * @param currency the {@link Currency} for which the balance is being set
+     * @param amount   the {@link BigDecimal} value representing the new balance
+     * @return {@code true} if the balance was successfully set, otherwise {@code false}
+     */
+    boolean setBalance(Currency currency, BigDecimal amount);
+
+    /**
+     * Deposits a specified amount of the given currency into the account.
+     * The new balance is calculated by adding the deposit amount to the current balance.
+     *
+     * @param currency the {@link Currency} being deposited
+     * @param amount   the {@link BigDecimal} value of the amount to deposit
+     * @return {@code true} if the new balance was successfully updated, otherwise {@code false}
+     */
+    default boolean deposit(Currency currency, BigDecimal amount) {
+        return setBalance(currency, getBalance(currency).add(amount));
+    }
+
+    /**
+     * Withdraws a specified amount of the given currency from the account.
+     * The new balance is calculated by subtracting the withdrawal amount
+     * from the current balance.
+     *
+     * @param currency the {@link Currency} from which the amount is being withdrawn
+     * @param amount   the {@link BigDecimal} value of the amount to withdraw
+     * @return {@code true} if the new balance was successfully updated, otherwise {@code false}
+     */
+    default boolean withdraw(Currency currency, BigDecimal amount) {
+        return setBalance(currency, getBalance(currency).subtract(amount));
+    }
+
+    /**
+     * Transfers a specified amount of a given currency from this account to another account.
+     * Event {@link BalanceTransferEvent} will be called when this method is called.
+     *
+     * @param to       the recipient {@link Account} to which the amount will be transferred
+     * @param currency the {@link Currency} of the amount being transferred
+     * @param amount   the {@link BigDecimal} value representing the amount to be transferred
+     * @return {@code true} if the transfer was successful, otherwise {@code false}
+     */
+    boolean transfer(Account to, Currency currency, BigDecimal amount);
+}