For the complete documentation index, see llms.txt. This page is also available as Markdown.

Archipelago

This service is in charge of clustering users according to their position and assigning a connection string that will allow the user to connect to an specifig transport.

List of islands

get
/comms/islands

Retrieves the list of communication islands in the server with details about the peers present in each island.

Responses
200

List of Islands

application/json; charset=utf-8
okbooleanOptional
get/comms/islands
200

List of Islands

Island Details

get
/comms/islands/{islandId}

Retrieve information about the specified islandId

Path parameters
islandIdstringRequired

ID of the Island. You can search for the list of islands using the /comms/islands endpoint.

Example: I5n
Responses
200

Island details

application/json; charset=utf-8
idstringOptional
maxPeersnumberOptional
centernumber[]Optional
radiusnumberOptional
get/comms/islands/{islandId}
200

Island details

List of peers

get
/comms/peers

Retrieves the list peers in the server with details about their positions and islands.

Responses
200

List of Peers

application/json; charset=utf-8
okbooleanOptional
get/comms/peers
200

List of Peers

Last updated