getting-started:example-lobby-browser

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
getting-started:example-lobby-browser [2025-12-06 02:48] nimdagetting-started:example-lobby-browser [2025-12-06 03:41] (current) nimda
Line 9: Line 9:
   * **[[rlink:community:start|Community API]]** - Public, unauthenticated access to lobby listings   * **[[rlink:community:start|Community API]]** - Public, unauthenticated access to lobby listings
   * **[[rlink:game:start|Game API]]** - Authenticated access to ongoing matches and detailed game data   * **[[rlink:game:start|Game API]]** - Authenticated access to ongoing matches and detailed game data
 +
 +For simpler integration, you can also use the **[[https://wiki.librematch.org/getting-started/example-lobby-browser#alternativewebsocket_api|aoe2lobby.com WebSocket API]]** which provides real-time updates without polling.
  
 ===== Quick Start: Community API ===== ===== Quick Start: Community API =====
Line 208: Line 210:
   * Provides schema information on connection   * Provides schema information on connection
   * Free to use for community projects   * Free to use for community projects
 +  * Live for 8+ months with proven reliability
 +
 +==== Connection ====
 +
 +**WebSocket URL:** <code>wss://data.aoe2lobby.com/ws/</code>
 +
 +The API supports subscribing to different data feeds by sending JSON subscription messages.
 +
 +==== Subscription Examples ====
 +
 +**Subscribe to spectate matches:**
 +<code json>
 +{"action":"subscribe","type":"matches","context":"spectate"}
 +</code>
 +
 +**Subscribe to lobby matches:**
 +<code json>
 +{"action":"subscribe","type":"matches","context":"lobby"}
 +</code>
 +
 +**Subscribe to specific Elo types:**
 +<code json>
 +{"action":"subscribe","type":"elotypes","context":"lobby","ids":["1223","3","4"]}
 +</code>
 +
 +**Subscribe to specific players:**
 +<code json>
 +{"action":"subscribe","type":"players","context":"lobby","ids":["3920944"]}
 +</code>
 +
 +Player status updates include current status, match ID, and Steam lobby ID:
 +<code json>
 +{
 +  "player_status": {
 +    "19501096": {
 +      "status": "lobby",
 +      "matchid": "412015195",
 +      "steam_lobbyid": "109775244730862406"
 +    }
 +  }
 +}
 +</code>
 +
 +==== Resources ====
  
-**Resources:** 
   * Instructions: aoe2lobby.com chat section   * Instructions: aoe2lobby.com chat section
-  * Discord support: https://discord.gg/8BAShCGS+  * Discord support: [[https://discord.gg/8BAShCGS|aoe2lobby Discord]]
  
 ===== Best Practices ===== ===== Best Practices =====
 +
  
 <WRAP center round important 60%> <WRAP center round important 60%>
Line 245: Line 291:
 ==== Documentation & Projects ==== ==== Documentation & Projects ====
  
-  * **LibreMatch Wiki:** [[https://wiki.librematch.org/rlink/game/start|RLINK documentation]]+ 
 +  * **Lib:reMatch Steam-Auth:** [[https://github.com/librematch/librematch-steam_auth|Reference implementation (Python)]] 
 +  * **Lib:reMatch OAPI-RLINK-Client:** [[https://github.com/librematch/librematch-rlink_client|Generated example python client incl. openapi.yaml]] 
 +  * **Lib:reMatch Wiki:** [[https://wiki.librematch.org/rlink/game/start|RLINK documentation]]
   * **ageLANServer:** [[https://github.com/luskaner/ageLANServer|Open source server implementation]] with model definitions   * **ageLANServer:** [[https://github.com/luskaner/ageLANServer|Open source server implementation]] with model definitions
   * **aoe2lobby.com:** WebSocket API for easier integration   * **aoe2lobby.com:** WebSocket API for easier integration
  • getting-started/example-lobby-browser.1764985707.txt.gz
  • Last modified: 5 months ago
  • by nimda