Command Line Interface
Pixel Composer supports a number of command line arguments which allow the program to be run headlessly (running without user interface).
However, due to the nature of the software, it cannot output stdout. Which means you can't see any output text when running it. To improve user experience, a CLI wrapper is provided as an external .exe that has to be downloaded separately.
Running .pxc Project
Command line operation is used to runs Pixel Composer project with custom values. Which means first you need to have Pixel Composer project with export nodes ready. Then you can use this script to runs the project:
./[pixelcomposer.exe] [path to project] [tags] [global variables]Tags
-c, --crashed Crash mode unused
Run Pixel Composer normally but with crash dialog. (Only used by the software itself, no reason to call it manually).
-h, --headless Runs in headless mode
Run Pixel Composer without the user interface. Without this tag Pixel Composer will runs as GUI normally.
-t, --trusted Trust project
Allow all shell execute nodes to run. By default all shell execute nodes are disabled when running in headless mode
-sl, --skiplua Skip lua initialization
Skip lua initialization on startup which should improve running speed marginally.
Global Variables
-name value
After tags, you can provides value to global variables. Use quotation marks to surround text with space inside.
CLI Wrapper
The CLI wrapper comes with text-based user interface and extra tags which allows for persist mode.
-v, --verbose Verbose mode
Display output text indicating status and errors.
-p, --persist Persist mode
Run Pixel Composer in persist mode. Used with headless mode to keep the program open after running the command.
-s, --server [port] Runs as server
Run Pixel Composer as a server at the given port value.
Persist Mode
Adding the persist tag -p will runs Pixel Composer in persist mode. The project will run once and an interactive shell will appear. You can send console commands through this shell.