Configuration

Everything is in config.yml, with a comment on every option. After a change run /sfx reload (storage changes need a restart).
General
| Option | Default | |
|---|---|---|
language | en | the file in lang/ |
stats | true | anonymous statistics (Statistics) |
update-check | true | checks tmstudio.dev for a new version (nothing is sent) |
web-editor.enabled | true | /sfx web (Web editor); false = the command is off and nothing is ever sent |
Storage
Where player settings (effects on/off, flashing, intensity, camera movement, sources, personal filter) are saved. New settings are added by themselves to a table made by an older version.
| Option | Default | |
|---|---|---|
storage.type | sqlite | sqlite (one server, data/players.db) or mysql / mariadb (shared by a network) |
storage.table-prefix | sfx_ | |
storage.mysql.* | host, port, database, username, password, properties |
Safety
| Option | Default | |
|---|---|---|
safety.clear-on-death | true | every ScreenFX effect is removed when a player dies |
safety.clear-on-world-change | false | same when a player changes world |
safety.max-duration-seconds | 300 | presets started by commands or plugins that never end by themselves stop after this (0 = no limit). A time written in the command always wins. Reactions, zones and items stop their effects by themselves |
safety.clear-foreign-effects | false | true = also removes effects added by /posteffect or other plugins |
safety.max-clouds | 40 | clouds of thrown items on the whole server at the same time; beyond this the oldest clear early |
safety.locked-commands | [msg, tell, w, r, reply, helpop] | commands players can still use while a scene holds them or a cutscene plays |
Effects never stay stuck: they are removed on quit and reload too.
Accessibility
| Option | Default | |
|---|---|---|
accessibility.allow-opt-out | true | players can turn off flashing effects or every effect for themselves |
accessibility.join-notice | true | one message (once) telling new players they can do it |
accessibility.effects-default | true | effects on for new players |
accessibility.flashing-default | true | flashing effects on for new players |
accessibility.intensity-default | normal | intensity for new players: soft, normal or strong |
accessibility.motion-default | true | camera movement on for new players |
accessibility.allow-off | [server, reactions, items, zones, scenes] | sources players may turn off for themselves; remove one to keep it always on (e.g. scenes on a story server) |
accessibility.intensity-skip | [iris, scan, zoom, letterbox, fade_black, fade_white, siren, binoculars, scope, gas_mask, visor, jail_bars] | effects whose levels are steps of a movement, not strength: the intensity leaves them as they are |
accessibility.motion-effects | [shake, wobble, trip] | looks hidden from players who turned the camera movement off |
accessibility.preview-preset | preferences_preview | the preset of the preview button in the preferences menu |
Fallback
What players who can't see screen effects get when a preset has no vanilla version: title, actionbar or none.
| Option | Default |
|---|---|
fallback.old-clients | title |
fallback.bedrock | none |
Presets with a vanilla version (most of them) play that version instead, also on Bedrock.
Hooks
Optional plugins, used only when installed. false = don't use it even if it is there.
| Option | |
|---|---|
hooks.placeholderapi | %screenfx_...% placeholders, and placeholders in preset texts |
hooks.viaversion | players on older clients get the vanilla versions |
hooks.floodgate | same for Bedrock players |
hooks.worldguard | zones that follow regions, and the screenfx-preset flags (a restart is needed after turning it on) |
hooks.mythicmobs | the screenfx mechanic in skills |
hooks.skript | Skript effects, conditions and events (a restart is needed after a change) |
hooks.denizen | the Denizen command and tags (a restart is needed after a change) |
Personal filters
| Option | Default | |
|---|---|---|
personal-filters.enabled | true | |
personal-filters.everyone | false | true = every player can use every filter, no permissions needed |
personal-filters.list | 8 filters | presets of presets/filters.yml players can pick |
Resource pack
See Resource pack for how each mode works.
| Option | Default | |
|---|---|---|
resource-pack.enabled | true | |
resource-pack.mode | auto | auto, self-host, url or merge-only |
resource-pack.official-host | true | auto mode: ask tmstudio.dev if it has this exact pack (only its SHA-1 is sent) |
resource-pack.port | 8163 | self-host port |
resource-pack.public-url | "" | e.g. http://play.myserver.com:8163 (empty = automatic) |
resource-pack.url | "" | mode url only |
resource-pack.required | false | true = players who decline are kicked by the client |
resource-pack.prompt | text of the pack request | |
resource-pack.join-delay-ticks | 20 | wait after joining before sending the pack |
Text format
Every text accepts MiniMessage (<red>, <gradient:#a:#b>, <rainbow>, <click>, <hover>), & codes and &#rrggbb hex. See Colors and text format.
Last updated