diff --git a/pms2bemani/README.md b/pms2bemani/README.md index 5b4b9f8..292038d 100644 --- a/pms2bemani/README.md +++ b/pms2bemani/README.md @@ -5,12 +5,14 @@ ## Usage ``` -usage: pms2bemani.py [-h] [--input-bp INPUT_BP] [--input-ep INPUT_EP] - [--input-np INPUT_NP] [--input-hp INPUT_HP] - [--input-op INPUT_OP] --name NAME --keysounds-folder - KEYSOUNDS_FOLDER [--preview PREVIEW] [--new] [--ifs] - [--preview-offset PREVIEW_OFFSET] - [--preview-duration PREVIEW_DURATION] +warning: no background specified, will only work with usaneko and up +usage: pms2bemani.py [-h] [--input-bp INPUT_BP] [--input-ep INPUT_EP] [--input-np INPUT_NP] [--input-hp INPUT_HP] [--input-op INPUT_OP] [--output OUTPUT] --name NAME + --musicid MUSICID --keysounds-folder KEYSOUNDS_FOLDER [--preview PREVIEW] [--new] --banner BANNER [--bg BG] [--hariai HARIAI] + [--metadata-fw-title METADATA_FW_TITLE] [--metadata-fw-artist METADATA_FW_ARTIST] [--metadata-fw-genre METADATA_FW_GENRE] + [--metadata-title METADATA_TITLE] [--metadata-artist METADATA_ARTIST] [--metadata-genre METADATA_GENRE] [--metadata-chara1 METADATA_CHARA1] + [--metadata-chara2 METADATA_CHARA2] [--metadata-has-battle-hyper] [--metadata-hariai-is-jacket] [--metadata-folder METADATA_FOLDER] + [--metadata-categories METADATA_CATEGORIES] [--metadata-cs-version METADATA_CS_VERSION] [--metadata-mask METADATA_MASK] + [--metadata-chara-x METADATA_CHARA_X] [--metadata-chara-y METADATA_CHARA_Y] [--preview-offset PREVIEW_OFFSET] [--preview-duration PREVIEW_DURATION] optional arguments: -h, --help show this help message and exit @@ -19,19 +21,54 @@ optional arguments: --input-np INPUT_NP Input file (NP) --input-hp INPUT_HP Input file (HP) --input-op INPUT_OP Input file (OP) - --name NAME Base name used for output - --keysounds-folder KEYSOUNDS_FOLDER - Input folder containing keysounds - --preview PREVIEW Input preview file (optional, overrides preview - generation code) + --output OUTPUT Output folder + --preview PREVIEW Input preview file (optional, overrides preview generation code) --new New chart format which supports hold notes - --ifs Create IFS output instead of folder output (requires - ifstools) + --bg BG Background image (optional, must be 128x256) + --hariai HARIAI Hariai image (optional, must be 250x322 or 382x502) + --metadata-fw-title METADATA_FW_TITLE + Fullwidth music title for database + --metadata-fw-artist METADATA_FW_ARTIST + Fullwidth music artist for database + --metadata-fw-genre METADATA_FW_GENRE + Fullwidth music genre for database + --metadata-title METADATA_TITLE + Music title for database + --metadata-artist METADATA_ARTIST + Music artist for database + --metadata-genre METADATA_GENRE + Music genre for database + --metadata-chara1 METADATA_CHARA1 + Chara1 for database + --metadata-chara2 METADATA_CHARA2 + Chara2 for database + --metadata-has-battle-hyper + Battle Hyper flag for database + --metadata-hariai-is-jacket + Jacket mask flag for database + --metadata-folder METADATA_FOLDER + Folder entry for database + --metadata-categories METADATA_CATEGORIES + Categories entry for database + --metadata-cs-version METADATA_CS_VERSION + CS version entry for database + --metadata-mask METADATA_MASK + Base mask value for database + --metadata-chara-x METADATA_CHARA_X + Chara X entry for database + --metadata-chara-y METADATA_CHARA_Y + Chara Y entry for database --preview-offset PREVIEW_OFFSET - Offset from start in seconds (ex. 10.4 would be 10.4 - seconds) + Offset from start in seconds (ex. 10.4 would be 10.4 seconds) --preview-duration PREVIEW_DURATION Length of preview in seconds + +required arguments: + --name NAME Base name used for output + --musicid MUSICID Music ID used for the database file + --keysounds-folder KEYSOUNDS_FOLDER + Input folder containing keysounds + --banner BANNER Banner image (must be 244x58) ``` - Use `--new` to specify the new chart format (Usaneko and later) which supports hold notes. diff --git a/pms2bemani/pms2bemani/pms2bemani.py b/pms2bemani/pms2bemani/pms2bemani.py index 569bb43..6669644 100644 --- a/pms2bemani/pms2bemani/pms2bemani.py +++ b/pms2bemani/pms2bemani/pms2bemani.py @@ -753,14 +753,17 @@ if __name__ == "__main__": for difficulty in difficulties: parser.add_argument('--input-%s' % difficulty, help='Input file (%s)' % difficulty.upper(), default=None) + #Display required arguments on help + requiredNamed = parser.add_argument_group('required arguments') + #Arguments parser.add_argument('--output', help='Output folder', default="output") - parser.add_argument('--name', help='Base name used for output', default=None, required=True) - parser.add_argument('--musicid', help='Music ID used for the database file', required=True, type=int) - parser.add_argument('--keysounds-folder', help='Input folder containing keysounds', default=None, required=True) + requiredNamed.add_argument('--name', help='Base name used for output', default=None, required=True) + requiredNamed.add_argument('--musicid', help='Music ID used for the database file', required=True, type=int) + requiredNamed.add_argument('--keysounds-folder', help='Input folder containing keysounds', default=None, required=True) parser.add_argument('--preview', help='Input preview file (optional, overrides preview generation code)', default=None) parser.add_argument('--new', help='New chart format which supports hold notes', default=False, action='store_true') - parser.add_argument('--banner', help='Banner image (optional, must be 244x58)', default=None, required=True) - parser.add_argument('--bg', help='Background image (optional, must be 128x256)', default=None, required=True) + requiredNamed.add_argument('--banner', help='Banner image (must be 244x58)', default=None, required=True) + parser.add_argument('--bg', help='Background image (optional, must be 128x256)', default=None, required=False) parser.add_argument('--hariai', help='Hariai image (optional, must be 250x322 or 382x502)', default=None) parser.add_argument('--metadata-fw-title', help='Fullwidth music title for database', default=None) parser.add_argument('--metadata-fw-artist', help='Fullwidth music artist for database', default=None) @@ -778,7 +781,8 @@ if __name__ == "__main__": parser.add_argument('--metadata-mask', help='Base mask value for database', default=0, type=int) parser.add_argument('--metadata-chara-x', help='Chara X entry for database', default=0, type=int) parser.add_argument('--metadata-chara-y', help='Chara Y entry for database', default=0, type=int) - + + print("warning: no background specified, will only work with usaneko and up") if os.path.exists("bmx2wavc.exe"): parser.add_argument('--preview-offset', help='Offset from start in seconds (ex. 10.4 would be 10.4 seconds)', default=-1, type=float) parser.add_argument('--preview-duration', help='Length of preview in seconds', default=10, type=float)