You are here: Home > Modules > Unreal

Installing a module

Unreal IRCd has a few modules that add extra functions, or improve on current ones. They only take a minute to install, modules first need to be placed in your Unreal source, and compiled from a source (.c) into a .so before they can be loaded, we will cover this in the steps below:

1. Download the module source file (.c) and place it in src/modules of your unreal install, this will either be unreal/src/modules or Unreal3.2/src/modules if you installed Unreal yourself.

2. Next we need to compile the module, this requires us connecting to the server using SSH, eg. Putty. Connect to your IRCd account using putty, and change directory to your Unreal installation. eg. cd unreal OR cd Unreal3.2

3. Compile the module/s using the following command:
make custommodule MODULEFILE=m_getinfo

The part in italics is the name of the module you're installing, without any file extension.

4. After compiling you will have a modulename.so file in the src/modules folder, this is the module file we can actually load. We load modules by adding a loadmodule line near the beginning of unrealircd.conf.
Using your preferred ftp client, connect to your IRCd account and open unrealircd.conf.

Use the example below to tell your server to load the module:
loadmodule "src/modules/modulename.so";

Getting this part wrong will cause errors, so make sure you include the "'s, spell the module name right and don't forget the .so and ; at end of line. When you have done this save unrealircd.conf.

5. To load the module just do a /rehash from your irc server, hopefully it will rehash, without any errors. You can check to see if it loaded by typing /module which will show you a list of loaded modules.

NOTEDo NOT forget, each module needs to be installed on modules folder located in Unreal3.*/src/modules ex: If you have the latest version of Unreal, type:

cd Unreal3.2.10.4/src/modules and than wget the modules you like

How to install UnrealIRCd 3.2 Modules

• wget http://ircd.zemra.org/modules/mod/antirandom.c
• cd ../..
• make custommodule MODULEFILE=antirandom
• add on your unrealircd.confloadmodule �src/modules/antirandom.so�;
• add this code to your unrealircd.conf

• hideserver {
• disable-map yes;
• disable-links yes;
• map-deny-message �/map Permission Denied � You do not have IRCop privileges�;
• links-deny-message �/links Permission Denied � You do not have IRCop privileges�;
• };

1. cd Unreal3.2/src/modules
1. wget http://ircd.zemra.org/modules/mod/netadmins.c
2. cd ../..
3. make custommodule MODULEFILE=netadmins
4. On your unrealircd.conf, put this line
loadmodule �src/modules/netadmins.so�;

Unrealircd.conf

set {
// Choose "no" here if you would like to allow
// netadmins to kill each other. Otherwise "yes".
netadmins-are-gods yes;
};

• wget http://ircd.zemra.org/modules/mod/operjoin.c
• cd ../..
• make custommodule MODULEFILE=operjoin
• make install
• loadmodule �src/modules/operjoin.so�; (add this line to your unrealircd.conf)
  /rehash your ircd

• wget http://ircd.zemra.org/modules/mod/m_ircops.c
• cd ../..
• make custommodule MODULEFILE=m_ircops
• make install
• loadmodule �src/modules/m_ircops.so�; (add this line to your unrealircd.conf)
  /rehash your ircd

How to install UnrealIRCd 4 Modules

In UnrealIRCd 4 you should place the .c file in your src/modules/third/ directory of the UnrealIRCd source directory.

cp somemodule.c /home/irc/unrealircd-4.x/src/modules/third

Then from your UnrealIRCd source directory you just run make and make install:

cd /home/irc/unrealircd-4.x
make
make install
loadmodule "third/modulename";

UnrealIRCd will automatically detect any .c files in the src/modules/third directory and compile them.

You should no longer use make custommodule, use the method described above instead!

The method from above ensures that when you reconfigure or recompile UnrealIRCd the third party modules will be recompiled as well. Also when you upgrade to a new version, UnrealIRCd 4 will automatically copy the 3rd party modules from your previous UnrealIRCd installation (based on your input of the 1st ./Config question)

Loadmodule directive

loadmodule <file-name-without-suffix>;

/* Just load all of UnrealIRCd's functionality (all 150+ modules) */
include "modules.default.conf";

/* If you want to load modules\m_something.dll */
loadmodule "third/m_something";

/* If you want to load modules/whatever.so */
loadmodule "third/whatever";