Thank you for purchasing the X-PRISON plugin!

We're excited to have you on board. If you need help, want to suggest features, or just hang out with the community, feel free to join our Discord server:

👉 https://discord.com/invite/ZeSkmEC6mG

---

📦 What's inside this download:

- X-Prison <version>.jar          — the plugin itself
- Resource Pack - Pickaxe Skins.zip — optional resource pack for the Pickaxe Skins module
- FREE GIFT FOR YOU.txt           — a little something for leaving a review
- README.txt                      — this file

---

📦 Installation Steps (Plugin Installing):

Pre-requirements: Java 17 and above, Spigot/Paper/Bukkit 1.13 - 26.2
(Paper is recommended - it renders gradients, hover and click text natively. On Spigot everything still works, colours are simply rendered down to classic colour codes.)

Required dependencies:
- WorldGuard (+ WorldEdit, which WorldGuard itself requires) - used by mines and auto-sell regions
- helper - a small library our core uses, it has no commands or config of its own
  https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper/target/helper.jar

Optional dependencies: Vault / PlayerPoints / ExcellentEconomy (economy hooks), PlaceholderAPI, ItemsAdder / Nexo / Oraxen (custom mine blocks), DecentHolograms, Multiverse-Core.

1. Upload the plugin .jar file into the `/plugins` folder of your server, next to helper.jar, WorldEdit.jar and WorldGuard.jar.
2. Start your server - the plugin will generate all necessary files and folders automatically.
3. Restart the server after any configuration change. Please do not use /reload, it is not supported by any modern plugin.

---

📦 Installation Steps (Base Configuration):

Note: Most of the setup is done via configuration files, but the fastest way to get going is the in-game wizard.
Note: There are a lot of useful commands to gain the best from the plugin. Definitely check out the Commands & Permissions wiki page!
https://github.com/Drawethree/X-Prison/wiki/Commands-&-Permissions

1. Run /xprison setup as an operator. The wizard lets you pick your database type (H2, SQLite or MySQL) and turn individual modules on or off. Restart the server afterwards so the database change is picked up.
   You can run /xprison health-check at any time for a quick status report - database connection, pickaxe configuration, module states and more.

2. Create prison mines by /mines create [name]. Before doing so, you need to have a selection ready using /mines tool.
After you create a mine, add some blocks (contents) to it by holding a block in your hand and running /mines addblock [name] command.
After adding blocks, open up a mine panel by /mines panel [name] and perform detailed GUI setup, and set the warp point with /mines settp [name].

3. Setup sellprices of blocks by /sellprice [price] [mine] with a block in your hand to configure selling prices of items. "mine" is a name of the mine you want to configure sellprices for and its optional if you want global sellprices. /sellprice editor [region] opens the sell price editor GUI.

4. If you would like to use autominer region, please create WorldGuard region called how would you like. Then visit autominer.yml configuration and update values.

5. Do not forget to check all configuration files and change messages / options / enchants etc. to your liking! There is also lot of predefined stuff that you can change, add, or delete. All messages are written in MiniMessage, so gradients and hex colours work out of the box.
   /xprison lint checks your configuration files for mistakes, and /xprison reload applies changes without a full restart.

---

🎨 Pickaxe Skins resource pack:

The Pickaxe Skins module uses custom model data. Upload the included "Resource Pack - Pickaxe Skins.zip" to your server (or any host) and set it as your server resource pack, then match the `custom-model-data` values in pickaxe-skins.yml to the models in the pack.

🧩 Addons:

Our addons (Casino, Crystals, Black Market, Pets, Lucky Blocks, Shop, Events, Momentum, Coinflip, extra enchant packs, ...) are dropped into `/plugins/X-Prison/addons/` and are loaded automatically on startup - no separate plugin installation needed.

📚 Documentation:

- Setup guide: https://github.com/Drawethree/X-Prison/wiki/Setup
- Commands & Permissions: https://github.com/Drawethree/X-Prison/wiki/Commands-&-Permissions
- Placeholders: https://github.com/Drawethree/X-Prison/wiki/Placeholders
- Changelog: https://github.com/Drawethree/X-Prison/wiki/Changelog
- FAQ / Troubleshooting: https://github.com/Drawethree/X-Prison/wiki/Frequently-Asked-Questions---Troubleshooting

Enjoy your premium experience with X-PRISON!
