Content generated with AI — it may contain mistakes.

ExyliaStaff/GuidesUpdated in v1.8.0

Answer help requests

Let players ask for help, alert staff on every server and talk through the request until it is closed.

Page 13 of 383 min read

A player runs /helpop <message> to ask for help. Every staff member on every server gets an alert with a Claim button. The one who claims it answers, and from then on whatever the player types into /helpop goes to that staff member, wherever they are. The request closes when staff close it, or on its own if nobody answers in time.

Before you start#

  • Players need exyliastaff.helpop. Staff who answer need exyliastaff.helpop.manage.
  • The module switch is modules.helpop in plugins/ExyliaStaff/config.yml.

Steps#

A player asks

The player runs /helpop My chest was emptied, please look. They are told their request number. A player has one live request at a time: asking again while it is unclaimed answers "You already have request #12 waiting".

Claim it

Staff see the alert with [ ✔ Claim ], [ ✦ Open list ] and [ ➥ Teleport ]. Click Claim, or run /hs claim <id>. The player is told who is on it.

Reply

Run /hs reply <id> <message>. The player answers by typing /helpop <message> again, and you see it as part of the same conversation. Replying to an unclaimed request claims it; one claimed by somebody else is refused.

Close it

Run /hs close <id> [reason]. Without a reason the default close reason is sent to the player. Any staff member can close any request.

Check that it works#

As a player run /helpop test, then as staff on another server confirm the alert arrived, claim it and reply. The player should see your lines as #<id> <your name> » <message>.

Going further#

The list#

/hs (long form /helpop-staff) opens the HELPOP menu, and so does the turtle helmet (slot 14) in the staff mode hotbar. Each request is a head:

  • Left click claims an unclaimed request.
  • Right click teleports you to the player, following them to their server.
  • Shift left click teleports you on duty (into staff mode and vanish first).
  • Shift right click closes it.

/hs list prints the open and claimed requests, oldest first, in chat. The console can use it.

Limit how often players ask#

cooldown-seconds (default 30) is the wait between two requests. Give a rank its own with exyliastaff.helpop.cooldown.<seconds>, for example exyliastaff.helpop.cooldown.10; the lowest one a player holds wins. Once a request is claimed, replies are not subject to that wait, only to a two second pause between lines so a flood is dropped silently. If the handler is not online right now, the player is told and their message is delivered on the handler's server.

Timeouts#

Every thirty seconds the module closes requests that waited too long. An unclaimed request closes after timeout-minutes (default 15) with the timeout-reason, and the player is told nobody was available. A claimed request with no message for claimed-timeout-minutes (default 30) closes with the inactive-reason. Set either to 0 to turn it off.

Commands and permissions#

CommandWhat it doesPermission
/helpop <message>Ask staff for help.exyliastaff.helpop
/helpop-staffOpen the help request queue.exyliastaff.helpop.manage
/helpop-staff listList open help requests in chat.exyliastaff.helpop.manage
/helpop-staff claim <id>Claim a help request.exyliastaff.helpop.manage
/helpop-staff reply <id> <message>Answer a help request.exyliastaff.helpop.manage
/helpop-staff close <id> [reason]Close a help request.exyliastaff.helpop.manage
PermissionWho has itWhat it allows
exyliastaff.helpopEveryoneAsk staff for help with /helpop.
exyliastaff.helpop.manageAdmins (op)Receive, claim and answer help requests.
Configuration and messages
plugins/ExyliaStaff/modules/helpop/config.yml
yaml
cooldown-seconds: 30
timeout-minutes: 15
claimed-timeout-minutes: 30
alert:
  sound:
    name: BLOCK_NOTE_BLOCK_BELL
    pitch: 1.2
KeyDefaultWhat it does
cooldown-seconds30Wait between two requests by one player. A wait under five minutes is not kept across a restart.
timeout-minutes15Minutes before an unclaimed request closes. 0 never.
claimed-timeout-minutes30Minutes without a message before a claimed request closes. 0 never.
alertbell soundEffect played for staff on every server; add a title or an action bar to it.

Messages are in lang/<language>/modules/helpop/messages.yml: sent and already-open (%id%); cooldown (%time%); alert-header, alert-line and alert-actions (%id%, %player%, %server%, %message%; the last is a clickable row you may empty); list-header, list-line, list-empty; not-found, already-claimed, not-yours; claimed, claimed-notice; transcript-staff and transcript-player; handler-offline; closed, closed-notice, timed-out; default-close-reason, timeout-reason, inactive-reason; player-offline, player-not-here, teleported, following. See ExyliaLib messages and colours.

PlaceholderShowsExample
%exyliastaff_staff_helpop_open%Unclaimed help requests.3
%exyliastaff_staff_helpop_claimed_by_me%Live help requests you have claimed.1

Something missing on this page? Tell us on Discord