Redstonium

A command-line Minecraft launcher written in Rust.

Redstonium is a lightweight, cross-platform tool for managing and launching Minecraft from your terminal. It handles authentication, version management, and game instances, providing a simple interface for automation and server-side setups.

Features

• Authentication: Securely logs into your Microsoft account to authenticate with Minecraft services. Caches credentials for future sessions.
• Version Management: Lists available Minecraft versions (releases, snapshots, etc.) and downloads all necessary game files, libraries, and assets.
• Instance Management: Create, list, and delete separate game instances, each with its own version and settings.
• Configuration: Set instance-specific memory allocation.
• Java Detection: Automatically finds suitable Java installations on your system.
• Cross-Platform: Works on Windows, macOS, and Linux.

Installation

You need the Rust toolchain installed to build Redstonium.

1. Clone the repository:

   git clone https://github.com/OmarAfet/Redstonium.git
   cd Redstonium

2. Build the project for release:

   cargo build --release

3. The executable will be located at target/release/Redstonium. You can move this file to a directory in your system's PATH to use it globally.

Usage

Redstonium is controlled via subcommands. You can see all available commands and options by running:

Redstonium --help

Basic Workflow

1. Create an instance: First, create an instance for a specific Minecraft version. For example, to create an instance named vanilla-1-21 for Minecraft 1.21:

   Redstonium instance create vanilla-1-21 1.21

2. Launch the instance: The first time you launch an instance, Redstonium will guide you through the Microsoft authentication process in your web browser. After that, your login will be cached.

   Redstonium launch vanilla-1-21

Other Commands

List available Minecraft versions:

# Show the 10 newest releases and snapshots
Redstonium list

# Show only the 5 latest release versions
Redstonium list --releases-only --limit 5

# Filter versions by a pattern
Redstonium list --filter "1.18"

Manage instances:

# List all created instances
Redstonium instance list

# Delete an instance
Redstonium instance delete vanilla-1-21

# Set the memory for an instance to 4096 MB
Redstonium instance memory vanilla-1-21 4096

Manage authentication:

# Check your current authentication status
Redstonium auth status

# Clear the cached login credentials
Redstonium auth clear

Manage Java:

# List detected Java installations
Redstonium java list

# See the recommended Java version for a Minecraft version
Redstonium java recommend 1.21

License

This project is licensed under the MIT License. See the LICENSE file for details.