lighty-version 26.5.8

Minecraft version management for Lighty Launcher
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

# lighty-version

Version management and builders for [LightyLauncher](https://crates.io/crates/lighty-launcher).

## Overview

**Version**: 26.5.8
**Part of**: [LightyLauncher](https://crates.io/crates/lighty-launcher)

`lighty-version` provides version builders that implement the `VersionInfo` trait from `lighty-loaders`, enabling version management for Minecraft instances.

## Features

- **VersionBuilder** - Standard version builder for all loaders
- **LightyVersionBuilder** - Custom server version builder for LightyUpdater
- **VersionInfo Implementation** - Implements core version trait
- **Directory Management** - Configurable game and Java directories
- **Type Safety** - Strongly typed version information

## Quick Start

```toml
[dependencies]
lighty-version = "26.5.8"
```

### VersionBuilder (Standard Loaders)

```rust
use lighty_core::AppState;
use lighty_version::VersionBuilder;
use lighty_loaders::types::Loader;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    AppState::init("MyLauncher")?;

    // Create instance with Fabric loader
    let instance = VersionBuilder::new(
        "my-instance",         // Instance name
        Loader::Fabric,        // Loader type
        "0.16.9",             // Loader version
        "1.21.1",             // Minecraft version
    );

    println!("Instance: {}", instance.name());
    println!("Game dir: {}", instance.game_dirs().display());

    Ok(())
}
```

### LightyVersionBuilder (Custom Server)

```rust
use lighty_core::AppState;
use lighty_version::LightyVersionBuilder;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    AppState::init("MyLauncher")?;

    // Create instance for custom server with LightyUpdater
    let instance = LightyVersionBuilder::new(
        "my-modpack",                  // Instance name
        "https://myserver.com/api",    // Server API URL
    );

    println!("Server: {}", instance.loader_version());

    Ok(())
}
```

### With Custom Directories

```rust
use std::path::PathBuf;

// Custom Java directory
let instance = VersionBuilder::new(
    "custom",
    Loader::Vanilla,
    "",
    "1.21.1",
)
.with_custom_java_dir(PathBuf::from("/usr/lib/jvm/java-21"));

// To relocate the game runtime (mods/saves/options.txt), use the
// launch-side knob:
//   .launch(...).with_arguments().set(KEY_GAME_DIRECTORY, "/opt/...").done()
```

## Core Types

| Type | Description |
|------|-------------|
| **VersionBuilder** | Standard version builder for all loaders |
| **LightyVersionBuilder** | Custom server builder for LightyUpdater |

Both implement `VersionInfo` from `lighty-loaders`.

## Documentation

📚 **[Complete Documentation](./docs)**

| Guide | Description |
|-------|-------------|
| [How to Use](./docs/how-to-use.md) | Practical usage guide with examples |
| [Overview](./docs/overview.md) | Architecture and design |
| [Exports](./docs/exports.md) | Complete export reference |
| [VersionBuilder](./docs/version-builder.md) | Standard version builder details |
| [LightyVersionBuilder](./docs/lighty-version-builder.md) | Custom server builder details |

## Related Crates

- **[lighty-launcher](../../../README.md)** - Main package
- **[lighty-loaders](../loaders/README.md)** - VersionInfo trait and loaders
- **[lighty-core](../core/README.md)** - AppState for launcher paths
- **[lighty-launch](../launch/README.md)** - Uses VersionBuilder for launching

## License

MIT