SimpleGame

This is an example game implemented using SimpleEngine, a 2D Java game engine. Please feel free to copy shamelessly to make your own games.

This example game runs as a JavaFX Application and an Android app.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

I suggest you do the following before cloning this project:

• Download the IntelliJ IDEA.
• Ensure you have Java JDK 1.8 or later installed.
• I also suggest you install the latest version of Gradle.
• Create a GitHub account.
• Set up GitHub over SSH.

Setting Up IntelliJ

• Clone this repository to your local machine (directions here).
• I strongly suggest creating a local branch before making any changes.
• Open IntelliJ, and create your project by importing from build.gradle. (Note: I suggest quickly reading up on how IntelliJ works with Gradle, but this is optional--you shouldn't need to mess with the build config.)

Building and Running: JavaFX

• Open the Gradle tool window in IntelliJ.
• Build and run the app. To do this:
  • Expand ":modules:javafx"
  • Expand "Tasks"
  • Expand "application"
  • Double-click "run".

Building and Running: Android

First, a few more setup steps:

• Get the Android SDK. There is a bug in IntelliJ that makes this very hard to do without using Android Studio. I suggest downloading and installing Android Studio, and using that to install the Android SDKs.
• If you'd like to continue to develop in IntelliJ, add the Android SDKs to your project through this workaround.

Now you're ready to build for Android:

• Add an Android run/debug configuration to IntelliJ.
• Build an unsigned APK. To do this:
  • Expand ":modules:android"
  • Expand "Tasks"
  • Expand "build"
  • Double-click "build".
• Run --> "Run 'android'", and follow instructions to create an AVD and launch the APK.

Running Tests

There aren't any tests for SimpleGame, but please feel free to add some. :)

Contributing

I rather like this CONTRIBUTING.md; let's follow that for any pull requests.

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Steve Martin - Initial work - Fitzcairn

License

This project is licensed under the MIT License - see the LICENSE.md file for details