TMDevelopmentTinulica & Maiky

Other plugins

Other plugins

Every hook is optional and used only when the plugin is installed (hooks in config.yml turns one off).

PluginWhat ScreenFX does with it
WorldGuardzones that follow regions, the flags screenfx-preset, screenfx-enter-preset, screenfx-exit-preset, PvP and animal rules for thrown items (Zones)
PlaceholderAPI%screenfx_...% placeholders, placeholders in preset texts and menus, the placeholder reaction (Placeholders)
MythicMobsthe screenfx mechanic (alias sfx) in skills
Nexo, Oraxenthe ScreenFX pack is copied into theirs (one pack for players); their items work in items.yml, reactions and protections
ItemsAdderthe pack is merged through its merge list ("ScreenFX/pack/files", then /iazip); its items work too
CraftEngineits items work in items.yml, reactions and protections
ViaVersionplayers on older clients get the vanilla versions
Geyser / FloodgateBedrock players get the vanilla versions; forms are asked in chat
BreweryXthe brewery-drunk reaction (swaying sight while drunk, through PlaceholderAPI)
Skripteffects, conditions and events for presets, cutscenes and shows (below)
Denizenthe screenfx command and tags (below)
ExcellentCrates, CrazyCratesready reactions: crate opening, rare rewards seen by players nearby
mcMMO, AuraSkillsready reactions: Berserk / mana abilities, level up
Citizens, FancyNpcsready reactions: a click on an NPC
CombatLogX, PvPManagerready reactions: red edges while tagged, relief at the end
NuVotifierready reaction: a party for voters
EssentialsXready reaction: the screen darkens while AFK

The ready reactions are off by default in reactions.yml: turn on the ones you have (Reactions).

Skript

Used when Skript is installed (hooks.skript, a restart is needed after a change).

Effectsplay screenfx preset "x" to %players% · stop screenfx preset "x" for %players% · clear screenfx effects of %players% · play screenfx scene "x" to %players% · stop screenfx scene of %players% · start/stop screenfx show "x"
Conditions%players% has screenfx enabled · %players% is watching a screenfx scene
Eventson screenfx preset start/end · on screenfx scene start/end (event-string = the preset or scene)
play screenfx preset "boss_phase" to all players
play screenfx scene "intro" to player

Denizen

Used when Denizen is installed (hooks.denizen, a restart is needed after a change).

Command- screenfx [play/stop/clear/scene/stopscene/show/stopshow] (<name>) (for:<player>|...)
Tags<player.screenfx_enabled> · <player.screenfx_scene> · <player.screenfx_intensity>
- screenfx play boss_phase
- screenfx scene intro

MythicMobs

Skills:
- screenfx{preset=summoning} @PlayersInRadius{r=30}
- screenfx{preset=cinematic;duration=10s} @trigger
- screenfx{preset=cinematic;stop=true} @trigger
- screenfx{effect=minecraft:blur;duration=3s} @PlayersInRadius{r=10}

From any plugin

Every plugin that can run a console command can play an effect:

# a jail plugin, when a player is arrested
- "sfx play busted %player_name%"
# crates: a jackpot for the big prize
- "sfx play jackpot {player}"
# minigames: start and end of a round
- "sfx play countdown @a"
- "sfx play victory %winner%"
# DeluxeMenus
click_commands:
  - "[console] sfx play dream %player_name%"
# Citizens NPC: cinematic bars while the NPC talks, then stop them from your dialogue plugin
/npc command add sfx play cinematic <p>
sfx stop cinematic %player_name%

Events of other plugins can start presets by themselves: a reaction with type: event and the class name of the event (Reactions). For your own plugin, see the Developer API.

Folia

Everything runs on the players' own regions. Folia doesn't fire the respawn and teleport events, so ScreenFX watches those moments itself (respawn, teleport and portal reactions work the same as on Paper). A player who watches a cutscene can't be teleported on Folia, so /tp, /teleport, /tphere, /tpall and the like end his scene first and then run (Cutscenes and shows).

Last updated

Sign in

New here? Just enter your email: the account is created when you click the link. No password needed.

or

We send you a link that signs you in with one click. It works for new and existing accounts.

Sign in with a password instead

By continuing you accept the Terms & Conditions and the Privacy policy.

Staff: open “Sign in with a password instead” and type your username instead of the email. After the password we ask for your 2FA code.