Sprouts

A multi-platform implementation of Sprouts, built with libGDX.

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

You need the following before installing Sprouts:

• Java 8 (or later)

• Android SDK

  • required packages:
    • platforms;android-28
    • platform-tools
    • build-tools;28.0.3
    • docs (optional, required to generate Javadocs)

Here is how you can install all of the required Android SDK packages in one line

$: ./ANDROID_HOME/tools/bin/sdkmanager "platforms;android-28" "platform-tools" "build-tools;28.0.3" "docs"

Building

Get a fresh copy of the project

git clone https://github.com/Glusk2/sprouts.git
cd sprouts

The following command builds the project and runs all tests

chmod +x gradlew
./gradlew build connectedCheck

If you want to build one of the distributables (.apk for Android, .jar for desktop), you have to run additional commands.

Building distributables

• Android

  ./gradlew android:assembleDebug

  The debug .apk is generated in android/build/outputs/apk/debug/

• Desktop

  ./gradlew desktop:dist

  The executable .jar is generated in desktop/build/libs/

• HTML

  ./gradlew html:dist

  The static web content (JS + HTML + CSS) files are generated in /html/build/dist/

• iOS

  Todo!

Documentation

The Javadoc for the latest build of the master branch is readily available here.

Releases

Releasing new version is fully automated. To initiate a new release, simply post a new comment to any issue with the following format:

Github, please release version: <tag>

where <tag> matches the following regular expression: ^v[0-9]+.[0-9]+.[0-9]+

IDE integration

You can find help on how to setup various IDEs for libGDX on their official page.