The program is a productivity timer with an adventure game aspect, letting a user designate durations for their work and break sessions (e.g., Pomodoro). After the user has completed the work timer, they obtain loot and upgrades that make the user’s character stronger, getting more loot the longer they have studied (if the user does not finish their session, they will receive less loot). Once the user starts their break session, they have a menu they can access for going to the shop and buying equipment, fighting bosses, changing equipment, or going back to studying.
The character should have stats the user can access that see how strong they are and what equipment they have. These stats determine their ability to defeat bosses. The user should be able to change the timer settings to match how much time they want to study and save their progress if they want to keep how long they’ve studied for using the program.
- timer: Start, pause, or end the timer early. After the timer is complete, the user can click a button to go to the break menu. The user can select from three different preset timer durations or set their own duration.
- Inventory: Have access to different types of items, including equippable items and consumables, that the user can equip or use.
- Stats: Stats that the user has and can level up as they continue to study and progress with the bosses. This also includes things like the user's gold and the stats for the Boss that the user can fight during their breaks.
- Dialogue: A series of dialogue options that the user can see during their breaks, study times, boss fights, etc.
- Break Menu: A place where the user can see different options after completing the study timer. This includes seeing their inventory and stats, going to the shop, or going to fight the boss or to go back to study.
- Settings: Where the user can save or load their saves, or quit the game. There is also the ability to pause the music in the settings menu.
- Shop Menu: The user can buy or sell their items that the user needs to fight the Bosses for or to get rid of unnecessary items in their inventory.
- Saving/Loading Data: The user can save their data for when the user wants to close the program, and can load their data again when the user runs the program again to study.
- Start Menu: Where the user starts the game: they can choose to load a save, or to start a new game.
- Boss Fights: The user can fight bosses during their breaks, which goes into a Rock/Paper/Scissors-type gamemode. If the user completes the boss fight successfully, then their stats are affected and the user "progresses" in the game.
For more info on gameplay, check out our wiki!
The program can be run from the class GameMain.java. This class is currently found in the "UI/screens" package. (The first time the code is run, it may say java: package org.jetbrains.annotations does not exist. If that happens, scroll down to the readInventory method and "Add 'annotations' to classpath." then run again)
See our Design Wiki for info on our major design decisions (Clean Architecture, SOLID, packaging etc.).
(include coverage reports + explanations of what hasn't been tested here)
- The dialogue system was not completed to a working degree, so there are no tests available for this feature. If it had been finished, the test coverage would have covered tests for: making sure the dialogue gets mapped correctly from an external .csv file, buttons redirecting to the correct scene, and correct text showing up.
-
The Shop Menu did not manage to have complete implementations for the Sell Menu screen, so it was omitted from the final project.
-
The Dialogue system did not manage to be completed on time, so some parts of the dialogue and cutscenes were not included in the final project when committing to our main branch.
-
The Music player experienced some issues after merging from the different branches to Main and we weren't sure how to fix this in time for submission, so the music currently is not being played.