Skip to content

vqiu25/orb-escape

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OrbEscape

About

Project for SOFTENG 206 (Software Engineering Design 1), a compulsory course for Part II Software Engineering students at the University of Auckland.

OrbEscape is an escape room game designed to enhance critical thinking skills among younger demographics. It features:

  • Riddles that leverage the OpenAI API
  • An intelligent "Game Master" to assist users through the OpenAI API
  • A carefully crafted pixel art interface
  • Various difficulty levels with different time limits
  • Elements of randomness for replayability

This project ultimately led to a first-in-course award in SOFTENG 206.

Video Demonstration

orb-escape.mp4

Acknowledgements

This project would not have been possible without the hard work and dedication of our lecturers:

  • Nasser Giacaman, and
  • Valerio Teragni

Furthermore, I would like to express my deepest gratitude towards my group members:

  • Liam Parker, and
  • William Chong

for their passion and commitment to this project.

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published