README.md

Gravity Box

Note: this repository mirrors the last public release of Gravity Box. The project is now closed-source.

A minimalist physics game written in Kotlin & libGDX.

This is the mobile port of my Game Maker's Toolkit Jam 2018 entry, made in 48 hours, which placed 152nd (out of 1038). You can play the original version here.

Built with

• Gradle - Build automation system
• Kotlin - Programming language
• LibGDX - Game framework
• shadow - Gradle plugin for creating JARs
• Ashley - Entity-component-system library
• LibKTX - Kotlin extensions for LibGDX
• LibKTX.inject - Dependency injection library
• Box2D - 2D physics library
• gdx-pay - Cross-platform in-app purchases API
• gdx-fireapp - Cross-platform Firebase API
• Firebase Ads - Mobile advertising API
• Firebase Authentication - Authentication API
• Firebase Performance - Performance monitoring API
• Firebase Crashlytics - Crash reporting API
• Firebase Realtime Database - NoSQL cloud database API

Tools used

• Android Studio - IDE
• Inkscape - Vector graphics editor
• TexturePacker - Texture atlas packing tool
• Hiero - Bitmap font packing tool
• gdx-liftoff - Setup tool for libGDX projects
• Google BigQuery - Web service for SQL queries

Running the game

If you just want to run the game on Desktop (Windows/Linux/macOS), without downloading the source-code and compiling it yourself, check out the Releases tab. To run the game on Android, install it from Google Play.

Command-line

Windows: gradlew desktop:run
Linux/macOS: ./gradlew desktop:run

Android Studio / IntelliJ IDEA

More often than not, running the game from the command-line won't work. I suggest installing Android Studio and opening the project there. Wait for Gradle to download all dependencies, then run either the android or Desktop configuration.

If you want to run the game only on Desktop (excluding Android), you can use IntelliJ IDEA.

The configurations previously mentioned, android and Desktop, won't show up in Eclipse.

License

All code is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.

All assets including graphics, sounds, icons and maps are licensed under the Creative Commons BY-NC 4.0 license unless otherwise indicated.

Acknowledgments

• ∞ Infinity Loop - for the UI design, color scheme