Welcome to the user guide for the IRCWX Staff Client. Here you will find useful information for the operation of the IRCWX Staff Client. This guide will give you a section by section review of the functions and operation of the client.
Now that you have downloaded and unzipped the IRCWX Staff Client let's go through how to get it started. First you will double click on the mIRC exe file to start the client. Once the client is opened it will ask you to fill in some settings.
The main dialog controls the connection/server
notices/sounds of the staff client. You will
need to get your connection details from your
system admin as they vary per server and staff
member.
Enter the details the dialog requests and hit the "Update Information" button. If your settings are correct you should be able to connect to the server by pressing the button.
The "
Server Notices"
tab is for turning off/on the server notice
windows. Server notices contain information
including: authentication, room joining,
connections, room creation, as well as errors
pertaining to those actions. Information
provided includes user's email/nickname/ip
address/room affected/etc. Note these windows
are OFF by default. You must check the boxes of
the notices you wish to monitor.
The "
Sounds"
tab allows you to turn off/on various event
sounds for your client. Note sounds are off by
default. You must check the boxes to turn
individual sounds on. If you wish to change a
sound you can replace it in the sounds folder.
Make sure you use the same filename and type to
replace a sound.
You will be notified with a popup box when there is a new version available. To update your client with a new version you simply copy and paste the new files into your current client's main directory. Updates do not include variable file or mainsettings.dat. If you have made any edits to the main files of the client you will have to re-add those. If you do edit the client you should create new files in remote to do so.
To access the channel menu you must right click in the channel window.
- AutoJoin: set/remove room from autojoin when connect
- Broadcast To Room: send a custom room broadcast
- Room Access: opens the room access dialog
- Room Properties: opens the room properties dialog
- CLOSE ROOM: closes the room
- KILL ROOM: kills/removes room from the server
- Set Room Topic: set the topic of the room
- Set Welcome Message: set the room welcome message
- Set Ownerkey: set the ownerkey to the room
- Set Hostkey: set the room hostkey
- Set various modes: set/unset various room modes
- Helpdesk Addon: opens helpdesk addon dialog
- Custom Messages Addon: open custom messages dialog
- Pager Addon: opens pager addon
- Nickname: provides information on the user
- Ignore: add/remove user to ignore
- Gag: +g this will prevent a user from interacting in a chatroom. This only affects normal users with no op status.
- Un-Gag: removes gag -g from a user
- Get User Modes: This will display all current user modes set. Mainly used for +g determination.
- Profile: view the user's profile
- Whois User: whois user to get information
- Status: change the user's status level
- Access: control user's room access levels and mass options
- Kick: kick user and clones of the user
- Ban: ban user and clones of the user
- Kick Selected: kick all users selected in the nicklist
- Ban Selected: ban all users selected in the nicklist
- ServerBan/Kill IP: serverban and kill user by IP
- i: Set room to invitation only. Only users that are /invited may enter.
- f: Room filter. This will filter out certain profanity form showing to the room.
- k: Room key. This will set a room key that must be used to enter the room.
- l: Room limit. Set the max limit of users that the room will accept.
- m: Room is Moderated. Only users with voice +v may send messages to the room.
- p: Room is private and will not show on the site room list.
- r: Registered user room
- t: Only a host or owner may set the room topic.
- u: Room Knocks. This will show room owners if a person sends a Knock to the room.
- w: Normal users cannot whisper non-hosts (note that this is a lowercase w).
- x: Mode restricts visibility of messaging within a channel.Any message sent by a member will only be received by the hosts and owners.
- P: This is room join flood protection.
- R: Registered network room
- W: Guests cannot whisper non-hosts (note that this is an UPPERCASE W).
Dialog shows a list of rooms on the server
- To create a room you can choose Room Create from the menu or simply type /j roomname
- Using this dialog you can create a room and preset all the options needed.
Dialog shows a list of rooms on the server
- Includes button for remote room access dialog
- Room categories are determined by the "roomcats" file in the main_settings folder. This file should be auto populated when you first run your script. If you do not see a list of categories please restart the client. If the problem persists please notify your server admin.
Dialog shows the results of a room whois.
- This dialog is accessible by doing /whois %#roomname or by using the roomlister.
- Once you have selected an entry you can peform various commands such as whois, gag, kick/ban, kill, etc on the user.
Use the room access dialog to control access levels for a room.
- DENY: Disallow access to an object that is accessible
- GRANT: Allow access to an object that is inaccessible
- HOST: Channel host access to specified channel
- OWNER: Channel owner access to specified channel
- VOICE: Voice access to specified channel
- Use File Menu to import/export saved access lists
- Use Actions Menu to remove entries
- Use View Menu to select different level views
- Entries can be nickname/passport/ip and wildcard * is allowed but should be limited
The best approach to using access entries is to use the member's passport. You will notice there are .'s in the passports. This makes parts of the passport dynamic and thus should not be used. For example if you see the passport:
191077a.3c59dc048e8850243be8079a5c74d079@SPCNMEMBER you should only use the
3c59dc048e8850243be8079a5c74d079 for the access entry. You may also see two sections with .'s like:
1.42cad.0_eae6aec19cf20c5786e428428cd7867c@SPCNMEMBER. In this case you should only use the
0_eae6aec19cf20c5786e428428cd7867c part. In
most cases the client converts this for you with automated commands. However in manual entries you should ensure you follow the preceding guidelines. Passports with 0_ are guest passports. 1_ are 3rd party guest passports. 10_ are staff members.
Use the server access dialog to control access levels for a server.
- DENY: Disallow access to the server
- GRANT: Allow access to the server
- Use File Menu to import/export saved access lists
- Use Actions Menu to remove entries
- Use View Menu to select different level views
- Entries with "D" are banned/denied and entries with "G" are grants
- Entries can be nickname/passport/ip and wildcard * is allowed but should be limited
Use the room properties dialog to edit room properties and modes.
- To edit a property you must unlock it first.
The Helpdesk Addon is helpful in speeding up the assistance speed for helpdesk users.
- All messages are editable by clicking the "options" button.
- You must set the Room Name for this to work. The default is set to Helpdesk. If you wish to use this addon in another room you need to change the roomname and save options.
- Highlighting by selecting a nickname in the nicklist will attach the user's nickname to your responses.
- To enable the user join sound when a person enters the helpdesk you must check the box "User Join Sound"
- To halt the sound from playing when a staff member joins you need to check the "Halt Sound on Staff Join".
The Custom Messages Addon allows you to store up to 55 custom messages.
- To edit a button's message you can click the ? button to the right of the button.
The Pager System Addon allows other users and staff to alert you and leave you messages while connected to the network.
- You can add alternate names.
- Option for staff only or anyone.
- To page a staff member use the ! symbol along with their nickname. ie: !Sysop_Steel
- Using !911 will alert all staff members in that room.
Server Notices Dialog allows you to turn off/on custom service notice windows