https://github.com/allejo/bzflagpluginstarter3

A React website to generate the skeleton for a BZFlag 2.4 compatible plug-in
https://github.com/allejo/bzflagpluginstarter3

bzflag bzflag-plugin code-generation reactjs typescript

Last synced: about 1 month ago
JSON representation

A React website to generate the skeleton for a BZFlag 2.4 compatible plug-in

• Host: GitHub
• URL: https://github.com/allejo/bzflagpluginstarter3
• Owner: allejo
• License: mit
• Created: 2018-12-24T06:17:33.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-16T03:54:38.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T06:16:36.918Z (7 months ago)
• Topics: bzflag, bzflag-plugin, code-generation, reactjs, typescript
• Language: TypeScript
• Homepage: https://bzflag-plugin-starter.allejo.org/
• Size: 1.42 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# BZFlag Plug-in Starter 3

A UI wrapper around [bzfPluginGen](https://github.com/allejo/bzfPluginGen) built with React to generate the skeleton of a BZFlag 2.4 compatible plug-in. This is the successor to [version 2](https://github.com/allejo/bzflagPluginStarter2) of this project, which was written as a monolithic Vue.js project.

This website will allow you to generate the skeleton of a plug-in that supports the following:

- Custom BZDB settings

- Custom callbacks

- Custom flags

- Custom map objects

- Custom poll types

- Custom slash commands

- Event registration

## Building

This project pulls from the [official bzflag.org documentation](https://github.com/BZFlag-Dev/bzflag.org) and generates JSON files used by this website to generate documentation in the plug-in skeleton.

This data is necessary in order to build the website.

### Fetching Data

To fetch the appropriate data, run the following command.

```bash

npm run data

```

### Development/Development

There are scripts for local development and production builds.

```bash

# Local development

npm run start

# Production build

npm run build

```

## Reporting Issues

This project is very modular and uses information from other repositories. Unless there is a bug in the website's behavior, keep the following in mind:

- If there is an error in the generated documentation, send a PR to the [`bzflag.org`](https://github.com/BZFlag-Dev/bzflag.org) repository

- If there is an error in the C++ generation, create an issue in the [`bzfPluginGen`](https://github.com/allejo/bzfPluginGen) repository

## License

[MIT](./LICENSE.md)