Gens Rewards
Sets what each Gens ranking place gets, how often (monthly or weekly) and on which days players can claim it at their Gens steward. Loads with the GameServer and with /reload plugins.
File Location#
Data/Plugins/Characters/GensRewards.xml
Dependencies#
- EventItemBagManager.xml - every
Bagindex must be listed there, with its bag file inData/EventItemBag/. The shipped bags are 320-327. GameServer/Data/GameServerInfo - Common.dat-GensSystemSwitchmust be1.GensSystemStartRewardDay/GensSystemFinalRewardDayare not used while this file is enabled.- DataServer 2.1.0 or newer and the database migration
0010_gens_reward_period.sql. Without them no ranking is frozen and every claim is refused.
How It Works#
- At the start of every period (the first day of the month, or Monday for
Weekly, server local time) the server freezes the Gens ranking. Every member with at leastMinPointscontribution gets a place inside their own family (Vanert or Duprian), highest points first. Members with the same points share a place. - On the claim days of that period a player talks to their own family's steward and claims the reward of their frozen place. One claim per character per period.
- The reward is one roll of an item bag. Every item goes straight into the inventory.
Points earned after the freeze count for the next period.
Configuration#
<GensRewards>#
| Attribute | Type | Range | Default | Effect |
|---|---|---|---|---|
Enabled | 0/1 | 0-1 | 0 | 1 = this file decides the rewards. 0 or no file = the old fixed rewards: places 1-8 only, Jewellery Cases, claim days from Common.dat |
Period | text | Monthly, Weekly | Monthly | How often the ranking is frozen and a new claim opens |
ClaimFromDay | int | Monthly 1-31, Weekly 1-7 | 1 | First claim day. Weekly: 1 = Monday, 7 = Sunday |
ClaimToDay | int | Monthly 1-31, Weekly 1-7 | 7 | Last claim day, same scale |
MinPoints | int | 0 and up | 10000 | Contribution points needed to get a place. 10000 is the official rule: below it a member has a title by points but no place |
<Reward>#
One row per place or range of places. Up to 32 rows.
| Attribute | Type | Range | Default | Effect |
|---|---|---|---|---|
Places | text | "3" or "2-5" | - | Frozen place(s) this row pays. A place without a row gets nothing |
Bag | int | EventItemBagManager index | - | Bag rolled once per claim. Its ItemDropCount is the number of items given (up to 32) |
Important Behavior#
- The claim is refused when the inventory has fewer free cells than the number of items the bag gives. Nothing is used up; the player can claim again after making room.
- A player who left their family and joined the other one after the freeze cannot claim that period.
- The freeze runs once per period even with several GameServers or restarts. A GameServer started in the middle of a period freezes the ranking right away the first time the file is enabled.
- Switching
PeriodbetweenMonthlyandWeeklyfreezes a new ranking at once. - Titles (Grand Duke ... Private) do not change with this file. They still follow the fixed game rule: 10,000+ points rank by place, below that by points.
Examples#
<GensRewards Enabled="1" Period="Monthly" ClaimFromDay="1" ClaimToDay="7" MinPoints="10000">
<Reward Places="1" Bag="320"/>
<Reward Places="2-5" Bag="321"/>
<Reward Places="6-10" Bag="322"/>
<Reward Places="11-30" Bag="323"/>
<Reward Places="31-50" Bag="324"/>
<Reward Places="51-100" Bag="325"/>
<Reward Places="101-200" Bag="326"/>
<Reward Places="201-300" Bag="327"/>
</GensRewards>
The shipped bags give the old fixed rewards:
| Bag | Places | Items |
|---|---|---|
| 320 | 1 | 30 x Shining Jewellery Case |
| 321 | 2-5 | 20 x Shining Jewellery Case |
| 322 | 6-10 | 20 x Elegant Jewellery Case |
| 323 | 11-30 | 10 x Elegant Jewellery Case |
| 324 | 31-50 | 10 x Steel Jewellery Case |
| 325 | 51-100 | 5 x Steel Jewellery Case |
| 326 | 101-200 | 5 x Old Jewellery Case |
| 327 | 201-300 | 3 x Old Jewellery Case |
<GensRewards Enabled="1" Period="Weekly" ClaimFromDay="6" ClaimToDay="7" MinPoints="5000">
<Reward Places="1" Bag="320"/>
<Reward Places="2-10" Bag="321"/>
</GensRewards>
Common Issues#
| Symptom | Cause | Fix |
|---|---|---|
| Every claim says "not eligible" | No ranking frozen yet: DataServer older than 2.1.0 or migration 0010_gens_reward_period.sql not run | Update the DataServer, run the migration, restart. The DataServer log shows [GensReward] Ranking frozen for period ... when it works |
| "Not eligible" for one player | Fewer than MinPoints points at the freeze, a place with no <Reward> row, or changed family since | Expected. The player can claim next period |
GameServer log: Bag N for place P gave no item | Bag index missing from EventItemBagManager.xml or its bag file is empty | Add the bag row and file, then restart (bags load at start) |
| The steward refuses the claim on some days | Today is outside ClaimFromDay-ClaimToDay | Expected |