Skip to content

Latest commit

 

History

History
141 lines (110 loc) · 5.87 KB

README.md

File metadata and controls

141 lines (110 loc) · 5.87 KB
Raw

Software Development Methods course project

CircleCI

Exam project for the Software Development Methods course at the University of Trieste. Written in Java, using Gradle, CircleCI and libGDX. The template for this project has been generated using libGDX's tool.

The Freedom board game

This repository contains an implementation of the freedom board game. Below you can find a brief description, which was taken from here:

Freedom is a two-player abstract strategy board game invented by Veljko Cirovic and Nebojsa Sankovic in 2010. It is played with black and white stones on a square board. The game is related to Go-Moku and Slimetrail. It can be played with a Go set or with pen and paper.

Rules:

  • Board: Freedom is played on a 10×10 square board. Beginners can try the game on an 8×8 board. Other board sizes may be also used.

  • Objective: The objective of Freedom is to have more "live" stones at the end of the game than your opponent has. A stone is considered to be "live" if it is a part of some horizontal, vertical or diagonal row of exactly 4 stones of the same color.

  • Play: A game begins with an empty board. Each player has an allocated color: White and Black. White plays first, putting one white stone anywhere on the board. After this move players take turns placing their stones on empty cells adjacent to the last opponent's stone. If all cells adjacent to the last opponent's stone are occupied then the player gets the right ("freedom") to place his stone on any empty cell of the board. The game ends when the board is filled with stones. The last player has the right to pass on his last turn (and leave the last cell empty) if placing his stone reduces his score.

Project configuration and setup

The project is divided in five different modules:

  1. A core module, containing the core classes and main GUI implementation
  2. An android module, with an AndroidLauncher that runs the game within an Android Activity
  3. A desktop module, with a DesktopLauncher to run the game as a desktop app
  4. A html module, that builds the necessary files to execute the game on a server or as a webapp
  5. A terminal module, to launch the application as a terminal-based game

All modules are fully documented with javadoc-style documentation. To generate it, simply run the relevant gradle task. You can optionally specify the module name.

./gradlew [module_name]:javadoc

Minimum requirements

This project requires Java version 11 to run, as specified in the gradle.build configuration files. As for Android, it requires API level 14 (Android 4.0) to run.

Code analysis

A dockerized SonarQube server with persistent storage is provided to enable code analysis. To start the server, simply run the following command:

docker compose -f path/to/docker-compose.yml up -d

An issue may appear on Linux systems, indicating that the container requires more virtual memory in order to run correctly:

max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]

To temporarily circumvent this issue, run the following command. For more information, check out this thread

sudo sysctl -w vm.max_map_count=262144

To use the Sonarqube Scanner run:

./gradlew -Dsonar.login=[auth_token] sonar

To generate a code coverage report for the whole project with JaCoCo run:

./gradlew -Dsonar.login=[auth_token] test jacocoTestReport sonar

Unit testing

Each module can have its own set of tests. Unit testing is done via the JUnit 5 framework, using Mockito to mock libGDX's rendering capabilities.

The tests can be executed all together, by running the main test task:

./gradlew test

Or they can be executed separately for each module:

./gradlew [module_name]:test

Run the project

To launch the desktop application, run:

./gradlew desktop:run

To launch the webapp, run:

./gradlew html:superDev

This command will also start a server on local port 8080.

If you only wish to compile the project to Javascript and then use the generated files yourself, run:

./gradlew html:dist

More details on what to do next and where to find the generated files can be found here. If you want to give it a try without having to compile everything yourself, you can take a look at the webapp version of the game on our GitHub Pages website!

To launch the terminal-based version of the game with gradle, run:

./gradlew terminal:run

As an alternative, you could also build the jar executable yourself by running:

./gradlew terminal:dist

The obtained jar file can be then executed by a JVM. You can find out the available command-line arguments by specifying the --help option.

To build an unsigned APK file for Android, run:

./gradlew android:assembleRelease

By default, you can't publish or install unsigned APKs on Android devices. We provide a version signed by us in the Releases section of this repository.

Credits

This project was built using the libGDX library. All credits go to the authors. The command line argument parsing was done using the JCommander tool. All credits go to the author, Cédric Beust.