Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[QoL] Run History Function #1815

Closed
wants to merge 251 commits into from
Closed

Conversation

frutescens
Copy link
Collaborator

@frutescens frutescens commented Jun 5, 2024

What are the changes?

This adds a new option on the menu for 'Run History'.
It allows users to store and look at a maximum of 25 past runs. This functionality automatically logs a run based on the current SessionSaveData and stores it in cache/the network database. At the moment, the function mirrors the 'Load Save' UI and only shows the team, whether they were victorious or not, the mode, wave, and the final timestamp of the run.

The server-side code is here: pagefaultgames/rogueserver#33

Why am I doing these changes?

This has been a feature requested by many users. In addition, this will allow the Balance and Development teams to do some analytics and have data on the gameplay experience.

I also have a bad memory so I thought it would be helpful to be able to access past runs to see what I need to do better.

What did change?

There are many changes:

  • New Menu Option
  • New UI
  • New 'RunHistoryData' item in cache
  • Network communication with new endpoint / table in database
  • New post-battle behavior

Screenshots/Videos

Features
image
image

Languages
image
image
image
image
image
image

How to test the changes?

Q: How can a reviewer test your changes once they check out on your branch?
A: Play normally and log runs - successful or losses.
Q: Did you just make use of the src/overrides.ts file?
A: Yes - but just to kill my Pokemon faster so I could log defeats.
Q: Did you introduce any automated tests?
A: No
Q: Does the reviewer need to do something special in order to test your change?
A: Yes - need to run RogueServer for network/database functionality

Checklist

  • There is no overlap with another PR?
  • The PR is self-contained and cannot be split into smaller PRs?
  • Have I provided a clear explanation of the changes?
  • Have I tested the changes (manually)?
    • Are all unit tests still passing? (npm run test)
      This still does not pass the Linter, but I plan on cleaning the PR up once all changes are made. My code is really messy, so I feel hesitant to remove all the imports.
  • Are the changes visual?
    • Have I provided screenshots/videos of the changes?

DustinLin and others added 30 commits May 11, 2024 11:24
merge from upstream main
f-fsantos and others added 16 commits July 6, 2024 15:25
[BETA] Read title from env files to allow for environment base changes
[BUG] - Beta -  Mutlihit Moves + Messages not properly rendering on faint
…ncounters-beta

[Beta] MEs dialogue token fix
This reverts commit 88c7378, reversing
changes made to ab155aa.
This was referenced Jul 6, 2024
@f-fsantos f-fsantos changed the base branch from main to beta July 10, 2024 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request Game Balance Changes focused on game balance UI/UX User interface/-experience related
Projects
None yet
Development

Successfully merging this pull request may close these issues.