WIP: Achievements by bb-froggy · Pull Request #118 · Sesu8642/FeudalTactics

bb-froggy · 2026-02-22T21:10:27Z

This PR is a Work in Progress for #101 Achievements.

I currently don't believe I require immediate feedback (although I am thankful for it), but here is where I track this task.

Status

So far, it implements the basic data and class structure for achievements. It also includes a UI page, which needs some attention. A couple of achievements are already added.

I rebased on February 19 after #116 was merged, therefore the initial commits all have that date.

Open Tasks

General/Architecture

Define a class for historic emperors and events. Achievements may, but don't need to, have such a historic connection. If they do, it defines their name and the history description will be pre-pended to the achievement's description. Usually, the "last achievement in a row" will get the historic connection.
Shall we align with Show some statistics when a game is over #95 somehow? They have some tasks in common. One of them is that if a player does something like destroy a capital and then presses undo, it should probably not be counted for neither the achievements nor for the per-game statistics.
Secret Achievements

UI

The background color for each achievement is very similar between finished and in-progress achievements. The black font for the "Unlocked" is hard to read. This is because the Window color somehow tints everything and so far I haven't been able to define the font and background color in absolute terms.
The two-line headings don't fit well in the achievement boxes (the single-line ones neither, but they are okay). Enlarging the achievement boxes would solve this problem only partially, as they are currently Window widgets and I had difficulties controlling the title in a way that would solve this. Possibly, a different kind of widget would be better. Also, you can currently move the achievement boxes around because they are Windows.
Achievement boxes shall get a black outline.

Achievements

We had lots of them defined and we may add others later. We need some "definition of done" for this PR and then we can add other achievements later on. There are many good ideas, but some of them will be hard to implement at least right now and it would take a lot of work to implement really all of them.

Achievements for which the current GameExitedEvent suffices

Achievements using castle counting

~~- [x] WinWithOnlyNCastlesAchievement with n = 0, 1, 3~~
~~- [x] BuyNCastlesAchievement with = 1, 20, 100~~

Unit Tests

Add Unit tests for the achievements to see whether they unlock when expected

…stuff

Sesu8642 · 2026-02-26T21:57:58Z

I had a brief look at your approach: scanning all moves "live" as they happen. It has the advantage that the player could be alerted about any new achievements right away. Disadvantages include:

the need to handle undoing moves
potentially running checks over and over again
limited knowledge about the previous turns and moves

Another approach could be to record all player moves during the game. It shouldn't be too difficult as incremental player moves are already recorded for the undo feature. You could take the same data (+ end of turn markers) and record the whole game. The recording could be added to the GameExitedEvent and then checked for any unlocked achivements.

The same data could also be used for other features, like offering to save the replay of a game for later re-watching or sharing. But that's certainly out of scope for this PR 😄

bb-froggy · 2026-03-02T20:34:02Z

The undo was already giving me some headaches. I tried to solved it for the "buy n castles" case, but for other ideas, it would be much easier if we had a fixed linear history and just scanned through that to forward the progress of the achievements. Your have convincing arguments. I think that this suggestion is a great idea.

Thus, I would scope this PR to just include achievements that work with only the current GameExitedEvent, which is a nice collection already IMHO. Everything else, I would remove again from the PR and we save that for a later modification.

Or: We leave the existing castle-counting code of AchievementGameStateTracker in there, but not add anything else that uses this approach, as it allows for the (quite challenging) low-castle achievements and the "buy n castle" achievements -- but once we have that later modification with the recorded game we will refactor the code to use that and remove the AchievementGameStateTracker. The one disadvantage I see is that we have the AchievementGameStateTracker listening for three events and writing to preferences for each of them, which might have a performance impact.

bb-froggy · 2026-03-03T21:14:49Z

I noticed that I also subscribed to the RegenerateMapEvent in WinVeryHardGamesInARowAchievement. I guess that's also okay, it won't happen mid-game, not so often in total, and there's no "Undo". I need it to prevent people from skipping maps that look difficult to avoid breaking their streak.

bb-froggy · 2026-05-13T20:41:48Z

Known open issues:

~~Using the localization~~
~~German translations~~
Achievement UI: unlocked and locked achievement boxes should have the same size
Test that achievement state is persisted correctly
When unlocking an achievement, the SlideStage UI seems not to update
@Sesu8642 's feedback on service and events architecture and injecting the achievements

Sesu8642 · 2026-05-14T09:01:13Z

I consider the localization nice to have for this, as it was added after this PR was already far along and you probably want to get it done soon.

Sesu8642

Gave it another review.

Sesu8642 · 2026-05-14T09:06:07Z

 		magFilter: Nearest
 		characters: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789()[]{}%&$§!?=+-.,:;_/\\*~#\"'↗–äöüÄÖÜßẞ\n"
 	}
+	MenuHeading: {


Is this font used somewhere? If not, it can be removed.

It is used by menu_heading, defined in SkinConstants as FONT_MENU_HEADING, and used as the heading in the dialog that opens when you tap on a specific achievement. The important thing is that it is white. This is better readable in the dialog box with its turquois/cyan/green-blue (?) background.

This file is generated and should not be edited directly. Instead, Skin Composer should be used. In addition to that, a new label style should be created and scaled in SkinFactory. Using the tool can be a bit tricky. Can I help you with that?

If you mean "do everything for me", then you have my permission ;-). If you have some pointers, and I'll take it from there, I would also be glad. I guess "Skin Composer" is that tool (=a standalone program?).

I'll take care of it :)

Sesu8642 · 2026-05-14T09:31:42Z

+ * Provides achievement classes, knows how to construct each individual achievement
+ */
+@Singleton
+public class AchievementProvider {


I would probably call this AchievementFacory, as provider may be confused with the @provides concept of Dagger.

Speaking of which, there could be a provideAchievments method in a dagger module that uses this factory and makes the list of achievements injectable. That way, the AchievementService can be simplified as it only calls this method once anyway.

That sounds interesting. I wasn't aware of this dagger concept.

Sesu8642 · 2026-05-14T09:41:59Z

+        this.prefStore = achievementsPrefs;
+    }
+
+    public void LoadPersistedAchievements(Iterable<AbstractAchievement> achievements) {


Not sure I like that side effect on the achievements. Maybe the achievementProvider/achievement list can be injected into the repository directly instead of the service. Then this method could use that instead of the parameter and just return the populated list to the service.

I refactored the code and now there is an AchievementsFactory with a Factory Method. I first wanted to use the dagger provides I had just learned about, but ultimately didn't use it.

My issue was that the AchievementsFactory "provides" a list of raw achievement classes. The AchievementRepository provides a list of achievement classes with the values loaded from the prefStore. I can only dagger-provide one of them (or use different collection classes to differentiate ... but that would be more of a hack). It felt unclean to me to provide the raw ones, because everywhere in the code except for the AchievementRepository itself, we'll want to have the ones with the loaded values. Thus, AchievementRepository uses the AchievementsFactory explicitly and calls the Factory Method. And AchievementService needs the reference to AchievementRepository anyway, so it feels redundant to have it injected both the AchievementsRepository AND the list of achievements. Hence, it also explicitly retrieves the achievements from the AchievementsRepository where it needs them and doesn't store a separate list of achievements. Consequently, the AchievementsSlide now gets its achievements for displaying also from the AchievementsRepository now and not the AchievementService.

… Generations and GameExit

…class

… loaded from prefStore

…ievementsService and -Repository

bb-froggy · 2026-05-20T20:54:59Z

I have addressed your concerns, @Sesu8642 . Please have a look, especially at the ones where I haven't yet resolved the conversation -- I didn't follow your suggestions by the letter in these cases and therefore I am not sure your concern is fully resolved.

Everything is hard-coded English as of yet.

The AI levels are shown as LEVEL1, LEVEL2, ... because the method converting them to readable display names wasn't there anymore -- I guess it needs a different approach now respecting the translations. This isn't even what it should be for English.

Sesu8642 · 2026-05-31T18:58:49Z

Sorry for the delay. I'm focusing on release 1.5 right now, which I want to get out soon. I'll review your latest changes after that.

Sesu8642 · 2026-06-05T21:06:02Z

It looks like there are some comments of mine from Mar 22 which you might have missed. Can you please have another look?

Sesu8642 · 2026-06-06T17:33:45Z

+    RICHARD_THE_LIONHEART("Richard the Lionheart", "Richard I. (1157-1199) was King of England. He fought many battles, especially in the Third Crusade, far away from his home."),
+    FREDERICK_THE_GREAT("Frederick the Great", "Frederick II. (1712-1786) was King of Prussia. While winning many battles, he is also known as a patron for education and the arts."),
+    LOUIS_XI("Louis XI", "Louis XI (1423-1483) was King of France and had the nickname 'The Universal Spider', as he carried out intrigues to play out his enemies against each other. He is known for his cunning and deviousness, but also for uniting France after the Hundred Years' War."),
+    HENRY_VIII("Henry VIII", "Henry VIII (1491-1547) was King of England. He is known for his six marriages, but also for building much military infrastructure."), // Reserved for BuyNCastlesAchievement


I noticed that the Henry ones are unused.

Just saw your comments not. I guess they can stay until the castle achievement is implemented.

Sesu8642 · 2026-06-06T18:47:38Z

I started moving strings over to the translation files. Some auto-formatting happened. Please make sure to pull my changes to avoid conflicts.
I'm aware many texts are not displayed properly yet.

bb-froggy added 18 commits February 19, 2026 22:07

Achievements Scaffolding

1b70332

Achievement: Win n games

be14b87

Prepare AchievementRepository.java

2ade8cd

Correctly wire the achievement events

335253e

Improved Achievements Layout

4457c90

Additional achievement types

5e7609d

Improve Achievements layout

412661f

Buy n Castles Achievement

53918d2

Win with only n castles Achievement and separate tracker for in-game …

cdf7144

…stuff

Refactor: Count things in tracker and make Achievements leaner

1b83982

re-order achievements on resize

9dc167d

WIP: Achievement for winning n games in a row

0ecde90

Detecting a very-hard win streak

988d79a

Check map sizes

9784dc1

Better colors for achievements

0038afe

Move TitleLabel into achievement box, event if it has two rows

2d6a94e

Change achievements title color (questionable decision)

3ffb1b9

AI Level Display name in Achievement DisplayName

262e7b9

bb-froggy added 2 commits March 3, 2026 22:06

Achievement "Win in n rounds"

a5db590

Achievement "Lose against weak AI"

49c4c9b

bb-froggy added 7 commits March 4, 2026 21:33

Achievement: Win and there are still many surviving enemies

1810eb3

Achievement: Win, but need more than n rounds

ced6e24

Win in more than n rounds -> Just play more than n rounds

b77fa45

Fancy names for each achievement category

a37d868

Fix Achievement UI scrolling layout

bbb3030

Small UI improvement

1261791

HRR Henry VI as emperor without castle

114c55c

bb-froggy added 8 commits April 22, 2026 21:24

The achievement classes decide whether they are secret

6cb7b45

Move AchievementsEventHandler.java out of ui

2b0396a

Redesign architecture for less coupling and more use of services

a935aeb

Achievements store their status via events

f758e4a

proper equals and hash code calculation

bb2738a

Merge branch 'master' into dev-achievements

e36a518

Fix compilation errors after merging i18n code

e67d5dc

Fix full achievement serialization issue

8b6779a

bb-froggy marked this pull request as draft May 13, 2026 20:36

Sesu8642 reviewed May 14, 2026

View reviewed changes

bb-froggy added 11 commits May 14, 2026 21:53

fix json de-serialization (hopefully for real this time)

31c2ceb

fix: Refresh achievements on every showing of the AchievementsScreen

4f8e0fb

Achievements directly return whether they have been changed after Map…

6d6316b

… Generations and GameExit

Register click events in AchievementsScreen instead of a lower-level …

1adf032

…class

Make the heading in the achievement details a little larger

2a2b65e

Make AchievementBox use defined size

fccc18f

Refactor: Where are Achievements constructed and where are the values…

fcb7eb6

… loaded from prefStore

Removed unneeded imports

d1dbfa4

Singular class names AchievementService and -Repository to plural Ach…

ef56491

…ievementsService and -Repository

Merge branch 'master' into dev-achievements

50b820c

Fix build issues after merging master

a2dec22

bb-froggy marked this pull request as ready for review May 20, 2026 20:55

Sesu8642 reviewed Jun 6, 2026

View reviewed changes

begin moving strings to translation file

7b97534

Conversation

bb-froggy commented Feb 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Status

Open Tasks

General/Architecture

UI

Achievements

Achievements for which the current GameExitedEvent suffices

Achievements using castle counting

Unit Tests

Uh oh!

Sesu8642 commented Feb 26, 2026

Uh oh!

bb-froggy commented Mar 2, 2026

Uh oh!

bb-froggy commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bb-froggy commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sesu8642 commented May 14, 2026

Uh oh!

Sesu8642 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bb-froggy commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sesu8642 commented May 31, 2026

Uh oh!

Sesu8642 commented Jun 5, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sesu8642 commented Jun 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bb-froggy commented Feb 22, 2026 •

edited

Loading

bb-froggy commented Mar 3, 2026 •

edited

Loading

bb-froggy commented May 13, 2026 •

edited

Loading

bb-froggy commented May 20, 2026 •

edited

Loading