> For the complete documentation index, see [llms.txt](https://obey.gitbook.io/wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://obey.gitbook.io/wiki/storedata/readme.md).

# Welcome

Next-generation Tebex, CraftingStore, and Custom Webstore integration for Minecraft servers.

**CrownStoreData** (also known as `CrownTebexData` / `CSD` / `CTD`) is an enterprise-grade Minecraft plugin designed to bridge the gap between your webstore and your Minecraft server. It transforms mundane store transactions into exciting in-game events, visual leaderboards, interactive community milestones, and automated Discord notifications.

Whether you run a single survival server or a massive network across multiple proxies, CrownStoreData delivers real-time synchronization, comprehensive player donation statistics, and high-performance processing on **Paper**, **Spigot**, and **Folia**.

***

## Key Features

* **Universal Store Provider Support**:
  * **Tebex (Buycraft)**: Automatic polling of payments, packages, and sales campaigns.
  * **CraftingStore**: Full API integration for automated payment synchronization.
  * **Manual Mode**: Flexible webstore command dispatching with smart delay stacking for multi-item cart purchases.
* **Interactive Community Goals**:
  * Set server-wide donation targets in **Internal** or **External** mode.
  * Configurable in-game progress bars supporting both **solid** and **hex gradient** styles.
  * Automated milestone rewards and execution of custom console commands.
  * Custom per-goal broadcast messages (`goal-reached-<goal_id>`).
* **GGWave Celebrations**:
  * Trigger exciting chat celebration waves whenever a player donates.
  * Multi-tiered reward structure based on payment amounts.
  * Rich visual chat designs: `RAINBOW`, `SOLID`, `SOLIDRAINBOW`, and `GRADIENT`.
  * Dynamic sound pitch escalation and per-player reward dispatching with duplicate protection.
* **Visual In-Game Announcements**:
  * 8-line rendered pixel-art player head avatars right inside Minecraft chat.
  * Dynamic titles, subtitles, and action bar notifications.
  * Customizable firework celebrations for donors or every online player.
* **Cross-Platform Bedrock Support**:
  * Native integration with **Geyser** and **Floodgate**.
  * Automatic Bedrock username prefix resolution and specialized skin rendering endpoints.
* **Discord Webhook & Rich Embeds**:
  * 4 customizable JSON embed templates: Purchases, Goal Completion, Milestones, and Sales.
  * Intelligent image mapping: `RANDOM` avatar render poses or `MAPPED` package banners.
  * Full PlaceholderAPI support directly inside Discord embed fields and descriptions.
* **Multi-Server & Network Scalability**:
  * Centralized **MySQL** / **MariaDB** or lightweight **H2** local storage.
  * Master/Reader architecture: one master server communicates with store APIs, while game instances read synced data without duplicating API limits or webhooks.
  * Built-in console migration tool (`/ctd migrate h2 mysql`).
* **Exhaustive PlaceholderAPI Integration**:
  * All-time and monthly donor leaderboards.
  * GGWave sent and participation rankings.
  * Individual player expenditure stats (for self or targeted player).
  * Real-time community goal progress bars for scoreboards, TAB, holograms, and NPCs.

***

## System Requirements

| Requirement            | Supported Versions                                                                                                      | Notes                              |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| **Server Software**    | Paper, Purpur, Spigot, Folia                                                                                            | Version 1.20+ recommended          |
| **Java Runtime**       | Java 17 or Java 21+                                                                                                     | Dependent on server version        |
| **Dependencies**       | [CrownCore](https://dsc.gg/crowndevelopment), [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) | **Required**                       |
| **Soft Dependencies**  | [Floodgate](https://geysermc.org/) (GeyserMC)                                                                           | Required for Bedrock skin handling |
| **Compatible Plugins** | DecentHolograms, FancyHolograms, FancyNpcs, Citizens, TAB                                                               | Supported via PlaceholderAPI       |

***

## Quick Start Installation

1. **Download & Place Plugins**:
   * Ensure [CrownCore](https://dsc.gg/crowndevelopment) and [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) are installed in your server's `plugins/` directory.
   * Place `CrownStoreData.jar` into the `plugins/` folder.
2. **Restart the Server**:
   * Start or restart your server to generate the plugin folder and configuration files at `plugins/CrownStoreData/`.
3. **Configure Your License**:
   * Open `plugins/CrownStoreData/config.yml`.
   * Enter your license key under `license: your-key-here` (obtained from our [Discord](https://dsc.gg/crowndevelopment)).
4. **Select Your Store Provider**:
   * Under `store.provider`, select `tebex`, `craftingstore`, or `manual`.
   * Add your secret key under `store.secret` (see [Store Providers](https://github.com/Obeeyyyy/CrownStoreData/tree/main/docs/features/store-providers.md) for details).
5. **Reload the Plugin**:
   * Run `/ctd reload` in-game or from console.
6. **Test Your Setup**:
   * Run `/ctd testpurchase` to test your chat broadcast, action bar, sound, and Discord embed!

***

## Need Help?

Join our official community Discord for fast support, updates, and community assistance:

* **Discord**: [dsc.gg/crowndevelopment](https://dsc.gg/crowndevelopment)
* **Resource Link**: [BuiltByBit Store](https://builtbybit.com/resources/tebexdata.52755/)