https://github.com/midnighttale/hyeconomy
Hyeconomy is a diamond economy plugin uses MariaDB for database storage
https://github.com/midnighttale/hyeconomy
asynchronous asyncio bukkit bukkit-plugin economy folia folia-plugin folia-supported mariadb minecraft minecraft-plugin minecraft-server paper paper-plugin papermc plugin
Last synced: 3 months ago
JSON representation
Hyeconomy is a diamond economy plugin uses MariaDB for database storage
- Host: GitHub
- URL: https://github.com/midnighttale/hyeconomy
- Owner: MidnightTale
- License: mit
- Created: 2023-09-29T06:36:27.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-01T19:59:30.000Z (about 2 years ago)
- Last Synced: 2023-10-02T08:34:43.180Z (about 2 years ago)
- Topics: asynchronous, asyncio, bukkit, bukkit-plugin, economy, folia, folia-plugin, folia-supported, mariadb, minecraft, minecraft-plugin, minecraft-server, paper, paper-plugin, papermc, plugin
- Language: Java
- Homepage: https://hynse.xyz
- Size: 131 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Features
- Economy system for managing in-game currency (diamonds).
- Deposit and withdraw diamonds.
- Send diamonds to other players.
- Check your current balance.
- View a leaderboard of top players.
- Support [MiniMessage](https://docs.advntr.dev/minimessage/format.html) format
- PlaceholderAPI supported
## Server Compatibility
- **Paper / Folia** and any forks.
- ⚠️ **Spigot**: untested.
- ⚠️ **ฺBukkit**: untested.
## Database Storage
Hyeconomy utilizes MariaDB for database storage. This ensures reliable and efficient data storage for player balances and transactions.
## Commands
### Player Command
- `/balance`: Check your current balance.
- `/balance `: Check other current balance.
- `/deposit `: Deposit diamonds into your account.
- `/withdraw `: Withdraw diamonds from your account.
- `/send `: Send diamonds to another player.
- `/top`: View the leaderboard of top players.
### Admin Command
- `/dgive `: Give balance to player account.
- `/dtake `: Take balance from player account.
- `/dset `: Set player balance specific value.
- `/dreset `: Reset specific player balance to 0.
- `/dreload`: Reload config and message.
## Permissions
- `hyeconomy.balance`: Permission to use the `/balance` command.
- `hyeconomy.balance.other`: Permission to use the `/balance` command check other.
- `hyeconomy.deposit`: Permission to use the `/deposit` command.
- `hyeconomy.withdraw`: Permission to use the `/withdraw` command.
- `hyeconomy.send`: Permission to use the `/send` command.
- `hyeconomy.top`: Permission to use the `/top` command.
- `hyeconomy.give`: Permission to use the `/dgive` command.
- `hyeconomy.take`: Permission to use the `/dtake` command.
- `hyeconomy.set`: Permission to use the `/dset` command.
- `hyeconomy.reset`: Permission to use the `/dreset` command.
- `hyeconomy.reload`: Permission to use the `/dreload` command.
## Configuration
You can customize various aspects of the plugin, including messages and database settings, by editing the `config.yml` and `messages.yml` files in the plugin's folder.
## PlaceholderAPI Integration
install [placeholderapi](https://www.spigotmc.org/resources/placeholderapi.6245/)
- display a player's balance `%hyeconomy_balance%`.
- display a specific player's balance by name, use `%hyeconomy_balance_PLAYERNAME%` (replace `PLAYERNAME` with the actual player's name).
- display the username balance of the top 10 players, use `%hyeconomy_balance_top_username_1%`, `%hyeconomy_balance_top_username_2%`, and so on, up to `%hyeconomy_balance_top_username_10%`.
- display the amount balance of the top 10 players, use `%hyeconomy_balance_top_amount_1%`, `%hyeconomy_balance_top_amount_2%`, and so on, up to `%hyeconomy_balance_top_amount_10%`.
Remember to replace `PLAYERNAME` with the actual player name you want to query in the second type of placeholder.
## Support
If you encounter any issues or have questions, please feel free to [open an issue](https://github.com/MidnightTale/hyeconomy/issues) on the GitHub repository.
## License
This plugin is open-source and available under the [MIT License](LICENSE).
## Developer API [](https://repo.hynse.xyz/api/latest/releases/xyz/hynse/api-hyeconomy)
### Information
Apache Maven `pom.xml`
```xml
hyeconomy
https://repo.hynse.xyz/repository/maven-releases/
xyz.hynse
api-hyeconomy
1.2-SNAPSHOT-1
```
Gradle Groovy DSL `build.gradle`
```gradlee
repositories {
maven { url = "https://repo.hynse.xyz/repository/maven-releases/"}
}
dependencies {
compileOnly 'xyz.hynse:api-hyeconomy:1.2-SNAPSHOT-1'
}
```
### Example
```java
import xyz.hynse.hyeconomy.API.HyeconomyAPI;
// when you need to get or set player balances:
HyeconomyAPI hyeconomyAPI = Hyeconomy.getAPI();
// Get a player's balance by UUID
UUID playerUUID = /* UUID of the player */;
int balance = hyeconomyAPI.getPlayerBalance(playerUUID);
// Set a player's balance by UUID
int newBalance = /* The new balance */;
hyeconomyAPI.setPlayerBalance(playerUUID, newBalance);
int amount = /*Amount want to add or subtract*/;
// Add a player's balance by UUID
HyeconomyAPI.addToPlayerBalance(UUID playerUUID, amount)
// subtract a player's balance by UUID
HyeconomyAPI.subtractFromPlayerBalance(UUID playerUUID, amount)
```