General Info
Guides & Resources
Info For Beginners
Glossary
Game Mechanics
Guides & Information
Useful Tools
Guides & Resources (old)
User Tools
Sidebar
dev:usage
Table of Contents
Using the Generator
Command Line Interface
python -m FreeEnt /path/to/rom make <arguments>
| Flag | Alternative | Description |
|---|---|---|
-h | --help | Shows help message, then exits |
-d | --debug | Starts with a full party and max HP; includes various other debug features1) and removes some obfuscation features |
-q | --quickstart | Skips the opening sequence |
-s SEED | --seed SEED | Specify a seed string2) - 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 flagstring3) |
-t TEST | --test TEST | Specify metaconfiguration settings (see below) |
-o OUTPUT | --output OUTPUT | Designate an output ROM filename |
-m | --metrics | Tracks and outputs performance metrics |
-r | --recompile | Forces recompilation of all .f4c files |
-l | --lastseed | Reuses the last seed (stored in .lastseed in the project root directory)4) |
-b | --beta | Denotes this as a beta build (adds “.b” to the version string) |
--hideflags | Hides the flags on the New Game screen and in the ROM metadata | |
--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 randomization5) (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
python -m FreeEnt /path/to/rom server <arguments>
| Flag | Alternative | Description |
|---|---|---|
-h | --help | Shows help message, then exits |
--local | Runs server on 127.0.0.1; enables console logging |
|
--password PASSWORD | Sets an admin password | |
--beta | Uses the beta site URL | |
--port PORT | Specify a port to use (default: 8080) | |
Tools
Coming Soon(TM)
1)
See:
scripts/debug_init.f4c and scripts/sandbox.f4c2)
NOTE: Unlike with the web server generator, there are no explicit limits for this string
3)
NOTE: Binary flagstrings are version-specific. Any difference in flag specifications will cause them to decode incorrectly
4)
NOTE: Specifying a seed will override this
5)
NOTE: This swaps the bosses' locations, so it does not result in duplicate bosses
dev/usage.txt · Last modified: 2024/06/26 17:35 by wylem
