Cobblemon Mod Builder

A CLI tool for generating Cobblemon sidemod configuration files.

Features

• Interactive prompts for mod configuration
• User profiles for reusable settings
• Input validation
• -y flag for non-interactive mode

Prerequisites

• Node.js >= 18.0.0

Usage

Run with npx (recommended):

npx github:timinc-cobble-help/tims-sidemod-builder

Run with npx and skip profile questions:

npx github:timinc-cobble-help/tims-sidemod-builder -y

Prompts

The tool will ask you for the following information:

1. Author's name (required): Your full name
2. Author's alias (optional): Nickname or handle
3. Sidemod package (required): Java package name (e.g., com.example.mod)
4. Cobblemon version (required): Choose between 1.6.1 or 1.7.0
5. Sidemod name (required): Name of your mod
6. Mod description (required): Brief description of your mod

Profiles

Profiles allow you to save and reuse author information and package settings across multiple projects.

• Profiles are stored in your system's config directory
• Only author and package information is saved (not mod-specific details)
• Use -y flag to skip questions that have profile values

Output

The tool generates a mod-config.json file in the current directory:

{
  "authorName": "John Doe",
  "authorAlias": "johnd",
  "sidemodPackage": "com.example.awesomemod",
  "cobblemonVersion": "1.7.0",
  "sidemodName": "My Awesome Mod",
  "modDescription": "An awesome mod for Cobblemon"
}