Resource pack

The ScreenFX pack adds the screenfx: effects, pictures, animations and sounds: 691 effect files made by 29 shaders, 12 pictures, 10 animations and 30 sounds with subtitles (Effects and pictures). Players without it still get the vanilla version of each preset, so nothing breaks, and they get the full one as soon as they load it.
Modes
resource-pack.mode in config.yml:
| Mode | |
|---|---|
auto (default) | with Nexo or Oraxen the ScreenFX pack is copied into their pack by itself (one pack for the players). With ItemsAdder add "ScreenFX/pack/files" to merge_other_plugins_resourcepacks_folders in its config.yml and run /iazip. Without them: the default pack of your ScreenFX version is downloaded from tmstudio.dev (no port to open); a pack you changed is hosted like self-host |
self-host | the plugin hosts the pack itself on port (8163). Open this port on your host (on Pterodactyl: an extra allocation). The address the player joined with is used, or public-url |
url | you upload plugins/ScreenFX/pack/ScreenFX-pack.zip to your web host and put the direct link in url |
merge-only | you add pack/ScreenFX-pack.zip to the pack of another plugin yourself; ScreenFX doesn't send it |
In auto mode ScreenFX asks tmstudio.dev if it has this exact pack: only the pack's SHA-1 is sent. official-host: false turns it off (the plugin then always hosts the pack itself).
required: true makes the client kick players who decline the pack. The prompt is the text of the request, sent join-delay-ticks after joining.
Changing the pack
plugins/ScreenFX/pack/files/ is the content of the pack: edit any file, add your pictures and GIFs (Effects and pictures), then run /sfx pack rebuild. The message shows the size and the SHA-1 of the new pack; send it to online players with /sfx pack send @a.
A changed pack is no longer the default one, so it can't come from tmstudio.dev: in auto mode ScreenFX hosts it itself (open the port), or use url / Nexo / Oraxen / ItemsAdder. Effects made only of layers that already exist (effects.yml) don't change the pack.
ScreenFX builds the pack the same way every time: if nothing changed, the SHA-1 stays the same and players don't download it again. A reload skips the zip when pack/files didn't change.
Commands
| Command | |
|---|---|
/sfx pack or /sfx pack status | mode, size, how many players loaded it, address, SHA-1, whether tmstudio.dev sends it (and why not), status |
/sfx pack send [players] | send the pack again |
/sfx pack rebuild | build the zip again from pack/files |
Admins are told in game when a player can't download the pack, and why the pack doesn't come from tmstudio.dev.
Players without the pack
They get potion effects that change the sight, red edges, frost, the camera tilt and shake, particles, titles and sounds. The gallery shows which presets need the pack.
Last updated