diff --git a/README.md b/README.md index 3b37be5..d999ce9 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,64 @@ decimal separator is not the dot (`.`). Speed up game reboots by caching game data. Cache data is stored in `data_cache.bin` and can be safely deleted if issues arise. +### LooseDBTables +Load game tables from `.json` files in `Sinmai_Data/StreamingAssets/DB`. +Useful for string edits (e.g. translation). + +Tables are automatically generated if the `DB` folder does not +exist. + +### MoreChartFormats +Load charts written in various formats: +- [simai](https://w.atwiki.jp/simai) +- srt/szt/sct/sdt (maimai classic chart format) + +To use, edit Music.xml to point the chart file path to your chart +file: + +```xml + + + {filename}.sdt + + + +``` + +The chart loader depends on the file extension: +- simai chart files must end with .simai +- srt chart files must end with .srt +- szt/sct/sdt files can use .szt/.sct/.sdt interchangeably. + +
+ Simai caveats + +- **`maidata.txt` is not supported. If you have one, paste the + content of each`inote_x` into their own `.simai` file.** +- Both `?` and `!` will create a slide without a star note, but + both of them will make the slide fade in (`!` makes the slide + suddenly appear in standard simai). +- `$` cannot be used to create a tapless slide (maiPad PLUS + syntax). +- `$$` is ignored, as star notes only spin when there's an + associated slide. +- `[BPM#a:b]` is not supported for specifying hold time. +- `` ` `` (fake EACH) makes taps 1/384 measures apart. +
+ +
+ SXT caveats + +- Encrypted chart files (`.srb`/`.szb`/`.scb`/`.sdb`) are not + supported. Decrypt them before loading into the game. +- Since this chart format does not contain timing data, the + song's BPM is retrieved by loading the `Music.xml` associated + with the chart, **and it is assumed that the chart and + `Music.xml` is in the same folder**. The SXT loader will not + work if the chart file is somehow in a different folder + from `Music.xml`. +
+ ### Singleplayer Show only the left monitor at the center of the screen.