 ______________________________________________________________________________________________
|                                                                                              |
|                                  IMC2 Cyclone Install File                                   |
|                                                                                              |
 

DESCRIPTION

IMC2 is an intermud communications protocol for connecting multiple MUD games together. Hubs
connect these muds together into entire IMC2 networks. This bridge connects these separate IMC2
networks together in a limited way that allows for each individual network to keep its sovereignty.

This bridge is the first time that an all encompassing solution is available for multiple networks. 
It was created from modifying a Hermes hub. A lot of useless code was removed, and some new features
were added.


INSTALLATION INSTRUCTIONS


Step 1 - Getting Ready

Place the bridge's directory in an appropriate user account that you have access to, and that is
not a possible security risk. Places not to stick a bridge are any special daemon-reserved user accounts,
in the 'root' user account, or in a privileged user account. If the server you put the bridge on is not
owned or ran by you, ask the system administrator if you can run a network protocol daemon. It is
especially important to ask if you plan on running a bridge on a mud hosting service's server.

Next, you must make sure that you will not have firewall problems in connecting to the desired networks.


Step 2 - Bridge Installation

All that you have to do is enter the hub directory and type make.


Step 3 - Obtaining Permission from Networks

Now that you have installed your IMC2 bridge correctly, you should get permission to connect it to the 
IMC2 networks that you wish to unite. Attempting to connect a network without its consent is unethical
and will probably get you banned from it.


Step 4 - Configuration

Once you have obtained permission, the IMC2 network administrator for each network should give you the
appropriate connection information. Remember to inform the network administrator that the connection 
lines should consist of the following (Note: there should be one entry per affiliate of the network)
(Another Note: Termonology is explained in the included TERMINOLOGY file):       

(for a relay bridge)
Mud-Type2 <affiliate-name>:<clientpwd><serverpwd>

(for a full bridge)
Router-Type1 <affiliate-name>:<127.0.0.1>:<some closed port>:<clientpwd><serverpwd>

For the bridge configuration file, there are four types of entries. They must be in this order;

*   Network
*   Full-Bridge and Router-Bridge
*   Bridged-Channel

Now, for a detailed look at the structure of each type:

[Network]

Network <network's name>
Connection <host>:<port>:<clientpwd><serverpwd>(all affiliates connected to the hub share this info)
Blacklist <space-separated list of blacklisted people/muds/networks>(must at least have word none) 

[Relay-Bridge]

Relay-Bridge <space-separated list of networks in the bridge>(must have all been declared earlier)

[Full-Bridge]

Full-Bridge <space-separated list of networks in the bridge>(must have all been declared earlier)

[Bridged-Channel]

Bridged-Channel (space separated list of the following format) <network>:<channel's hub>:<name> 


Step 5 - Starting the Bridge

Now that you have the appropriate settings in your configuration file, you can type './bridgestart &'
to connect to your chosen IMC2 network. If you have nohup available on the server you are using,
you may want to try typing 'nohup ./bridgestart &' instead.    


CONTACT INFO

If you wish to contact the author of this IMC2 bridge, or have questions or problems regarding it,
please use the IMC2 UIN Public Forum. This forum can be found at http://uin.aethiamud.org.


--- THE END ---

