Paths

Paths is a Maven-based JavaFX application developed as part of an assessment in the subject Programming 2 at the Department of Computer Technology and Informatics, at the Norwegian University of Science and Technology, in the spring of 2023.

Team: Ramtin Forouzandehjoo Samavat and Tobias Skipevåg Oftedal

Table of Contents

• Overview
• Prerequisites
• Features
• Technologies Used
• Installation
• Usage
• Acknowledgements

Overview

The application serves as a game engine for choice-based and interactive storytelling.

Prerequisites

Before running the Paths application, ensure that you have met the following requirements:

• You have Java version 17 installed Java JDK
• You have installed Maven

Features

Paths offers the following key features:

• Choice-based and interactive storytelling
• Graphical User Interface
• Text-to-Speech
• JSON Data Handling
• Text File Handling
• Testing Framework (JUnit)

Technologies Used

Paths utilizes the following technologies:

• JavaFX
• Maven
• JUnit
• Gson
• ControlsFX
• TTS

Installation

To run the Paths application locally, follow these steps:

1. Clone the repository from GitLab (you need to be connected to the NTNU network or have a VPN connection established):

git clone https://github.com/RamtinS/paths.git

2. Open the project in IntelliJ IDEA or your preferred Java IDE.
3. Ensure a clean build of the application by executing the following command:

mvn clean install

4. Run the MainApp class as the entry point of the application.
5. Start exploring the game filled with choice-based gameplay and interactive storytelling!

Usage

To run the application, execute the following command:

mvn javafx:run

Acknowledgements

Special thanks to the subject teachers for creating this assignment and providing us with the opportunity to develop this project.