Command line

Examples

Compile and run the project /home/user/crown/samples/01-physics using a mapped core folder:

export CROWN=/home/user/crown
cd $CROWN/platforms/linux64/bin
./crown-development --compile --continue --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples

Compile and run for HTML5:

./crown-development --compile --continue --platform html5 --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples

Compile a “bundled” version of the project:

./crown-development --compile --bundle --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples

Run the project from bundled data:

./crown-development --data-dir $CROWN/samples/01-physics_linux

Customize the data directory name:

./crown-development --compile --data-dir $CROWN/samples/01-physics_custom --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples

Options

--

End of the runtime’s options.

All options following -- are passed to the game but will not be interpreted by the runtime.

-h --help

Display this help.

-v --version

Display engine version.

--source-dir <path>

Specify the <path> of the project’s source data.

The <path> must be absolute.

--data-dir <path>

Run with the data located at <path>.

The <path> must be absolute.

--bundle-dir <path>

Run with the bundles located at <path>.

The <path> must be absolute.

--map-source-dir <name> <path>

Mount <path>/<name> at <source-dir>/<name>.

The <path> must be absolute.

--boot-dir <prefix>

Use <prefix>/boot.config to boot the engine.

The <prefix> must be relative.

--compile

Compile the project’s source data.

When using this option you must also specify --source-dir.

--bundle

Generate bundles after the data has been compiled.

--platform <platform>

Specify the target <platform> for data compilation. Possible values for <platform> are:

  • android

  • html5

  • linux

  • windows

--continue

Run the engine after the data has been compiled.

--console-port <port>

Set port of the console server.

When no port is specified, the engine uses the port 10001.

--port-file <path>

Write selected console port to <path>. The file is written after the console server has bound a port if any.

--wait-console

Wait for a console connection before booting the engine.

--parent-window <handle>

Set the parent window <handle> of the main window.

This option should be used only by the tools.

--server

Run the engine in server mode.

When using this option you must also specify --source-dir.

--pumped

Do not advance the renderer unless explicitly requested via console.

--hidden

Make the main window initially invisible.

--keep-above

Keep the main window above other windows.

--renderer <renderer>

Set the renderer backend. Possible values for <renderer> are:

  • auto

  • d3d11

  • gl

  • gles

  • vk

--window-rect <x y w h>

Set the main window’s position and size.

--string-id <string>

Print the 32- and 64-bits IDs of <string>.

--run-unit-tests

Run unit tests and quit.