Skip to main content

Unity Engine

Today: REST API​

Call the AyakaMods REST API from Unity via UnityWebRequest, sending the XF-Api-Key header. Works now, on any supported Unity version.

Roadmap: native plugin​

AyakaMods maintains a fork of AyakaMods's MIT-licensed Unity plugin, repointed to the AyakaMods backend. AyakaMods's Unity plugin already exposes an API Path (server URL) setting, so repointing the base URL is straightforward; the per-endpoint and JSON model mapping to AyakaMods is the remaining work.

Status: in progress. See Feature Support for what maps today.

Configuration​

  • API key (game-scoped for an official developer)
  • API Path / Base URL https://ayakamods.com/api/
  • Auth header XF-Api-Key

Live-service note​

Keep mods client-side and verify entitlement in your client before enabling the mod manager. See Ownership & Anti-Piracy.