Introduce advanced tax & wage contribution logic #1163

ZelionD · 2025-01-12T14:11:27Z

Description

This PR adds configurable option for advanced Tax & Wage sentiment contribution logic. This is recommended to prevent exploiting in-game default tax & wages logic, when player sets very high taxes and wages to make profit. With new advanced logic proposal tax & wages are divided by intervals and every next interval gives twice less sentiment modifier than previous. Additionally the new sentiment/happiness drop has been applied. Originally we had a maximum drop rate of -2 sentiment per tick. With new settings it has increased. To prevent suffering at early game or when building a new block the cooldowns has been applied for first 30 months of gameplay and for 18-20 months for each house individually (starts once house get first citizens). Cooldown resets once house becomes villa.

Example:
Some house happiness level is 82, new sentiment/happiness target is 10, the raw change is -72. Difference percent is 72/82*100% = 87%. In VeryHard mode 50% of it is applied to a new delta change, which is 43% of -72 => -30. So on next tick the house will loose 30 points of happiness instead of 2.

…30 months passed

…res storage_id/sentiment_cooldown

…anced-tax-wage-sentiment-contribution

…ile version to 0x9f

…anced-tax-wage-sentiment-contribution

crudelios

Ok, I've finally looked at this.

While I think the core of the changes is going in a good direction, there are some points I don't quite agree.

Anyway, if you have any questions please let me know!

crudelios · 2025-01-22T12:31:20Z

src/building/building.c

@@ -205,6 +220,7 @@ building *building_create(building_type type, int x, int y)

    // subtype
    if (building_is_house(type)) {


Suggested change

if (building_is_house(type)) {

if (building_is_house(type) && b->subtype.house_level < HOUSE_SMALL_VILLA) {

I think this would be more readable and not require the check in the function.

Which check are you referring to?

int building_is_house(building_type type) { return type >= BUILDING_HOUSE_VACANT_LOT && type <= BUILDING_HOUSE_LUXURY_PALACE; }

It has nothing to the check of villa house, just a generic housing. Also in that if branch there is also an assignment b->subtype.house_level = type - BUILDING_HOUSE_VACANT_LOT; which will stop working for villas with your suggestion. If you're referring to a initialize_sentiment_cooldown, then probably function could be removed, since you didn't like the initialized flag, probably it could be removed in favor of checking save file version instead.

crudelios · 2025-01-22T12:31:43Z

src/building/building.c

@@ -424,6 +440,11 @@ int building_is_house(building_type type)
    return type >= BUILDING_HOUSE_VACANT_LOT && type <= BUILDING_HOUSE_LUXURY_PALACE;
 }

+int building_is_storage_kind(building_type type)


Suggested change

int building_is_storage_kind(building_type type)

int building_uses_storage(building_type type)

Not sure if the suggested naming is somehow better than proposed in the PR.

crudelios · 2025-01-22T12:33:09Z

src/building/building.h

+typedef struct advanced_sentiment {
+    uint8_t cooldown_initialized: 1;
+    uint8_t cooldown: 3;
+    uint8_t reserved: 4;
+} advanced_sentiment;


Please, no bitfields. Just use plain ints in the house structure. We're not starved for memory.

That were done under the purpose of potential improvements to keep compatibility with versions without making a breaking change. By using int, no more future improvements which could require some bit flags possible without incrementing the save version

Frankly I don't think it's worth it. We're saving just 4 bits and then we'll need a version bump anyway. And I'd really prefer to use a whole int, even if wasteful.

I mean if you want to save some savegame bytes for later you might as well reserve them now, if we do bump the savegame version.

crudelios · 2025-01-22T12:34:40Z

src/building/building.h

+#define ADVANCED_SENTIMENT_COOLDOWN_MAX_TICKS   7
+#define ADVANCED_SENTIMENT_COOLDOWN_TICK_MONTHS 3


Wouldn't it just be simpler to use one tick per month and increase max ticks?

If use an int, then yes, but as I replied above, there will be no room for improvements without breaking changes to save files. The initial idea was to re-use existing byte of data previously not used by houses, however it then were moved to it's own memory

crudelios · 2025-01-22T12:36:28Z

src/building/building.h

+    // New advanced sentiment contribution logic requires cooldown for newly built houses.
+    // The new happiness gain/drop logic will not be applied until cooldown expires.
+    // Cooldown ticks get decreased every Jan/Apr/Jul/Oct, which gives 18-20 months in total.
+    // That should be enough to build new housing block and evolve it.
+    struct advanced_sentiment house_adv_sentiment;


Suggested change

// New advanced sentiment contribution logic requires cooldown for newly built houses.

// The new happiness gain/drop logic will not be applied until cooldown expires.

// Cooldown ticks get decreased every Jan/Apr/Jul/Oct, which gives 18-20 months in total.

// That should be enough to build new housing block and evolve it.

struct advanced_sentiment house_adv_sentiment;

int sentiment_cooldown_ticks;

No need to call it advanced or anything 😉 Also, I think only the actual ticks are needed. See above.

Also, the explanation of the mechanics can stay on the sentiment.c side of things.

crudelios · 2025-01-22T13:57:55Z

src/city/sentiment.h

@@ -25,6 +25,6 @@ void city_sentiment_reduce_crime_cooldown(void);
 int city_sentiment_get_blessing_festival_boost(void);
 void city_sentiment_decrement_blessing_boost(void);

-void city_sentiment_update(void);
+void city_sentiment_update(int update_sentiment_cooldown);


We can either do this (call the function with update_sentiment_cooldown enabled or disabled), or we can double the number of ticks as well as reduce the sentiment jump effect by half, therefore making the whole thing more granular.

This is also only possible because I got rid of tick updates only every X months.

crudelios · 2025-01-22T13:59:01Z

src/core/config.c

@@ -72,6 +72,7 @@ static const char *ini_keys[] = {
    "gameplay_change_yearly_autosave",
    "gameplay_change_auto_kill_animals",
    "gameplay_change_nonmilitary_gates_allow_walkers",
+    "gameplay_change_advanced_tax_wage_sentiment_contribution",


As mentioned above, I don't think we need a config for this.

I think we do need, it's still could require some improvements, but should be distributed with players to test. In the end of course it could become non-optional, but for now it's suggested to provide an option

I think it's fine to implement this as an option now for testing, but endstate being integrating this change as a base. We may do it with the larger roundup of option integration before the next release.

crudelios · 2025-01-22T13:59:19Z

src/game/save_version.h

@@ -2,7 +2,7 @@
 #define GAME_SAVE_VERSION_H

 typedef enum {
-    SAVE_GAME_CURRENT_VERSION = 0x9e,
+    SAVE_GAME_CURRENT_VERSION = 0x9f,


As mentioned above, no need for save version bump.

I don't think I'm following this suggestion

crudelios · 2025-01-22T14:00:29Z

src/game/tick.c

+    int update_sentiment_cooldown = game_time_day() == 0;
+    if (update_sentiment_cooldown || game_time_day() == 8) {
+        city_sentiment_update(update_sentiment_cooldown);


Suggested change

int update_sentiment_cooldown = game_time_day() == 0;

if (update_sentiment_cooldown || game_time_day() == 8) {

city_sentiment_update(update_sentiment_cooldown);

if (game_time_day() == 0 || game_time_day() == 8) {

city_sentiment_update();

By having more granular value changes and more cooldown ticks you can still update sentiment twice a month.

If using int probably yes

src/window/config.c

…anced-tax-wage-sentiment-contribution

Keriew · 2025-01-26T14:08:51Z

src/building/state.h

@@ -11,8 +11,9 @@
 #define BUILDING_STATE_TOURISM_BUFFER_SIZE (BUILDING_STATE_ORIGINAL_BUFFER_SIZE + 6) // 134
 #define BUILDING_STATE_VARIANTS_AND_UPGRADES (BUILDING_STATE_TOURISM_BUFFER_SIZE + 2) // 136
 #define BUILDING_STATE_STRIKES (BUILDING_STATE_VARIANTS_AND_UPGRADES + 1) // 137
-#define BUILDING_STATE_SICKNESS (BUILDING_STATE_STRIKES + 5) // 142
-#define BUILDING_STATE_WITHOUT_RESOURCES (BUILDING_STATE_SICKNESS - RESOURCE_MAX_LEGACY) // 126 (plus variable resource size)
+#define BUILDING_STATE_ADV_SENTIMENT (BUILDING_STATE_STRIKES + sizeof(advanced_sentiment)) // 138


These defines here are used for the purpose of backward compatibility, the state where we actually have the newly added values never happened, so any additions to the size should be at the end of the segment.

…anced-tax-wage-sentiment-contribution

…ome pays

Keriew · 2025-02-10T20:07:54Z

src/city/sentiment.c

@@ -35,6 +37,22 @@
 #define IMPERIAL_GAMES_SENTIMENT_BONUS 15
 #define POP_STEP_FOR_BASE_AVERAGE_HOUSE_LEVEL 625

+#define min(a,b)             \


Looks like MSVC doesn't support these kind of macros, so MSVC builds fail. Could you perhaps add it as a function instead? Or maybe even just inline it. It looks like it's only being used once.

ZelionD added 20 commits January 12, 2025 09:08

introduce advanced tax & wage contribution logic

d751924

replace & with and word

e8eb3f8

introduce faster sentiment drop, refactoring

1bc7bef

add missed ini key entry

51fde7b

move advanced tax and wage logic to difficulty tab

04c5d91

add faster sentiment gain, new gain/loss logic is enabled only after …

618838e

…30 months passed

adjust gain/drop modifiers by difficulty

9a7f864

make changes to the comments

dc46c8b

fix example Keriew#2 in explanation comment

91135dc

add new sentiment change logic cooldown for newly built houses

57a99e0

prevent compile warning by add a name to union (extra_attr) which sha…

4979e7e

…res storage_id/sentiment_cooldown

fix an issue with storage_id for buildings which are not storage kind

f154f23

Merge branch 'master' of github.com:ZelionD/augustus into feature/adv…

2e34ea6

…anced-tax-wage-sentiment-contribution

move advanced sentiment variable to it's own property and bump save f…

990456a

…ile version to 0x9f

Merge branch 'master' of github.com:ZelionD/augustus into feature/adv…

ebdaa02

…anced-tax-wage-sentiment-contribution

revert cross-compilation changes accidentally commited

a45a2f8

fix load order from file

58eebdf

name struct advanced_sentiment

59c1c30

simplify a logic for gain/loss sentiment points, lower punishment

c834aad

update examples for gain/loss house happiness

17db04d

crudelios requested changes Jan 22, 2025

View reviewed changes

Merge branch 'master' of github.com:ZelionD/augustus into feature/adv…

1950d23

…anced-tax-wage-sentiment-contribution

Keriew reviewed Jan 26, 2025

View reviewed changes

ZelionD added 7 commits February 3, 2025 15:22

Merge branch 'master' of github.com:ZelionD/augustus into feature/adv…

f9e1f11

…anced-tax-wage-sentiment-contribution

apply suggestions

db4c714

rename building_is_storage_kind to building_uses_storage

cc909fe

remove redundant comment

8993c5c

apply suggestion for population check instead of months

d7bbfb7

make wage interval a preprocessor definition

5876bde

add early return for case when wages set to exactly the same amount R…

4e8dff6

…ome pays

replace shr by div

a5e5c5d

Keriew reviewed Feb 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce advanced tax & wage contribution logic #1163

Introduce advanced tax & wage contribution logic #1163

ZelionD commented Jan 12, 2025 •

edited

Loading

crudelios left a comment

crudelios Jan 22, 2025

ZelionD Jan 22, 2025

crudelios Jan 22, 2025

ZelionD Jan 22, 2025

crudelios Jan 22, 2025

ZelionD Jan 22, 2025

crudelios Jan 26, 2025

crudelios Jan 22, 2025

ZelionD Jan 22, 2025

crudelios Jan 22, 2025

crudelios Jan 22, 2025

crudelios Jan 22, 2025

ZelionD Jan 22, 2025

Keriew Jan 26, 2025

crudelios Jan 22, 2025

ZelionD Jan 22, 2025

crudelios Jan 22, 2025

ZelionD Jan 22, 2025

Keriew Jan 26, 2025 •

edited

Loading

Keriew Feb 10, 2025

		@@ -205,6 +220,7 @@ building *building_create(building_type type, int x, int y)

		// subtype
		if (building_is_house(type)) {

	if (building_is_house(type)) {
	if (building_is_house(type) && b->subtype.house_level < HOUSE_SMALL_VILLA) {

	int building_is_storage_kind(building_type type)
	int building_uses_storage(building_type type)

		#define ADVANCED_SENTIMENT_COOLDOWN_MAX_TICKS 7
		#define ADVANCED_SENTIMENT_COOLDOWN_TICK_MONTHS 3

Introduce advanced tax & wage contribution logic #1163

Are you sure you want to change the base?

Introduce advanced tax & wage contribution logic #1163

Conversation

ZelionD commented Jan 12, 2025 • edited Loading

Description

crudelios left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Keriew Jan 26, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZelionD commented Jan 12, 2025 •

edited

Loading

Keriew Jan 26, 2025 •

edited

Loading