TShock/docs/ssc-config.md
Lucas Nicodemus 270794ee69
Add field dump descriptions to docs
This adds the newly dumped field descriptions to the docs. In
particular, this adds field descriptions for the config file,
permissions, and ssc config. This also updates the sidebar with this
information.

The dumper formats have also been revamped for markdown.
2022-10-18 23:50:01 -07:00

35 lines
1.1 KiB
Markdown

## Enabled
Enable server side characters, causing client data to be saved on the server instead of the client.
* **Field type**: `Boolean`
* **Default**: `False`
## LogonDiscardThreshold
Time, in milliseconds, to disallow discarding items after logging in when ServerSideCharacters is ON.
* **Field type**: `Int32`
* **Default**: `250`
## ServerSideCharacterSave
How often SSC should save, in minutes.
* **Field type**: `Int32`
* **Default**: `5`
## StartingHealth
The starting default health for new players when SSC is enabled.
* **Field type**: `Int32`
* **Default**: `100`
## StartingInventory
The starting default inventory for new players when SSC is enabled.
* **Field type**: `List`1`
* **Default**: `System.Collections.Generic.List`1[TShockAPI.NetItem]`
## StartingMana
The starting default mana for new players when SSC is enabled.
* **Field type**: `Int32`
* **Default**: `20`
## WarnPlayersAboutBypassPermission
Warns players and the console if a player has the tshock.ignore.ssc permission with data in the SSC table.
* **Field type**: `Boolean`
* **Default**: `True`