Content generated with AI — it may contain mistakes.

ExyliaEvents/GuidesUpdated in v1.11.0

Limit who can join an event

Sign-up lists, private events, blacklists and blocked ranks: choose who may join an ExyliaEvents event.

Page 8 of 254 min read

By the end of this page one event only admits the players you list, and you know how to keep a player or a whole rank out of every event. Sign-ups are called inscriptions in the commands.

Before you start#

  • The event configuration exists. Create it as in Your first event.
  • You have exyliaevents.admin.inscriptions. It is separate from exyliaevents.admin and defaults to op.

Steps#

Open the access screen

Run /eventsadmin, click Configurations, open your event, then click Access. The screen shows Access mode, Whitelist, Blacklist, Blocked ranks and Start event.

Make it private

Click Access mode to switch between public (anyone can join) and private (only the whitelist). From a command: /eventsadmin access <configId> private.

Add the players

Click Whitelist, then Add online player or Add by name. Offline players work: the list stores UUIDs, so somebody can be signed up days before. From a command: /eventsadmin inscriptions add <configId> <player>.

Start the event

Click Start event, or run /eventsadmin inscriptions startevent <configId>. The list stays in force while the event is private.

Afterwards

Open Whitelist and click Clear whitelist before the next round, or click Access mode to make the event public again.

Check that it works#

Join with an account that is not on the list, with /events join or from the menu. It must be refused with "This event is private" (the refused-private line of your messages.yml). Then add that player and join again.

Going further#

Sign-up commands#

/eventsadmin inscriptions open <configId> is the same as making the event private, and close makes it public. Closing does not delete the list, so you can reopen it for a second round. add and remove edit one player. clear empties the list.

remove and clear ask for confirmation. Add confirm at the end to skip it, for example /eventsadmin inscriptions clear tournament1 confirm. A console sender must type confirm.

It pairs with scheduled events

Make the event private during the week, schedule it for Friday from the event's Schedules screen (Game flow), and it starts on its own with only the signed-up players able to enter.

Keep a player or a rank out#

Click Blacklist to keep named players out of this event, public or private. Click Blocked ranks to keep a permission group out, for example your staff. Ranks are read from your permissions plugin through ExyliaLib's group lookup.

One list for every event#

Each list exists once per configuration and once globally. The global one applies to every event. Open it with /eventsadmin access, or click Global access on the /eventsadmin panel. The global scope has a blacklist and blocked ranks only: it has no private mode and no whitelist. In commands, write global as the scope.

Rules, commands and storage

Every way of joining obeys the same order:

  1. A blacklisted player (in the event or global list) is always refused.
  2. A whitelisted player is let in, even from a blocked rank.
  3. A player in a blocked rank (event or global) is refused.
  4. If the event is private, anyone not whitelisted is refused.

Adding a player to one of the two player lists takes them off the other. Each refused player is told which rule stopped them (refused-blocked, refused-rank, refused-private in messages.yml).

CommandWhat it does
/eventsadmin inscriptions open|close <configId>Private mode on or off.
/eventsadmin inscriptions add|remove <configId> <player>Edit the whitelist. remove asks first.
/eventsadmin inscriptions clear <configId>Empty the whitelist. Asks first.
/eventsadmin inscriptions startevent <configId>Start the event.
/eventsadmin accessOpen the global access screen.
/eventsadmin access <configId|global>Open that scope's access screen.
/eventsadmin access <scope> public|privateTurn private mode off or on.
/eventsadmin access <scope> whitelist add|remove <player>Edit the whitelist.
/eventsadmin access <scope> blacklist add|remove <player>Edit the blacklist.
/eventsadmin access <scope> rank add|remove <rank>Edit the blocked ranks.

All of them need exyliaevents.admin.inscriptions. The access commands remove at once; the screens' Clear buttons ask first.

The lists live in the database, one row per scope, so they survive restarts and are shared by every server on the same database. Other plugins can ask the same question with EventsAPI.canAccess(player, configId).

Something missing on this page? Tell us on Discord