Skip to content

objz/rmcl

rmcl

Contributors Forks Stargazers Issues GPL-3.0 License

Rusty MineCraft Launcher. or Rust MineCraft cLi. pick whichever sounds better to you.

screenshot

Report Bug · Request Feature


about

we all love TUIs. and we all know the official Minecraft launcher is not exactly a joy to use (performance wise; no hatespeech here). so here's rmcl, a fully featured Minecraft launcher that lives in your terminal. written in Rust because if you're replacing something bloated you might as well go all the way.

it does everything you'd expect from a launcher. multiple instances, mod loaders, modpack imports, Microsoft auth, content management, launching. all from a TUI or from the command line. the TUI is the main thing though, the CLI is there for scripting and automation.

features

instances create and manage multiple instances, each with their own version, loader, mods, and settings
mod loaders vanilla, Fabric, Quilt, Forge, NeoForge. more might show up later
content browse and toggle mods, shaders, resource packs. view worlds, screenshots, and logs
modpack import import from Modrinth via .mrpack file, URL, or slug
accounts multiple Microsoft accounts and offline players, switch between them
launching launch directly from the TUI or generate a desktop shortcut for any instance
desktop shortcuts click it and Minecraft starts, no need to open rmcl or type anything
CLI every feature the TUI has is also available as a subcommand
theming 10 built-in themes, custom themes, color overrides

authentication

rmcl uses its own Microsoft client ID for Minecraft account authentication.

Authentication is performed through Microsoft’s official services.

installation

macOS / Linux

prebuilt archives are attached to each GitHub release.

# Homebrew
brew install objz/tap/rmcl

Windows

release builds include a .zip archive and an .msi. WinGet and Chocolatey packages are submitted from release CI and become available after review.

# WinGet
winget install Objz.Rmcl

# Chocolatey
choco install rmcl

Arch Linux

# from source (release tarball)
paru -S rmcl

# prebuilt binary
paru -S rmcl-bin

# latest git
paru -S rmcl-git

Cargo

cargo install rmcl

package status

release:

GitHub release crates.io

package managers:

Homebrew tap WinGet Chocolatey

aur:

AUR rmcl AUR rmcl-bin AUR rmcl-git

from source

requires a Rust toolchain and a JDK (javac and jar on PATH).

git clone https://github.com/objz/rmcl.git
cd rmcl
cargo build --release

where things live

config & data

settings, accounts, instances, and cached game metadata.

what Linux macOS Windows
config (config.toml, theme.toml, accounts.json) ~/.config/rmcl/ ~/Library/Application Support/rmcl/ %APPDATA%\rmcl\
instances ~/.local/share/rmcl/instances/ ~/Library/Application Support/rmcl/instances/ %LOCALAPPDATA%\rmcl\instances\
metadata (versions, libraries, assets, loader profiles) ~/.local/share/rmcl/meta/ ~/Library/Application Support/rmcl/meta/ %LOCALAPPDATA%\rmcl\meta\

each instance has an instance.json for its config and a .minecraft/ directory with the actual game files. standard layout, nothing weird.

logs

launcher logs are per-session and contain rmcl's own output. instance launch logs capture game stdout/stderr per launch.

what Linux macOS Windows
launcher logs ~/.cache/rmcl/ ~/Library/Caches/rmcl/ %LOCALAPPDATA%\rmcl\
instance launch logs <instances>/<name>/.minecraft/logs/launches/ same same

configuration

everything is configured through TOML files. config.toml for paths, default memory allocation, and UI behavior. theme.toml for theme selection and border style. you can also override individual colors without making a full custom theme.


themes

rmcl ships with 10 built-in themes:

catppuccin · dracula · nord · gruvbox · one-dark · solarized · tailwind · tokyo-night · rose-pine · terminal

you can create your own by dropping a TOML file in ~/.config/rmcl/theme/ and referencing it by name, or point to an absolute path.


contributing

contributions are welcome. fork it, branch it, PR it. see CONTRIBUTING.md for code style and project structure.


license

GPL-3.0. see LICENSE.


About

A minecraft CLI launcher written in Rust

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors

Languages