Skip to main content

Mod Manager / Launcher Integration

For third-party tools (Vortex-style managers, launchers, Discord bots) that browse mods across all games on AyakaMods.

Getting a key​

This tier is issued manually so we can attach fair-use limits.

  1. Contact AyakaMods staff to request API access (link on the main site once live).
  2. Tell us: your tool's name, what it does, and roughly its expected request volume.
  3. Staff review and issue you an unrestricted key (zero game bindings = browses all public games).

Tool keys are read-only Guest keys: they see exactly what a logged-out visitor sees and cannot write anything, so shipping one inside a desktop app is acceptable. If it leaks or gets abused, we revoke it and issue a new one. See Keep your key safe.

There is no wizard for this tier - it is a short request-and-issue flow.

What your key can do​

  • List and read mods across every public game: GET mods/
  • Read categories, versions, updates, reviews, comments
  • Resolve download URLs per version

Typical flow​

  1. GET mod-games/ - list games you can offer.
  2. GET mod-games/{game_id}/mods/?order=download_count - browse one game's mods. (GET mods/ lists across all games and has no game_id filter.)
  3. GET mods/{id}/versions/ - list versions for install/update.
  4. GET mod-versions/{id}/download?file={fileId} - fetch the file, with your key.

Checking installed mods for updates​

Two cheap patterns, pick one:

  • Batch by ID. GET mods/?mod_ids=12,34,56 returns up to 100 mods in one response. Compare each mod's last_update (Unix timestamp) with the value you stored at install time. Split bigger libraries into chunks of 100.
  • Newest first, stop early. GET mods/?order=last_update&direction=desc and page until you reach mods older than your previous check.

A mod missing from the batch response is not visible to your key any more (removed, moderated or NSFW-excluded). Treat it as unavailable, not as an error.

Rules​

  • Always fetch downloads through the API download endpoint, never a cached raw URL - see Acceptable Use.
  • Poll politely: check on launch or on a timer measured in minutes, not seconds, and cache responses. See Acceptable Use.
  • Attribute AyakaMods as the source in your UI.