bms-rs 1.0.0

The BMS format parser.
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

//! This module introduces struct [`Metadata`], which manages data to organize BMS scores in a BMS player.

use std::path::PathBuf;

use crate::bms::prelude::*;

#[derive(Debug, Default, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
/// This aggregate manages data to organize BMS scores in a BMS player.
pub struct Metadata {
    /// The play style of the score.
    pub player: Option<PlayerMode>,
    /// The play level of the score.
    pub play_level: Option<u8>,
    /// The difficulty of the score.
    pub difficulty: Option<u8>,
    /// The email address of the author.
    pub email: Option<String>,
    /// The url of the author.
    pub url: Option<String>,
    /// The path to override the base path of the WAV file path.
    /// This allows WAV files to be referenced relative to a different directory.
    pub wav_path_root: Option<PathBuf>,
    /// Divide property. `#DIVIDEPROP`
    pub divide_prop: Option<String>,
    /// Whether the score is the octave mode.
    /// In octave mode, the chart may have different note arrangements or gameplay mechanics.
    pub is_octave: bool,
}