User's Guide User's Guide

Table of Contents


Quick Start

Just a few points to get you started. There are basically two kinds of text you will type in NexusChat; commands or speech. Once you are logged in, any regular text you type will show up to everyone as you saying it. If you put a / or a . at the beginning of a line, then it becomes a command. For a list of commands, you can type /? For even more help on a command, you can type /help <command> where <command> is the name of the command you would like to see. Thats the basics, read on for more information about using NexusChat!



A channel is much like a room, in that only the people in that channel can hear what is being said. Channels can be up to 20 characters in length and contain alpha-numeric characters (0-9 A-Z) and underscores (_) Channel moderator is a special access given to the first person into the channel. Moderators may lock, kick users, and change the channel limit. A moderator may also impart moderator access to another user in the channel. Once the last person leaves a channel, it will be reset (unlocked and unmoderated) (see the command list for help on the commands)



The /a command allows you to perform what are called actions. The usage is very simple, whatever follows the /a will be appended to your handle. If you are familiar with MUDs, you probably know this command as an 'emote' ex. If you are 'Joe User' and you type '/alaughs out loud' everyone will see the following text: --> #1:Joe User laughs out loud That #1 is the user's node number (this is to prevent handle spoofing) That's pretty much it, just be creative.


Vote Kill

What is vote kill? Well, the vote kill command allows non-administrators to get rid of pesky or annoying guests. The main idea behind vote kill is that the majority can act in place of a sysop. Of course people with that power like to use it often, and not always properly. Vote kill is toggleable by the system operators So how does vote kill work? Pretty simple; vote kill counts the number of users online that are NOT guests and do NOT have access to the /k (kill/kick) command. The latter is to disqualify admins from the count, in case they are not around or whatever. Everytime a user votes, it is checked against the current count. (NOTE: no user may vote more than once) If the current count is *greater* than half of the counted users, the guest is killed*. * This is true in all cases except when there is only one counted user online, if that is the case, the guest will not be able to be killed. So, for example, say there is 1 sysop, 1 guest, and 2 users online. Both users will have to vote to kick the guest. If three users are online, only two of them must vote, and so on. Another thing to note is that votes stick across voters calls. That means that if a couple of users vote and then log out, and another user comes on and votes, it will be calculated with the current online user count and the cummulative vote count, if that makes any sense :) (note: a guest is defined as a user with a class priority of 0, if you don't understand what this means, ask a sysop)


Color Codes

Using the color code special character (the 'pipe' |) you can set foreground and background colors with the following codes: |f0 Black |b0 Black |f1 Blue |b1 Blue |f2 Green |b2 Green |f3 Cyan |b3 Cyan |f4 Red |b4 Red |f5 Magenta |b5 Magenta |f6 Brown |b6 Brown |f7 Light Gray |b7 Gray |f8 Dark Gray |f9 Light Blue |f10 Light Green |f11 Light Cyan |f12 Light Red |f13 Light Magenta |f14 Yellow |f15 White Examples: '|f15Hello!' Will print 'Hello!' in white '|f011 color' This one is a little tricky, nchat counts up to two digits after a valid |f or |b. So if you use a 0-9 color code and want a number right after it, you need to add that extra 0 so that the color will be correct.



The email sub system of nchat is very minimal and simplistic, I basically designed it so that admins could have a quick and easy way to communicate with each other when they were not around, but all users may use email. When you login, you will be informed if you have any messages, and if so how many. Typing /mail will show you the oldest message in your mailbox and then delete the message, you may type /mail until your mailbox is empty. To send an email type '/mail <user> <text>' where <user> is the user number of the person you would like to send the message to. <text> is the body of your message (you don't get any carriage returns, its very simple, remember? :))


User Command List

This list does not cover all commands, only those that are default to the USER class, if you want a full command list, consult the NexusChat documentation. /? Display the online command list and help /q Disconnect from NexusChat /h<text> Set your handle to <text> /echo Toggle character echo /ansi Toggle ansi color usage /a<text> Perform an 'action' using <text> (see Actions section) /save Saves your current settings (these are automatically saved when you quit though) /s<args> Without any arguments displays the users that are currently logged on. If you type '/s#' you will receive an "extended" list, displaying the user's channel, and class. If you supply /s with a node number, you will get a very detailed listing of that node. /passwd <text> Change your current password to <text> /p<node><text> This will send a private message <txt> to the person on <node> Private being that only that person will be shown the message. /x<node> Squelch a node. Squelching a node will prevent that user from sending you private messages. /i Display NexusChat version information /msg<text> This will set what is referred to as your 'away message' This is the message that is seen by your node in the right hand side of a /s. People also use this to store quotes and other messages, but you only get 20 characters. /t<number> This changes your current channel to <number> (see Channels section) /ci This command will display information about the current channel you are in such as its capacity and whether or not it is locked. /co This will toggle the locked status of the room. A locked room will prevent any users from getting in. (you must have channel moderator) /ck<node> Kick <node> from the channel you are in (you must have channel moderator) /cm<node> Give channel moderator status to <node> (you must have channel moderator) /cl<number> Set the channel user limit to <number> /cls List all channels with some information /vk<node> Vote kill <node (see Vote Kill section) /page<node> Page without arguments toggles your ability to be paged by other users, with a <node> argument, it will page the user /mail Check your email (see Mail section for info on using email)