> For the complete documentation index, see [llms.txt](https://rapidmesck.gitbook.io/cobblemon-smartphone/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rapidmesck.gitbook.io/cobblemon-smartphone/readme.md). # Cobblemon Smartphone Welcome to the Cobblemon Smartphone developer documentation. This mod provides a smartphone item for Cobblemon that can be extended with custom actions and personalized with custom themes: * **Datapack API** — Add actions via JSON files in datapacks or resource packs. No coding required. * **Mod API** — Add actions programmatically from your own mod. Full control with Kotlin/Java. * **Theme System** — Customize wallpapers, frames, app icons, UI elements, and color palettes via resource packs. * **Theme Creator Studio** — Visual standalone HTML tool (`theme_creator.html`) to preview and generate themes and resource packs. ## Quick Start | I want to... | Use | | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | Visually design & export a theme pack | [Theme Creator Studio](/cobblemon-smartphone/themes.md#theme-creator-studio-visual-web-tool) (`theme_creator.html`) | | Add a button that runs commands | [Datapack API](/cobblemon-smartphone/datapack-api.md) | | Open PC, Pokédex, healing, or another supported interface | [Datapack API](/cobblemon-smartphone/datapack-api.md#built-in-functions) | | Add an unsupported GUI or custom logic | [Mod API](/cobblemon-smartphone/mod-api.md) | | Require a smartphone upgrade to unlock an action | Both APIs support this | | Customize wallpapers, colors, frames, and icons | [Theme System](/cobblemon-smartphone/themes.md) | | Configure cooldowns, feature toggles, or upgrade checks | [Mod Configuration](#mod-configuration) | ## Supported Versions * Minecraft **1.21.1** * Cobblemon **1.6+** * Loaders: **Fabric** (0.16+), **NeoForge** (21.1+) ## API Overview ### Datapack API Place JSON files in `data//smartphone_actions/` inside any datapack. Each file defines one action button. ```json { "id": "mypack:my_action", "texture": "mypack:textures/gui/buttons/my_button.png", "hover_texture": "mypack:textures/gui/buttons/my_button_hover.png", "functions": ["open_pc"], "commands": ["say Hello from smartphone!"], "order": 100, "cooldown_seconds": 10, "require_mod": "optional_mod_id", "require_upgrade": "upgrade_my_feature" } ``` → [Full Datapack API Reference](/cobblemon-smartphone/datapack-api.md) ### Mod API Implement the `SmartphoneAction` interface in your Kotlin/Java code and register it. ```kotlin object MyAction : SmartphoneAction { override val id = "mymod:my_action" override val texture = ResourceLocation.fromNamespaceAndPath("mymod", "textures/gui/buttons/my_button.png") override val hoverTexture = ResourceLocation.fromNamespaceAndPath("mymod", "textures/gui/buttons/my_button_hover.png") override fun onClick() { // Your logic here } override fun isEnabled(): Boolean { // Return false to hide the button return true } } // In your mod init: SmartphoneActionRegistry.register(MyAction) ``` → [Full Mod API Reference](/cobblemon-smartphone/mod-api.md) ### Theme System Place JSON files in `assets//themes/.json` or PNG images in `assets//textures/gui/themes/` inside any resource pack. No server reload or code required. ```json { "id": "mypack:neon", "name": "Neon Cyber", "wallpaper": "mypack:textures/gui/wallpapers/neon.png", "large_wallpaper": "mypack:textures/gui/wallpapers/neon_large.png", "colors": { "primary": "#00FFCC", "time": "#00FFCC" } } ``` → [Full Theme System Reference](/cobblemon-smartphone/themes.md) ## Upgrade System Both APIs support the **smartphone upgrade** mechanic. Upgrades allow actions to be locked behind a smithing table recipe that permanently adds an NBT tag to the smartphone. | Feature | Datapack API | Mod API | | ------------------------------------- | ------------------------------------- | --------------------------------------------------------------------- | | Require upgrade for action | `"require_upgrade": "upgrade_"` | Use `SmartphoneHelper.satisfiesUpgradeRequirement()` in `isEnabled()` | | Define upgrade/item | Via smithing recipe JSON | Register `SmartphoneUpgrade` | | Use built-in PC/healing/GUI functions | `"functions": ["open_pc"]` | Send the matching packet or call custom logic | | Simulate arbitrary item use | ❌ | `SimulatedItemUse.simulate()` | If an action ID is listed in `ignoreUpgrades` in the mod config, that action is shown and can be used without the matching smartphone upgrade. ## Mod Configuration Cobblemon Smartphone writes its config to: ``` config/cobblemon_smartphone.json ``` The file is created automatically on first load and rewritten with any missing default fields. ```json { "ignoreUpgrades": [], "cooldowns": { "healButton": 60, "pcButton": 5, "cloudButton": 5, "waystoneButton": 5, "pokedexButton": 1 }, "features": { "enableHeal": true, "enablePC": true, "enableCloud": true, "enablePokenav": true, "enableCobbleDollars": true, "enableWaystone": true, "enablePokedex": true, "enableScanner": true } } ``` | Field | Type | Default | Description | | ---------------- | ------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ignoreUpgrades` | String array | `[]` | Action IDs listed here ignore their upgrade requirement. Built-in and datapack actions not listed still require the matching smithing upgrade. Ex: `["cobblemon_smartphone:cobblenav_pokenav","cobblemon_smartphone:waystones_warp_stone"]` | | `cooldowns` | Object | See example | Cooldown values, in seconds, for built-in actions. | | `features` | Object | See example | Toggles for built-in smartphone actions. Disabled features remain hidden even when their action ID is listed in `ignoreUpgrades`. | ## Upgrade Smithing Recipe Format Upgrade recipes use vanilla `minecraft:smithing_transform` with a smartphone tag as the base: ```json { "type": "minecraft:smithing_transform", "fabric:load_conditions": [{ "condition": "fabric:all_mods_loaded", "values": ["mymod"] }], "neoforge:conditions": [{ "type": "neoforge:mod_loaded", "modid": "mymod" }], "template": { "item": "cobblemon:upgrade" }, "base": { "tag": "cobblemon_smartphone:smartphones" }, "addition": { "item": "mymod:my_item" }, "result": { "id": "cobblemon_smartphone:red_smartphone", "count": 1, "components": { "minecraft:custom_data": { "cobblemon_smartphone:upgrades": { "upgrade_my_feature": true } } } } } ``` The **Mixin on `SmithingTransformRecipe`** automatically preserves the smartphone color when crafting — the `red_smartphone` in the result is just a placeholder for JEI/EMI/REI display. ### Recipe Conditions Use platform-specific conditions to hide recipes when required mods are absent: * **Fabric**: `fabric:load_conditions` with `fabric:all_mods_loaded` * **NeoForge**: `neoforge:conditions` with `neoforge:mod_loaded` Both can coexist in the same JSON — each loader ignores the other's field. ## Links * [Cobblemon Mod](https://modrinth.com/mod/cobblemon) * [Architectury API](https://docs.architectury.dev/)