LightyLauncher Documentation

Comprehensive documentation for LightyLauncher library.

Quick Navigation

🎯 Getting Started

1. Main README - Quick start and installation

2. Examples - Code examples with detailed explanations

3. Architecture - Understand the system design

📚 Core Guides

Guide	Purpose	Best For
Sequence Diagrams	Visual workflows for all operations	Understanding flow and process
Re-exports Reference	Complete API reference	Finding available types and functions
Architecture	System design and patterns	Understanding internals
Examples	Example walkthroughs	Learning by example

Documentation Structure

docs/
├── README.md                 # This file
├── sequence-diagrams.md      # Visual workflows
├── reexports.md             # API reference
├── architecture.md          # System design
├── examples.md              # Example walkthroughs
└── img/                     # Images and diagrams

Guide Details

Sequence Diagrams

File: sequence-diagrams.md

Visual diagrams for:

• Complete launch sequence

• Authentication flows (Offline, Microsoft)

• Installation process (parallel downloads)

• Java management

• Instance control

• Console streaming

• Event flow

• Loader-specific sequences (Fabric, LightyUpdater)

When to use: Understanding how components interact and the order of operations.

Re-exports Reference

File: reexports.md

Complete reference of all types and functions re-exported by lighty-launcher:

• Module organization

• Type definitions

• Function signatures

• Import patterns

• Usage examples

• Links to detailed crate documentation

When to use: Finding what's available and how to import it.

Architecture

File: architecture.md

System architecture documentation:

• Module overview and dependencies

• Data flow diagrams

• Design patterns (Builder, Trait-based, Event-driven, etc.)

• Concurrency model

• Error handling strategy

• Platform support

• Performance optimizations

• Security considerations

When to use: Understanding the overall system design and implementation details.

Examples

File: examples.md

Detailed walkthroughs of all examples:

• Example overview table

• Running instructions

• Code walkthroughs

• Key concepts explained

• Event types demonstrated

• Common patterns

• Troubleshooting

When to use: Learning by example and finding code snippets.

By Use Case

I want to...

Launch Vanilla Minecraft

1. Read: Examples - vanilla.rs

2. See flow: Sequence Diagrams - Complete Launch

3. Run: cargo run --example vanilla --features vanilla

Use a Mod Loader (Fabric, Quilt, Forge)

1. Read: Examples - fabric.rs

2. See how loaders merge: Sequence Diagrams - Fabric Loader

3. Check exports: Re-exports - Loaders Module

Track Progress with Events

1. Read: Examples - with_events.rs

2. See event flow: Sequence Diagrams - Event Flow

3. Check event types: Re-exports - Events Module

Manage Running Instances

1. Read: Examples - Instance Control

2. See instance lifecycle: Sequence Diagrams - Instance Control

3. Check API: Re-exports - Launch Module

Understand System Design

1. Read: Architecture

2. See module dependencies: Architecture - Module Dependencies

3. Check design patterns: Architecture - Design Patterns

Create Custom Authentication

1. Read: Re-exports - Authentication Module

2. See auth flow: Sequence Diagrams - Authentication

3. Check trait: Architecture - Trait-Based Extensibility

Build a Custom Launcher UI

1. Read: Architecture - System Overview

2. Check Tauri integration: Re-exports - Tauri Module

3. Use events: Examples - with_events.rs

Crate-Specific Documentation

Each crate has its own detailed documentation:

Core Crates

• lighty-core - Core utilities and AppState

• lighty-launcher - Main package with re-exports

Feature Crates

• lighty-auth - Authentication providers

• lighty-event - Event system

• lighty-java - Java runtime management

• lighty-launch - Launch orchestration

  • Launch Process

  • Arguments System

  • Installation

  • Instance Control

  • Events

  • How to Use

  • Exports

• lighty-loaders - Mod loader implementations

• lighty-version - Version builders

  • How to Use

  • Overview

  • Exports

  • VersionBuilder

  • LightyVersionBuilder

Examples Directory

All examples are located in examples/:

• vanilla.rs - Basic Vanilla launcher

• fabric.rs - Fabric mod loader

• quilt.rs - Quilt mod loader

• neoforge.rs - NeoForge mod loader

• forge.rs - Forge mod loader

• forge_legacy.rs - Legacy Forge (1.7.10-1.12.2)

• optifine.rs - OptiFine

• lighty_updater.rs - Custom modpack server

• with_events.rs - Complete event system demo

See Examples Guide for detailed walkthroughs.

Additional Resources

External Links

• Crates.io - Published packages

• Docs.rs - API documentation

• GitHub - Source code

• LightyUpdater - Custom server

Community

• Issues - Bug reports and feature requests

• Discussions - Questions and ideas

Contributing

See CONTRIBUTING.md for contribution guidelines.

License

MIT License - see LICENSE file for details.