Documentation • Discord Server
Overview • Issues and Bugs • Contributing
This repository serves as both an issue tracker and as a reference for anyone using Wynncraft's Public API service. This repository is not for other Wynncraft related items.
Do not discuss / share any vulnerabilities or bugs that can be used to exploit the API or our platforms. Instead, please private message Colin#0670 on discord or colin350 on the forums.
If you would like to make an issue regarding the API or its documentation, please open an issue here.
If you would like to suggest a feature to the API or its documentation, please open an issue here. Please prefix the title of the issue with Request:.
The Wynncraft Team has decided to make the Official Public API Documentation a community effort, as well as put a foot forward towards developing an ecosystem that is built off of our API service. We hope in the future language specific libraries and wrappers are built around our API service, and more creative tools created by the community are to come!
To contribute to the Documentation, you will need a few things:
-
You will need the latest version of Node.js and NPM installed on your system. You can get node.js and npm together on their website.
-
You will need to globally install gitbook-cli via NPM, as the documentation platform is built on top of gitbook. To install gitbook-cli, you will run something like this:
$ npm install -g gitbook-cli. We depend on gitbook 3. If a new version is released, do not upgrade until this README is updated. -
You will need to fork this repository and clone it to your system.
-
After making your proposed changes, in the root of this repository, you should run:
$ gitbook build
$ gitbook serve-
You should test the new documentation you've generated on your local host, and make sure it is bug free and compiles without any errors!
-
When you are done, submit a pull request and I will review it!
Best of luck, and happy coding! -Colin
