Skip to content

AgreeableDeerGames/GameBackbone

Repository files navigation

GameBackbone

GameBackbone (GB) is a small, low-level library meant to accelerate the production of 2D video games. GB provides little to no gameplay logic and is simply meant to help remove long overhead times when starting a new 2D game. This narrow scope allows users of GB to maintain total control over their codebase.

A good understanding of C++ is required to make use of GB. Game developers who want to quickly make a game without a background in software development should look into other solutions.


Tests

Install Guide

Follow the install guide.

User Guide

Follow the user guide to learn the core concepts for GB.

Documentation

We use Doxygen to document our code. The documentation for the master branch can be found here. If you require the documentation for a non-master branch, it can be built by running Doxygen on the Doxyfile at the root level of the project.

Versioning

We follow Semantic Versioning Major.Minor.Patch

  • Major
    • Increments in Major version indicate backwards incompatible API changes
  • Minor
    • indicates one or more backwards compatible functionality additions to the API
  • Patch
    • Indicates one or more backwards compatible bug fixes

All versions before 1.0.0 are unstable and have no guarantee for backwards compatibility

License

See the license here

Submitting Issues

  1. Create an issue here
  2. Assign Ryan Lavin
  3. Give a brief description of what is wrong and the steps to reproduce the error
  4. Assign one or more tags to the issue that you think best summarizes it
  5. Do not assign a project or milestone

Submitting Code/Fixes

  1. Check our developer guide
  2. Make sure your code compiles with no warnings (this includes CppCheck warnings)
  3. Make sure your code passes all unit tests
  4. Make sure no memory leaks are detected in any of the unit tests
  5. Create Pull Request
  6. Assign Ryan Lavin as reviewer