:video_game: Game jam framework based on libgdx.
:video_game: Game jam Java framework based on libgdx.
:space_invader: Features | :package: Installation | :green_book: Documentation | :beers: Collaboration | :rocket: License | :pencil: Changelog
Another game development framework? Really?! 🤔
In Java world, we game developers already have libgdx in order to create beautiful, feature-rich games. It allows us to be highly flexible how we design our game, however it is not ideal for small game jams. Especially in the first hours time is spent on wiring everything together, creating game object classes, setting up lighting, physics, tweening, writing shaders and particle management as well as sound manipulation.
From experience, this can take several hours which is costly, especially on small 24 hour game jams. You could move away from Java and use a popular game engine instead, but we Java developers like it simple and we do not want to give up on Java! Alternatively, all the boilerplate work should be done for you - and this is where braingdx comes into play!
This framework does not replace libgdx but gives your game superpowers!
This framework provides:
This framework is currently developed by a single person. Pull requests are very welcome! The following roadmap is planned for the first 1.0 release of this framework:
<dependency>
<groupId>io.github.bitbrain</groupId>
<artifactId>braingdx-2d</artifactId>
<version>$braingdxVersion</version>
</dependency>
Add the following to your build.gradle
file to your core
module:
compile "io.github.bitbrain:braingdx-2d:$braingdxVersion"
compile "io.github.bitbrain:braingdx-2d:$braingdxVersion:sources"
compile "io.github.bitbrain:braingdx-2d:$braingdxVersion:javadoc"
Replace $brainGdxVersion
with the version on Maven Central.
Important! This framework requires box2dlights >= 1.5.x
which automatically comes with this framework as a dependency. Make sure to remove any box2dlights
dependencies from your core setup which are <1.5!
After that you are ready to go! Learn here how to integrate braingdx into your libgdx game!
Feel free to create a new pull request. When you detect an issue please report it here.
This software is licensed under the Apache 2 License.
I would like to thank Mario Zechner and the libgdx community for developing such an amazing framework to work with. Also special thanks to Aurelien Ribon for creating a Java tween engine which can be used all over the place. This project also includes his work.