Skip to content

objz/mcl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

125 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mcl

Contributors Forks Stargazers Issues GPL-3.0 License

MineCraft Launcher. or 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. so here's mcl, 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 mcl or type anything
CLI every feature the TUI has is also available as a subcommand
theming 10 built-in themes, custom themes, color overrides

installation

Arch Linux

AUR version AUR version AUR version

# from source (release tarball)
paru -S mcl-launcher

# prebuilt binary
paru -S mcl-launcher-bin

# latest git
paru -S mcl-launcher-git

also available on crates.io

from source

requires a Rust toolchain.

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

other platforms

mcl can be compiled for Linux, macOS, and Windows. right now it's only packaged for Arch Linux (AUR) but official packages for other platforms and package managers will be added continuously.


where things live

path what
~/.config/mcl/config.toml general config (paths, memory defaults, UI settings)
~/.config/mcl/theme.toml theme, border style, color overrides
~/.config/mcl/accounts.json accounts
~/.local/share/mcl/instances/ instances, each in its own directory
~/.local/share/mcl/meta/ cached game metadata, libraries, assets, loader profiles

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


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

mcl 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/mcl/theme/ and referencing it by name, or point to an absolute path.


contributing

contributions are welcome. fork it, branch it, PR it. make sure cargo clippy and cargo test pass before opening a PR.


license

GPL-3.0. see LICENSE.


About

A minecraft CLI launcher written in Rust

Resources

License

Stars

Watchers

Forks