-
version – The version of the level, which should start at 1. For every revision of the chart(s), you should bump the version by 1.
- Theoretically, the CytoidIO scoreboard should only show the scores from the latest level version; however, as there are too few scores now, this behavior is not yet implemented.
-
id – Unique identifier of the level; must contain a~z, 0~9, . and _ only.
- The best practice as well as the simplest is always to start with your username, then a dot, then the song name (with
_ as whitespace), i.e. john_doe.freedom_dive.
- If the song belongs to a certain type, you can insert the type at the middle, i.e.
decnoe.undertale.hopes_and_dreams.
- If the song has different versions, you can insert the version name at the end, i.e.
mekko.glorious_crown.full_ver
-
title – The title of the song in its original language, i.e. Senbonzakura ❎ 千本桜 ✅.
- Each word should be capitalized (unless the original title is stylized, e.g. aLIEz).
- Use brackets to include additional information, e.g. TV Size, Short Ver., DJ YOSHITAKA Mix, i.e. Floor of Lava Album version ❎ Floor of Lava (Album Ver.) ✅.
-
title_localized – (Optional) An English translation of the “title” field.
- Literal translation is always preferred over other types of translations (e.g. romaji) unless there is no official literal translation, e.g. Inochi ni Kirawarete iru ❎ Hated By Life Itself ✅.
- This feature will be implemented in Cytoid 1.5 (and relevant CytoidIO updates).
-
artist – The name of the artist(s) of the song in their original language, i.e. mafumafu ❎ まふまふ ✅.
- If there are multiple artists, use half-space comma (,) to separate them, i.e. まふまふ, そらる.
- If the song is a cover, use the format [composer/original artist] feat. [cover artist], i.e. 40mP feat. まふまふ.
- If the song is a Vocaloid song (or similar), use the format [composer] feat. [vocal], i.e. ハチ feat. 初音ミク.
- If the song is a remix, simply write the remixer's name.
-
artist_localized – (Optional) An English translation of the “artist” field
- If the artist does not have an official English name, use romaji, pinyin, or similar systems to translate their name.
-
artist_source – The source of the song; must be a URL.
- If the artist has uploaded the song to any site (e.g. YouTube, SoundCloud), provide the URL of that page as the source.
- Otherwise, provide the iTunes, Bandcamp or similar site's URL where the song can be purchased.
-
illustrator – The name of the artist of the cover image in their original language.
- If there are multiple artists, use half-space comma (,) to separate them.
-
illustrator_source – The source of the cover image; must be a URL.
- If the artist has uploaded the cover image to any site (e.g. pixiv, DeviantArt), provide the URL of that page as the source. If you don't know where it's coming from, just use SauceNAO or Google Reverse Image Search.
- For cover images of commercial music games, provide the URL to the game/company's official website.
-
music.path/music_preview.path/background.path/{chart}.path – Relative paths of the corresponding files.
- IMPORTANT! Make sure there are no special characters (including non-English characters and whitespaces) in your paths. They may break both the game and CytoidIO.
- Just simply use
music.mp3, preview.mp3, background.jpg, and chart.easy/hard/extreme.txt, and then rename your files to match the paths.
-
{chart}.type – Type of the chart; must be easy, hard or extreme.
-
{chart}.name – Name of the chart.
- This is basically "custom difficulty name." You can use
CHAOS here.