uchat docs

Learn the three ways to add features to a uchat chat room on your site, and which one to pick for each job.

Create a chat room and paste the install code to show it on your site. Also covers frameworks, CMSs, channel chat rooms, and what to check when the room does not show.

Use a page script to receive the chat room join event, show a notice line, and send a message.

How members logged in to your site join the chat room with their nickname, ID, level, and permissions, and what to check when they cannot join.

How to register events before uchat.js loads, how to split events across several chat rooms on one page, and how to attach and clean up chat rooms in an SPA, and how to add a floating widget in the bottom-right corner.

Follow one example that adds a menu button to the default skin, takes input with a dialog, attaches an area above the chat, and cleans up with remove functions.

How to use channels (room.plugin) to exchange non-chat data between people in the same chat room, and how to validate the data you receive.

How to send data from your server to a chat room channel with the server API (v2), and how your page script or a plugin can pick out and show only the data your server sent.

What to check in tokens, member integration signatures, channel data, the server API, and screen output before you launch a site with uchat.

Attributes of the u-chat tag that embeds a chat room, and the rules for installing and removing it.

U.chat(), the entry point for page scripts, and the values and functions of the room object that event callbacks receive.

A list of chat room events, the data each one receives, and what is actually blocked when a before handler returns false.

The full list of the room.skin API, which adds menus, dialogs, areas, and styling to the default skin (basic-v2).

The canonical reference for room.plugin channels, which exchange real-time data, covering functions, value formats, and save and sending limits.

Authentication, endpoints, responses, and error codes for the REST API (v2) that lets your server read a chat room's state and send data to plugin channels, plus the older v1 method.

The fields of the member integration user_data string, how to build the signature (hash), the time sync checks, and fixed values for testing.

The room.skin API of the legacy skin (basic) used by older chat rooms — jQuery DOM, menu bar, popups, nickname menu — and a mapping table for moving to the default skin.

An example where everyone in the chat room watches a YouTube video picked by a moderator or higher.

An example where you challenge someone to rock paper scissors from the nickname menu, verify the values both sides sent, and announce the result.

An example of changing nickname colors and images, message backgrounds, line spacing, and hiding nicknames in the default skin.

An example where your server notifies the chat room through the server REST API (v2) when a payment completes, and a page script receives it and shows it in the chat window.

A short developer-oriented summary of the admin page menus and the admin commands used inside the chat room.