Rooms Management
Introduction
Rooms Management is a module that allows staff to check in and out of venue rooms while remaining within the privacy of the venue's Discord server. This helps to ensure that there's no ambiguity or confusion about which rooms are available at any given time.
This page is meant as an informational breakdown of the Events Module. Check out the Rooms Management Tutorial if you're looking for a guide on how to use the module.
Preparation
First off, ensure that you have FroggeBot installed in your server.
Room Check Main Menu
To access the Rooms Management module, run the /admin rooms command in a private channel.
Add Room
The button will create a new room in the management system. Consult the Room Menu section for more information on how to set up a room.
Modify Room
Clicking the button will prompt you to choose the room you want to edit. This will open the Room Menu for the selected room.
Remove Room
The button will prompt you to choose the room you want to delete. This will remove the room from the management system after a confirmation.
Set Channel
The button will prompt you to choose the channel where room management messages will be posted. This is typically a private staff channel.
Post All Rooms
Once the configuration for all rooms has been completed, the button will post a separate message in the room management channel with the status of each room.
This is the message that staff will use to check in and out of rooms.
Room Menu
The Room Menu is where you can customize the room's backing fields. This includes the room's name, description, and owner.
Toggle Button
The button will display as if there is no data for the field, and otherwise.
Set Name
Clicking the button will prompt you to enter a name for the room. This name will be displayed in the room status message.
Restrictions
Max Length: 50 characters
Set Owner
The button will prompt you to enter the owner of the room. This is typically the staff member who is responsible for the room in the event of needing it unlocked or other issues.
Set Theme
The button will prompt you to enter a theme for the room. This is particularly useful for quick room selection in venues that have multiple rooms with different purposes.
Restrictions
Max Length: 80 characters
Set Description
The button will prompt you to enter a description for the room. This is a good place to describe the room's purpose, any rules for the room, or other relevant information.
Restrictions
Max Length: 200 characters
Set Emoji
By clicking the button, you can choose an emoji to display on the check-in button for the room. This is purely aesthetic and can be any emoji you like that the app has access to.
Note
The app has access to all emojis in the current server as well as all default Unicode emojis.
Toggle Locked
The button will toggle the room's locked status. This is useful for rooms that are not currently in use or are reserved for special circumstances.
If a room is marked as locked, when a given staff member tries to check in, the owner of the room will be notified so they can unlock it.
This differs from Toggle Disabled, in that, a locked room is still visible and can be checked into, but a disabled
room is unavailable for check-in.
Toggle Disabled
The button will toggle the room's disabled status. This is useful for rooms that are not currently in use or are reserved for special circumstances.
If a room is marked as disabled, it will be visible in the room status message but cannot be checked into.
Set Index
The button will prompt you to enter an index for the room. This is used to determine the order in which rooms are displayed in the rooms management channel.
Add Image
The button will prompt you to enter an image to display in the room status message. This is optional but is recommended in order to give staff a visual representation of the room.
Remove Image
The button will remove the selected image from the room status message.
Rooms Management Channel
The messages posted in the rooms management channel will display the status of each room. This includes the room's name, owner, theme, description, locked/disabled status, and the check-in button. (Additionally, if the room is disabled, there will also be an unlock button.)
Reserving a Room
To check into a room, staff can click the button. This will prompt you to select how long you'd like to reserve the room for.
After selecting a time frame, the room will be marked as reserved until the time has expired and the status message will be updated accordingly to reflect the reservation.
Request Unlock
Have you ever needed to use a room only to find it locked and have no idea where the owner is? The button is here to help. No need to fumble through the server member list to find the owner, or worse, ping them directly. Just click the button and the owner will be notified that you need access.