Skip to content

Feature: Multi-currency support #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lt-name merged 7 commits into from
Feb 16, 2025
Merged

Feature: Multi-currency support #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3b05d9e
change: new version config.yml
Mcayear Oct 2, 2024
d3b3c5f
refactor: yaml provider
Mcayear Oct 2, 2024
312ca77
refactor: sqlite provider
Mcayear Feb 15, 2025
3287666
refactor: command supports multiple currencies.
Mcayear Feb 15, 2025
840e70f
Merge branch 'master' into feat/currency
lt-name Feb 15, 2025
051b523
feat(config): upgrade config and data format to version 3
Mcayear Feb 16, 2025
9c34d47
refactor: remove unused language files, update README.
Mcayear Feb 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,37 @@ Core of economy system for Nukkit

## For developers

### Single Currency Economies

Developers can access to EconomyAPI's API by using:
```java
EconomyAPI.getInstance().myMoney(player);
EconomyAPI.getInstance().reduceMoney(player, amount);
EconomyAPI.getInstance().addMoney(player, amount);
```

> [!TIP]
> Operating through the provider:
> - `provider.addMoney(player, amount);`

### Multiple Currency Economies

**`currencyName`:** This parameter is a `String` that specifies the currency you want to interact with. If your economy system supports multiple currencies (e.g., real-world currencies like "USD", "EUR", "GBP" or in-game items like "Gold", "Silver", "Diamonds"), you can use this parameter to target a specific currency.

If your system only has one currency, use the first set of methods (without the `currencyName` parameter).

```java
EconomyAPI.getInstance().myMoney(player, currencyName);
EconomyAPI.getInstance().reduceMoney(player, amount, currencyName);
EconomyAPI.getInstance().addMoney(player, amount, currencyName);
```

> [!TIP]
> When operating through the provider, the parameter order needs to be adjusted:
> - `provider.addMoney(currencyName, player, amount);`

### Maven repository

```xml
<repository>
<id>nukkitx-repo</id>
Expand Down
28 changes: 23 additions & 5 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>me.onebone</groupId>
<artifactId>economyapi</artifactId>
<version>2.0.6-SNAPSHOT</version>
<name>EconomyAPI</name>
<groupId>me.onebone.economyapi.EconomyAPI</groupId>
<artifactId>EconomyAPI</artifactId>
<version>2.1.0-SNAPSHOT</version>
<url>https://github.com/MemoriesOfTime/EconomyAPI</url>

<repositories>
Expand Down Expand Up @@ -49,7 +48,26 @@
</distributionManagement>

<build>
<finalName>${project.name}-${project.version}</finalName>
<finalName>${project.name}-${project.version}-MOT</finalName>

<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/plugin.yml</include>
</includes>
<filtering>true</filtering>
</resource>

<resource>
<directory>src/main/resources</directory>
<excludes>
<exclude>**/plugin.yml</exclude>
</excludes>
<filtering>false</filtering>
</resource>
</resources>

<defaultGoal>clean package</defaultGoal>
<plugins>
<plugin>
Expand Down
Loading