Content generated with AI — it may contain mistakes.

ExyliaStaff/GuidesUpdated in v1.9.0

Freeze a player for a screenshare

Pin a suspected cheater in place, tell them why and keep them frozen even if they log out.

Page 6 of 385 min read

Freezing locks a suspect in place for a screenshare. The frozen player cannot move, act or run commands, sees only a reminder and staff chat, and stays frozen if they log out. You freeze with one command or one click.

Before you start#

  • Give the staff rank exyliastaff.freeze. To make a rank immune, give it exyliastaff.freeze.bypass.
  • The module switch is modules.freeze in plugins/ExyliaStaff/config.yml.
  • With PacketEvents, the client is pinned by dropping every position packet and answering with a teleport back, so there is no rubber-banding. Without it freeze still works but pins the player with server-side movement checks instead.

Steps#

Freeze the player

Run /freeze <player> [reason] (alias /ss), or look at the player within five blocks and click the Packed ice (FREEZE, slot 8) in the staff mode hotbar. The reason is shown to the player and kept with the session.

Talk to them

Type in public chat. Your lines and theirs go to a private freeze chat that every staff member with exyliastaff.freeze can read.

Release

Run /unfreeze <player> (alias /unss), or click the ice again. /freezetoggle <player> (alias /sstoggle) does one or the other.

The console can freeze too. You cannot freeze yourself, and a target holding exyliastaff.freeze.bypass cannot be frozen.

Check that it works#

Freeze a test player. They should be unable to move, see a blinding effect with a FROZEN title and a block of ice on their head, glow for staff, and receive a reminder every five seconds. Release them: armour comes back and the effects clear.

What the frozen player gets#

  • The frozen message lines with your name and the reason (a line holding %reason% is left out when there is none), then a reminder every reminder-seconds: a title, an action bar and a sound.
  • The frozen sidebar: who froze them and for how long.
  • Glow, the potion effects in look.effects, and a helmet, after their armour is saved. The armour comes back on release, and after a crash on the next join, on the server it came off. The helmet is recognised by a tag, so changing its name or the language mid-freeze still takes it off.

They cannot move, break, place, drop or pick up items, or run commands outside allowed-commands (by default msg, r, reply, tell, w). Configurable: damage (block-damage), opening inventories (block-inventories) and being teleported except by a plugin (block-teleports). Plugin teleports pass on purpose, so a staff /tphere on a frozen player works. The "you cannot do that" line is sent at most once every two seconds.

Going further#

The chat#

What the frozen player and the staff member holding them type in public chat is taken out of it before any other plugin or a Discord bridge reads it, and goes to the freeze chat on every server: the frozen player's lines use chat-format, the staff member's chat-staff-format. Every staff member with exyliastaff.freeze reads every session so a colleague can step in; the frozen player reads only the staff member holding them. The frozen player hears staff and nobody else, and the staff member holding them hears staff and frozen players. Global chat bypasses this like every other chat rule.

Logging out#

Logging out does not end a freeze. With persist-on-quit on (the default), the player comes back frozen on whichever server of the network they join, and staff everywhere get alert-rejoin. The kept freeze lasts 10 minutes after logout: a player who stays away longer, a banned one for example, comes back free. New in v1.9.0 With it off, the freeze ends on quit and the player rejoins free.

Either way, logging out is how a player refuses a screenshare, so the server reacts. With alert-quit on, every staff member with exyliastaff.freeze on every server is told, and the quit-commands run with %player%:

yaml
quit-commands:
  - 'console-proxy:ban %player% Logged out while frozen'

Other plugins hear it as FrozenPlayerQuitEvent; see the API. A /stop ends every freeze whatever persist-on-quit says, but runs no quit commands and raises no alert.

Replay and other servers#

The moment a freeze starts, the last minute before it is saved as a replay (capture.freeze in the replay module). Every freeze and release is published on the freeze channel: staff on every server get the alert-frozen and alert-unfrozen lines with the server name, and a server that has the player online applies or releases the freeze.

Commands and permissions#

CommandWhat it doesPermission
/freeze <player> [reason]Freeze a player for a screenshare.exyliastaff.freeze
/unfreeze <player>Release a frozen player.exyliastaff.freeze
/freezetoggle <player>Freeze the player, or release them if frozen.exyliastaff.freeze
PermissionWho has itWhat it allows
exyliastaff.freezeAdmins (op)Freeze and unfreeze players.
exyliastaff.freeze.bypassAdmins (op)Cannot be frozen.
Configuration (modules/freeze/config.yml)
plugins/ExyliaStaff/modules/freeze/config.yml
yaml
reminder-seconds: 5
look:
  strip-armor: true
  helmet: PACKED_ICE
  glow: true
  effects:
    - BLINDNESS
    - DARKNESS
block-damage: true
block-inventories: true
allowed-commands:
  - msg
  - r
  - reply
  - tell
  - w
block-teleports: true
alert-quit: true
persist-on-quit: true
quit-commands: []
KeyDefaultWhat it does
reminder-seconds5Seconds between reminders.
look.strip-armortrueTake the armour off, give it back on release.
look.helmetPACKED_ICEWorn on the head. Empty for none. Its name is helmet-name in the messages file.
look.glowtrueThe frozen player glows.
look.effectsblindness, darknessPotion effects held for the whole freeze. Unknown names are skipped.
block-damage, block-inventories, block-teleportstrueThe configurable restrictions above.
allowed-commandsmsg, r, reply, tell, wCommands a frozen player may still run, matched on the bare label.
alert-quittrueTell staff on every server when a frozen player logs out.
persist-on-quittrueKeep a player frozen when they log out, until they come back on any server.
quit-commands[]Run on logout. console-proxy: needs the library's proxy bridge.

Messages are in lang/<language>/modules/freeze/messages.yml: frozen (list of lines, %staff% and %reason%), unfrozen, froze, unfroze, already-frozen, not-frozen and bypass (%target%), self, no-target, the alerts alert-frozen, alert-unfrozen, alert-quit and alert-rejoin (%staff%, %target%, %server%), chat-format and chat-staff-format (%server%, %player%, %message%), blocked-command, blocked-action, reminder (title, action bar and sound played on every reminder) and helmet-name. See ExyliaLib messages and colours.

Placeholders: %staff_freeze_by% (who froze the viewer), %staff_freeze_time% (how long, as a clock), %staff_freeze_target% (who the viewer has frozen here) and %staff_frozen%. See Placeholders.

Something missing on this page? Tell us on Discord