pkg.gl

Bounce Send this message to the server, tell it which clients should receive the message and the server will forward the message to all those targets to which any one requirement applies.

Bounced

Bounced Sent to clients after a client requested this message be sent to them, more info in the Bounce package.

Command

Command defines model for Command.

Connect

Connect Sent by the client to initiate a connection to an Archipelago game session.

Connected

Connected Sent to clients when the connection handshake is successfully completed.

ConnectionRefused

ConnectionRefused Sent to clients when the server refuses connection.

ConnectUpdate

ConnectUpdate Update arguments from the Connect package, currently only updating tags and items_handling is supported.

DataPackage

DataPackage Sent to clients to provide what is known as a 'data package' which contains information to enable a client to most easily communicate with the Archipelago server.

DataPackageObject

DataPackageObject defines model for DataPackageObject.

DataStorageOperation

DataStorageOperation A DataStorageOperation manipulates or alters the value of a key in the data storage.

DeathLink

DeathLink defines model for DeathLink.

GameData

GameData defines model for GameData.

Get

Get Used to request a single or multiple values from the server's data storage, see the Set package for how to write values to the data storage.

GetDataPackage

GetDataPackage Requests the data package from the server.

Hint

Hint An object representing a Hint.

InvalidPacket

InvalidPacket Sent to clients if the server caught a problem with a packet.

JSONMessagePart

JSONMessagePart Message nodes sent along with PrintJSON packet to be reconstructed into a legible message.

LocationChecks

LocationChecks Sent to server to inform it of locations that the client has checked.

LocationInfo

LocationInfo Sent to clients to acknowledge a received LocationScouts packet and responds with the item in the location(s) being scouted.

LocationScouts

LocationScouts Sent to the server to retrieve the items that are on a specified list of locations.

NetworkItem

NetworkItem Items that are sent over the net (in packets) use the following data structure and are sent as objects:.

NetworkPlayer

NetworkPlayer A list of objects.

NetworkSlot

NetworkSlot An object representing static information about a slot.

NetworkVersion

NetworkVersion An object representing software versioning.

PrintJSON

PrintJSON Sent to clients purely to display a message to the player.

ReceivedItems

ReceivedItems Sent to clients when they receive an item.

Retrieved

Retrieved Sent to clients as a response the a Get package.

RoomInfo

RoomInfo Sent to clients when they connect to an Archipelago server.

RoomUpdate

RoomUpdate Sent when there is a need to update information about the present game session.

Say

Say Basic chat command which sends text to the server to be distributed to other clients.

Set

Set Used to write data to the server's data storage, that data can then be shared across worlds or just saved for later.

SetNotify

SetNotify Used to register your current session for receiving all SetReply packages of certain keys to allow your client to keep track of changes.

SetReply

SetReply Sent to clients in response to a Set package if want_reply was set to true, or if the client has registered to receive updates for a certain key using the SetNotify package.

StatusUpdate

StatusUpdate Sent to the server to update on the sender's status.

Sync

Sync Sent to server to request a ReceivedItems packet to synchronize items.

UpdateHint

UpdateHint Sent to the server to update the status of a Hint.