# Manual for `CompileDatabase` command

### Compile whole ma2 database to simai

## Basic usage

    MaichartConverter CompileDatabase --params

## Example usage

    MaichartConverter CompileDatabase -p "/Users/Neskol/MaiAnalysis/A000/" -c "/Users/Neskol/MaiAnalysis/Image/Texture2D/" -v "/Users/Neskol/MaiAnalysis/DXBGA_HEVC/" -m "/Users/Neskol/MaiAnalysis/Sound/" -o "/Users/Neskol/MaiAnalysis/Output_HEVC_By_Cab/" -g 2 -d

## Available Params

### Required Params:

> Unless otherwise specified, `XXXXXX` here stands for musicID.

- `-p | --path <path>`: Path to `A000` Folder. Expects file structure of `A000/music/musicXXXXXX/Music.xml`
- `-o | --output <path>`: Path to output folder. Program will try to write to this path and create new folder when
  necessary so make sure you have write permission of the given folder.

### Optional Params:

- `-m | --music <path>`: Path to MP3 files. Expected naming scheme is `musicXXXXXX.mp3`.
- `-c | --cover <path>`: Path to track pictures. Expected naming scheme is `UI_Jacket_XXXXXX.png`.
- `-v | --video <path>`: Path to background videos. Expected naming scheme is `XXXXXX.mp4`
- `-g | --genre <number 0-6> `: Preferred categorizing scheme.
  `0 = Genre, 1 = Level, 2 = Cabinet, 3 = Composer, 4 = BPM, 5 - SD/DX Chart, 6 = No subfolders`
- `-d | --decimal`: Option to force levels to be displayed in decimals (e.g. `14+ => 14.7`).
- `-i | --ignore`: Ignore incomplete assets and proceed converting. Folder will be marked as `_incomplete` if any asset
  is missing. Missing Assets will be listed in `log.txt`.
- `-n | --number`: Use `musicID` as folder name instead of sort name.
- `-j | --json`: Create a log file of compiled tracks in JSON (`index.json`).
- `-z | --zip`: Zip each track folder and delete original folder.
- `-k | --collection`: Generates `manifest.json` for in game grouping. Will generate `collections` folder in output
  folder.

### Depreciated/Under development params:

> These parameters are not tested. Feel free to test and report issues!

- `-f | --format <string>`: Forces program to compile carts in given format (within composed `maidata`.txt). Available
  format: `Simai, SimaiFes, Ma2, Ma2_104`.
- `-r | --rotate <string>`: Forces program to rotate all charts in given method. Available
  rotations: `Clockwise90, Clockwise180, CounterClockwise90, CounterClockwise180, UpsideDown, LeftToRight`.
- `-s | --shift <int>`: Shifts notes in all charts front or back by given ticks.