Events

Introduction

The Events module is a powerful tool that allows you to create and manage staffable events for your venue. It's a great way to keep your staff informed about upcoming shifts and to keep them engaged with your server.

This page is meant as an informational breakdown of the Events Module. Check out the Creating a Staffable Event tutorial if you're looking for a guide on how to create your first event.

Events Menu

To access the Events main menu, use the /admin events command. This will bring up a dashboard of all current events configured by your venue. From here you can create new events and edit existing ones.

Add Event

The Add Event button will create a new staffable event with null values.

To see what you can do with an event, check out the event menu section.

Events List

The Events List button will spawn a paginated list of all currently active events.

There is also a Edit this Event button that will call the event menu for the selected event.

Remove Event

The Remove Event by ID button will spawn a pop-up window where you can enter the ID of the event you want to remove.

The ID of an event can be found at the bottom of the event menu or on the posting message for the selected event.

Event Templates Button

The Event Templates button will spawn a paginated list of all currently templated events. Templates are a great way to create a base event that can be easily duplicated and modified for future events.

Scroll through the list and click on the Create New Event from this Template button to create a new event based on the selected template.

To make an event into a template, scroll down to the make into template section of the guide.

Schedule Lockout

The Set Schedule Lockout button will spawn a pop-up window where you can set the amount of time in minutes before an event that the schedule will be locked. This will prevent staff from signing up for, or dropping, shifts too close to the event start time.

The default value is 0 minutes.

Default Schedule Channel

The default schedule channel is the channel where all event-related messages will be posted. This includes event creation messages, event sign-up messages, and event reminder messages.

The Default Schedule Channel button will prompt you to input a channel mention of the channel you want to set as the default schedule channel.

This channel can be a Text Channel or a Forum Channel.

Event Menu

The Event Menu is where you can view and edit the details of a specific event. To access the Event Menu, click on an event from the Events List or create a new event using the Add Event button.

Set Name

The Set Name button will prompt you to input a new name for the event.

Restrictions

Max Length: 60 characters

Set Start/End Times

The Set Start Time and Set End Time buttons will prompt you to input a new start or end datetime for the event, respectively.

These should be entered in the format MM/DD/YY HH:MM AM/PM in your venue's configured timezone.

Set Image

The Set Image button will prompt you respond with an image to use for the event. This image will be displayed in the top-right of the event posting message.

Restrictions

• Max File Size: 8MB
• File Types: A/PNG, JPEG, GIF, WEBP

Edit Shift Brackets

The Edit Shift Brackets button calls up the Shift Brackets menu where you can add, remove, and edit the shift brackets for the event.

For more information on breaking your event into multiple shifts, check out the Shift Brackets section.

Edit Positions

The Edit Positions button calls up the Event Positions menu where you can add, remove, and edit the positions for the event.

For more information on creating positions for your event, check out the Event Positions section.

Add Event Element

The Add/Modify Event Elements button invokes the Event Elements menu where you can add, remove, and edit elements for the event.

Elements are a great way to add additional information to your event posting message. For example, you could add a location, party finder message, shout run details, DJ lineup, etc.

Toggle Template

Clicking the Toggle Template button will toggle the event between a normal event and a template. Templates are a great way to create a base event that can be easily duplicated and modified for future events.

For more information on creating a template, check out the Event Templates section.

Manually Edit Staff

The Manually Edit Staff button invokes the Staff Management menu where you can manually add or remove staff from the event.

Shift Brackets

Shift brackets are a way to break your event into multiple shifts. This is useful for events that span several hours. For example, an opening that lasts from 8:00 PM to 2:00 AM could be broken into two shifts: 8:00 PM to 11:00 PM and 11:00 PM to 2:00 AM.

Add Shift

The Add Shift button will create a new shift bracket for the event.

Before the shift bracket is created, you will be prompted to input the start and end times for the shift. The times in the select menu are displayed local to your venue's configured timezone.

Modify Shift

The Modify Shift button will prompt you to select the shift bracket you want to edit, then display the current start and end times for the shift.

From this menu, you can change the start and end times, or remove the shift bracket entirely.

Remove Shift

The Remove Shift button will prompt you to select the shift bracket you want to remove, then display a confirmation message before removing the shift bracket.

Event Positions

Event positions are the roles that staff can sign up for during an event. For example, DJ, Bartender, or Security.

The number of a given event position is the number of staff needed to fill that role per shift. For example, if you have 2 Dancer positions and 3 shifts, you will need 6 Dancers to fill all shifts.

Add Position

The Add Position button will create a new position for the event.

You'll be presented with a select menu of all currently configured positions for the venue. If you don't see the position you're looking for, check out the Position Management documentation or the Position Creation Tutorial.

You may select as many positions as you want from the select menu.

Following that, a pop-up window will prompt you to input the number of staff needed for each position per shift.

Modify Position

The Modify Position button will prompt you to select the position(s) you want to edit, then display a pop-up with the current number of staff needed for that position per shift. Edit the value in the input field to make changes.

Remove Position

The Remove Position button will prompt you to select the position(s) you want to remove, then remove them.

This step does not have a confirmation message, so be sure you want to remove the position before clicking the button.

Event Elements

Event elements are a way to add additional information to your event posting message. For example, you could add a location, party finder message, shout run details, DJ lineup, etc. This allows you to customize your event posting and consolidate all relevant information in one place.

Add Element

The Add Element button will create a new element for the event. You'll be prompted to select the type of element you want to add. There are currently nine types of elements:

• Address: The address of the event.
• Theme: The event's theme, if applicable.
• Syncshell: Syncshell connection info for the event.
• Party Finder: A message for the party finder.
• Shout Run: Details for a shout run.
• Greeting: The message your greeter should be using.
• Venue Shout: An in-game shout for the venue during open time.
• DJ Info: The DJ information for the event.
• Miscellaneous: A catch-all for any other information you want to include.

From there, the menu for the selected element type will be displayed, where you can edit the element's title, which has been generated automatically for you based on the element type, and the element's content.

Additionally, the Remove Element button will remove the selected element from the event entirely.

Modify Element

The Modify Element button will prompt you to select the element you want to edit, then display the current title and content for the element.

From the displayed menu, you can change the title and content, or remove the element entirely.

Remove Element

The Remove Element button will prompt you to select the element you want to remove, then display a confirmation message before removing the element.

Event Templates

Event templates are a great way to create a base event that can be easily duplicated and modified for future events.

All events have the option to be toggled between a normal event and a template. To toggle an event into a template, click the Toggle Template button in the Event Menu.

To access your venue's list of templated events, click the Event Templates button from the individual Event Menu.

Click the Create New Event from this Template button to create a new event based on the selected template and edit it as you would any other event.

Staff Management

With any event, you may need to manually add or remove staff.

The Manually Edit Staff button in the Event Menu will call up the Staff Management menu.

Add Staff

The Add Staff button will prompt you to input a Discord mention of the staff member you want to add to a given event. After mentioning the staff member, you will be prompted to select the position(s) you want to add them to, followed by the shift bracket(s) they'll be working.

Finally, you'll be prompted to select the staff member to assign from a list of staff members who have the selected position(s) and are not already assigned to the selected shift(s).

Remove Staff

The Remove Staff button will prompt you to select the staff member you want to remove from the event, followed by a confirmation message before removing them.