GDScript GW2 API

[AsherGlick]

As of writing there is no GW2 API module written in gdscript, There are some features for both existing marker attributes and for future plugin API. Implementing a gdscript interface for the entire API might be a little too ambitious so we will only focus on a few of the APIs.

• [ ] Festival Marker attributes use this API to decide if some markers should be hidden or shown base on what the current festival is, if any. There is no festival API specifically, so instead we will copy what BlishHud and TacO does and check the daily achievements to see if they contain any festival achievements. https://wiki.guildwars2.com/wiki/API:2/achievements/daily Marker Attributes: Festival

  enum Festival {dragonbash, festival_of_the_four_winds, halloween, ...}
  func getCurrentFestival() -> Festival:
  ...

• [ ] Achievements Marker attributes use this API to decide if some markers should be hidden or shown based on what achievements the player has completed or not completed. https://wiki.guildwars2.com/wiki/API:2/account/achievements Marker Attributes: AchievementBit, AchievementId

  func getAchievement(id: int, bit: int|null) -> bool:
  if bit == null:
      return _getAchievementJSON(id)["done"]
  else:
      return bit in _getAchievementJSON(id)["bits"]

• [ ] Daily Crafting This could be used to make a plugin that shows the user what they have crafted for the day, or a list of what they have not yet crafted for the day. https://wiki.guildwars2.com/wiki/API:2/dailycrafting (for the list of possible daily crafting) https://wiki.guildwars2.com/wiki/API:2/account/dailycrafting (for the list things the account has crafted today)

  func getDailyCrafting() -> {crafted :[], remaining:[]}:
  ...

• [ ] Dungeons This could be used to make a plugin that shows the user which dungeons they have left to complete that day. https://wiki.guildwars2.com/wiki/API:2/account/dungeons TODO: Psuedocode

• [ ] MapChests https://wiki.guildwars2.com/wiki/API:2/account/mapchests TODO: Psuedocode

• [ ] Inventory https://wiki.guildwars2.com/wiki/API:2/account/bank https://wiki.guildwars2.com/wiki/API:2/account/materials https://wiki.guildwars2.com/wiki/API:2/account/inventory We might be able to do a pretty neat thing where we only expire data for the character you are logged in on, allowing us to cache alternate character's inventories for longer. https://wiki.guildwars2.com/wiki/API:2/account/legendaryarmory TODO: Psuedocode

• [ ] Raids This could be used to make a plugin that shows the user which raid bosses they have left to complete that week https://wiki.guildwars2.com/wiki/API:2/account/raids TODO: Psuedocode

• [ ] World Bosses This could be used to make a plugin that shows the user which world bosses they have left to beat that day. https://wiki.guildwars2.com/wiki/API:2/account/worldbosses TODO: Psuedocode

This list may change, Festival and Achievements are required for marker attribute support but the others probably wont get implemented until after #21 is completed.

[dlamkins]

Hey, just a heads up regarding the active festival. Sometime last year, a change was made to the achievements API, which unintentionally began showing more achievements than should be visible, making festival detection no longer possible with this method.

With API fixes and development fairly slow on the ANET side, we've opted to resolve this ourselves with our own endpoint. Burrito is more than welcome to use this endpoint as well if you would like.

https://l.blishhud.com/general/getActiveFestivals

Implementation details are visible here: https://github.com/blish-hud/bhud-functions/blob/main/general/GetActiveFestivals.cs

Essentially, we perform the old method of the lookup. If we detect that all festivals are active (which should not be possible), we fall back to a manually updated field. This allows us to return to the previous method once the API changes are corrected without needing an application update. The response is an array of festival names. Of course, you should only expect it to contain one value currently, but it returns an array in case something new is introduced in the future.

This is an issue that I don't believe has yet been addressed by TacO directly, so I don't believe it is accurately handling the festival flag at this time.

Let me know if you have any questions. 👍

[AsherGlick]

Thanks @dlamkins. We will probably end up doing the same thing and falling back on your or another alternative endpoint. How do you keep your active festival endpoint up to date? Is it a manual process?

[dlamkins]

Yes, it's a manual process at this time. I've considered looking at performing some sort of evaluation with the wiki (or some other source), but currently, updating the endpoint every few weeks manually is a lot less time-consuming than devising another solution (at least so far). 😄

[AsherGlick]

We will probably use your blishhud API as a fallback at first, and maybe forever. I also opened a PR that has some festival wiki parsing stuff in it to possibly automate that or a similar API. Though it is still unknown if the automation will be stable or if it is just going to be a more complicated version of "manually updating every few weeks" due to breakages in the automation's assumptions every time a new festival is announced.