Struct bms_rs::bmson::BmsonInfo

pub struct BmsonInfo {

    pub title: String,
    pub subtitle: String,
    pub artist: String,
    pub subartists: Vec<String>,
    pub genre: String,
    pub mode_hint: String,
    pub chart_name: String,
    pub level: u32,
    pub init_bpm: FinF64,
    pub judge_rank: FinF64,
    pub total: FinF64,
    pub back_image: Option<String>,
    pub eyecatch_image: Option<String>,
    pub title_image: Option<String>,
    pub banner_image: Option<String>,
    pub preview_music: Option<String>,
    pub resolution: u32,
}

Header metadata of chart.

Fields

title: String

Self explanatory title.

subtitle: String

Self explanatory subtitle. Usually this is shown as a smaller text than title.

artist: String

Author of the chart. It may multiple names such as Alice vs Bob, Alice feat. Bob and so on. But you should respect the value because it usually have special meaning.

subartists: Vec<String>

Other authors of the chart. This is useful for indexing and searching.

Value of the array has form of key:value. The key can be music, vocal, chart, image, movie or other. If it has no key, you should treat as that key equals to other. The value may contains the spaces before and after key and value, so you should trim them.

Example

"subartists": ["music:5argon", "music:encX", "chart:flicknote", "movie:5argon", "image:5argon"]

genre: String

Self explanatory genre.

mode_hint: String

Hint for layout lanes, e.g. “beat-7k”, “popn-5k”, “generic-nkeys”. Defaults to "beat-7k".

If you want to support many lane modes of BMS, you should check this to determine the layout for lanes. Also you can check all lane information in sound_channels for strict implementation.

chart_name: String

Special chart name, e.g. “BEGINNER”, “NORMAL”, “HYPER”, “FOUR DIMENSIONS”.

level: u32

Self explanatory level number. It is usually set with subjective rating by the author.

init_bpm: FinF64

Initial BPM.

judge_rank: FinF64

Relative judge width in percentage. The variation amount may different by BMS player. Larger is easier.

total: FinF64

Relative life bar gain in percentage. The variation amount may different by BMS player. Larger is easier.

back_image: Option<String>

Background image file name. This should be displayed during the game play.

eyecatch_image: Option<String>

Eyecatch image file name. This should be displayed during the chart is loading.

title_image: Option<String>

Title image file name. This should be displayed before the game starts instead of title of the music.

banner_image: Option<String>

Banner image file name. This should be displayed in music select or result scene. The aspect ratio of image is usually 15:4.

preview_music: Option<String>

Preview music file name. This should be played when this chart is selected in a music select scene.

resolution: u32

Numbers of pulse per quarter note in 4/4 measure. You must check this because it affects the actual seconds of PulseNumber.

Trait Implementations

impl Clone for BmsonInfo

fn clone(&self) -> BmsonInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BmsonInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BmsonInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<BmsonInfo> for BmsonInfo

fn eq(&self, other: &BmsonInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BmsonInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BmsonInfo

impl StructuralEq for BmsonInfo

impl StructuralPartialEq for BmsonInfo