Site Tools


dev:usage

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
dev:usage [2024/06/24 21:30] – created wylemdev:usage [2024/10/24 22:22] (current) – [Command Line Interface] wylem
Line 7: Line 7:
 ^ Flag ^ Alternative ^ Description ^ ^ Flag ^ Alternative ^ Description ^
 | ''-h'' | ''%%--%%help'' | Shows help message, then exits ^ | ''-h'' | ''%%--%%help'' | Shows help message, then exits ^
-| ''-d'' | ''%%--%%debug''Removes some obfuscation features ^+| ''-d'' | ''%%--%%debug''Starts with a full party and max HP; includes various other debug features((See: ''scripts/debug_init.f4c'' and ''scripts/sandbox.f4c'')) and removes some obfuscation features ^
 | ''-q''| ''%%--%%quickstart'' | Skips the opening sequence ^ | ''-q''| ''%%--%%quickstart'' | Skips the opening sequence ^
 | ''-s SEED'' | ''%%--%%seed SEED'' | Specify a seed string((NOTE: Unlike with the web server generator, there are no explicit limits for this string)) - will default to a random string of numbers ^ | ''-s SEED'' | ''%%--%%seed SEED'' | Specify a seed string((NOTE: Unlike with the web server generator, there are no explicit limits for this string)) - will default to a random string of numbers ^
 | ''-f FLAGS'' | ''%%--%%flags FLAGS'' | Specify a flag string, either in human-readable format or as a binary flagstring((NOTE: Binary flagstrings are version-specific. Any difference in flag specifications will cause them to decode incorrectly)) ^ | ''-f FLAGS'' | ''%%--%%flags FLAGS'' | Specify a flag string, either in human-readable format or as a binary flagstring((NOTE: Binary flagstrings are version-specific. Any difference in flag specifications will cause them to decode incorrectly)) ^
-| ''-t TEST'' | ''%%--%%test TEST'' | Specify metaconfiguration settings ^+| ''-t TEST'' | ''%%--%%test TEST'' | Specify metaconfiguration settings (see below) ^
 | ''-o OUTPUT'' | ''%%--%%output OUTPUT'' | Designate an output ROM filename ^ | ''-o OUTPUT'' | ''%%--%%output OUTPUT'' | Designate an output ROM filename ^
 | ''-m'' | ''%%--%%metrics'' | Tracks and outputs performance metrics ^ | ''-m'' | ''%%--%%metrics'' | Tracks and outputs performance metrics ^
-| ''-r'' | ''%%--%%recompile'' | Forces recompilation of all .f4c files ^+| ''-r'' | ''%%--%%recompile'' | Forces recompilation of all .f4c files((To save build time, individual blocks - msfpatches/events/etc. - are cached. If you change any consts, you may need to force recompilation by using this option)) ^
 | ''-l'' | ''%%--%%lastseed'' | Reuses the last seed (stored in ''.lastseed'' in the project root directory)((NOTE: Specifying a seed will override this)) ^ | ''-l'' | ''%%--%%lastseed'' | Reuses the last seed (stored in ''.lastseed'' in the project root directory)((NOTE: Specifying a seed will override this)) ^
 | ''-b'' | ''%%--%%beta'' | Denotes this as a beta build (adds ".b" to the version string) ^ | ''-b'' | ''%%--%%beta'' | Denotes this as a beta build (adds ".b" to the version string) ^
-| ''%%--%%hideflags'' || Hides the flags on the New Game screen ^+| ''%%--%%hideflags'' || Hides the flags on the New Game screen and in the ROM metadata ^
 | ''%%--%%spoileronly'' || Doesn't output a ROM file ^ | ''%%--%%spoileronly'' || Doesn't output a ROM file ^
  
 +==== Test Settings ====
 +These can be specified either as string containing JSON, the name of a file containing JSON, or as a semicolon-separated list of key:value pairs.
  
 +^ Key ^ Data Type ^ Description ^
 +| ''quickstart'' | Boolean | Skip the opening sequence (same effect as the ''-q'' flag) | 
 +| ''open'' | Boolean | Make all vehicles and underground access available from the start |
 +| ''characters'' | Boolean | Make all other characters available in Mysidia (forces ''Cbye'' off) |
 +| ''items'' | Boolean | Pre-fill inventory with useful items |
 +| ''gp'' | Boolean | Start with max GP |
 +| ''noboss'' | Boolean | Skip all boss battles |
 +| ''boss'' | Object | Bosses to override; applied after boss randomization((NOTE: This swaps the bosses' locations, so it does not result in duplicate bosses)) (forces ''Bstandard'' on). Format is ''boss_slot: boss'' pairs |
 +| ''hobs'' | String | Specify spell for Rydia to learn at Mt. Hobs (forces ''vanilla:hobs'' off) |
 ===== Web Server ===== ===== Web Server =====
  
dev/usage.1719264650.txt.gz · Last modified: 2024/06/24 21:30 by wylem