Awesome
Maintenance Notice
Rubeus Engine is not being maintained. Reach out to us at our Discord server linked above for any questions you may have.
Contents
<a name=what>What is Rubeus?
A cross-platform 2D game engine written in C++17 using OpenGL 3.3. The main objective of making this engine is to provide a simple and fast API to help people realize their game ideas efficiently.
Rubeus uses broCLI, a Go based CLI tool that helps create the project structure for using Rubeus.
Read the Getting Started guide and prefer to use the API documentation for technical reference on Rubeus code structure. <br><br>
<p align="center"> <img src=ReadmeAssets/demo_game.png width=600 align=middle alt="Screenshot from a demo game"> </p> <p align="center"> <i>The ping-pong demo game that Rubeus comes with</i> </p> <p align="center"> <img src=ReadmeAssets/10_9_8.png width=600 alt="Multiple textures"> </p> <p align="center"> <i>A custom shader that emulates a light effect over 2D sprites</i> </p>Rubeus v1.0 and v2.0 are available for use. For using Rubeus for your project, follow the Getting Started guide. We also invite you to contribute to this engine along with us. Head here to read the contributing guidelines. You can also talk to all the fellow contributors at <a href="https://chat.sdslabs.co">SDSLabs' chat hookup</a>.
<a name=why>Why is Rubeus?
Rubeus was at first an initiative by SDSLabs to inculcate the spirit of game development amongst the members of this organization. But after Rubeus achieved a slightly mature state, we realised that it would be best for the development of this project if we get inputs from game engine developers across the open source community, and build this together.
As previously said, we do not expect to have any monetary gains off making this project open-source, nor from any of the games that we might be developing on Rubeus.
Currently Rubeus supports:
- Colour and image textured 2D sprites
- Collision detection and resolution of boxes, circles and planes.
- Cueing music and sound effects with a single line of code.
- Taking user inputs through mouse and keyboard.
- Easy first look interface for a beginner
More advanced features are scheduled for the next release.
<a name=setup>How do I use Rubeus?
Rubeus is currently available for use on Windows, Linux and Mac build is getting ready.
For making a game:
Follow the Getting Started guide.
For participating in Rubeus:
Setup instructions for Rubeus are explained here. Also make sure to read the contribution guidelines. A good start would be trying to build Rubeus on your personal systems. Join our Discord server: https://discord.gg/Cva2VFQ.
<a name=how>How can I contribute?
Everyone reading this is invited to contribute to Rubeus either through opening issues on Github, making pull requests, adding Wiki pages and talking to us at our Discord server, or our chat hookup to talk to SDSLabs. Make sure to read the contribution guidelines to ease your way in.
<a name=remarks>Remarks
- Credits to the owners of helper code:
- Guerrilla Renderer, the main rendering engine, highly inspired by the Sparky Engine
- Awerere Physics collision system, the physics update engine using a homebrewed maths library i.e. Rubeus Maths Library (RML)
- Symphony Audio Engine, audio effects and cueing engine using SFML as the backend.
- Easy to use workflow, efforts are being made to release as little information to the user as possible without compromising flexibility.
- v1.0 and v2.0 are available for use.
<a name=license>License
This project is under the MIT license