collider.jam
Version:
Hand-crafted and fun to use game framework for jamming, creative coding, and rapid game development
43 lines (37 loc) • 2.15 kB
Plain Text
Usage: jam <command> [jam options] [custom options]
Following commands are available [shortcuts are in brackets]:
[r] run - start collider.jam server (default command)
[o] play, open - start the project in default web browser
[i] init <name|id> - init a package project from a sample,
run [jam init list] to list available samples
[n] new | create - create a new entity, run "new ls" to list posibilities
bootstrap <name> - bootstrap from a sample
patch <patch-name> - fix the project with a patch
[p] pack [out|dist] - assemble all resources in <out> folder, create archives in ./dist
[c] clean - remove all generated content
[ca] clean all - remove all generated content and locally installed modules
[u] units - list units
[f] files - list indexed files for each unit
[v] version - show framework version, run with -v for more details
[h] help - this message
[m] man <topic> - start in the browser and open the online help system
Available [jam options]:
-d, --debug - debug mode
-g, --global - use global modules in package mode
-t, --test [test-name] - run all the tests, or a test specified by name
-y, --types - generate types.ts meta info
--box <box-name> - select a box to run
-f, --flow - flow mode to autoload updates (automatically enabled on debug)
-m, --mute - mute mode to suppress any output
-p, --port - server port
-s, --static - static mode
-n, --pregen - run pregenerated package in static mode
-b, --hub - run the hub/boost included in the mix
-mc, --mission-control - run collider.jam mission control
--version - alternate option for version
-h, --help - alternate option for help
[custom options] can be declared and used later in hub or mod.
These options are available in environment configuration.
[jam --showStat] - sets [/env/config/showStat] to true
[jam --speed 90] - sets [/env/config/speed] to 90
[jam run] is executed by default if no command is available