mai2: update documentation
This commit is contained in:
parent
e3b1addce6
commit
dcff8adbab
@ -105,28 +105,48 @@ Config file is located in `config/cxb.yaml`.
|
|||||||
|
|
||||||
### SDEZ
|
### SDEZ
|
||||||
|
|
||||||
| Version ID | Version Name |
|
| Game Code | Version ID | Version Name |
|
||||||
|------------|-------------------------|
|
|-----------|------------|-------------------------|
|
||||||
| 0 | maimai DX |
|
| SDEZ | 0 | maimai DX |
|
||||||
| 1 | maimai DX PLUS |
|
| SDEZ | 1 | maimai DX PLUS |
|
||||||
| 2 | maimai DX Splash |
|
| SDEZ | 2 | maimai DX Splash |
|
||||||
| 3 | maimai DX Splash PLUS |
|
| SDEZ | 3 | maimai DX Splash PLUS |
|
||||||
| 4 | maimai DX Universe |
|
| SDEZ | 4 | maimai DX Universe |
|
||||||
| 5 | maimai DX Universe PLUS |
|
| SDEZ | 5 | maimai DX Universe PLUS |
|
||||||
| 6 | maimai DX Festival |
|
| SDEZ | 6 | maimai DX Festival |
|
||||||
|
|
||||||
|
For versions pre-dx
|
||||||
|
| Game Code | Version ID | Version Name |
|
||||||
|
|-----------|------------|----------------------|
|
||||||
|
| SBXL | 1000 | maimai |
|
||||||
|
| SBXL | 1001 | maimai PLUS |
|
||||||
|
| SBZF | 1002 | maimai GreeN |
|
||||||
|
| SBZF | 1003 | maimai GreeN PLUS |
|
||||||
|
| SDBM | 1004 | maimai ORANGE |
|
||||||
|
| SDBM | 1005 | maimai ORANGE PLUS |
|
||||||
|
| SDCQ | 1006 | maimai PiNK |
|
||||||
|
| SDCQ | 1007 | maimai PiNK PLUS |
|
||||||
|
| SDDK | 1008 | maimai MURASAKI |
|
||||||
|
| SDDK | 1009 | maimai MURASAKI PLUS |
|
||||||
|
| SDDZ | 1010 | maimai MILK |
|
||||||
|
| SDDZ | 1011 | maimai MILK PLUS |
|
||||||
|
| SDEY | 1012 | maimai FiNALE |
|
||||||
|
|
||||||
### Importer
|
### Importer
|
||||||
|
|
||||||
In order to use the importer locate your game installation folder and execute:
|
In order to use the importer locate your game installation folder and execute:
|
||||||
|
DX:
|
||||||
```shell
|
```shell
|
||||||
python read.py --series SDEZ --version <version ID> --binfolder /path/to/game/folder --optfolder /path/to/game/option/folder
|
python read.py --series <Game Code> --version <Version ID> --binfolder /path/to/StreamingAssets --optfolder /path/to/game/option/folder
|
||||||
|
```
|
||||||
|
Pre-DX:
|
||||||
|
```shell
|
||||||
|
python read.py --series <Game Code> --version <Version ID> --binfolder /path/to/data --optfolder /path/to/patch/data
|
||||||
```
|
```
|
||||||
|
|
||||||
The importer for maimai DX will import Events, Music and Tickets.
|
The importer for maimai DX will import Events, Music and Tickets.
|
||||||
|
The importer for maimai Pre-DX will import Events and Music. Not all games will have patch data.
|
||||||
|
|
||||||
**NOTE: It is required to use the importer because the game will
|
**NOTE: It is required to use the importer because some games will not function properly or even crash without Events!**
|
||||||
crash without Events!**
|
|
||||||
|
|
||||||
### Database upgrade
|
### Database upgrade
|
||||||
|
|
||||||
@ -135,6 +155,7 @@ Always make sure your database (tables) are up-to-date, to do so go to the `core
|
|||||||
```shell
|
```shell
|
||||||
python dbutils.py --game SDEZ upgrade
|
python dbutils.py --game SDEZ upgrade
|
||||||
```
|
```
|
||||||
|
Pre-Dx uses the same database as DX, so only upgrade using the SDEZ game code!
|
||||||
|
|
||||||
## Hatsune Miku Project Diva
|
## Hatsune Miku Project Diva
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user