Group Project in TDT4240 - Software Architecture

Table of Contents

• Group Project in TDT4240 - Software Architecture
  • Introduction
  • Installation and Setup
    • Prerequisites
    • Installing
  • How to Play
  • Running the tests
  • Contributors

Introduction

Installation and Setup

Prerequisites

Git
Git is a distributed version control system that is used to manage the source code of this project. It is essential for cloning the project from GitHub and collaborating with other developers.
• Git - Version Control System
  • Download and install Git from the official Git website.
  • After installation, verify the installation by running git --version in your command line or terminal.

Java JDK 17 (Download from Oracle's website)
This project requires Java JDK to be installed. The project is tested with JDK 17.
• Java JDK 17 - Java Development Kit is essential for compiling and running Java applications.
  • Download and install it from Oracle's Java JDK Download Page or adopt an open-source JDK like AdoptOpenJDK.
  • After installation, verify the installation by running java -version and javac -version in your command line or terminal.

Gradle 6.7
Gradle is used as the build tool for this project. It automates the process of building, testing, and deploying the application.
• Gradle 6.7 - Gradle brings advanced build toolkit to manage dependencies and other aspects of the build process.
  • You can download Gradle from the Gradle Download Page.
  • Alternatively, if you are using a Gradle Wrapper script (gradlew or gradlew.bat), you do not need to manually install Gradle, as the wrapper script will handle the installation for you.
  • To confirm that Gradle is properly installed, run gradlew -v in your command line or terminal which will display the installed Gradle version.

Android SDK (if you want to run the game on Android)
When testing the Android app one can run it either by connecting your Android phone via USB to your computer, or you could use an Android emulator (virtual device). To do this, you need to have the Android SDK installed.

Ensure that both Java and Gradle are properly installed and configured in your system's PATH environment variable for being able to run the game.

Installing

To install the project, you can use the following commands:

git clone https://github.com/SverreNystad/besieged.git

How to Play

The game can be played on both desktop and Android.

To start the game, you can start it on desktop using the following command:

gradlew desktop:run

To start the game on Android, you can use the following command:

gradlew android:run

Running the tests

To run the tests, you can use the following command:

./gradlew test

Contributors

Jens Martin Norheim Berget

Magnus Vesterøy Bryne

Mattias Tofte

Sverre Nystad

Tim Matras

Tobias Fremming