Construct addon development assistant
$ npm i -g c2-addon-assistant
Usage: c2addona [options] [command]
Construct addon development assistant
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
init <addon_type> Initialize the addon workspace
update Copy working version to C2. Create/update beta *.c2addon and *.c3addon. Create/update ACE.md.
release Save current beta addons as version-marked addons and creates release zip file.
config Starts config prompt
set-version [version] Sets the version in info.xml and edittime.js
This example creates the "AwesomePlugin" plugin
- Create directory named exactly like the plugin you're working on and enter it (
c2addona
takes addon name from the parent directory)
$ mkdir AwesomePlugin
$ cd AwesomePlugin
- Now you're in the root of your plugin workspace and can create the workspace
$ c2addona init plugin
- In result of workspace initialization, you'll have the following directory structure
│ release.bat
│ set-version.bat
│ update.bat
│
├───capx
│ AwesomePlugin.capx
│
├───releases
├───source
│ ├───c2addon
│ │ │ info.xml
│ │ │
│ │ └───files
│ │ └───AwesomePlugin
│ │ common.js
│ │ edittime.js
│ │ PluginIcon.ico
│ │ runtime.js
│ │
│ └───c3addon
└───versions
source/c2addon
- the place with code you will work withsource/c3addon
- C3 addon source generated automatically byC2C3AddonConverter
tool byblackhornet
(included)capx/
- place for your example capxesversions/
- contains versionedc2addon
andc3addon
files after usingc2addona release
command (or triggeringrelease.bat
)releases/
- containsAwesomePlugin_v<version>.zip
files generated after usingc2addona release
command (or triggeringrelease.bat
)
Three new files will appear after using c2addona update
command (or triggering update.bat
):
beta-AwesomePlugin.c2addon
- current working version of c2 addonbeta-AwesomePlugin.c3addon
- current working version of c3 addonACE.md
- acetable of current working version generated with c2-addon-parser by Armaldio
Discord: https://discord.gg/ayRypRH
Facebook: https://www.facebook.com/C2C3Plugins
Under MIT license © Toby R