ServerSeedSetter

Server side adapter for RunConfigAPI. Any server that supports the simple contract, can be used to curate the seeds of the users.

NOTE

Originally the mod was created for Nugger's Peak Tournament, so default config values are set to be pointing to the Remote Server where the tournament was hosted on.

Server-side Contract

All requests going out include Steam Auth tickets of the client, server decided whether or not to authenticate or ignore them alltogether.

Structures

Client Request

Client requests data from the server using the following struct with POST method:

{
	ticket: "XXXXXXXXXXXXXXXXXXXXXX"
}

where ticket is a Steam Authorization Ticket.

Server Information Response

Server must respond with the following struct:

{
	"seed": XXXX,
	"biomes":
	[
		{"section": "Biome_X", name: "XXXXXX", variant: "XXXXXXX"},
		...
		{"section": "Biome_X", name: "XXXXXX", variant: "XXXXXXX"},
	]
}

seed field is an integer that specifies seed that would be used for map/loot generation section is the biome section of the map, value must be in a Biome_X format, where X is either 1, 2 or 3 name is the name of the biome and will be used as biome identifier variant is the variant for biome specified by name field. Invalid variants for the biomes may lead to unidentified behaviour.

Usage

Installing this mod is only half of the value, as the other half comes from the remote server. To ensure proper communication, please refer to Configuration section.

Configuration is a REQUIRED step (at least for now)

Configuration

Enabled

Whether or not the setter is activated.
Default: true

BaseURL

Base URL of the remote server to recieve seed information from
Both protocol and baseURL need to be specified, path will be added to baseURL separately.
Note: dont specify any trailing forward slashes ('/') as they will be added implicitly when creating full request URL
Default: https://api.kirsho.dev

InfoRequestPath

Path to the endpoint from which to recieve seed information
Note: dont specify any preceding forward slashes ('/') as they will be added implicitly when creating full request URL
Default: peak/nugget

Support and Suggestions

If you have any questions regarding the setup or have any suggestions, feel free to contact me on discord: @kirsho