We are releasing the very first version of our technical documentation to prepare the community for the upcoming launch of the Public API of NextColony.
The documentation is Open Source and contributions are very welcome.
- Documentation Portal: https://jarunik.github.io/nc-docs/
We currently cover the following topics to give you insight into the technical side of the game:
JSON
Definition of the Custom JSON operations to trigger game actions through the steem blockchain. This allows you to play the game by directly interacting with the blockchain or write your own tool to trigger game actions. If you want to try it out you can manuall create game action with the help of https://app.steemconnect.com/sign for example.
Documentation: https://jarunik.github.io/nc-docs/json/
Example:
API
Definition of the still very raw and early API to talk with our back-end server. This allows to retrieve the game state.
Warning: The public API is not live on the game server at the time for publishing this post. This means that the example will not work yet. The API will go live soon. Please be gentle with it in the beginning. It will improve with usage.
Documentation: https://jarunik.github.io/nc-docs/api/
Example:
UID
A very first insight into how we are dealing with randomness and blockchain to create unique ingame items that are reproducible.
Documentation: https://jarunik.github.io/nc-docs/uid/
Example:
Github
It is hard work to create and maintain technical documentation as it always clashes with creation of new features. We took the time none the less as we think it is helpful for the game community. There are most likely still some errors in the documentation and it can be improved a lot. We hope it is already helpful for you in the current state. Please log error as github issues or even better create a feature branch and open a pull request to improve the documentation yourself.
- Documentation: https://jarunik.github.io/nc-docs/
- Github: https://github.com//jarunik/nc-docs
Join NextColony:
https://nextcolony.io/
Cheers
Some more words that might be interesting for contributors.
Contributor Information
The documentation is written in Markdown and published with Vuepress.
You can find guides and more details here:
Writing
Writing content is very simple with standard markdown:
Example: https://raw.githubusercontent.com/Jarunik/nc-docs/master/docs/api/README.md
Configuration
The sidebar is mostly generated automatically out of the markdown files and titles.
On top of that the documentation portal can be configured with the Vuepress Configurations:
https://github.com/Jarunik/nc-docs/tree/master/docs/.vuepress
Contributions
Reporting Bugs
If you want to let us know about a problem please open an issue on github here:
https://github.com/Jarunik/nc-docs/issues
Writing Content
It should be relatively easy to run the documentation locally.
- Install Yarn
- Clone the Repository
- Run
yarn installin the repository - Run
yarn docs:devto start the dev environment locally - Open http://localhost:8080/ in your browser to see the documentation
- Start writing by editing the markdown files.
Please use the regular github forking workflow to contribute content:
- Create a Fork
- Create a Branch
- Do the Changes on your Branch
- Submit a Pull Request
More details about the github fork workflow: https://gist.github.com/Chaser324/ce0505fbed06b947d962
I will review and merge pull requests on a regular basis.
You can also contact jarunik on our nextcolony discord server:
https://discord.gg/A8tH9Vv
Thanks for your help