invar 0.6.0

CLI management tool for modded Minecraft servers
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

use clap::ValueEnum;
use semver::Version;
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, HashSet};
use strum::{Display, EnumIter};

/// A struct representing a Minecraft instance.
///
/// An instance does NOT take into account the associated `Component`s. Those
/// bounded with an `Instance`, all the `Config`s and `Override`s form a `Pack`.
/// See `Pack` if that's what you're looking for.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Instance {
    pub minecraft_version: Version,
    pub loader: Loader,
    pub loader_version: Version,

    /// Mods with an incompatible loader will be allowed in the pack if this
    /// list contains their loader.
    ///
    /// Some mods like [Sinytra Connector](https://github.com/Sinytra/Connector) allow loading Fabric mods
    /// on Forge/NeoForge, this option makes it so you can add mods that would
    /// require a compatibility layer without getting bombarded with
    /// incompatibility warnings.
    pub allowed_foreign_loaders: HashSet<Loader>,
}

impl Instance {
    #[must_use = "Unused instance dependencies"]
    pub fn index_dependencies(&self) -> HashMap<Loader, Version> {
        let mut dependencies = HashMap::new();
        dependencies.insert(self.loader, self.loader_version.clone());
        dependencies.insert(Loader::Minecraft, self.minecraft_version.clone());
        dependencies
    }
}

/// Possible types of modloaders an instance can depend on.
///
/// Implements [`serde`]'s (De)serialization and [`clap`]'s [`ValueEnum`].
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ValueEnum, EnumIter, Display, Hash,
)]
#[serde(rename_all = "lowercase")]
pub enum Loader {
    /// Vanilla minecraft with no external modloader.
    ///
    /// You won't be able to load mods (and thus shaders) if this is the
    /// [`Instance::loader`].
    #[serde(alias = "vanilla", alias = "none", alias = "datapack")]
    Minecraft,

    /// The [**Forge**](https://minecraftforge.net) modloader.
    ///
    /// Has been around for a long time, and still kinda is the goto loader.
    Forge,

    /// The [**NeoForge**](https://neoforged.net) modloader.
    ///
    /// It is compatible with [`Forge`](Loader::Forge), is open-source and
    /// fresh, but is only available for newer versions.
    Neoforge,

    /// The [**Fabric**](https://fabricmc.net) modloader.
    ///
    /// Modular, lightweight mod loader. Performant and fresh, but incompatible
    /// with [`Forge`](Loader::Forge) mods.
    Fabric,

    /// The [**Quilt**](https://quiltmc.org/en) modloader.
    ///
    /// An open-source, community-driven modding toolchain. I believe its
    /// [`Fabric`](Loader::Fabric)-compatible in terms of mods.
    Quilt,

    /// Some other modloader we don't know about.
    ///
    /// Shaders sometimes say their loader is `"iris"` or `"optifine"`, mods may
    /// just say `"modloader"`. In these cases, it's up to the user to check
    /// that the component is compatible with the instance.
    #[serde(other)]
    Other,
}