council meeting

Author: Trolldemorted

src/SUMMARY.md

@@ -20,6 +20,7 @@
     - [Update Shipyard Experience](./scheduled-tasks/0006-update-shipyard-experience.md)
     - [Celebration](./scheduled-tasks/0007-celebration.md)
     - [Update Sailor Pools](./scheduled-tasks/0026-update-sailor-pools.md)
+    - [Council Meeting](./scheduled-tasks/002e-council-meeting.md)
     - [Unfreeze Port](./scheduled-tasks/0053-unfreeze-port.md)
 - [Towns](./towns.md)
     - [Ticks](./towns/ticks.md)

src/operations/0048-make-town-hall-offer.md

@@ -17,8 +17,8 @@ struct operation_48_make_town_hall_offer
 ```
 
 ## Normal Towns
-For normal towns a *Council Meeting* scheduled task is scheduled at `0xE00` ticks (14 days) ahead.
+For normal towns a *Council Meeting* scheduled task is scheduled at the given *meeting timestamp*.
 
 ## Hanseatic Settlements
 Hanseatic settlements have no council and expand military or enlarge town wall offers.
-A change to the head tax is applied immediately, and an *Extra Tax* scheduled task is scheduled at the next tick.
+A change to the head tax is applied immediately, an *Extra Tax* scheduled task is scheduled at the next tick.

src/scheduled-tasks/002e-council-meeting-approved-limits.png

@@ -0,0 +1,90 @@
+# Council Meeting
+The `handle_st_2e_council_meeting` function at `0x004E9A94` handles the entire council meeting voting process by rescheduling itself multiple times.
+
+```c
+struct scheduled_task_2e_council_meeting
+{
+  signed __int32 field_0_extra_tax_amount;
+  unsigned __int8 field_4_town_index;
+  council_meeting_type field_5_meeting_type;
+  char field_6_pending_yes;
+  char field_7_pending_no;
+  unsigned __int8 field_8_yes;
+  unsigned __int8 field_9_no;
+  char field_A_maybe_abstain;
+  unsigned __int8 field_B_player_vote_bitmask;
+  signed __int16 field_C_tax_per_head_amount;
+  char field_E_merchant_index;
+  char field_F;
+};
+```
+
+## First Execution
+On the first tick of the day (and thus the first tick of the meeting), the task is initialized:
+- `pending_no` is set to `22`.
+- `pending_no` is decreased by `1` for every bribed councillor.
+- For every player merchant:
+    - If the merchant is a councillor or higher, a notification is sent to the player.
+    - `pending_no` is decreased by `1` for a councillor, by `2` for a patrician and mayor, and by `3` for an alderman.
+- Should `pending_no` be smaller than `4`, it is set to `4`.
+
+Afterwards the offer-specific votes in favour are determined, and the task is rescheduled at 4 ticks in the future.
+
+### Extra Tax
+TODO
+
+### Enlarge Town Walls
+TODO
+
+### Expand Military
+The expand military voting behaviour is calculated as follows:
+```python
+if town.is_under_siege():
+    total_citizens *= 2
+
+t = 512 - 203 * town.approved_militia_size + total_citizens
+if t < 100:
+    pending_yes = pending_no // 10
+elif t <= 920:
+    pending_yes = pending_no * t // 256
+else:
+    pending_yes = 9 * pending_no // 10
+
+pending_no -= pending_yes
+```
+
+This causes the following relationship of citizens and military size:
+![](002e-council-meeting-approved-limits.png)
+
+### Change Tax per Head
+TODO
+
+## Subsequent Executions
+If `pending_no` and `pending_yes` are bigger than `0`, the yes vote count is increased if the following formula is true:
+```python
+yes + 3 * pending_yes <= no + 3 * pending_no
+```
+Otherwise the no vote count is increased.
+
+If only one of `pending_no` and `pending_yes` is bigger than `0`, the corresponding vote count is increased.
+
+If both `pending_no` and `pending_yes` are `0`, no vote count is increased.
+
+If the least significant byte of the timestamp is smaller than `0xDC`, the scheduled task is rescheduled at 4 ticks in the future.
+Otherwise the task is rescheduled at the next tick.
+
+
+## Final Execution and Result
+During the execution of the task on the first tick of the following day the result of the ballot is determined and applied.
+
+### Extra Tax
+TODO
+
+### Enlarge Town Walls
+TODO
+
+### Expand Military
+If the town's old approved military size is below `0x8000`, it is increased by `10`.
+
+### Change Tax per Head
+TODO

src/scheduled-tasks/002e-council-meeting.md

@@ -0,0 +1,56 @@
+import matplotlib.pyplot as plt
+import numpy as np
+
+
+def is_upgrade_approved(rank: int, total_citizens: int, old_approved_size: int, under_siege: bool) -> bool:
+    no = 22
+    # Assuming no bribes
+    # Assuming singleplayer
+    if rank == 4:
+        no -= 1 # Councillor
+    elif rank == 5:
+        no -= 2 # Patrician
+    else:
+        no -= 3 # Mayor/Alderman
+
+    if under_siege:
+        total_citizens *= 2
+
+    t = 512 - 203 * old_approved_size + total_citizens
+    if t < 100:
+        yes = no // 10
+    elif t <= 920:
+        yes = no * t >> 10
+    else:
+        yes = 9 * no // 10
+    no -= yes
+    
+    if rank == 4:
+        yes += 1
+    else:
+        yes += 3
+
+    return yes > no
+
+
+def plot_approved_limit_per_citizens():
+    plt.clf()
+    plt.title("Militia Expansion Votes (Singleplayer, Alderman, No Bribes)")
+    plt.xlabel("Total Citizens")
+    plt.ylabel("Approved Size")
+    x_data = []
+    y_data = []
+
+    for x in range(1_000, 6_000):
+        x_data.append(x)
+        for old_approved_size in range(1, 100).__reversed__():
+            if is_upgrade_approved(7, x, old_approved_size, False):
+                y_data.append(old_approved_size)
+                break
+
+
+    plt.plot(x_data, y_data, linewidth=1)
+    plt.savefig("002e-council-meeting-approved-limits.png", dpi=200)
+
+
+plot_approved_limit_per_citizens()