From 698f272ddd41d5f7dec5edd000c1da774dc653b7 Mon Sep 17 00:00:00 2001 From: Melissa Geels Date: Sat, 30 May 2026 16:41:16 +0200 Subject: [PATCH 1/3] Added remarks about the room join endpoint --- docs/live/clubs/room-join-link.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/live/clubs/room-join-link.md b/docs/live/clubs/room-join-link.md index 8e0c626..c25deda 100644 --- a/docs/live/clubs/room-join-link.md +++ b/docs/live/clubs/room-join-link.md @@ -25,7 +25,9 @@ Gets a join link for a club room. **Remarks**: -- If the requested room is inactive, using this endpoint will start it. `joinLink` will be an empty string while the room isn't ready. +- If the requested room is inactive, using this endpoint will start it. `joinLink` will be an empty string while the room isn't ready, which is also reflected by `starting`. +- Nadeo's code retries the request every 2 seconds for club rooms and 5 seconds for the track of the day channel. +- You should stop retrying for a room to start when any error is returned. --- From 73a597abe6953a03b28bcb6bc5836b7bbaf39cf2 Mon Sep 17 00:00:00 2001 From: Melissa Geels Date: Sat, 30 May 2026 17:10:11 +0200 Subject: [PATCH 2/3] Added note about the starting bool --- docs/live/clubs/room-join-link.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/live/clubs/room-join-link.md b/docs/live/clubs/room-join-link.md index c25deda..11893f6 100644 --- a/docs/live/clubs/room-join-link.md +++ b/docs/live/clubs/room-join-link.md @@ -26,6 +26,7 @@ Gets a join link for a club room. **Remarks**: - If the requested room is inactive, using this endpoint will start it. `joinLink` will be an empty string while the room isn't ready, which is also reflected by `starting`. +- `starting` may still be `true` even though a `joinLink` has already been assigned, which means the server is still starting. At that point, Nadeo's code will stop calling this endpoint entirely and instead query the server directly using [CGameManiaTitleControlScriptAPI::GetServerInfo](https://next.openplanet.dev/Game/CGameManiaTitleControlScriptAPI#:~:text=GetServerInfo). - Nadeo's code retries the request every 2 seconds for club rooms and 5 seconds for the track of the day channel. - You should stop retrying for a room to start when any error is returned. From 7c78597b78ec0c0ac82a2811533ffbaea3850e21 Mon Sep 17 00:00:00 2001 From: Melissa Geels Date: Sat, 30 May 2026 17:26:05 +0200 Subject: [PATCH 3/3] Remove link and replace with explanation for external apps --- docs/live/clubs/room-join-link.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/live/clubs/room-join-link.md b/docs/live/clubs/room-join-link.md index 11893f6..b21584d 100644 --- a/docs/live/clubs/room-join-link.md +++ b/docs/live/clubs/room-join-link.md @@ -26,7 +26,7 @@ Gets a join link for a club room. **Remarks**: - If the requested room is inactive, using this endpoint will start it. `joinLink` will be an empty string while the room isn't ready, which is also reflected by `starting`. -- `starting` may still be `true` even though a `joinLink` has already been assigned, which means the server is still starting. At that point, Nadeo's code will stop calling this endpoint entirely and instead query the server directly using [CGameManiaTitleControlScriptAPI::GetServerInfo](https://next.openplanet.dev/Game/CGameManiaTitleControlScriptAPI#:~:text=GetServerInfo). +- `starting` may still be `true` even though a `joinLink` has already been assigned, which means the server is still starting. At that point, Nadeo's code will stop calling this endpoint entirely and instead query the server directly with a maximum retry count. Querying like this can't really be replicated from external applications, so it should be fine to rely on `starting` instead. - Nadeo's code retries the request every 2 seconds for club rooms and 5 seconds for the track of the day channel. - You should stop retrying for a room to start when any error is returned.