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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
WonderlandEditor [--magnum-...] [-h|--help]
  [--project PROJECT] [--windowless]
  [-p|--package] [-b|--benchmark]
  [-o|--output OUTPUT] [-s|--server] [-w|--watch]
  [--accept-eula] [--credentials CREDENTIALS]
  [--preferences PREFERENCES] [--import IMPORT]

Arguments:
  -h, --help                 display this help message and exit
  --project PROJECT          Project to load at startup
  --windowless               Use the editor without window (e.g. for automated builds)
  -p, --package              Package the project
  -b, --benchmark            Benchmark the project
  -o, --output OUTPUT        Package project to given destination
  -s, --server               Start the web server
  -w, --watch                Watch JavaScript files
  --accept-eula              Use this if you agree with the terms in the EULA
  --credentials CREDENTIALS  Credentials
  --preferences PREFERENCES  Path to a preferences.json file to override default
  --import IMPORT            Import a scene

Examples

Here are some useful commands to automate some workflows:

Package Your Project via CLI

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

Coding Without the Editor

`1`	`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:

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

On windows, use move instead of mv.