Tutorial: Setting Up the Room Check Module

The Room Check module is a specialized module that allows you to manage and oversee your venue's rooms and their status. This module is designed to help you keep track of which rooms are open, in-use, and disabled.

In this tutorial, we will learn how to create a room in the Room Check module and manage its status.

For more general information on the events module, check out the Room Check documentation.

Preparation

First off, ensure that you have FroggeBot installed in your server.

Additionally, ensure you have images of the room(s) you intend to register with the bot. These images will be used to help users identify the rooms at a glance.

Setting the Post Channel

Before creating a room, you'll need to set the post channel for the Room Check module. This channel is where the bot will post the room status messages that employees can react to.

To call the Room Check menu, run the /admin rooms command in a private channel.

Click the Set Channel button and the app will prompt you to select a category channel to post room statuses in.

Creating a Room

After setting the post channel, you can begin creating rooms. From the Room Check main menu, click the Add Room button. This will begin the process of creating a new room.

After clicking the button, the new room's menu will be displayed. Here, you'll note that the room has been automatically numbered as the next available room number. If you need to change this, you can do so by clicking the Set Index button.

Main Details

There are five main details we'll want to set for each room:

• Name - The name of the room as defined in-game by the room's owner.
• Owner - The owner of the room, typically the user who owns the character that created the room.
• Theme - The theme of the room, for quick reference on the room status message.
• Description - A brief description of the room, for additional context.
• Emoji - A decorative emoji that will go on the 'Reserve' button.

Set Name

Let's start by setting the name of the room. This is generally set as the Greeting on the in-game Additional Chambers room listing.

Clicking the Set Name button will prompt you to enter the name of the room. This is the name of the room as defined in-game by the room's owner.

Set Owner

Next, we'll set the owner of the room. This is typically the user who owns the character that created the room.

Clicking the Set Owner button will prompt you to enter a mention for the owner of the room. This person will be notified of any unlock requests.

Set Theme

Now we can set the room's theme. Usually this will be the same as the room's name, but it can be used to elaborate on the room's purpose or style if desired.

Clicking the Set Theme button will prompt you to enter the theme of the room.

Set Description

Now we'll set the description, which is a brief description of the room, for additional context. This can be used to provide additional information about the room's purpose, style, or any special features.

For this tutorial, we don't have any additional information to add, so we'll leave it blank.

Set Emoji

Finally, we'll set the emoji that will go on the 'Reserve' button. This emoji is purely decorative and can be anything you like from your server's emoji list or a standard Unicode emoji.

Locking and Disabling a Room

Under certain circumstances, you may need to lock or disable a room. Locking a room will display an 'Unlock' button on the room's posted status message - allowing employees to effortlessly request an unlock from the owner, while disabling a room will prevent users from reserving it entirely.

Let's lock our room, so only the fanciest of frogs can reserve it.

Click the Toggle Locked button to lock the room.

Similarly, using the Toggle Disabled button will disable the room. However, we won't be doing that in this tutorial.

Adding Images

In order to help users identify the rooms at a glance, you can add images of the room to the room's status message.

Let's add an image now to give user's a better idea of what the room looks like before they reserve it.

Click the Add Image button and respond in chat with the image you want to use for the room.

You can add multiple images to a room, but for this tutorial, we'll only be adding one.

Posting the Room

Once you've set up the room to your liking, you can post the room to the post channel by navigating back to the Room Check main menu and clicking the Post All Rooms button.