mcjsongen

🏗️ A CLI (and js/ts library) that simplifies the task of creating model, blockstate, loot table JSON files for Minecraft Modding

Tech Stack

• TypeScript
• ESLint
• Prettier

Installation

NPM

# Globally (CLI)
npm install -g mcjsongen

# Locally (Library)
npm install mcjsongen

Yarn

# Globally (CLI)
yarn global add mcjsongen

# Locally (Library)
yarn add mcjsongen

CLI Usage

Usage: mcjsongen [options] [command]

A CLI (and js/ts library) that simplifies the task of creating model, blockstate, loot table JSON files for Minecraft Modding

Options:
  -V, --version                        output the version number
  -h, --help                           show this help message

Commands:
  gen <category> <type> <id> [mod]     Output result of an individual generator
  create <category> <type> <id> [mod]  Write result of an individual generator to assets directory
  new <template> <id> [mod]            Generate a block/item from a template and write to assets
                                       directory
  help [command]                       display help for command

Library Usage

🚧 Documentation will be available soon. The Library is currently not suggested for use in the current version.

Generators (for gen and create)

models

• crossBlock
• flowerPotCrossBlock
• item

blockstates

• general
• ages (Takes additional data: Amount of growth stages)

Templates (for new)

• berry: Creates berry item and berry bush block with 4 growth stages
• flower: Creates a normal minecraft flower with block and item. Allows for the creation of multiple at once by seperating the IDs with a ,.

How to report issues/questions

• For general issues/questions, open an issue
• For security issues, please email [e-mail]
• For important questions, please email [e-mail]

License

As this is an open-source project, support is limited. Please use GitHub Issues for community support or contact [e-mail] for very important matters.

ℹ️ All code in this repository is licensed under the MIT License.