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.

Sign up for GitHub

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

Jump to bottom

Better/more informative TPS/FPS display #1561

Open
xsebek opened this issue Sep 30, 2023 · 3 comments · May be fixed by #2062
Open

Better/more informative TPS/FPS display #1561

xsebek opened this issue Sep 30, 2023 · 3 comments · May be fixed by #2062
Labels
C-Low Hanging Fruit Ideal issue for new contributors. S-Moderate The fix or feature would substantially improve user experience. T-UI Involves the user interface. Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. Z-Instrumentation Improving visibility into performance and internal game behavior Z-Performance This issue concerns memory or time efficiency of the Swarm game. Z-User Experience This issue seeks to make the game more enjoyable to play.

Comments

@xsebek
Copy link
Member

xsebek commented Sep 30, 2023 •
edited
Loading

A very useful tool for players conscious about performance in game is displayed UPS/FPS.

Here is a nice explanation from helpful player of Factorio:

FPS = Frames Per Second. This number is sacrificed first if UPS is below 60.
UPS = Updates Per Second, the number of times the game engine updates all entities on the map.

Because the terminal does not need to update all the time, we might want to add instead:

TPS = Ticks Per Second. That is the actual number of ticks executed, not the target value we show in UI now.

This would allow even non-developers to notice and quantify performance problems and make life much easier for developers hunting those problems down.

This could be a debugging option turned on in UI and by command line flag.
@xsebek xsebek added Z-User Experience This issue seeks to make the game more enjoyable to play. Z-Feature A new feature to be added to the game. C-Low Hanging Fruit Ideal issue for new contributors. S-Moderate The fix or feature would substantially improve user experience. T-UI Involves the user interface. Z-Performance This issue concerns memory or time efficiency of the Swarm game. Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. labels Sep 30, 2023
@kostmo
Copy link
Member

kostmo commented Oct 1, 2023

Related: #1348

@xsebek
Copy link
Member Author

xsebek commented Oct 1, 2023

@kostmo thanks for the link, I was not aware we had that feature in UI. 👍

@byorgey
Copy link
Member

byorgey commented Dec 14, 2023

Just looking at this again. So concretely, what should be different from the current status quo? When focusing on the world panel and hitting the f shortcut to toggle the FPS display on, we currently show this:

fps

And as noted above, we also currently draw the tpf indicator in red when it hits the cap.

Some options I can imagine:

  • Do we need better documentation/discovery of the ability to display FPS?
  • Should we display the actual ticks / second (slower than requested) when the tpf gets capped?
  • Any other statistics we should display?

@kostmo kostmo added Z-Instrumentation Improving visibility into performance and internal game behavior and removed Z-Feature A new feature to be added to the game. labels Jun 16, 2024
This was referenced Jul 20, 2024
Closed
Draft
@byorgey byorgey changed the title Display UPS/FPS Better/more informative TPS/FPS display Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-Low Hanging Fruit Ideal issue for new contributors. S-Moderate The fix or feature would substantially improve user experience. T-UI Involves the user interface. Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. Z-Instrumentation Improving visibility into performance and internal game behavior Z-Performance This issue concerns memory or time efficiency of the Swarm game. Z-User Experience This issue seeks to make the game more enjoyable to play.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Show the current TPS if it is slower than the target. swarm-game/swarm
3 participants
@kostmo @byorgey @xsebek