UNPKG

@origami-minecraft/devbuilds

Version:

Origami is a terminal-first Minecraft launcher that supports authentication, installation, and launching of Minecraft versions โ€” with built-in support for Microsoft accounts, mod loaders, profile management, and more. Designed for power users, modders, an

211 lines (137 loc) โ€ข 3.58 kB
# ๐ŸŒธ Origami CLI โ€” Documentation > โœจ **Lightweight Minecraft CLI Launcher** > Supports profiles, authentication, version installation, Java management, mod installation, and launching โ€” both scriptable & interactive. --- ## ๐Ÿ“ฆ Installation ### Stable Release (Recommended) ```bash npm install -g @origami-minecraft/stable ```` ### Development Build (Unstable, bleeding-edge) ```bash npm install -g @origami-minecraft/devbuilds ``` --- ## ๐Ÿงญ Usage ```bash origami [command] [options] ``` To show help: ```bash origami --help ``` --- ## ๐Ÿ“œ Commands ### `menu` Launch the full interactive menu UI. ```bash origami menu ``` --- ### `launch` Launch Minecraft using the currently selected profile. ```bash origami launch ``` --- ### `profile` Manage Minecraft profiles. #### Options: * `-s, --select <profile>` โ€” Select a specific profile * `-i, --install` โ€” Install a Minecraft version * `-d, --delete` โ€” Opens the Profile Deletion Menu * `-l, --list` โ€” List all available profiles #### Examples: ```bash origami profile origami profile --list origami profile --select MyProfile origami profile --install ``` --- ### `auth` Authenticate Minecraft accounts. #### Options: * `-l, --login <provider>` โ€” Log in using a provider (`microsoft`, `littleskin`, `ely_by`, `meowskin`) * `-r, --remove <account>` โ€” Remove an account by ID * `-c, --choose` โ€” Select an account to use #### Examples: ```bash origami auth origami auth --login microsoft origami auth --remove 1234567890abcdef origami auth --choose ``` --- ### `java` Manage Java runtimes (Temurin). #### Options: * `-i, --install` โ€” Download and install a Temurin JDK * `-s, --select` โ€” Choose a JDK installed via Origami * `-d, --delete` โ€” Delete installed Java #### Examples: ```bash origami java --install origami java --select origami java --delete ``` --- ### `modrinth` Install mods, shaders, or resource packs from Modrinth (requires selected profile). ```bash origami modrinth ``` --- ### `manage` Manage installed content for the selected profile โ€” enables/disables mods and removes items. ```bash origami manage ``` --- ### `clean` Reset data folders related to Minecraft or Origami. #### Options: * `--minecraft` โ€” Reset `.minecraft` folder * `--origami` โ€” Reset Origami configuration (e.g. accounts, profiles) * `--all` โ€” Reset everything #### Examples: ```bash origami clean --minecraft origami clean --origami origami clean --all ``` --- ## ๐Ÿงช Supported Auth Providers You can log in using: * `microsoft` โ€” Official Microsoft account login * `littleskin` โ€” BlessingSkin auth system * `ely_by` โ€” Ely.by auth system * `meowskin` โ€” BlessingSkin auth system --- ## ๐Ÿ’ก Tips & Notes * You **must select a profile** before launching Minecraft. * Development builds (`-devX`) may contain experimental or incomplete features. * You can install, select, and delete Java via `origami java`, `origami java:delete`. * You can manage mods and content via `origami modrinth` and `origami manage`. --- ## ๐Ÿ“ฆ Version Example ```bash origami --version # 1.0.6 or 1.0.6-dev3 ``` --- ## ๐Ÿ”ง Example Script Usage ```bash #!/bin/bash # Script to set up Java, log in, install mods, and launch Minecraft origami java --install origami java --select origami auth --login microsoft origami profile --select myProfile origami modrinth origami launch ``` --- ## ๐Ÿ“– Related * [GitHub Repository](https://github.com/merasugd/origami-launcher) * [NPM Page](https://www.npmjs.com/package/@origami-minecraft/stable)