This project was done under the University of Auckland for the COMPSCI 732/ SOFTENG 750 course taught under Andrew Meads. This project was completed as a group assignment for the course, and as such all assets and code created in this project is under the universities licensing.
This project is the submission for the 'Lively Lions' team.
The ECIDNA machine
Welcome to Purrlock Holme's Crypawtography Agency! Put on your detective hat and get ready to be immersed into a thrilling world where you get to follow the tales of our very own feline detective. Solve complex ciphers, from modern day emoji substitutions to old school ceaser shift ciphers. Follow the cases as you learn about this detectives world, find all the notes and save the day! Dont worry if you get stuck, your office is well stocked with a reference book and conspiracy board. If you ever need some help then Caperton Capybaraton, the Director of the Bureau of International Obscure Mystery Exploration (B.I.O.M.E), is just a phone call away. Now get ready, hold on steady and start decoding!
Portrait of Purrlock Holmes
This is a MERN stack web game where you are Purrlock Holmes attempting to solve multiple ciphers and mysteries. The game is designed to be educational and fun, with a focus on teaching the player about cryptography and ciphers. The game is designed to be played in a web browser, and is designed to be played on a desktop or laptop computer with a large fixed aspect ratio, ideally 1920 x 1080.
The live deployment of this game can be found at: https://project-group-lively-lions.onrender.com/
Have a look at our wiki for a detailed breakdown of our project development, the ciphers used in this game, the backend and database used, the game visual and audio assets, our meeting notes from the past few months, and our contribution breakdown.
- Make sure you have the latest version of git, pnpm (>=8.15.1), node (>=20.11.0) installed.
- Clone the repository (
git clone https://github.com/UOA-CS732-SE750-Students-2024/project-group-lively-lions.git) into your preferred folder cd project-group-lively-lionsthen runpnpm installto install the dependencies.- Run
pnpm run devto start a local development server on your machine. - Open your browser and navigate to local host to see the game in action.
git clone https://github.com/UOA-CS732-SE750-Students-2024/project-group-lively-lions.git
cd project-group-lively-lions
#run the following if using pnpm
pnpm install
pnpm run dev
#run the following if using npm
npm install
npm run dev- Alt + Shift + F should format the code in the current file according to Prettier + ESLint rules, otherwise you can also run
pnpm run formatto format all files. - Running
pnpm run buildproduces an application bundle that is suitable to be served over a static hosting service in./dist. Subsequently, runningpnpm run previewwill boot up a local server with the application bundle in./dist.
This database is set to be automatically run upon apps startup, however if you need to run it for development reasons then:
- navigate into the root directory using a terminal
- run the server.mjs file using
node src/backend/server.mjs
This will start the server connection manually. This connection is hosted on localhost:3000 and connects to the server using the general MongoDB URI stored in the .env.
We used VS Code with a variety of packages to make the development process easier and faster. The main packages used by the team were:
- Prettier - Code formatter
- ESLint
- Tailwind CSS IntelliSense
- Github Copilot.
(Optional) Change the corresponding VSCode settings:
