api

type Bounce struct {
	Cmd string `json:"cmd"`

	// Data The data in the Bounce package copied
	Data map[string]interface{} `json:"data"`

	// Games Optional. Game names this message is targeting
	Games *[]string `json:"games,omitempty"`

	// Slots Optional. Player slot IDs that this message is targeting
	Slots *[]string `json:"slots,omitempty"`

	// Tags Optional. Client Tags this message is targeting
	Tags *[]Tags `json:"tags,omitempty"`
}

type Bounced struct {
	Cmd string `json:"cmd"`

	// Data The data in the Bounce package copied
	Data map[string]interface{} `json:"data"`

	// Games Optional. Game names this message is targeting
	Games *[]string `json:"games,omitempty"`

	// Slots Optional. Player slot IDs that this message is targeting
	Slots *[]string `json:"slots,omitempty"`

	// Tags Optional. Client Tags this message is targeting
	Tags *[]Tags `json:"tags,omitempty"`
}

type ClientStatus int

type Command struct {
	// contains filtered or unexported fields
}

type CommandKeys string

type Commands = []Command

type Connect struct {
	Cmd string `json:"cmd"`

	// Game The name of the game the client is playing. Example: A Link to the Past
	Game string `json:"game"`

	// ItemsHandling Flags configuring which items should be sent by the server. Read below for individual flags.
	ItemsHandling ItemHandlingFlag `json:"items_handling"`

	// Name The player name for this client.
	Name string `json:"name"`

	// Password If the game session requires a password, it should be passed here.
	Password string `json:"password"`

	// SlotData If true, the Connect answer will contain slot_data
	SlotData bool `json:"slot_data"`

	// Tags Denotes special features or capabilities that the sender is capable of. Tags
	Tags []Tags `json:"tags"`

	// Uuid Unique identifier for player client.
	Uuid string `json:"uuid"`

	// Version An object representing the Archipelago version this client supports.
	Version NetworkVersion `json:"version"`
}

type ConnectUpdate struct {
	Cmd string `json:"cmd"`

	// ItemsHandling Flags configuring which items should be sent by the server.
	ItemsHandling ItemHandlingFlag `json:"items_handling"`

	// Tags Denotes special features or capabilities that the sender is capable of. Tags
	Tags []Tags `json:"tags"`
}

type Connected struct {
	// CheckedLocations Contains ids of all locations that have been checked. Useful for trackers, among other things. Location ids are in the range of ± (2^53)-1.
	CheckedLocations []int  `json:"checked_locations"`
	Cmd              string `json:"cmd"`

	// HintPoints Number of hint points that the current player has.
	HintPoints int `json:"hint_points"`

	// MissingLocations Contains ids of remaining locations that need to be checked. Useful for trackers, among other things.
	MissingLocations []int `json:"missing_locations"`

	// Players List denoting other players in the multiworld, whether connected or not.
	Players []NetworkPlayer `json:"players"`

	// Slot Your slot number on your team. See NetworkPlayer for more info on the slot number.
	Slot int `json:"slot"`

	// SlotData Contains a json object for slot related data, differs per game. Empty if not required. Not present if slot_data in Connect is false.
	SlotData map[string]interface{} `json:"slot_data"`

	// SlotInfo maps each slot to a NetworkSlot information.
	SlotInfo map[int]NetworkSlot `json:"slot_info"`

	// Team Your team number. See NetworkPlayer for more info on team number.
	Team int `json:"team"`
}

type ConnectionRefused struct {
	Cmd string `json:"cmd"`

	// Errors Optional. When provided, should contain any one of:
	// InvalidSlot, InvalidGame, IncompatibleVersion, InvalidPassword, or InvalidItemsHandling.
	Errors *[]ConnectionRefusedError `json:"errors,omitempty"`
}

type ConnectionRefusedError string

type DataPackage struct {
	Cmd string `json:"cmd"`

	// Data The data package as a JSON object.
	Data DataPackageObject `json:"data"`
}

type DataPackageObject struct {
	// Games Mapping of all Games and their respective data
	Games map[string]GameData `json:"games"`
}

type DataStorageOperation struct {
	// Operation the operation to be applied
	Operation interface{} `json:"operation"`

	// Value the value used by the operation. Operation key dependant.
	Value *interface{} `json:"value,omitempty"`
}

type DeathLink struct {
	// Cause Optional. Text to explain the cause of death. When provided, or checked, this should contain the player name, ex. "Berserker was run over by a train."
	Cause *string `json:"cause,omitempty"`

	// Source Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game.
	Source string `json:"source"`

	// Time Unix Time Stamp of time of death.
	Time float32 `json:"time"`
}

type GameData struct {
	// Checksum A checksum hash of this game's data.
	Checksum string `json:"checksum"`

	// ItemNameToId Mapping of all item names to their respective ID.
	ItemNameToId map[string]int `json:"item_name_to_id"`

	// LocationNameToId Mapping of all location names to their respective ID.
	LocationNameToId map[string]int `json:"location_name_to_id"`
}

type Get struct {
	Cmd string `json:"cmd"`

	// Keys Keys to retrieve the values for.
	// Additional arguments sent in this package will also be added to the Retrieved package it triggers.
	//
	// Some special keys exist with specific return data, all of them have the prefix _read_, so hints_{team}_{slot} is _read_hints_{team}_{slot}.
	// - hints_{team}_{slot} | list[Hint] | All Hints belonging to the requested Player.
	// - slot_data_{slot} | dict[str, any] | slot_data belonging to the requested slot.
	// - item_name_groups_{game_name} | dict[str, list[str]] | item_name_groups belonging to the requested game.
	// - location_name_groups_{game_name} | dict[str, list[str]] | location_name_groups belonging to the requested game.
	// - client_status_{team}_{slot} | ClientStatus | The current game status of the requested player.
	// - race_mode | int | 0 if race mode is disabled, and 1 if it's enabled.
	Keys *[]string `json:"keys,omitempty"`
}

type GetDataPackage struct {
	Cmd string `json:"cmd"`

	// Games If specified, will only send back the specified data. Such as, ["Factorio"] -> Datapackage with only Factorio data.
	Games *[]string `json:"games,omitempty"`
}

type Hint struct {
	Entrance        string `json:"entrance"`
	FindingPlayer   int    `json:"finding_player"`
	Found           bool   `json:"found"`
	Item            int    `json:"item"`
	ItemFlags       int    `json:"item_flags"`
	Location        int    `json:"location"`
	ReceivingPlayer int    `json:"receiving_player"`

	// Status An enumeration containing the possible hint states.
	// Hints for items with ItemClassification.trap default to HINT_AVOID.
	// Hints created with LocationScouts, !hint_location, or similar (hinting a location) default to HINT_UNSPECIFIED.
	// Hints created with !hint or similar (hinting an item for yourself) default to HINT_PRIORITY.
	// Once a hint is collected, its' status is updated to HINT_FOUND automatically, and can no longer be changed.
	Status HintStatus `json:"status"`
}

type HintStatus int

type InvalidPacket struct {
	Cmd string `json:"cmd"`

	// OriginalCmd The cmd argument of the faulty packet, will be None if the cmd failed to be parsed.
	OriginalCmd *string `json:"original_cmd,omitempty"`

	// Text A descriptive message of the problem at hand.
	Text string `json:"text"`

	// Type The PacketProblemType that was detected in the packet.
	Type PacketProblemType `json:"type"`
}

type ItemHandlingFlag int

type JSONMessagePart struct {
	// Color only available if type is a color
	Color *JSONMessagePartColor `json:"color,omitempty"`

	// Flags only available if type is an item_id or item_name
	Flags *int `json:"flags,omitempty"`

	// Player only available if type is either item or location
	Player *int   `json:"player,omitempty"`
	Text   string `json:"text"`

	// Type type is used to denote the intent of the message part.
	// This can be used to indicate special information which may be rendered differently depending on client.
	// How these types are displayed in Archipelago's ALttP client is not the end-all be-all.
	// Other clients may choose to interpret and display these messages differently.
	Type JSONMessagePartType `json:"type"`
}

type JSONMessagePartColor string

type JSONMessagePartType string

type LocationChecks struct {
	Cmd string `json:"cmd"`

	// Locations The ids of the locations checked by the client.
	// May contain any number of checks, even ones sent before;
	// duplicates do not cause issues with the Archipelago server.
	Locations []int `json:"locations"`
}

type LocationInfo struct {
	Cmd string `json:"cmd"`

	// Locations Contains list of item(s) in the location(s) scouted
	Locations []NetworkItem `json:"locations"`
}

type LocationScouts struct {
	Cmd string `json:"cmd"`

	// CreateAsHint If non-zero, the scouted locations get created and broadcasted as a player-visible hint.
	// If 2 only new hints are broadcast, however this does not remove them from the LocationInfo reply.
	CreateAsHint *int `json:"create_as_hint,omitempty"`

	// Locations The ids of the locations seen by the client.
	// May contain any number of locations, even ones sent before;
	// duplicates do not cause issues with the Archipelago server.
	Locations []int `json:"locations"`
}

type NetworkItem struct {
	// Flags Flags used in the NetworkItem
	Flags NetworkItemFlags `json:"flags"`

	// Item The item id of the item.
	// Item ids are only supported in the range of [-253, 253 - 1].
	// Anything ≤ 0 is reserved for Archipelago use.
	Item int `json:"item"`

	// Location The location id of the item inside the world.
	// Location ids are only supported in the range of [-253, 253 - 1].
	// Anything ≤ 0 reserved for Archipelago use.
	Location int `json:"location"`

	// Player The player slot of the world the item is located in,
	// except when inside an LocationInfo Packet then it
	// will be the slot of the player to receive the item.
	Player int `json:"player"`
}

type NetworkItemFlags int

type NetworkPlayer struct {
	// Alias represents the player's name in current time.
	Alias string `json:"alias"`

	// Name The original name used when the session was generated.
	// This is typically distinct in games which require baking names into ROMs or for async games.
	Name string `json:"name"`

	// Slot Slot numbers are unique per team and start at 1.
	// Slot number 0 refers to the Archipelago server;
	// this may appear in instances where the server grants the player an item
	Slot int `json:"slot"`

	// Team Team numbers start at 0
	Team int `json:"team"`
}

type NetworkSlot struct {
	Game string `json:"game"`

	// GroupMembers only populated if type == group
	GroupMembers []int  `json:"group_members"`
	Name         string `json:"name"`

	// Type An enum representing the nature of a slot.
	Type SlotType `json:"type"`
}

type NetworkVersion struct {
	Build int `json:"build"`

	// Class constant string set to "Version"
	Class string `json:"class"`
	Major int    `json:"major"`
	Minor int    `json:"minor"`
}

type OperationKey string

type PacketProblemType string

type Permission int

type PrintJSON struct {
	Cmd string `json:"cmd"`

	// Countdown Message Type: Countdown
	// Amount of seconds remaining on the countdown
	Countdown *int `json:"countdown,omitempty"`

	// Data Message Type: (all)
	// Textual content of this message
	Data []JSONMessagePart `json:"data"`

	// Found Message Type: Hint
	// Whether the location hinted for was checked
	Found *bool `json:"found,omitempty"`

	// Item Message Type: NetworkItem 	ItemSend, ItemCheat, Hint
	// Source player's ID, location ID, item ID and item flags
	Item *NetworkItem `json:"item,omitempty"`

	// Message Message Type: Chat, ServerChat
	// Original chat message without sender prefix
	Message *string `json:"message,omitempty"`

	// Receiving Message Type: ItemSend, ItemCheat, Hint
	// Destination player's ID
	Receiving *int `json:"receiving,omitempty"`

	// Slot Message Type: Join, Part, Chat, TagsChanged, Goal, Release, Collect
	// Slot of the triggering player
	Slot *int `json:"slot,omitempty"`

	// Tags Message Type: Join, TagsChanged
	// Tags of the triggering player
	Tags *[]Tags `json:"tags,omitempty"`

	// Team Message Type: Join, Part, Chat, TagsChanged, Goal, Release, Collect, ItemCheat
	// Team of the triggering player
	Team *int `json:"team,omitempty"`

	// Type Message Type: (all)
	// PrintJsonType of this message (optional)
	Type *PrintJsonType `json:"type,omitempty"`
}

type PrintJsonType string

type ReceivedItems struct {
	Cmd string `json:"cmd"`

	// Index The next empty slot in the list of items for the receiving client.
	Index int `json:"index"`

	// Items The items which the client is receiving.
	Items []NetworkItem `json:"items"`
}

type Retrieved struct {
	Cmd string `json:"cmd"`

	// Keys A key-value collection containing all the values for the keys requested in the Get package.
	Keys map[string]interface{} `json:"keys"`
}

type RoomInfo struct {
	Cmd string `json:"cmd"`

	// DatapackageChecksums Checksum hash of the individual games' data packages the server will send. Used by newer clients to decide which games' caches are outdated. See Data Package Contents for more information.
	DatapackageChecksums map[string]string `json:"datapackage_checksums"`

	// Games List of games present in this multiworld.
	Games []string `json:"games"`

	// GeneratorVersion Object denoting the version of Archipelago which generated the multiworld.
	GeneratorVersion NetworkVersion `json:"generator_version"`

	// HintCost The percentage of total locations that need to be checked to receive a hint from the server.
	HintCost int `json:"hint_cost"`

	// LocationCheckPoints The amount of hint points you receive per item/location check completed.
	LocationCheckPoints int `json:"location_check_points"`

	// Password Denoted whether a password is required to join this room.
	Password bool `json:"password"`

	// Permissions Mapping of permission name to Permission, keys are: "release", "collect" and "remaining".
	//
	// ## release
	// Dictates what is allowed when it comes to a player releasing their run. A release is an action which distributes the rest of the items in a player's run to those other players awaiting them.
	//     auto: Distributes a player's items to other players when they complete their goal.
	//     enabled: Denotes that players may release at any time in the game.
	//     auto-enabled: Both of the above options together.
	//     disabled: All release modes disabled.
	//     goal: Allows for manual use of release command once a player completes their goal. (Disabled until goal completion)
	//
	// ## collect
	// Dictates what is allowed when it comes to a player collecting their run. A collect is an action which sends the rest of the items in a player's run.
	//     auto: Automatically when they complete their goal.
	//     enabled: Denotes that players may !collect at any time in the game.
	//     auto-enabled: Both of the above options together.
	//     disabled: All collect modes disabled.
	//     goal: Allows for manual use of collect command once a player completes their goal. (Disabled until goal completion)
	//
	// ## remaining
	// Dictates what is allowed when it comes to a player querying the items remaining in their run.
	//     goal: Allows a player to query for items remaining in their run but only after they completed their own goal.
	//     enabled: Denotes that players may query for any items remaining in their run (even those belonging to other players).
	//     disabled: All remaining item query modes disabled.
	Permissions map[string]Permission `json:"permissions"`

	// SeedName Uniquely identifying name of this generation
	SeedName string `json:"seed_name"`

	// Tags Denotes special features or capabilities that the sender is capable of. Example: WebHost
	Tags []Tags `json:"tags"`

	// Time Unix time stamp of "now". Send for time synchronization if wanted for things like the DeathLink Bounce.
	Time float32 `json:"time"`

	// Version Object denoting the version of Archipelago which the server is running.
	Version NetworkVersion `json:"version"`
}

type RoomUpdate struct {
	// CheckedLocations May be a partial update, containing new locations that were checked, especially from a coop partner in the same slot.
	CheckedLocations *[]int `json:"checked_locations,omitempty"`
	Cmd              string `json:"cmd"`

	// MissingLocations Never sent in this packet. If needed, it is the inverse of checked_locations.
	MissingLocations *map[string]interface{} `json:"missing_locations,omitempty"`

	// Players Sent in the event of an alias rename. Always sends all players, whether connected or not.
	Players *[]NetworkPlayer `json:"players,omitempty"`
}

type Say struct {
	Cmd string `json:"cmd"`

	// Text Text to send to others.
	Text string `json:"text"`
}

type Set struct {
	Cmd string `json:"cmd"`

	// Default The default value to use in case the key has no value on the server.
	Default *interface{} `json:"default,omitempty"`

	// Key The key to manipulate. Can never start with "_read".
	Key *string `json:"key,omitempty"`

	// Operations Operations to apply to the value, multiple operations can be present and they will be executed in order of appearance.
	Operations *[]DataStorageOperation `json:"operations,omitempty"`

	// WantReply If true, the server will send a SetReply response back to the client.
	WantReply *bool `json:"want_reply,omitempty"`
}

type SetNotify struct {
	Cmd string `json:"cmd"`

	// Keys Keys to receive all SetReply packages for.
	Keys *[]string `json:"keys,omitempty"`
}

type SetReply struct {
	Cmd string `json:"cmd"`

	// Key The key that was updated.
	Key string `json:"key"`

	// OriginalValue The value the key had before it was updated. Not present on "_read" prefixed special keys.
	OriginalValue *interface{} `json:"original_value,omitempty"`

	// Value The new value for the key.
	Value interface{} `json:"value"`
}

type SlotType int

type StatusUpdate struct {
	Cmd string `json:"cmd"`

	// Status One of Client States. Send as int. Follow the link for more information.
	Status ClientStatus `json:"status"`
}

type Sync struct {
	Cmd string `json:"cmd"`
}

type Tags string

type UpdateHint struct {
	Cmd string `json:"cmd"`

	// Location The ID of the location to update the hint for. If no hint exists for this location, the packet is ignored.
	Location int `json:"location"`

	// Player The ID of the player whose location is being hinted for.
	Player int `json:"player"`

	// Status If included, sets the status of the hint to this status. Cannot set HINT_FOUND, or change the status from HINT_FOUND.
	Status *HintStatus `json:"status,omitempty"`
}