JavaFX Fighting Game: NTNU FIGHTERZ

Discover the full dynamics of NTNU FIGHTERZ. Click on the GIF to watch the game in action.

Table of contents

1. Introduction
2. Setup
3. Usage
4. Tests
5. Repository Structure
6. Contributors

---

Introduction

NTNU FIGHTERZ is a scaling fighting game inspired by the likes of Super Smash Bros. In its current avatar, players get to embody the unique character, "The Angry Cyclist", a nimble and dynamic fighter with a quirky set of moves. Group 1 IT1901 Fall 2022 course Our Project is seperated into four main parts: base, docs, fxui og gameplay

Base contains userinformation. DAO; Database Access Object is used. Base README

Docs and the folder release1 contains all the documentation for the project. Here lies all from diagrams to meetings. Docs README

Fxui contains most of the graphical and "main" parts of the project. Fxui README

Gameplay contains all the game logic. Gameplay README

Setup

Prerequisites:

• Java JDK 17 or higher.
• Maven 3.8.6 or newer.

Clone the repository

git clone https://github.com/sandviklee/NTNU-FIGHTERZ.git;
cd NTNU-FIGHTERZ;
cd gr2201;

Install dependencies

To install all the necessary dependencies run the following command.

mvn clean install -DskipTests

Usage

To run NTNU-FIGHTERZ, there are two systems one needs to start; the server and the game. One do not need to run the server to start the game, but then one can not save ones profile or log into an older account.

Starting the game

Navigate to the directory named "gr2201" in your command line interface and execute the following command:

mvn clean compile;
cd fxui;
mvn javafx:run

Starting the Server (optional)

To start the server one needs to make sure that the port 8080 is not currently in use. If it is in use you need to kill the application running on that port to make the server be able to use the port. after that run the following code.

mvn clean compile;
cd springboot/restserver;
mvn spring-boot:run

Tests

To run the full test suit, run the following command in the folder gr2201:

mvn test

Genererate test coverage repport

Jacoco can be launched by typing:

mvn clean jacoco:prepare-agent install jacoco:report

Contributors

Elin Haugum

Kristoffer Nohr Olaisen

Simon Sandvik Lee

Sverre Nystad