Server settings

These settings go in server.cfg and apply to every Element Labs product on the server. Every one has a default that suits a normal server. You change them to diagnose a problem, to work around a firewall, or to turn off the version check and error reports.

setr el:debug "true"

Use setr, not set: setr also makes the value visible to players’ games, which is where half of the debug output comes from. Put the lines before the ensure lines of your Element Labs resources.

Switches are on only for the exact text "true", and the ones on by default are off for anything else. setr el:debug 1 leaves debug output off, and setr el:telemetry "yes" turns reports off. Write "true" or "false".

All settings

Setting	Default	Accepted values	What it changes
`el:debug`	`"false"`	`"true"`, `"false"`	`"true"` prints every diagnostic message from every product. Applies immediately, no restart needed.
`el:debug:channels`	empty	Channel names separated by commas	Prints diagnostic messages from the named channels only. Ignored while `el:debug` is `"true"`. Applies immediately.
`el:versionCheck`	`"true"`	`"true"`, `"false"`	`"false"` stops the check for newer releases. No request is made.
`el:versionChannel`	`"auto"`	`"auto"`, `"stable"`, `"candidate"`, `"off"`	Which releases count as newer. See Release channels.
`el:versionCatalog`	`https://telemetry.elementlabs.net/catalog`	A URL	Where the version check reads the list of releases.
`el:telemetry`	`"true"`	`"true"`, `"false"`	`"false"` stops the installation report and the error reports. See Privacy and data.
`el:telemetryEndpoint`	`https://telemetry.elementlabs.net`	A URL	Where those reports are sent.
`el:clientErrorLimit`	`5`	A whole number	How many error reports one player’s game may pass to the server per minute. The rest are dropped.
`el:rpcRequestLimit`	`120`	A whole number	How many requests one player may send a product within `el:rpcRequestWindowMs`. Requests beyond it are refused.
`el:rpcRequestWindowMs`	`10000`	Milliseconds	The length of that window.
`el:dependencyCheck`	`"true"`	`"true"`, `"false"`	`"false"` lets a product start with an `element_sdk` outside the versions it accepts. For diagnosis only: see below.

Apart from el:debug and el:debug:channels, a change applies the next time the resource starts.

Debug output

Off by default, and best left off: it is detailed and continuous. Turn it on to answer a question, then off again. For example, which of your resources each product chose:

[DEBUG] [FrameworkAdapter] Using "esx" adapter.
[DEBUG] [NotifyAdapter] Using "standalone" adapter.

standalone means no supported resource was found and the product’s own version is in use. A channel is the name in the second pair of brackets, here FrameworkAdapter. To see only some channels, name them, in any capitalisation:

setr el:debug:channels "config,dependencies"

Release channels

el:versionChannel decides which published releases your installed version is compared with:

Value	Compared with
`auto`	Stable releases if yours is a normal release, test releases if yours is a pre-release such as `1.1.0-beta.1`.
`stable`	Stable releases only.
`candidate`	Test releases only.
`off`	Nothing. No out-of-date notice is printed, but the request is still made. Use `el:versionCheck "false"` to stop the request.

Dependency check

With el:dependencyCheck at its default, a product refuses to start when element_sdk is outside the versions it accepts. See Versions and releases. Setting it to "false" lets the product start anyway. Use it only to confirm that a version mismatch is the cause of a problem: a product running on an element_sdk it was not built for fails later, in ways that are harder to trace. Set it back afterwards.

Example

A server whose firewall blocks outgoing requests, while diagnosing a configuration problem:

setr el:versionCheck "false"
setr el:telemetry "false"
setr el:debug:channels "config"

ensure element_sdk
ensure element_3d_pausemenu_assets
ensure element_3d_pausemenu

Get started

Configure

Compatibility

Troubleshooting

Policies

For scripters

Changelog

All settings

Debug output

Release channels

Dependency check

Example

Get started

Configure

Compatibility

Troubleshooting

Policies

For scripters

Changelog

​All settings

​Debug output

​Release channels

​Dependency check

​Example

All settings

Debug output

Release channels

Dependency check

Example