WonderlandEditor CLI

To allow packaging project on Continuous Integration and to allow developers a even more efficient workflow, the Wonderland Editor provides a Command Line Interface (CLI).

WonderlandEditor

The main WonderlandEditor executable contains UI as well as CLI functionality. It is located in the bin/ folder of your installation.

CLI Arguments

WonderlandEditor [--magnum-...] [-h|--help] [--project PROJECT] [--version] [--windowless] [-p|--package] [--create] [-b|--benchmark BENCHMARK] [--client-platform CLIENT_PLATFORM] [--browser BROWSER] [-o|--output OUTPUT] [-s|--server] [-w|--watch] [--accept-eula] [--credentials CREDENTIALS] [--preferences PREFERENCES] [--import IMPORT] [--config CONFIG] [--enable-plugins] [--inspect-brk]

Arguments:
  -h, --help                  display this help message and exit
  --project PROJECT           Project to load at startup
  --version                   Print version information and terminate
  --windowless                Use the editor without window (e.g. for automated builds)
  -p, --package               Package the project
  --create                    Create a new project if it does not exist.
  -b, --benchmark BENCHMARK   Run benchmark with given config file
  --client-platform CLIENT_PLATFORM  The target client platform to run the app on
                              (default: desktop)
  --browser BROWSER           The target browser to run the app on
                              (default: default)
  -o, --output OUTPUT         Package project to given destination
  -s, --server                Start the web server
  -w, --watch                 Watch JavaScript files
  --accept-eula               Automatically accept the EULA. By using this you agree with the terms in the EULA
  --credentials CREDENTIALS   Credentials
                              (environment: WLE_CREDENTIALS)
  --preferences PREFERENCES   Path to a preferences.json file to override default
  --import IMPORT             Import a scene
  --config CONFIG             Path to the packaging configuration file
  --enable-plugins            Enable plugin execution.
  --inspect-brk               Launch with node inspector and wait for it to attach

Examples

Here are some useful commands to automate some workflows:

Package Your Project via CLI

WonderlandEditor --windowless --project MyProject.wlp --package

Coding Without the Editor

WonderlandEditor --windowless --project MyProject.wlp --server --watch

Convert a Scene To Streamable .bin

To convert a scene file (e.g. a GLTF file) into a streamable .bin file, create an empty project Streamable.wlp and enable Views > Project Settings > packageForStreaming.

Now you can use the following command to convert a GLTF file:

WonderlandEditor --windowless --project Streamable.wlp --package --import my-scene.glb
mv deploy/Streamable.bin my-scene.bin

On windows, use move instead of mv.