Skip to content

aayushdutt/mctui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mctui - Minecraft TUI Launcher (Beta)

A fast, terminal-based Minecraft launcher built with Go and Bubbletea.

Features

  • 🚀 Fast - Native binary, instant startup
  • 🎮 Instance Management - Create, configure, and launch Minecraft instances
  • 📦 Modrinth Integration - Browse and install mods directly
  • 🔐 Microsoft Auth - Secure login with device code flow
  • 🖥️ Beautiful TUI - Modern terminal interface with mouse support

Quick Start

# Run directly
go run .

# Or build and run
make build
./mctui

Project Structure

mctui/
├── main.go                 # Entry point
├── internal/
│   ├── app/               # Main Bubbletea application
│   ├── ui/                # TUI views and components
│   ├── core/              # Business logic (instances, versions)
│   ├── api/               # HTTP clients (Mojang, Modrinth, MSA)
│   └── config/            # Configuration management
├── Makefile               # Build commands
└── BEST_PRACTICES.md      # Architecture guide

Keybindings

Key Action
↑/↓ or j/k Navigate
Enter or l Launch/Select
n New instance
m Open mods
s Settings
/ Search
q Quit

Data & Configuration

Data is stored in ~/.local/share/mctui (Linux/macOS) or %APPDATA%\mctui (Windows).

  • Instances: .../instances/
  • Java Runtimes: .../java/ (Automatic downloads are stored here and reused across instances)
  • Accounts: .../accounts.json
  • Assets/Libraries: Shared global cache

License

MIT

About

mctui - Minecraft TUI Launcher (Beta)

Resources

Stars

Watchers

Forks

Packages

No packages published