Skip to main content

UI Configuration

The Room System includes a highly customizable user interface, allowing you to seamlessly blend the system's menus and panels into your world's specific aesthetic.

By selecting the Rooms Management, you can easily adjust colors, backgrounds, and page titles without needing to edit any code or dig through deep UI hierarchies.

Theme & Background​

These settings control the base look and feel of the Room System's interface.

  • Primary Color: Sets the main accent color used throughout the UI (shown as cyan in the default setup).
  • Background Color: Determines the base color of the UI panel.
  • Background Image: Allows you to assign a custom image to serve as the background for the room's interface.

Door State Colors​

You can visually communicate whether a room is open or restricted by customizing the colors associated with its locked and unlocked states.

Room Is Locked Colors​

  • Is Locked Primary Color: The main color displayed when a room is locked (default is red).
  • Is Locked Secondary Color: The secondary accent color for the locked state (also default red).

Room Is Unlocked Colors​

  • Is Unlocked Primary Color: The main color displayed when a room is open and accessible (default is green).
  • Is Unlocked Secondary: The secondary accent color for the unlocked state (also default green).

Room Config Titles​

If you want to rebrand the different tabs of the Room System UI to better fit your world's theme (for example, changing "Room" to "Apartment" or "Intercom" to "Notifications"), you can easily rename the page headers here.

  • Main Page Text: The title for the primary status page. Default is Overview.
  • Notifications Page Text: The title for the notifications area. Default is Intercom Queue.
  • Intercom Page Text: The title for the active intercom screen. Default is Intercom Feed.
  • Invite Page Text: The title for the menu where owners manage access. Default is Invite Players.
  • Settings Page Text: The title for the room's configuration menu. Default is Room Settings.