Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/AresChat/sb0t/llms.txt

Use this file to discover all available pages before exploring further.

Room is a static singleton object that is available in every sb0t script without any import or instantiation. It exposes the core properties of the running chatroom, allowing scripts to read server metadata and make controlled mutations such as changing the active topic or setting a room-wide URL tag.

​
Properties

​
Room.version
int
required
Scripting API version integer. Use this to guard features that may not be available in older server builds. Read-only.
​
Room.name
string
required
The configured name of the chatroom as set in the server settings. Read-only.
​
Room.topic
string
required
The current room topic broadcast to all users. Assigning a new string immediately pushes the updated topic to every connected client. Read/write.
​
Room.botName
string
required
The display name used by the server’s bot when sending automated messages. Read-only.
​
Room.customNames
bool
required
Global switch for custom user names. When set to false, scripts cannot override individual display names room-wide. Toggling this at runtime takes effect immediately. Read/write.
​
Room.externalIp
string
required
The externally visible IP address of the server, returned as a dotted-decimal string. Read-only.
​
Room.hashlink
string
required
A fully-formed arlnk:// deep-link that clients can use to join this room directly. Read-only.
​
Room.port
int
required
The TCP port on which the chatroom is listening for incoming Ares connections. Read-only.
​
Room.startTime
number
required
Unix timestamp (seconds since epoch) recorded when the server process started. Useful for calculating uptime. Read-only.

​
Methods

​
Room.setUrl(address, text)
function
Sets the room-wide URL tag that is displayed to all connected users. Both parameters must be non-empty strings for the tag to be applied. Passing two empty strings ("", "") clears any existing URL tag, behaving identically to Room.clearUrl().
ParameterTypeDescription
addressstringThe fully-qualified URL (e.g. https://example.com).
textstringThe human-readable label shown in the Ares client.
​
Room.clearUrl()
function
Removes the currently active URL tag from the room. All connected clients will immediately see the tag disappear.

​
Examples

// Set a welcome topic when the script loads
Room.topic = "Welcome to " + Room.name + "! Type !help for commands.";

Build docs developers (and LLMs) love

Get started for freeTalk to us