Heads up! This project has been superseded by version 3, available here.
A Vue.js powered website used to generate the skeleton of a BZFlag 2.4 compatible plug-in. The roadmap and currently supported features for this website are as follows:
- API Events
- Custom Poll Types
- Generic Callbacks
- Custom Map Objects
- Slash Commands
- URL Jobs
The website is built with Webpack and has npm scripts to build the site for a development environment or for production.
npm install
npm run fetch-events
# for a production build
npm run build
# for development
npm run devWhen running the website in a development environment, the website will be available at localhost:8080. When building the website for production, deploy everything in the app/ folder.
This project makes use of a few separate parts so here's a brief explanation of each.
All BZFlag API events are generated automatically from BZFlag's official documentation repository. The event documentation is not committed directly to this repository and instead is just fetched from the official docs during the deployment process; any changes to the documentation need be made in the official documentation and will be automatically updated on this website the next deployment.
npm run fetch-eventsThe license headers available to be picked are stored in the src/licenses directory. The given structure of the licenses is straightforward; if you'd like to submit a new license, please note that only open source licenses will be accepted.