Flash Ware Studios
Internet Relay Chat Server (IRC daemon)
Version 1.3

-- About this IRCd

Read this text file to understand how you can automate the server and its tools.
Also read IRCd notes.txt for information about known bugs and
tips, and config.txt for info about .fwsd files.
This IRCd is based on RFC 2812, and should be compatible with any IRC client.

Tips:
* Whenever you find a user@host situation in the config, 127.0.0.1 is always the local clients IP
  By default it is cloaked to %server%=servername, but the IP remains 127.0.0.1! (/USERIP)
* Always have notices shown/enabled, so you can see them in the main server window

-- Server GUI

The server window is a console.
Type "help" to see available commands.

Rightclick any port to see a popupmenu from which you can
restart, close and change any port. Also use the /ports command when you
are an IRC operator on the server with umode +A.

Use the 'topmost' command to make the ircd stay on top.

In the batch section, in the config file you type commands in list form,
that will be performed as in the Server GUI (console window).

-- Operators

In the server config file (.fwsd) you see a lot of oper variables
which affect every operator on your server. The only difference is
if an operator has the +A flag, Server Admin. This operator is in full
control at all times. A normal client cannot gain this flag (yet), 
only the server operator using the servers user interface.

More to come...

Notes:
Operators can talk in a channel in which they are banned, unless kicked or channel 
flag +m is enabled.
Operators must be chanops to set topic no matter what, unless a script is made for
that purpose.
A client with usermode +A (server admin), is not god unless he has all power-usermodes.
You can restrict any IRC operator to a few selected usermodes, making his power
as limited as you would want it.

-- Batch files

Example:
- Every batch file should start with:
@echo off

- then with the execution of cert. servers:
rem Usage: fwsd IRCd [configfile]
- the [configfile] MUST have the .fwsd extension
- [configfile] can be omitted, which would make the ircd try ircd.fwsd
start IRCd ircd.fwsd

- execute IRC client?
rem Usage: fwsdClient server port (password)
- password option can be omitted
- local server, std. port 6667, no password
start fwsdClient 127.0.0.1 6667

- then perhaps the listener, with a hard-to-guess password
start Listener mysecretpassword

- and to close the batch window
exit

-- Servers tools

Config.exe:
Edits the servers config files (.fwsd), and lets you edit
each servers MOTD files. Note: The Motd function currently
only works when servername and servername.fwsd are exactly
like. Ill fix this later on!

ConNuke.exe:
Tries to kill any listening daemon by connecting and disconnecting
an awful lot of times. This is a pain in the ass
for the FWS IRCd, but it still runs as if nothing happens =)
The port is closed automatically if there is too much activity on
the spesific port. This tool is NOT meant for DoS purposes!

fwsdClient.exe:
I just started building this advanced IRC Client, so please
ignore its many bugs for now. It will get better.
Usage (parameters): fwsdClient.exe [server] [port] (password)
There is also an .ini file: fwsdClient.ini

Socket.exe:
Basic "telnet" client, everything is text/raw, but its very
possible to enter a server and chat with it. I often use it to
check possible bugs. My debugging tool. Can be used like telnet.
Line is ended with CR or LF.

IRCd.exe:
The main server file, check its size :)
Usage: 	IRCd.exe [filepath\]file.fwsd
Path or not, both works. Thats why batch files (.bat) can be used.
As you can see the .fwsd files are the fwsircd version of .conf.
If no parameter is used with IRCd.exe, "ircd.fwsd" is used.

ListenCon.exe:
Connects to a remote Listener.exe and with the correct password makes
it start the IRCd. Useful or not I like having choices and a solution
to every problem. The listener uses port 6897.
ListenCon usage:
ListenCon Host Port Pass Configfile

Listener.exe:
Listens on port 6897 for requests.
Usage:	Listener.exe [password]

TestBots.exe:
Basic bots which just register and join a channel. Create as many as you
want, but of course 500 or more will strangle your machine!

Resolver.exe:
Type IP or hostname to (try to) resolve it.

Signal Die, Signal Rehash and Signal Restart uses the signal port on the IRCd.

fwsbnc.exe:
IRC proxy with fwsdenc encryption support

fwspipe.exe:
IRC pipe with fwsdenc encryption support

fwsdGraph.exe:
Used by IRCd.exe for showing connection statistics and such.
More features will come...

Config.exe:
Configuration editor

Password.exe
Generate encrypted passwords.

fwsdServ.exe:
FWS IRCd Services
Read IRC Services.txt file for more info on how to with the FWS IRCd services

Last updated 02.07.2005