Installation

- Put
ScreenFX-<version>.jarinplugins/(Paper, Purpur or Folia 26.3+, Java 25). - Start the server. Every file is created by itself (see the table below).
- Join and type
/sfx. Reactions are already on: take some damage, stand near an explosion, open the gallery and click a preset.
The resource pack needs nothing in most cases:
- with Nexo or Oraxen the ScreenFX pack is copied into theirs: players get one pack;
- with ItemsAdder add
"ScreenFX/pack/files"tomerge_other_plugins_resourcepacks_foldersin itsconfig.ymland run/iazip; - without them, players download the default pack from tmstudio.dev (no port to open);
- if you change the pack (your own pictures, GIFs, effects with your own values, edited files), ScreenFX hosts it itself: open port 8163 (TCP) on your host. On Pterodactyl add it as an extra allocation.
More in Resource pack.
| File | |
|---|---|
config.yml | storage, safety, accessibility, fallback, hooks, resource pack |
lang/en.yml | every message and menu text |
presets/ | presets, one file per theme (custom.yml = made with the editor), _guide.yml explains every option |
effects.yml | your own effects (custom:<name>) |
reactions.yml | automatic effects |
items.yml | ScreenFX items |
zones.yml | your zones |
zone-templates.yml | ready-made zones |
scenes.yml | cutscenes (Cutscenes and shows) |
shows.yml | shows |
menus/ | every menu: layout, buttons, texts, your own menus |
pack/ | the resource pack: pack/files is its content, pack/ScreenFX-pack.zip the built zip |
data/ | player settings (SQLite), internal records |
backups/ | the files as they were before a /sfx web apply (Web editor) |
Tip: after editing a file run /sfx reload. Mistakes are shown in the console with the file, the preset or entry and the step (and the line for YAML mistakes); a broken file is never overwritten.
Updating
Replace the jar and restart. ScreenFX keeps your files and adds what the new version brings:
- new options and messages are added to
config.ymlandlang/en.yml, with their comments; - new presets, items, reactions and ready-made zones are added once (if you delete one, it doesn't come back);
- default entries an update fixes are updated too, only where you never changed them: your edits always stay;
- the default resource pack of the new version is used by itself.
Keep only one ScreenFX jar in plugins/.
Last updated