CobblePass

# CobblePass - The Ultimate Battle Pass for Cobblemon Welcome to the completely revamped CobblePass! This mod provides a deeply integrated and highly customizable battle pass system for your Cobblemon server. Engage your players with a rewarding progression system, complete with free and premium tracks, seasonal content, and a wide array of configurable rewards. !(https://i.giphy.com/media/v1.Y2lkPTc5MGI3NjExaTU2ZTBpNWpkMXpyOTJyY3FnOWYxZHppOXRpcnhobm5veXU3bjVseCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/YNbbM79OAECuE6HU5I/giphy.gif) ## Features - **Seasons:** Create unique battle pass seasons with configurable durations and rewards. - **Dual Reward Tracks:** Implement both `free` and `premium` reward tiers. - **Dynamic GUI:** A clean, intuitive, and paginated GUI (`/bp`) for players to view progress and claim rewards. - **XP Progression:** - Gain XP from various in-game actions: catching, defeating, evolving, hatching, and trading Pokémon. - Two XP progression models: - **`FORMULA`:** XP required per level increases based on a configurable multiplier. - **`MANUAL`:** Manually define the exact XP required for each level. - **Diverse Reward Types:** - **`ITEM`:** Grant any item from Minecraft or other mods, with full NBT support. - **`POKEMON`:** Reward players with specific Pokémon, including level, shininess, and other attributes. - **`COMMAND`:** Execute any server command as a reward, with placeholders for player name and UUID. - **Admin Management:** - A full suite of commands for managing seasons, players, and configurations. - Create, start, stop, and delete seasons. - Modify player XP, levels, and premium status on the fly. - Reload configurations without a server restart. - **Economy Integration:** Charge for the premium pass using any Impactor-compatible economy plugin. - **Highly Configurable:** Tweak everything from XP values to reward templates and season settings through intuitive JSON files. - **Data Integrity:** Player data is saved reliably and includes safeguards against corruption. ## Dependencies CobblePass requires the following mods to be installed on your server: - **(https://modrinth.com/mod/fabric-api)** - **(https://modrinth.com/mod/cobblemon)** (v1.6+) - **(https://modrinth.com/mod/impactor)** (For economy features) - **(https://modrinth.com/mod/gooeylibs)** ## Installation 1. Ensure you have a Fabric server running Minecraft 1.21.1 or later. 2. Download the latest versions of CobblePass and all required dependencies. 3. Place the `.jar` files into your server's `mods` folder. 4. Start your server. CobblePass will generate its default configuration files in the `config/cobblepass/` directory. --- ## Getting Started: Your First Season Setting up a new Battle Pass is easy with the in-game creation tool. **Step 1: Create the Battle Pass** - As an operator, run the command: `/battlepass create` - This will open a GUI where you can set: - **Duration:** The length of the season in days. - **Max Level:** The highest level players can achieve. - **Premium Toggle:** Whether this season will have a premium track. - Click "Create Battle Pass". This generates `config.json` and `tiers.json` files and resets all player progress for a fresh start. **Step 2: Configure Your Rewards** - Open `config/cobblepass/tiers.json`. - By default, it's filled with placeholder rewards (Apples). Customize each level's `freeReward` and `premiumReward`. See the detailed **(#tiersjson)** section below for examples of Item, Pokémon, and Command rewards. - This is where you can also define reusable reward `templates`! **Step 3: Configure Settings** - Open `config/cobblepass/config.json`. - Adjust XP gain values (`catchXP`, `defeatXP`, etc.), the cost of the premium pass (`premiumCost`), and the XP progression model (`xpProgression`). See the **(#configjson)** section for more details. **Step 4: Reload the Configuration** - Once you've saved your changes to the JSON files, run the command: `/battlepass reload` - This will load all your new settings and rewards into the server without needing a restart. **Step 5: Start the Season!** - When you're ready for the season to begin, run: `/battlepass season start` - The timer will start, and players can now begin earning XP! --- ## Commands The base command is `/battlepass` with aliases `/bp` and `/pass`. ### Player Commands | Command | Description | | :--- | :--- | | `/bp` | Opens the main Battle Pass GUI to view progress and claim rewards. | | `/bp premium` | Shows information about the premium pass, including cost and status. | | `/bp premium buy` | Purchases the premium pass if `premiumMode` is enabled and the player has enough funds. | | `/bp claim <level> ` | A command-based way to claim a reward for a specific level. The GUI is the primary method. | ### Admin Com