This document covers...
  • 1) Rooms
  • 2) Moderators
  • 3) Creating a room
  • 4) Admin functions
  • 1) Rooms

    Rooms allow you to create sub-topics in your chat room or entirely new topics altogether. readyChat's room system allows you to create an unlimited number of rooms quickly and easily from your administration panel. Rooms are lightweight files stored in the chat/ directory on your server. This allows for fast swapping between rooms without straining your web server.

    2) Moderators

    At this time moderators can moderate globally. At a future time this may be change to include room specific moderators.

    3) Creating a room

    Creating a new room is an easy task, you'll have multiple rooms in no time! See below for an explanation of the required fields.

    Room Title
    The room title is self explanatory. This is the title of your new chat room. Don't worry, you can change this later if you're not satisfied. This should be a short nippy title else it won't display too nicely on the rooms list.

    Room Topic
    The topic is displayed at the top of the chat when a user connects to a room. It can be useful for outlining the basic room rules, or for setting a topic users must relate their chats to.

    Room Limit
    The room limit allows a set number of people into the chat room at any one time. The recommended value is 25, though it can be set higher. We recommend keeping your lobby limit high so users won't have a problem connecting initially.

    Room Icon
    To set a room icon, insert an URL into this field. The recommended size is 16x16/12x12 (px) though icons will be resized regardless of what size you enter.

    Room Password
    If a room password is present, users must enter it before they can enter the room. This is perfect for admin only rooms, or rooms where you'd like a select few members to enter. Passwords should contain letters and numbers, other characters are accepted but are not recommended.

    4) Admin Functions

    Prune chat rooms
    Similar to the /prune command that can be run inside individual rooms, this task will prune all chat rooms instantly to clear old messages.

    Kicking all users from chat
    The "Kick all users from chat" option allows you to kick all users from all rooms. This might be useful if you wish to close your chat site for maintenance and cannot risk doing it whilst chatters are online. The suggested method of use is heading to site settings and closing the login form. After doing this, kicking the site will disconnect any clients and prevent them from logging in.
    "Kick all users from chat" will kick moderators but not administrators.

    Send global announcement
    Sending a global announcement will send a message to all rooms which you can define. This is useful for announcing competitions, information regarding the chat and more. The system uses the same method for parsing as the live chat does, therefore HTML is disabled. You can insert links by typing it out in full. For example, "http://google.com".