https://github.com/allejo/bzfplugingen

The core logic for generating a BZFlag C++ plug-in source from JSON
https://github.com/allejo/bzfplugingen

aclovis bzflag bzflag-plugin

Last synced: 5 days ago
JSON representation

The core logic for generating a BZFlag C++ plug-in source from JSON

• Host: GitHub
• URL: https://github.com/allejo/bzfplugingen
• Owner: allejo
• License: mit
• Created: 2018-12-22T23:08:28.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-08-14T23:06:25.000Z (over 2 years ago)
• Last Synced: 2024-10-12T19:47:34.656Z (about 1 month ago)
• Topics: aclovis, bzflag, bzflag-plugin
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@allejo/bzf-plugin-gen
• Size: 162 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# bzfPluginGen

[![Build Status](https://travis-ci.com/allejo/bzfPluginGen.svg?branch=master)](https://travis-ci.com/allejo/bzfPluginGen)

[![Coverage Status](https://coveralls.io/repos/github/allejo/bzfPluginGen/badge.svg?branch=master)](https://coveralls.io/github/allejo/bzfPluginGen?branch=master)

[![Latest release](https://img.shields.io/github/v/release/allejo/bzfPluginGen?include_prereleases)](https://github.com/allejo/bzfPluginGen/releases/latest)

Generating the skeleton of a BZFlag plug-in can be repetitive, mundane, tedious and synonyms. This library will be dedicated to generating a C++ plug-in skeleton given a JSON object following the [IPlugin TypeScript interface](./src/IPlugin.ts).

There is no UI or CLI tool in this repo for you to run and test. If you are looking for a web-based UI, take a look at [BZFlag Plug-in Starter v3](https://github.com/allejo/bzflagPluginStarter3).

## Usage

The library has the [`PluginBuilder`](./src/PluginBuilder.ts) and [`PluginWriter`](./src/PluginWriter.ts) classes for you to make use of.

- The `PluginBuilder` is a helper class that will help you build the `IPlugin` interface programmatically and correctly.

- The `PluginWriter` class takes an `IPlugin` object and provides a `write()` method to output the generated C++ code.

## License

[MIT](./LICENSE.md)