SOFTENG 206 - EscAIpe Room

Group Project with Contributors:

Reuploaded from a private repository

AI Text Box Integrated Escape Room Game

Welcome to the AI Text Box Integrated Escape Room Game! This project is a thrilling and interactive escape room game where players must find clues and solve puzzles to escape various rooms. The game is developed using Java, JavaFX, CSS, and the OpenAI API.

Introduction

The AI Text Box Integrated Escape Room Game is designed to provide an immersive experience where players interact with an AI-powered text box to find clues and escape from different rooms. The game leverages the OpenAI API to process player inputs and generate responses, enhancing the gameplay with intelligent and context-aware interactions.

Features

• Interactive Gameplay: Players interact with the game through an AI text box, finding clues and solving puzzles to escape rooms.
• AI-Powered Responses: The game uses the OpenAI API to generate intelligent and context-aware responses to player inputs.
• Engaging UI: The game is developed with JavaFX, providing a rich and engaging user interface.
• Stylish Design: Custom CSS is used to enhance the visual appeal of the game.
• Difficulty Levels: Choose from Easy, Medium, and Hard levels to match your skill and challenge preference.
• Timers: Select from 2, 4, or 6-minute timers to add an extra layer of excitement and urgency to the game.

Technologies Used

• Java: The core programming language used for the game's logic.
• JavaFX: Used for creating the user interface.
• CSS: Used for styling the game interface.
• OpenAI API: Used to process player inputs and generate AI-powered responses.

To setup OpenAI's API

• add in the root of the project (i.e., the same level where pom.xml is located) a file named apiproxy.config

• put inside the credentials that you received from [email protected] (put the quotes "")

  email: "[email protected]"
  apiKey: "YOUR_KEY"
  

  these are your credentials to invoke the OpenAI GPT APIs

To setup codestyle's API

• add in the root of the project (i.e., the same level where pom.xml is located) a file named codestyle.config

• put inside the credentials that you received from [email protected] (put the quotes "")

  email: "[email protected]"
  accessToken: "YOUR_KEY"
  

these are your credentials to invoke GradeStyle

To run the game

./mvnw clean javafx:run

To debug the game

./mvnw clean javafx:run@debug then in VS Code "Run & Debug", then run "Debug JavaFX"

To run codestyle

./mvnw clean compile exec:java@style