GenshinUID

API compatibility

• Protocol: onebot.v11
• Transport: reverse-websocket (OneBots connects to the framework WebSocket server)
• The Application does not invent framework-specific actions. Standard actions stay in the protocol; platform-specific actions are forwarded only when the selected Adapter exposes them.
• The genshinuid extension adds framework compatibility only. It does not enable a transport or edit account configuration.

Generate both configurations

onebots frameworks --framework genshinuid --account <platform.account_id>

For separate hosts, add --origin http://<onebots-host>:6727 and --framework_origin http://<framework-host>:<port>. The output contains the exact OneBots YAML, GenshinUID configuration, endpoint, and checks.

Configure OneBots

plugins:
  adapters: [<adapter>]
  protocols: [onebot-v11]
  applications: [genshinuid]

<platform>.<account_id>:
  account_id: <account_id>
  # Add the Adapter credentials documented for the platform.
  onebot.v11:
    use_http: false
    use_ws: false
    use_ws_reverse: true
    ws_reverse_url: <framework-websocket-url>
    access_token: <shared-token>

onebots ui --data-dir /path/to/onebots-data

Copy the generated “GenshinUID configuration” into the framework project. Keep the protocol, endpoint, and token identical on both sides. In containers, use a reachable service name instead of 127.0.0.1 for another container.

Verify and repair

onebots doctor --data-dir /path/to/onebots-data
onebots frameworks --framework genshinuid --account <platform.account_id>

Symptom	Fix
plugin load failure	Select the named extension in the installation plan, then verify and activate the candidate runtime
refused connection / 404	Fix host, port, account path; for forward WS explicitly set use_ws: true
reverse WS absent	Start the framework listener first and correct ws_reverse_url
401	Make both tokens identical and remove stale environment overrides
Unknown action	Check required/missing actions and Adapter capabilities; disable the dependent plugin or implement a real Application conversion
connected without events	Repair account login, platform subscriptions/permissions, and event filters

See the framework troubleshooting guide for command-level diagnosis.