Donut Shards

<p align="center"> <img src="https://raw.githubusercontent.com/Fuzss/modresources/main/pages/commons/headers/about.png" alt="About"> </p> <p align="center"> <img src="https://i.imgur.com/JGvHLWD.png" alt="DonutShards" width="400"> </p> <p align="center"> <a href="https://nightbeam.dev/support"> <img src="https://i.imgur.com/R9eqHGA.png" alt="Support Nightbeam Studio" width="400"> </a> </p> <p align="center"> <strong>DonutShards</strong> is a configurable shard economy and reward foundation for modern Paper and Folia servers. It introduces an original donut-and-cosmic virtual currency system backed by a durable SQL ledger, asynchronous economy operations, safe player transfers, recurring rewards, and a Cosmic Confection Exchange GUI. </p> <p align="center"> <a href="https://discord.gg/TJc3CxR4jK"><img src="https://img.shields.io/static/v1?label=&message=Discord&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=discord&logoColor=white" alt="Discord"></a> <a href="https://www.youtube.com/@nightbeamstudio"><img src="https://img.shields.io/static/v1?label=&message=YouTube&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube"></a> <a href="https://github.com/MeherBenSalem"><img src="https://img.shields.io/static/v1?label=&message=GitHub&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=github&logoColor=white" alt="GitHub"></a> <a href="https://www.curseforge.com/members/nightbeamstudio/projects"><img src="https://img.shields.io/static/v1?label=&message=CurseForge&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=curseforge&logoColor=white" alt="CurseForge"></a> <a href="https://modrinth.com/organization/nightbeam"><img src="https://img.shields.io/static/v1?label=&message=Modrinth&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=modrinth&logoColor=white" alt="Modrinth"></a> </p> # Features | Feature | Description | | --- | --- | | Virtual Shard Economy | Player shard balances stored as 64-bit integers | | Economy Operations | Add, remove, set, and transfer shard balances | | Atomic Transfers | Taxed player transfers processed atomically | | Balance Protection | Negative-balance and overflow protection | | Transaction Ledger | Transaction history with idempotent transaction keys | | SQLite Storage | Local SQLite database supported by default | | MariaDB & MySQL | Optional MariaDB and compatible MySQL storage | | HikariCP Pooling | Efficient SQL connection pooling | | Recurring Rewards | Basic recurring shard reward functionality | | Cosmic Confection Exchange | Original inventory GUI for shard-based interactions | | MiniMessage Support | MiniMessage-formatted player-facing messages | | Async Java API | Asynchronous public API for plugin integrations | | Paper & Folia Support | Region-safe scheduler abstraction for both platforms | | Configurable Economy | Configurable maximum balance and transfer tax | <p align="center"> <a href="https://builtbybit.com/creators/nightbeamstudio.617578/"> <img src="https://i.imgur.com/IeI5PsC.png" alt="Upgrade to Premium" width="350"> </a> </p> # Shard Economy DonutShards provides a dedicated virtual currency that can serve as the foundation for rewards, shops, progression systems, and custom server mechanics. Balances are stored as **64-bit integers** in a durable SQL-backed ledger. ## Economy Operations * Add shards * Remove shards * Set balances * Transfer shards between players * Apply configurable transfer tax * Enforce a configurable maximum balance * Prevent negative balances * Protect against numeric overflow # Player Transfers Players can transfer shards directly to other players. Transfers are handled atomically so the debit and credit operations are treated as one transaction. ## Transfer Features * Player-to-player shard payments * Configurable transfer tax * Atomic balance updates * Negative-balance protection * Overflow protection * Transaction history * Idempotent transaction keys # Transaction Ledger DonutShards stores economy activity in a persistent SQL-backed transaction system. The transaction foundation includes: * Persistent player balances * Transaction history storage * Idempotent transaction keys * Atomic economy operations * SQL-backed durability Idempotent transaction keys help prevent the same logical transaction from being applied multiple times when an operation is retried. # Storage DonutShards supports multiple SQL storage options. ## SQLite SQLite is the default option and works without additional database infrastructure. It is suitable for: * Standalone servers * Simple installations * Development environments * Servers that do not require an external database ## MariaDB & MySQL MariaDB and compatible MySQL storage can be used when an external database is preferred. Database connections use **HikariCP** connection pooling. Production installations should use a dedicated, least-privilege database account. # Recurring R