SCUMServer Automation
Admin reference · SSA Bridge modules
Admin reference

Updated Describes manager 5.11.2 and SSA Bridge 2.19.1

SSA Bridge module reference

Every query and every verb the SSA Bridge accepts — 188 reads across 44 modules and 256 writes across 35. This is the vocabulary behind the module_data and module_command actions on the bridge's TCP interface, for anybody building their own tool against it.

It is generated from the mod itself, so it describes the build it was generated from and nothing else.

How to read it

A request names the module and one string:

{"id":"1","action":"module_data","module":"zones","what":"zones"}
{"id":"2","action":"module_command","module":"zones","what":"move:Outpost A0:-604800:12000"}

The tables below give that string. 4 fields means the verb and three arguments, separated by the module's own separator — so a verb marked 4 fields is sent as verb:a:b:c. A verb with no field count is sent on its own.

What each field MEANS is not in this table, and that is deliberate. It is generated from the mod's parsers, which know how many fields they take and not what to call them. Send a verb wrong and the module answers with a sentence naming what it wanted — that refusal is the documentation for the arguments, and it is written for a person to read.

Every module ships switched off. A module that is off refuses its own verbs and says which setting to turn on. Ask the socket for modules to see what is on, what each setting is and what it does — that comes from the mod, not from here.

7 of these modules are read-only and have no verbs at all: bases, craft, events, live, place, vehicles, virtual.

⚠ Not everything here could be read from the source. These modules have an entry point whose grammar the generator could not parse, so their lists below are incomplete rather than empty: despawn. Ask the module itself — a wrong what is answered with the list it accepts.

The modules

In-game actions

actions · 16 settings

Reads — module_data

Writes — module_command

Creature behaviour

ai · 3 settings

Reads — module_data

Writes — module_command

Live bases and raid protection

bases · 5 settings · read-only

Reads — module_data

Base building

build · 10 settings

Reads — module_data

Writes — module_command

Weather and time

climate · 3 settings

Reads — module_data

Writes — module_command

Crafting and fishing

craft · 11 settings · read-only

Reads — module_data

Damage at a point

damage · 7 settings

Reads — module_data

Writes — module_command

Remove from the world

despawn · 19 settings

Reads — module_data

Writes — this module takes module_command and its grammar could not be read here.

Door Shuffle

doors · 22 settings

Reads — module_data

Writes — module_command

Encounters and spawn waves

encounters · 6 settings

Reads — module_data

Writes — module_command

Live world

entities · 6 settings

Reads — module_data

Writes — module_command

Live game events

events · 12 settings · read-only

Reads — module_data

Gardens and crops

farming · 5 settings

Reads — module_data

Writes — module_command

Window and door barricades

fortifications · 6 settings

Reads — module_data

Writes — module_command

Move items

give · 9 settings

Reads — module_data

Writes — module_command

Radiation and wetness

hazard · 3 settings

Reads — module_data

Writes — module_command

Live inventories

items · 10 settings

Reads — module_data

Writes — module_command

Killbox

killbox · 9 settings

Reads — module_data

Writes — module_command

Live player data

live · 18 settings · read-only

Reads — module_data

Doors and locks

locks · 12 settings

Reads — module_data

Writes — module_command

Medical state

medical · 9 settings

Reads — module_data

Writes — module_command

Server notifications

notify · 5 settings

Reads — module_data

Writes — module_command

Offline raid protection

offline · 5 settings

Reads — module_data

Writes — module_command

Placement check

place · 2 settings · read-only

Reads — module_data

Fire, power and cooking

power · 7 settings

Reads — module_data

Writes — module_command

Raid protection control

protect · 4 settings

Reads — module_data

Writes — module_command

Quests

quests · 8 settings

Reads — module_data

Writes — module_command

Raid detection

raid · 5 settings

Reads — module_data

Writes — module_command

Vehicle condition

repair · 13 settings

Reads — module_data

Writes — module_command

Fuel & resource stations

resources · 4 settings

Reads — module_data

Writes — module_command

Live server settings

settings · 2 settings

Reads — module_data

Writes — module_command

Precise spawning

spawn · 8 settings

Reads — module_data

Spawn points

spawnpoints · 2 settings

Reads — module_data

Writes — module_command

Live squads

squads · 7 settings

Reads — module_data

Writes — module_command

Survival stats

stats · 9 settings

Reads — module_data

Writes — module_command

Live storage

storage · 9 settings

Reads — module_data

Writes — module_command

Teleport

teleport · 7 settings

Reads — module_data

Writes — module_command

Trade outposts

trade · 7 settings

Reads — module_data

Writes — module_command

Live vehicles

vehicles · 11 settings · read-only

Reads — module_data

Owners of sleeping mines, bedrolls and depots

virtual · 5 settings · read-only

Reads — module_data

Wildlife population

wildlife · 3 settings

Reads — module_data

Writes — module_command

Levels and streaming

world · 4 settings

Reads — module_data

Writes — module_command

Live world events

worldevents · 8 settings

Reads — module_data

Writes — module_command

Custom zones

zones · 5 settings

Reads — module_data

Writes — module_command