Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

mc init

mc init [OPTIONS] [PATH]

Creates a new instance: a mc.kdl manifest and a .gitignore. PATH defaults to the current directory and is created if it does not exist. The command refuses to run where a mc.kdl already exists.

The generated .gitignore excludes runtime state — the installed JDKs and Minecraft binaries, the live server directory, scratch space, and run-time lock files — so an instance can be versioned with git. The manifest and the mc.lock lockfile are not excluded: commit them to make the instance reproducible. An existing .gitignore is left untouched; a warning lists any of these entries it lacks.

Options

  • --name <NAME> — the instance name. Defaults to the directory name.
  • --eula — record your agreement to the Minecraft EULA in the generated manifest. Without it, the manifest is created with eula #false and the instance will not start until you edit it.
  • --preset <PRESET> — the shape of the generated manifest:
    • vanilla — no mod loader and no mods.
    • optimized — a mod loader plus performance mods. This is the default.
    • technical — a mod loader plus performance mods and tools for technical play.

Presets pin the latest Minecraft release and compatible mod versions at the time the command runs; the generated manifest is a starting point to edit, not a fixed template.

Examples

mc init myserver
mc init --preset technical --eula
mc init myserver --name "smp" --preset vanilla