Add configurable leaderboard income columns by jsshap · Pull Request #4453 · openfrontio/OpenFrontIO

jsshap · 2026-06-30T00:33:45Z

Before opening a PR: discuss new features on Discord first, and file bugs or small improvements as issues. You must be assigned to an approved issue — unsolicited PRs will be auto-closed.

Add approved & assigned issue number here:

Resolves #4074

Description:

Adds gold/min and configurable scoreboard columns. Adds optional cities column.

Testing: npm test

Please complete the following:

I have added screenshots for all UI updates
I process any text displayed to the user through translateText() and I've added it to the en.json file
I have added relevant tests to the test directory

Please put your Discord username so you can be contacted if a bug or regression is found:

jsshap

CLAassistant · 2026-06-30T00:33:51Z

All committers have signed the CLA.

coderabbitai · 2026-06-30T00:34:15Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a2c7ddcc-b876-4377-bf84-2c7fa0fa7e79

📥 Commits

Reviewing files that changed from the base of the PR and between ed3536f and ae514fe.

📒 Files selected for processing (2)

tests/PackedPlayerUpdates.test.ts
tests/PlayerUpdateDiff.test.ts

🚧 Files skipped from review as they are similar to previous changes (1)

tests/PlayerUpdateDiff.test.ts

Walkthrough

Adds a rolling gold-per-minute stat on the server, carries it through player update paths, and lets the leaderboard show configurable columns saved in user settings.

Changes

goldPerMinute stat and configurable leaderboard columns

Layer / File(s)	Summary
goldPerMinute tracking in PlayerImpl `src/core/game/Game.ts`, `src/core/game/PlayerImpl.ts`, `src/core/game/GameImpl.ts`	`addGold` gets a `countAsIncome` flag, `donateGold` passes `false`, and `PlayerImpl` tracks rolling gold-income buckets to emit `goldPerMinute` in full and partial updates.
Packed update protocol: stride 4→5 `src/core/game/GameUpdates.ts`, `src/core/game/GameUpdateUtils.ts`, `src/client/render/types/Renderer.ts`, `src/client/view/GameView.ts`, `src/client/view/PlayerView.ts`, `tests/GameUpdateUtils.test.ts`, `tests/PackedPlayerUpdates.test.ts`, `tests/PlayerUpdateDiff.test.ts`, `tests/client/render/frame/derive/*`, `tests/client/view/GameView.test.ts`, `tests/util/viewStubs.ts`	`PlayerUpdate`, `PlayerState`, diff/apply logic, packed record decoding, and related tests all move to a 5-field player stats record that includes `goldPerMinute`.
UserSettings leaderboard column persistence `src/core/game/UserSettings.ts`, `tests/UserSettings.test.ts`	Adds persisted leaderboard column selection with allowed-key filtering, default fallback, and toggle behavior.
Leaderboard HUD: dynamic columns and settings UI `src/client/hud/layers/Leaderboard.ts`, `resources/lang/en.json`	Leaderboard headers and rows now render from configurable column definitions, with new settings controls and translation labels for the extra column UI.

Sequence Diagram(s)

sequenceDiagram
  participant PlayerImpl
  participant GameUpdateUtils
  participant GameView
  participant PlayerView
  participant Leaderboard

  PlayerImpl->>GameUpdateUtils: toUpdate() / toFullUpdate()
  GameUpdateUtils-->>GameView: packedPlayerUpdates + PlayerUpdate
  GameView->>PlayerView: stateFromUpdate()
  PlayerView-->>Leaderboard: goldPerMinute(), tiles, gold, troops

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

openfrontio/OpenFrontIO#3967: Updates the diff/apply player update path that this PR extends with goldPerMinute.
openfrontio/OpenFrontIO#4244: Changes the packed player update channel and client decode path that this PR expands to 5 fields.
openfrontio/OpenFrontIO#4379: Touches the leaderboard sorting code path that this PR refactors for dynamic columns.

Suggested labels

UI/UX, Feature

Suggested reviewers

evanpelle
Celant

Poem

Gold flows steady, soft and bright,
Packed in records, day and night.
Columns wake and sort anew,
Quiet stats now shine through.
A minute counts, the board can say,
Who earns the most along the way.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	The PR also adds a column chooser and a Cities column, which go beyond the linked issue's gold/min scoreboard request.	Split the column-chooser UI and Cities column into a separate PR or issue if they are intended as follow-up work.
Docstring Coverage	⚠️ Warning	Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: adding configurable leaderboard income columns.
Description check	✅ Passed	The description matches the change set and describes the gold/min and configurable leaderboard work.
Linked Issues check	✅ Passed	The implementation appears to cover server-side gold/min tracking, sliding-window buckets, and client updates required by `#4074`.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/client/hud/layers/Leaderboard.ts`:
- Around line 186-202: The ranking logic in updateLeaderboard is using the full
playerViews list, so dead players can affect the computed fallback place for the
local player. Update the Leaderboard.updateLeaderboard flow to filter the
game.playerViews() result to alive players before sorting, or compute the place
from an alive-only list, so the local player’s rank is based only on active
players.

In `@tests/PackedPlayerUpdates.test.ts`:
- Around line 51-55: The PackedPlayerUpdates assertions are incorrectly using
Number(alice.gold()) for the new goldPerMinute slot, which can hide a packing
bug in PackedPlayerUpdates. Update the expectations in the affected test cases
to assert goldPerMinute with its known income value directly, using the relevant
PackedPlayerUpdates/record tuple checks instead of deriving that field from
alice.gold().

In `@tests/PlayerUpdateDiff.test.ts`:
- Around line 134-211: The new tests are bypassing the shared core-simulation
harness by constructing players and calling game.addPlayer directly. Update
these cases to use the setup() helper from tests/util/Setup.ts to create the
game instance and obtain players, keeping the assertions around PlayerInfo,
game.player, toUpdate, donateGold, and drainPackedPlayerUpdates intact. If a
special exception applies, make it explicit; otherwise route both tests through
the standard test setup pattern.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ef07d4b5-718a-4069-92f2-e1e7acf75e78

📥 Commits

Reviewing files that changed from the base of the PR and between f4b47ce and 7534539.

📒 Files selected for processing (19)

resources/lang/en.json
src/client/hud/layers/Leaderboard.ts
src/client/render/types/Renderer.ts
src/client/view/GameView.ts
src/client/view/PlayerView.ts
src/core/game/Game.ts
src/core/game/GameImpl.ts
src/core/game/GameUpdateUtils.ts
src/core/game/GameUpdates.ts
src/core/game/PlayerImpl.ts
src/core/game/UserSettings.ts
tests/GameUpdateUtils.test.ts
tests/PackedPlayerUpdates.test.ts
tests/PlayerUpdateDiff.test.ts
tests/UserSettings.test.ts
tests/client/render/frame/derive/nuke-telegraphs.test.ts
tests/client/render/frame/derive/player-status.test.ts
tests/client/view/GameView.test.ts
tests/util/viewStubs.ts

ryanbarlow97 · 2026-06-30T16:27:18Z

I think this is tackling too many things at once, can you split them into multiple PRs?

jsshap · 2026-06-30T16:42:36Z

I think this is tackling too many things at once, can you split them into multiple PRs?

What are you referring to specifically?

ryanbarlow97 · 2026-06-30T16:57:28Z

I think this is tackling too many things at once, can you split them into multiple PRs?

What are you referring to specifically?

I mean, you added adjustable columns, and a gold/min, would be good to split into 2 prs

jsshap · 2026-06-30T17:17:49Z

I think this is tackling too many things at once, can you split them into multiple PRs?

What are you referring to specifically?

I mean, you added adjustable columns, and a gold/min, would be good to split into 2 prs

That was the ask in the issue. Happy to split if you like, but I think adding extra columns without the ability to remove them will add clutter we don't want there

ryanbarlow97 · 2026-06-30T18:15:49Z

I think this is tackling too many things at once, can you split them into multiple PRs?

What are you referring to specifically?

I mean, you added adjustable columns, and a gold/min, would be good to split into 2 prs

That was the ask in the issue. Happy to split if you like, but I think adding extra columns without the ability to remove them will add clutter we don't want there

PR 1 should be configurable columns, PR 2 will be the addition of new items

You can do something like

leaderboard update part 1
then
leaderboard update part 2

jsshap requested a review from a team as a code owner June 30, 2026 00:33

github-project-automation Bot added this to OpenFront Release Management Jun 30, 2026

github-project-automation Bot moved this to Triage in OpenFront Release Management Jun 30, 2026

github-actions Bot assigned jsshap Jun 30, 2026

Add configurable leaderboard income columns

7534539

jsshap force-pushed the feature/4074-leaderboard-income-columns-v2 branch from a059744 to 7534539 Compare June 30, 2026 00:34

jsshap added 2 commits June 29, 2026 17:43

resolved conflicts

50fe296

add troop count leaderboard column

ed3536f

coderabbitai Bot requested changes Jun 30, 2026

View reviewed changes

Comment thread src/client/hud/layers/Leaderboard.ts Outdated

Comment thread tests/PackedPlayerUpdates.test.ts Outdated

Comment thread tests/PlayerUpdateDiff.test.ts Outdated

github-project-automation Bot moved this from Triage to Development in OpenFront Release Management Jun 30, 2026

address leaderboard review comments

ae514fe

coderabbitai Bot approved these changes Jun 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add configurable leaderboard income columns#4453

Add configurable leaderboard income columns#4453
jsshap wants to merge 4 commits into
openfrontio:mainfrom
jsshap:feature/4074-leaderboard-income-columns-v2

jsshap commented Jun 30, 2026

Uh oh!

CLAassistant commented Jun 30, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 30, 2026 •

edited

Loading

❌ Failed checks (2 warnings)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanbarlow97 commented Jun 30, 2026

Uh oh!

jsshap commented Jun 30, 2026

Uh oh!

ryanbarlow97 commented Jun 30, 2026

Uh oh!

jsshap commented Jun 30, 2026

Uh oh!

ryanbarlow97 commented Jun 30, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

jsshap commented Jun 30, 2026

Description:

Please complete the following:

Please put your Discord username so you can be contacted if a bug or regression is found:

Uh oh!

CLAassistant commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

❌ Failed checks (2 warnings)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanbarlow97 commented Jun 30, 2026

Uh oh!

jsshap commented Jun 30, 2026

Uh oh!

ryanbarlow97 commented Jun 30, 2026

Uh oh!

jsshap commented Jun 30, 2026

Uh oh!

ryanbarlow97 commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CLAassistant commented Jun 30, 2026 •

edited

Loading

coderabbitai Bot commented Jun 30, 2026 •

edited

Loading

ryanbarlow97 commented Jun 30, 2026 •

edited

Loading