Skip to content
A set of commands to manage Construct 3 addon development
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
src
test-generator
test
.editorconfig
.gitignore
LICENSE.md
README.md
package-lock.json
package.json

README.md

Construct 3 Addon CLI

A set of commands to manage Construct 3 addon development

oclif Version Downloads/week License

Usage

You can use this addon as an npx script too. e.g. npx c3-addon-cli addAction myShinyAction

$ npm install -g c3-addon-cli
$ c3-addon-cli COMMAND
running command...
$ c3-addon-cli (-v|--version|version)
c3-addon-cli/1.2.0 win32-x64 node-v10.15.0
$ c3-addon-cli --help [COMMAND]
USAGE
  $ c3-addon-cli COMMAND
...

Commands

c3-addon-cli addAction ID

Add new action

USAGE
  $ c3-addon-cli addAction ID

ARGUMENTS
  ID  An identifier for the action. This will be the scriptName too.

OPTIONS
  -h, --isHighlighted  Is highlighted
  --dryRun             Dry run. Don't write any changes to disk

See code: src\commands\addAction.js

c3-addon-cli addCondition ID

Add new condition

USAGE
  $ c3-addon-cli addCondition ID

ARGUMENTS
  ID  An identifier for the condition. This will be the scriptName too.

OPTIONS
  -h, --isHighlighted  Is highlighted
  -i, --isInvertible   Is invertible
  -t, --isTrigger      Is trigger
  --dryRun             Dry run. Don't write any changes to disk

See code: src\commands\addCondition.js

c3-addon-cli addExpression ID

Add new expression

USAGE
  $ c3-addon-cli addExpression ID

ARGUMENTS
  ID  An identifier for the expression. This will be the scriptName too.

OPTIONS
  --dryRun  Dry run. Don't write any changes to disk

See code: src\commands\addExpression.js

c3-addon-cli help [COMMAND]

display help for c3-addon-cli

USAGE
  $ c3-addon-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

c3-addon-cli init OUTDIR

Start a new C3 plugin

USAGE
  $ c3-addon-cli init OUTDIR

ARGUMENTS
  OUTDIR  The output directory for the new C3 plugin code

See code: src\commands\init.js

Plans

  1. Provide the cli functionality for behaviors and effects too

License

MIT license. See LICENCE.md

You can’t perform that action at this time.