Some documentation for Boomlings's servers, and the game itself.
Boomlings Docs is a project built to openly give advanced information and readable information for aspiring developers looking to interface with Boomlings. Primarily, we aim to create this as a website for people to learn more about the inner workings of boomlings, along with it's data.
You will require Node.js >=12 to debug and run this project.
Boomlings Docs is built off of the docsify engine, outputted to a generator file to be able to work well on server environments, rather than GitHub pages. This is primarily to allow for easy domain usage and development in a place where it can always update, and be hosted upon locally rather than over GitHub's servers.
As such, rather than having to install using the package.json; (which we would recommended doing anyways using npm install,) the installation and such has been included in generator.js.
node generator.js
To debug it, you will need to properly clone or pull this repository.
Contributions are preferably made to the documentation, rather than the simple generator.js file; unless need be. Contributions to all aspects of this project are preferred to be made over pull requests and issues. Ideas on what to contribute or read over can be read in the issues section of this repository.