rosu-mods 0.4.0

Library for osu! mods
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

[![crates.io](https://img.shields.io/crates/v/rosu-mods.svg)](https://crates.io/crates/rosu-mods) [![docs](https://docs.rs/rosu-mods/badge.svg)](https://docs.rs/rosu-mods)

# rosu-mods

<!-- cargo-rdme start -->

A library to provide types for all [osu!] gamemods as defined in the official [mods.json] file.

Individual gamemod types are generated automatically through the [`generate-mods`] binary.

### Types

In total there are three different collections for mods.

#### `GameModsLegacy`

[`GameModsLegacy`] is a lightweight type that is essentially just bitflags for the [legacy mods].

```rust
use rosu_mods::GameModsLegacy;

let hdnc = GameModsLegacy::Nightcore | GameModsLegacy::Hidden;
assert_eq!(hdnc.to_string(), "HDNC");
assert!(hdnc.contains(GameModsLegacy::DoubleTime));
```

#### `GameMods`

[`GameMods`] is a collection of the [`GameMod`] enum. [`GameMod`] distinguishes between each
mode so if a mod is valid for multiple modes, each of those modes will have a variant for that
mod.

```rust
use rosu_mods::{GameMod, GameMods, generated_mods::AccuracyChallengeMania};

// The `mods!` macro is only available if the `macros` feature is enabled
let mut mods: GameMods = rosu_mods::mods!(Taiko: AC HR);

// In addition to the two taiko mods, let's add a mania mod too
mods.insert(GameMod::AccuracyChallengeMania(AccuracyChallengeMania {
    restart: Some(true),
    ..Default::default()
}));

assert_eq!(mods.to_string(), "ACHRAC");

let mut iter = mods.into_iter();
assert_eq!(iter.next(), Some(GameMod::AccuracyChallengeTaiko(Default::default())));
assert_eq!(iter.next(), Some(GameMod::HardRockTaiko(Default::default())));
assert_eq!(iter.next(), Some(GameMod::AccuracyChallengeMania(AccuracyChallengeMania {
    restart: Some(true),
    minimum_accuracy: None,
    accuracy_judge_mode: None,
})));
assert_eq!(iter.next(), None);
```

#### `GameModsIntermode`

[`GameModsIntermode`] is a collection of the [`GameModIntermode`] enum. Unlike [`GameMod`],
this enum does not distinguish between modes. As such, variants do not carry further data
because a mod may have different settings depending on the mode.

Since [`GameModsIntermode`] does not carry additional data and also consists of fewer variants,
it is generally easier to deal with than [`GameMods`].

```rust
use rosu_mods::{GameModIntermode, GameModsIntermode};

// The `mods!` macro is only available if the `macros` feature is enabled
let mut mods: GameModsIntermode = rosu_mods::mods!(WG FI);

// Let's add some more mods
mods.extend([GameModIntermode::Easy, GameModIntermode::HardRock]);

assert_eq!(mods.to_string(), "EZFIHRWG");

let mut iter = mods.into_iter();
assert_eq!(iter.next(), Some(GameModIntermode::Easy));
assert_eq!(iter.next(), Some(GameModIntermode::FadeIn));
assert_eq!(iter.next(), Some(GameModIntermode::HardRock));
assert_eq!(iter.next(), Some(GameModIntermode::Wiggle));
assert_eq!(iter.next(), None);
```

### Features

| Flag      | Description                                                                                      | Dependencies
| --------- | ------------------------------------------------------------------------------------------------ | ------------
| `default` | No features enabled                                                                              |
| `macros`  | Enables the `mods!` macro                                                                        | [`pastey`]
| `serde`   | Implements `serde::{Deserialize, Serialize}` for all types and enables the `serde` module        | [`serde`]
| `rkyv`    | Implements `rkyv::{Archive, Serialize, Deserialize}` for all types and enables the `rkyv` module | [`rkyv`]

[osu!]: https://osu.ppy.sh/home
[mods.json]: https://github.com/ppy/osu-web/blob/master/database/mods.json
[`generate-mods`]: https://github.com/MaxOhn/rosu-mods/tree/main/generate-mods
[legacy mods]: https://github.com/ppy/osu-api/wiki#reference
[`pastey`]: https://docs.rs/pastey
[`serde`]: https://docs.rs/serde
[`rkyv`]: https://docs.rs/rkyv
[`GameModsLegacy`]: https://docs.rs/rosu-mods/latest/rosu_mods/legacy/struct.GameModsLegacy.html
[`GameMods`]: https://docs.rs/rosu-mods/latest/rosu_mods/mods/struct.GameMods.html
[`GameMod`]: https://docs.rs/rosu-mods/latest/rosu_mods/generated_mods/gamemod/enum.GameMod.html
[`GameModsIntermode`]: https://docs.rs/rosu-mods/latest/rosu_mods/intermode/struct.GameModsIntermode.html
[`GameModIntermode`]: https://docs.rs/rosu-mods/latest/rosu_mods/generated_mods/intermode/enum.GameModIntermode.html

<!-- cargo-rdme end -->