Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/endel/c3addon
Construct 3 Addon Authoring Commandline Utilities
https://github.com/endel/c3addon
construct3 construct3-addon
Last synced: 18 days ago
JSON representation
Construct 3 Addon Authoring Commandline Utilities
- Host: GitHub
- URL: https://github.com/endel/c3addon
- Owner: endel
- License: mit
- Created: 2018-03-28T18:12:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-16T18:28:25.000Z (over 1 year ago)
- Last Synced: 2024-10-13T08:21:22.215Z (about 1 month ago)
- Topics: construct3, construct3-addon
- Language: TypeScript
- Homepage: https://www.scirra.com/forum/addon-authoring-commandline-tool_t202291
- Size: 46.9 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Construct 3 Addon Authoring Commandline Utilities (`c3addon`)
This tool helps you to build and distribute your Construct 3 Addons.
> C3 Addon SDK Documentation: https://www.construct.net/br/make-games/manuals/addon-sdk
See [TODO](#todo) for ideas for this tool. Feel free to open issues to propose new ideas.
## Requirements
Node.js v8.0.0+
## Installation
```
npm install -g c3addon
```
## Commands
### `c3addon init`
Bootstrap an empty addon project.
### `c3addon serve`
Start an http server to test your addon on [Construct 3 Editor](https://editor.construct.net/).
### `c3addon pack`
Pack your addon into a `name.c3addon` file, ready to be uploaded to the addon
server.
### `c3addon docs`
Generate documentation based on your addon's `aces.json` + language files.
## TODO
- A `watch` command to watch and validate for ACEs and their language attributes. It's very annoying to refresh the editor and see error messages regarding missing language entries.
- Implement the `docs` command - to generate a user-friendly list of actions, conditions and expressions.
- On `init` command, use [inquirer](https://github.com/SBoudrias/Inquirer.js/) and ask the user for addon name, description, and all its basic properties.
## License
MIT