xykit

# **XyKit** Starter Kits, Redeemable CDK Codes and Safe YAML Data Management **Language notice:** The SpigotMC resource page, documentation and support channel are English-only. Chinese-language support is not provided on SpigotMC. The plugin's default configuration comments, player messages, administrator feedback and console messages are currently Chinese. ### **About XyKit** XyKit is a lightweight kit and redemption-code plugin for Paper servers. Administrators define starter or CDK kits in YAML and choose whether each reward action runs as the player, the console, a temporary operator command, a direct message or a broadcast. Starter-kit claims are recorded by player UUID to prevent repeat claims. CDK codes have configurable random formats, are checked for uniqueness and can be created individually or in batches with a maximum-use count. ### **Compatibility** * **Server software:** Paper 26.2.x * **Java:** 25 or newer * **Plugin version:** 1.3.3 * **API dependency:** Paper API 26.2 is provided by the server and is not bundled * **Server testing:** The 1.3.3 Paper 26.2 update was built successfully; no additional live Paper 26.2 server test was performed for that update * Spigot, Purpur and other server implementations have not been tested and are not claimed as supported ### **Free Resource** XyKit should be published as a **free resource** at ****$0.00**.00**. It is a small, self-contained utility released under the MIT License, with its complete source code and release binaries publicly available on GitHub. It has no paid service, premium dependency, license server or feature suitable for a separate paid edition. ### **Main Features** * One-time starter kits tracked separately for each player UUID and kit name * Redeemable CDK kits with per-code maximum-use limits * Single or batch CDK generation, up to 100 codes per command * Configurable CDK length and character set * In-memory and YAML duplicate-code checks * Player, console, temporary-operator, message and broadcast reward actions * Administrative CDK statistics and exhausted-code cleanup * Configuration and data reload command * Automatic rolling backup before YAML data saves * Timestamped manual backups and guarded restore workflow ### **Claim and Redemption Safety** Starter claims are stored under each player's UUID, so changing a player name does not reset claim history. CDK records store the linked kit, maximum uses, current uses and creation timestamp. A code is validated against its assigned kit before its use counter is increased and saved. ### **Data and Backup Model** All persistent data is stored in `plugins/XyKit/data.yml`. Before saving, XyKit replaces `data.yml.backup` with a copy of the current data file. Administrators can also create timestamped manual backup files with `/kit backup`. Stop the server and keep an external copy of the plugin directory before major upgrades or bulk data operations. ### **Flexible Reward Actions** Kit actions support `{player}` replacement. Use an unprefixed command for player execution, `cmd:` for console execution, `op:` for temporary operator execution, `msg ` for a private message and `broadcast:` for a server-wide message. Only trusted administrators should be allowed to edit kit commands. ### **Dependencies** * **Required plugins:** None * **Bundled third-party libraries:** None * **Server-provided API:** Paper API ### **Links** * [Source Code](https://github.com/yangzijian52/xykit) * [Downloads](https://github.com/yangzijian52/xykit/releases) * [English Support and Bug Reports](https://github.com/yangzijian52/xykit/issues) * [MIT License](https://github.com/yangzijian52/xykit/blob/main/license) * [Full Documentation](https://github.com/yangzijian52/xykit/blob/main/docs/spigotmc-resource-bbcode.txt) ### **Important Notes** * The runtime interface and bundled configuration comments are currently Chinese even though the SpigotMC listing and support channel are English-only. * Only Paper 26.2.x with Java 25 or newer is claimed as supported. * The current implementation always uses `data.yml`. The `database.mysql` example settings do not enable a MySQL backend. * The configured `cooldown` value is loaded but is not currently applied; starter kits remain one-time claims. * `/kit create` does not write a new kit automatically; it instructs the administrator to edit `config.yml`. * The `op:` action temporarily grants operator status. Use it only with trusted, reviewed commands. * Back up `plugins/XyKit/data.yml` before replacing the jar or editing stored data.