# Eclipse Playback A server-side Fabric mod for Cobblemon that provides **PokePaste team importing**, **automatic battle replay recording**, and **custom sprite uploads** for fakemon. ## Features ### PokePaste Team Import Import competitive teams directly from [PokePaste](https://pokepast.es) URLs into your Cobblemon party. - Parses full Showdown format teams (species, moves, EVs, IVs, nature, ability, held item) - Supports custom/Eclipse Pokemon species mappings - Import teams for yourself or other players **Genesis Forms Integration:** Built-in support for [Genesis Forms](https://modrinth.com/mod/cobblemon-genesis-forms) items out of the box: - Mega Stones (Charizardite X/Y, Mewtwonite X/Y, etc.) - Z-Crystals (Pikashunium-Z, etc.) - Primal Orbs (Red Orb, Blue Orb) - Ogerpon Masks (Cornerstone, Hearthflame, Wellspring, Teal) - Legendary Items (Rusted Sword/Shield, Adamant Crystal, Lustrous Globe, Griseous Core) - Genesect Drives (Shock, Burn, Chill, Douse) - Memory items and Type Plates **Custom Item Mappings:** Configure additional item mappings in `config/eclipse_playback/item_mappings.json` to support other mods or custom items. ### Battle Replay Recording Automatically captures PvP battles and uploads them to the [Cobblemon Eclipse Replay Viewer](https://cobblemoneclipse.com/replays/). - Records complete battle logs in Showdown protocol format - Uploads replays to **https://cobblemoneclipse.com/replays/** for public viewing - Captures player teams, winner, turn count, and duration - Configurable broadcast messages when replays are uploaded - Supports MiniMessage formatting for chat announcements - Each server is assigned a unique UUID for tracking and moderation ### Custom Fakemon Sprites Servers running fakemon or custom Pokemon can upload front/back sprites so they display correctly in the replay viewer instead of showing a substitute placeholder. - Place PNG sprites in the `config/eclipse_playback/sprites/` folder - Files must be named `{pokemonname}-front.png` or `{pokemonname}-back.png` - Maximum dimensions: 128x128 pixels - Maximum file size: 50KB per sprite - Sprites are uploaded automatically on server startup - Already-uploaded sprites are tracked locally and won't re-upload **Example:** ``` config/eclipse_playback/sprites/ ├── exogon-front.png ├── exogon-back.png ├── fakemon-front.png └── fakemon-back.png ``` ### Server Identity Each server is automatically assigned a unique UUID on first startup. This UUID is sent with all replay and sprite uploads, allowing the Eclipse website to track which server submitted what data. If a server uploads inappropriate content, an admin can ban that server's UUID and scrub all of its data. - UUID is auto-generated on first run and saved to `config/eclipse_playback/replays.json` - OP players (level 2+) are reminded to set their server name if it's still the default "My Server" - No registration or manual setup required - just install and go --- ## Commands | Command | Permission | Description | |---------|------------|-------------| | `/giveteam ` | `pokepaste.giveteam` | Import a PokePaste team to your party | | `/pokepaste ` | `pokepaste.giveteam` | Same as /giveteam | | `/giveteamother ` | `pokepaste.giveteamother` | Import a team to another player's party | | `/pokepaste reload` | `pokepaste.admin` | Reload configuration files | | `/pokepaste eclipse list` | `pokepaste.admin` | List all custom Pokemon mappings | --- ## Permissions All permissions default to OP level 2 if no permission manager is installed. | Permission | Description | |------------|-------------| | `pokepaste.giveteam` | Use /giveteam and /pokepaste to import teams | | `pokepaste.giveteamother` | Import teams to other players | | `pokepaste.admin` | Reload config and view eclipse mappings | --- ## Configuration ### Replay Config **Location:** `config/eclipse_playback/replays.json` ```json { "enabled": true, "serverName": "My Server", "serverIp": "play.myserver.com", "serverUuid": "", "broadcastToServer": true, "broadcastFormat": "[Eclipse Replay] {player1} vs {player2} - Watch Replay" } ``` | Option | Description | Default | |--------|-------------|---------| | `enabled` | Enable/disable replay recording and sprite uploads | `true` | | `serverName` | Your server's display name in replays | `"My Server"` | | `serverIp` | Server IP shown to viewers (optional) | `""` | | `serverUuid` | Unique server identifier (auto-generated, do not change) | `""` (auto-fills) | | `broadcastToServer` | `true` = announce to all players, `false` = only battle participants | `true` | | `broadcastFormat` | MiniMessage format for chat announcements. Placeholders: `{player1}`, `{player2}`, `{winner}`, `{url}` | Eclipse gradient style | ### PokePaste Config **Location:** `config/pokepaste/eclipse_pokemon.json` Defines custom Pokemon species mappings for servers with custom Pokemon: ```json { "eclipseMappings": { "flygon": { "eclipseSpecies": "exogon", "displayName": "Exogon", "description": "Eclipse variant of Flygon. Use: (eclipse) Flygon" } }, "customSpecies": { "surusypia": { "cobblemonSpecies": "surusypia", "displayName": "Surusypia", "description": "Custom Pokemon. Use directly: Surusypia" } } } ``` **Usage in PokePaste:** - Write `(eclipse) Flygon` to get the mapped Eclipse species - Write `Surusypia` directly for custom species ### Item Mappings Config **Location:** `config/eclipse_playback/item_mappings.json` Maps Showdown item names to actual mod items. Genesis Forms items are included by default. ```json { "formItemNamespace": "genesisforms", "customMappings": { "cornerstonemask": { "namespace": "genesisforms", "itemId": "cornerstone_mask" }, "charizarditex": { "namespace": "genesisforms", "itemId": "charizardite-x" } }, "suffixPatterns": { "ite": { "keepAsIs": true }, "iumz": { "dropLast": 1, "appendSuffix": "-z" } } } ``` | Option | Description | |--------|-------------| | `formItemNamespace` | Default namespace for form-changing items | | `customMappings` | Explicit item name to mod item mappings | | `suffixPatterns` | Rules for automatically transforming item names by suffix | ### Custom Sprites **Location:** `config/eclipse_playback/sprites/` Place PNG sprites in this folder to upload them to the Eclipse replay viewer. The folder is created automatically on first startup. | Requirement | Value | |-------------|-------| | File format | PNG only | | Naming | `{name}-front.png` or `{name}-back.png` | | Max dimensions | 128x128 pixels | | Max file size | 50KB per file | Sprites are uploaded once and tracked in `config/eclipse_playback/sprites-uploaded.json`. If you update a sprite file, the new version will be re-uploaded automatically on the next server restart. --- ## Requirements - Minecraft 1.21.1 - Fabric Loader 0.16.5+ - Fabric API - Cobblemon 1.7.0+ --- ## Notes - **Server-side only** - Players do not need to install this mod - Battle replays are uploaded to the public [Eclipse Replay Viewer](https://cobblemoneclipse.com/replays/) - Custom sprites appear in the replay viewer for any Pokemon that doesn't have an official sprite - MiniMessage formatting requires MiniPlaceholders or a compatible library (falls back to plain text if unavailable) - The server UUID is generated once and persists across restarts - do not edit or share it

Cobblemon Eclipse

Members

Cobblemon Eclipse