Feat: Area Ranks #671

RyanYappert · 2024-12-27T10:57:55Z

Implements Area Ranks and their associated unlocks.

Finishes packet structures for several area-rank related packets.
Adds, upgrades, and migrates from pcaps handlers for various area-rank related features:
- Fetching Area Ranks, related unlocks, and the area spot information.
- Fetching the Area Supply items that a player is eligible for, as well as obtaining those items from the area supply.
- Gaining Area Points and ranking up.
Adds database structures for area ranks ddon_area_rank and waiting supply items ddon_area_rank_supply.
- This migrates DB version 27 -> 28
Adds scheduled task for the weekly area rank support. This includes both the weekly point rollover and the distribution of supplies.
- This occurs on Mondays at 5 am by default.
- Adds RPC internal commands to support the notifying of non-head servers of this event.
Adds /areapoint [areaId] [amount] as a debug command.
Adds AreaRankSpotInfoAsset, AreaRankRequirementAsset, and AreaRankSupplyAsset.
- The SpotInfo and Requirement assets are serverside copies of information the client uses in the UI without prompting. These "define" what things unlock when, and what point totals or quests are needed to progress to a certain rank. As such, these largely should not be altered.
- The Supply asset defines the slate of area rank supply rewards for combinations of weekly point totals and area rank. These can be freely altered.
Adds Area Point support for quests, by the (possibly abusive) new PointType.
- Based on wiki-crawled values, the reward for a given quest seems to be based entirely on the quest's recommended level and area. For S2/S3 areas, all quests reward a flat 500 points. For S1 areas, this curve seemed to be based on pre-relaxation values that seemed to reward very large amounts of AP relative to the rank requirements. Since the rank requirements seem roughly similar in magnitude between S1/S2/S3, the curve was flattened so that high level S1 quests do not reward such absurd AP amounts.
- A quest's "tier" is floor(level/5). It's AP is then 5*tier^2 + 5*tier + 30.
  - The original curve is 10*tier^2 + 10*tier + 30
- ~~Existing world and board quests have had AP rewards added based on this curve. This is why it touches 700+ files, sorry.~~
  - Existing world quests will automatically get AP added to them if they don't have an entry listed. Board quests have been modified manually because they need it as part of a data structure and its a bit of a pain to sneak it in.
  - Board quests reward half as much AP as world quests.
- EnableAreaRankSpotLocks has been added to the GameLogicSettings. When this is true, the full area rank system is implemented. When false, all spot unlocks are granted automatically; this does cause some UI weirdness with the Area List, but should be functionally fine.

To-Do:

AreaGetAreaQuestHintListHandler is a very bizarre system and the way that we track quests and alert the client to them is somehow not working the way it wants. Luckily, this system is dumb and terrible, and we can probably safely ignore it.
- For the moment, this handler always returns an empty list of quest hints, which the client interprets as "this feature is currently not available" and the option in the UI is grayed out.
Area Rank 11 apparently releases all the unreleased warp points in an area; I or somebody has to write that map if we want to bother with that reward.
S1 has 47 area trials; S2 has 26, S3 has 8. Now that the systems are done, I can write those.

Checklist:

The project compiles
The PR targets develop branch

Arrowgene.Ddon.Database/Files/Database/Script/migration_arearank.sql

Arrowgene.Ddon.GameServer/Chat/Command/Commands/AreaPointCommand.cs

Arrowgene.Ddon.Shared/Entity/Structure/CDataAreaRankSeason3.cs

Arrowgene.Ddon.Shared/Entity/Structure/CDataCycleContentsNews.cs

Arrowgene.Ddon.Shared/Entity/Structure/CDataCycleContentsRank.cs

alborrajo · 2024-12-27T13:24:06Z

Arrowgene.Ddon.GameServer/Handler/AreaGetAreaSupplyHandler.cs

+            {
+                19 => true,
+                20 => false,
+                _ => throw new ResponseErrorException(ErrorCode.ERROR_CODE_AREAMASTER_INVALID_SUPPLY_STORAGE),


We've seen this 19/20 values meaning to bag/to storage a lot, maybe it should be time to move them into an enum? 🤔

I agree, but do we know what it really means?

Besides 19 meaning bag and 20 being storage, not really, maybe the mobile app has some answers

Arrowgene.Ddon.GameServer/Handler/AreaGetAreaSupplyInfoHandler.cs

Arrowgene.Ddon.GameServer/Handler/AreaGetLeaderAreaReleaseListHandler.cs

Arrowgene.Ddon.Shared/Entity/EntitySerializer.cs

pacampbell · 2024-12-27T21:10:48Z

Arrowgene.Ddon.GameServer/Handler/AreaGetAreaSupplyHandler.cs

+            {
+                19 => true,
+                20 => false,
+                _ => throw new ResponseErrorException(ErrorCode.ERROR_CODE_AREAMASTER_INVALID_SUPPLY_STORAGE),


I agree, but do we know what it really means?

Arrowgene.Ddon.GameServer/Quests/QuestStateManager.cs

pacampbell · 2024-12-27T21:19:41Z

Arrowgene.Ddon.Shared/Files/Assets/quests/q20000002.json

@@ -61,8 +65,16 @@
        {
          "type": "MyQstFlags",
          "announce_type": "Accept",
-          "set_flags": [ 6 ],
-          "check_flags": [ 1, 2, 3, 4, 5 ]
+          "set_flags": [


These JSON formatting changes made to all these quests makes it harder to read which is important since we are hand writing all these quests.

The problem is that any change I make programmatically re-formats the JSON to "standard" JSON. Maybe there's some option in Python's json module that I'm not using, but the alternative is hand-adding rewards to 237 world quests, or doing area-points programmatically on deserializing the asset, which I didn't like conceptually.

…when using a master craft pawn, clean up skill assets, fix missing serializer from sebastian-heinz#671.

alborrajo · 2024-12-30T15:04:21Z

Arrowgene.Ddon.GameServer/Characters/AreaRankManager.cs

+                throw new ResponseErrorException(ErrorCode.ERROR_CODE_AREAMASTER_SUPPLY_NOT_AVAILABLE, $"No valid asset for {areaId} found in AreaRankSupply asset.");
+            }
+
+            var rankSupplies = areaSupplies.Where(x => x.MinRank <= rank).OrderBy(x => x.MinRank).LastOrDefault();


Wouldn't it be better to use Single() instead so it also throws an exception if there's more than one?

No, because you want the last one that you qualify for.

areaSupplies .Where(x => x.MinRank <= rank) // Get all qualifying supply sets; this is usually multiple if your rank is higher than 4 or so, depending on area. .OrderBy(x => x.MinRank) // Sort from lowest required rank to highest. .LastOrDefault() // Take the highest rank qualifying supply set.

alborrajo · 2024-12-30T15:04:31Z

Arrowgene.Ddon.GameServer/Characters/AreaRankManager.cs

+                throw new ResponseErrorException(ErrorCode.ERROR_CODE_AREAMASTER_SUPPLY_NOT_AVAILABLE, $"No valid asset for {areaId}, rank {rank} found in AreaRankSupply asset.");
+            }
+
+            var pointSupplies = rankSupplies.SupplyItemInfoList.Where(x => x.MinAreaPoint <= points).OrderBy(x => x.MinAreaPoint).LastOrDefault();


Arrowgene.Ddon.GameServer/Handler/AreaGetAreaBaseInfoListHandler.cs

Arrowgene.Ddon.Shared/Entity/EntitySerializer.cs

- Find packet which controls area rank. - Implement req/res packets for area rank.

…GameRequestPacketHandlers.

… GameRequestPacketHandler; cleanup useless quests from that pcap.

…ieving supply goods, and other area rank mechanics.

…lues based on wiki-crawling.

…ions to Area Rank handlers.

…ling spots.

…opagate properly; fix DC when handing in delivery quests.

RyanYappert requested a review from pacampbell December 27, 2024 10:57

alborrajo reviewed Dec 27, 2024

View reviewed changes

pacampbell mentioned this pull request Dec 27, 2024

feat: Area Rank Exploration #605

Closed

2 tasks

pacampbell reviewed Dec 27, 2024

View reviewed changes

RyanYappert mentioned this pull request Dec 28, 2024

Fix: Entity Serializer List Cleanup #672

Merged

2 tasks

alborrajo reviewed Dec 30, 2024

View reviewed changes

pacampbell and others added 16 commits January 16, 2025 22:47

feat: Area Rank Exploration

fdec275

- Find packet which controls area rank. - Implement req/res packets for area rank.

Structures for the remaining area packets. Upgrades some handlers to …

ef43b5d

…GameRequestPacketHandlers.

Area Rank Spot Info.

e068e55

Fix serialization to JSON for CDataQuestOrderList; upgrade handler to…

495735b

… GameRequestPacketHandler; cleanup useless quests from that pcap.

Tweaks to many area rank packets and CDatas.

5cb2b29

Area Rank assets; supply and requirements.

663c04f

Area Rank stuff in the DB. Migrates DB version 27 -> 28.

3d4285b

AreaRankManager, /areapoint command, and handlers for ranking up, rec…

7f58c6c

…ieving supply goods, and other area rank mechanics.

AreaPointResetTask, every Monday at 5.

94b1904

Some cleanup on other chat commands; research on the ShopType enum.

f00885f

Add AP support to quests, provide all existing quests with some AP va…

ca0e400

…lues based on wiki-crawling.

Fix missing area ranks on character creation, add ResponseErrorExcept…

20896ec

…ions to Area Rank handlers.

Review comments.

4b13eb5

The party leader's personal quests can always drive world state.

4c9f867

Adjustments to Area Rank data structure; add toggle for ranks control…

8b60284

…ling spots.

Add fallback for quests without explicit AP rewards; revert WQ files.

453508c

RyanYappert force-pushed the feat/area_ranks branch from ee1c2a5 to d1507fc Compare January 17, 2025 08:58

Clean up rebase from hell; add areapoint and arearank commands.

a926307

RyanYappert force-pushed the feat/area_ranks branch from d1507fc to a926307 Compare January 17, 2025 09:08

RyanYappert marked this pull request as ready for review January 17, 2025 09:09

Fix typo in migration; upgrade QuestQuestProgressHandler so errors pr…

048dff9

…opagate properly; fix DC when handing in delivery quests.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Area Ranks #671

Feat: Area Ranks #671

RyanYappert commented Dec 27, 2024 •

edited

Loading

alborrajo Dec 27, 2024

pacampbell Dec 27, 2024

alborrajo Dec 30, 2024

pacampbell Dec 27, 2024

pacampbell Dec 27, 2024

RyanYappert Dec 28, 2024

alborrajo Dec 30, 2024

RyanYappert Jan 17, 2025

alborrajo Dec 30, 2024

Feat: Area Ranks #671

Are you sure you want to change the base?

Feat: Area Ranks #671

Conversation

RyanYappert commented Dec 27, 2024 • edited Loading

To-Do:

Checklist:

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

RyanYappert commented Dec 27, 2024 •

edited

Loading