Command Line Options

Command Line Options

User Options

• --config-path="PATH" - Sets the path to the user configuration area.

• --fullscreen - Sets the game to start in fullscreen mode.

• -h, --help - Displays command line usage text.

• --host - Sets the game server host address.

• --joystick, --no-joystick - Enables/disables joystick support.

• --level "LEVEL_FILE" - Starts the game on the specified level. The "LEVEL_FILE" is a path to a file, relative to the "~/data/levels/" directory.

• --level-path="PATH" - Sets the path to the game level files.

• --music, --no-music - Enables/disables the background music.

• --native - Sets game resolution to 1px=1px, instead of the default doublesized mode where 1px=4px. Should be set after the window dimensions are set.

• --relay - Use the server as a relay in multiplayer rather than trying to initiate direct connections through hole-punching.

• --resizable, --no-resizable - Allows/disallows to resize the game window.

• --scale - turns on a special pixel-art interpolation algorithm (custom, loosely based on 2xSaI) to upscale the game to 2x the size, rather than using the blocky nearest-neighbor interpolation the game currently defaults to. Currently has some visual issues with text and transparent edges; we want to fix the algorithm to categorically solve them, rather than altering content to work around them.

• --no-send-stats - Disables sending game statistics over the network.

• --sound, --no-sound - Enables/disables the sound and music engine.

• --widescreen - Sets widescreen mode, increasing the game view area for wide screen displays.

• --width "int", --height "int" - Sets the game window to these dimensions, scales the graphics up to that size.

• --windowed - Starts in windowed mode.

• --wvga - Sets the display size to 800x480.

Diagnostic Options

• --debug, --no-debug - Enables/disables debug mode.

• --fps, --no-fps - Enables/disables framerate display.

• --potonly - Use power of two-sized textures only.

• --textures16 - Use 16 bpp textures only (default on iPhone).

• --textures32 - Use 32 bpp textures (default on PC/Mac).

Developer Options

• --benchmarks - runs all the game's benchmarks (intended to measure the speed of certain low-level functions), prints the results to the console, and then immediately exits the program. Generally only useful if you're actually hacking on the engine to optimize the speed of these.

• --benchmarks=name - runs just the named benchmark, rather than all of them.

• --compiled - Uses precalculated tile patterns, rather than calculating which individual graphics should be used for each tile on startup. Requires that you have an up-to-date set of compiled tile data, which is created by running the game with --utilities=compile_levels.

• --no-compiled - Disables precompiled tile patterns.

• --set-fps=10 - Sets the framerate to 10 frames per second. You may substitute 10 with any number.

• --show-hitboxes - Shows the collision boxes for all of the in-game objects. Useful for tweaking said collision boxes to line up right with the actual graphics.

• --simipad - Changes various options to emulate an iPad environment.

• --simiphone - Changes various options to emulate an iPhone environment.

• --tests - runs all of the unit tests, prints the results to the console, and then immediately exits the program. Unit tests are sanity checks to make sure you're not breaking something already finished in the game when you add something new.

• --notests - Normally, our unit tests are run automatically on each launch (although they don't exit the program like in the "--tests" option. This causes them not to be run at all.

• --utility=xx - Allows you to run any chunk of code defined in an instance of "UTILITY(xx) { ...bunch of code... }" in the existing C++ code.

• --level-path="path" - Sets the folder to look for levels in. Useful for mod writers.

Developer Utilities

Sorry, haven't had time to document what these do.

• --utility=document_object_functions

• --utility=object_definition

• --utility=correct_solidity

• --utility=compile_levels - Precompiles all of our autotiling data into the "~/data/compiled/" directory.

• --utility=hole_punch_test

• --utility=generate_scaling_code

• --utility=object_compiler

• --utility=object_editor

• --utility=render_level

Note on

When we refer to: "~/", we mean the root level of your frogatto folder. On windows, or unix-built-from-source, this is the same folder the executable is in. On a mac, this is inside the double-clickable Frogatto application, and can be accessed by right clicking on the application, and selecting the menu option "Show Package Contents". This shows a secret folder of what's inside the program, and the "~/" folder is the one inside "Contents" called "Resources".