Bestia Developer Documentation

Explore vast lands in a procedurally generated world, fight tough monsters, or join guilds in your quest for honor. But be prepared: the world might end sooner as you would expect.

Congratulations! You just have found the Developer Documentation of Bestia. Here you find everything from game design guidelines to engine architecture overview as well as the API documentation to access game resources.

Project Repositories

You find the three project repositories on GitHub (consider to give them a star!)

Repository Relations

To build the whole software you need to understand the relationship between the repositories. The relation is somewhat complicated as there are some inter-repositories dependencies. The bestia-behemoth repository contains the server but also the ProtoBuf message definition. This definition is required to build the bestia-entity-plugin for Godot. The result of this build, the Godot engine, is required to build the bestia-client game. The server can be built only with the bestia-behemoth repository. The relation is depicted in the following diagram:

graph LR zone[bestia-behemoth] -- ProtoBuf messages --> plugin[bestia-entity-plugin] voxel[Voxel Plugin] -- required --> godot[Godot Engine] plugin -- required --> godot godot -- required --> client[bestia-client]

Getting Started

The documentation is split into three main sections:

  1. Game Design
  2. Client Documentation
  3. Server Documentation

The info found in this document should help you to get kickstarted and join the development. Depending on where you want to contribute you should read the required sections. With the provided guidelines enthusiasts should very easily be able to create contributions from artworks to scripts.

Contributing

Contributions to both the game design and the game itself (the client and the server) are very welcome!

You may find a little Edit this page link at the bottom of each page. If you want to change some game design aspects feel free to give it a try!

Inside this game design document you possibly will find certain Contributing sections which will give you some guidelines to follow in order to help to get you changes into the game quickly.

Read the Bestia Game Design section first to get a grasp for what this game is all about and align your contributions and changes under these game guidelines to maximize your chance of a fast approval of your contribution.

You can use the Edit link on the bottom right of every page to directly edit this document and create a Pull Request on Github.