> ## Documentation Index
> Fetch the complete documentation index at: https://www.retailnexus.work.gd/llms.txt
> Use this file to discover all available pages before exploring further.

# Reservation System Manual

In this manual, you can see how to setup the reservation system, install it and configuring it.

#### Importing the file to Roblox Studio

<Steps>
  <Step title="Step 1">
    Download the product file from the discord server. There's a channel named "Reservation System" under the "Products" folder, where you can download the product file.
  </Step>

  <Step title="Step 2">
    Import the file to Roblox Studio by dragging and dropping the file to your experience
  </Step>

  <Step title="Step 3">
    Ungroup the model "Reservation System | UNGROUP"
  </Step>
</Steps>

#### Configuring the master settings of the system

Here you can configure the master settings of the system. Go to `RN | Reservation System > Configuration` to configure the system.

##### Configurations

<AccordionGroup>
  <Accordion title="`CheckInTimeout`">
    Changes the timeout for check-in after the reservation starts in minutes. Example: if  set to 10, you have to check-in to the room within 10 minutes of the reservation starting. The reservation is automatically cancelled after this timeout ends. Default parameter: 10
  </Accordion>

  <Accordion title="`MaxBookingTime`">
    Changes the maximum time of a reservation in minutes. Example: if `MaxBookingTime` is set to 60, the maximum time for a booking is 60 minutes. Default parameter: 60
  </Accordion>

  <Accordion title="`MaxTimeBeforeBooking`">
    Changes the maximum time in minutes before a reservation can be made. Example: if set to 30, the maximum time you can make a reservation in advance is 30 minutes. Default parameter: 30
  </Accordion>

  <Accordion title="`Colors`">
    With this table, you can change different screen and side LED colors for different scenarios. Default parameters:<br />`Available = Color3.fromRGB(80, 160, 100),`

    `		Busy = Color3.fromRGB(180, 70, 70),`

    `		CheckIn = Color3.fromRGB(200, 140, 50),`

    `		Offline = Color3.fromRGB(100, 100, 100)`
  </Accordion>
</AccordionGroup>

ㅤㅤㅤㅤㅤ

#### Configuring a Reservation Screen's settings

Here you can configure each individual Reservation Screen's settings. Go to `RN | Reservation System > Reservation Screen > Configuration`

<AccordionGroup>
  <Accordion title="`RoomName`">
    Changes the name that will be displayed on the screen.
  </Accordion>

  <Accordion title="`MaxPeople`">
    Changes the maximum number of people that can fit in the room.
  </Accordion>
</AccordionGroup>

ㅤㅤㅤㅤㅤ

### Using the system

Here you can see how you can use the system.

ㅤㅤㅤㅤㅤ

#### Room Available

When the room is available, you can see the upcoming reservations and schedule a new reservation. To schedule a new reservation, press "Reserve" to open the reservation menu.

<Frame>
  <img src="https://mintcdn.com/retail-nexus/ytdMiUyLeERrzfFJ/images/RSAvailable.png?fit=max&auto=format&n=ytdMiUyLeERrzfFJ&q=85&s=aafc4c42aa5d8285e1cff670053fca39" alt="RS Available" title="RS Available" className="mx-auto" width="997" height="630" data-path="images/RSAvailable.png" />
</Frame>

ㅤㅤㅤㅤㅤ

After pressing "Reserve" this menu will come up on the screen. Here you can make a new reservation.

<Frame>
  <img src="https://mintcdn.com/retail-nexus/ytdMiUyLeERrzfFJ/images/RSMakeReservation.png?fit=max&auto=format&n=ytdMiUyLeERrzfFJ&q=85&s=573412ce6856f07ad12c36cc49bedbd0" alt="RS Make Reservation" title="RS Make Reservation" className="mx-auto" width="998" height="628" data-path="images/RSMakeReservation.png" />
</Frame>

Use the up/down arrows above and below the numbers to change them. The left number is the time that the reservation starts. The right number is the time that the reservation ends.

Click on the "New Reservation" text to open the on-screen keyboard where you can change the reservation name.

You can toggle the "Require Meeting Passcode" if you want there to be a password required when you check-in to the reservation. If Meeting Passcode is toggled, you can click on the "Passcode" field to change the Passcode for check-in. The Passcode is by default randomly generated if you don't modify it.

Click on the "Waiting Room" toggle if you want the reservation room to be a waiting room for the time of the reservation.

Click "Reserve" to complete the reservation. The screen will show a confirmation text before returning to the home screen. If there's a problem with any of the fields in the reservation, the screen will show a notification that the field is filled in incorrectly.

ㅤㅤㅤㅤㅤ

#### Checking in to a reservation

When it is time for a reservation, the screen's and side LED's colors will turn orange or the set color in settings and the button on the screen will change to "Check-in" indicating that you can now check-in to the room. If you do not check-in within the set time in settings, the reservation will be automatically cancelled.

<Frame>
  <img src="https://mintcdn.com/retail-nexus/ytdMiUyLeERrzfFJ/images/RSCheck-in.png?fit=max&auto=format&n=ytdMiUyLeERrzfFJ&q=85&s=4edc481371bddd0ec09f48aff96e9c9a" alt="RS Check In" title="RS Check In" className="mx-auto" width="998" height="630" data-path="images/RSCheck-in.png" />
</Frame>

Click "Check-in" to check-in to your reservation. If the reservation has a passcode, the screen will show you a text field where you are required to input the passcode in to.

ㅤㅤㅤㅤㅤ

#### Room Busy

When the room is currently busy, the screen and side LEDs will be red or the set color in settings. When the room is busy, you can release the room early pressing "Release Room" or make a new reservation by pressing "Reserve"

<Frame>
  <img src="https://mintcdn.com/retail-nexus/ytdMiUyLeERrzfFJ/images/RSBusy.png?fit=max&auto=format&n=ytdMiUyLeERrzfFJ&q=85&s=fc5590455aaf87ff86b51fcf34ae6e9d" alt="RS Busy" title="RS Busy" className="mx-auto" width="994" height="625" data-path="images/RSBusy.png" />
</Frame>

When the reservation ends, the room will automatically be released, and the reservation will be deleted.

ㅤㅤㅤㅤㅤ

#### Deleting a reservation

If you want to delete a reservation that you no longer need, press the gear icon in the top-right corner of the screen to open a menu where you can remove reservations.

<Frame>
  <img src="https://mintcdn.com/retail-nexus/ytdMiUyLeERrzfFJ/images/RSAvailableSettings.png?fit=max&auto=format&n=ytdMiUyLeERrzfFJ&q=85&s=93c86a401d8a2555fe2cf467fca42898" alt="RS Available Settings" title="RS Available Settings" className="mx-auto" width="994" height="625" data-path="images/RSAvailableSettings.png" />
</Frame>

ㅤㅤㅤㅤㅤ

After pressing the gear icon, it will open this menu where you can click the "X" on a reservation to delete it. If the reservation has a passcode, you need to enter the passcode before you can delete the reservation. After deleting reservations, press "Save" to save changes. If you want to cancel deleting a reservation, press cancel.

<Frame>
  <img src="https://mintcdn.com/retail-nexus/ytdMiUyLeERrzfFJ/images/RSDeleteReservation.png?fit=max&auto=format&n=ytdMiUyLeERrzfFJ&q=85&s=1df542c9275dca673a8a3b7e2b025cd9" alt="RS Delete Reservation" title="RS Delete Reservation" className="mx-auto" width="995" height="628" data-path="images/RSDeleteReservation.png" />
</Frame>

ㅤㅤㅤㅤㅤ

<Card title="Reservation System API Documentation" icon="code" horizontal href="https://www.retailnexus.work.gd/reservation-system-api" />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.