EnergyMech: Docs: Installing

== Installing (2.x) == Installing (3.x) ==

Important!

The examples in this text shows how things can look when you install your EnergyMech. UNIX shells can differ alot nowadays. There will be atleast small differences between the sample outputs on this page and how it looks on your own shell.

Also note that this is not a UNIX tutorial. If you dont know enough basic UNIX commands to install your EnergyMech with the help of this document, then you shouldn't even try.

Downloading

First of all, you need to retrieve a suitable distribution package. There are a few packages to choose from currently, please refer to the download page to see which one suits you the best.

When you know which package you want, start ftp and connect to ftp.eggheads.org.

You can find the distribution packages in the directory /pub/energymech. Just pick the one you want and download it to your shell. Don't forget to turn on BINARY mode (a.k.a. IMAGE mode) before you transfer the file as it otherwise might be corrupted.

As an alternative, you can use Lynx to access the download page of this website and download the package of your choice from there. If you're not familiar with Lynx, use ftp.

If security is a concern to you (it should be if you are planning on running the EnergyMech as root), be sure to grab the PGP signature file or the MD5 checksums from the download page to verify the package with once you have downloaded it.

It might look something like this:

~$ ftp
ftp> open ftp.eggheads.org
Connected to ftp.eggheads.org.
220 ftp.eggheads.org NcFTPd Server (licensed copy) ready.
Name (ftp.eggheads.org:mech): ftp
331 Guest login ok, send your complete e-mail address as password.
Password: (you enter your email address here)
230-You are user #2 of 50 simultaneous users allowed.
230-
230 Logged in anonymously.
ftp> cd pub/energymech
250 "/pub/energymech" is new cwd.
ftp> dir
200 PORT command successful.
150 Opening ASCII mode data connection for /bin/ls.
-r--r--r--   1 ftpuser  ftpusers   123269 Oct 24 07:00 emech-2.7.0.tar.bz2
-r--r--r--   1 ftpuser  ftpusers   148726 Oct 24 06:59 emech-2.7.0.tar.gz
-r--r--r--   1 ftpuser  ftpusers     1653 Mar 19 14:49 spaceman-pgp.asc
226 Listing completed.
ftp> bin
200 Type okay.
ftp> get emech-2.7.0.tar.gz
local: emech-2.7.0.tar.gz remote: emech-2.7.0.tar.gz
200 PORT command successful.
150 Opening BINARY mode data connection for emech-2.7.0.tar.gz (148726 bytes).
226 Transfer completed.
148726 bytes received in 146 secs (0.84 Kbytes/sec)
ftp> quit
221 Goodbye.
~$ ls -l emech-2.7.0.tar.gz
-rw-r--r--   1 mech     users      148726 Mar 19 13:37 emech-2.7.0.tar.gz
~$

By now you should have your chosen package on your shell.

Unpacking

Once you have downloaded your selected package, you need to unpack it. The package will unpack into a directory called "emech" so there is no need to make a directory to unpack the files in.

If your shell has GNU TAR the command would look like:

~$ tar zxvf emech-2.7.0.tar.gz

And if your shell has any other version of TAR, it would look like:

~$ gzip -dc emech-2.7.0.tar.gz | tar xvf -

The filename would of course vary depending on the package you chose to download.

As the files are being decompressed and untarred the filenames with path will be listed. If any errors occur you most likely have a corrupted package or your shell quota limit has been reached.

Compiling

If you chose one of the binary install packages, skip this stage as you already have an executable to run.

To be able to compile, you first have to run the configure script. The configure script will check for all the programs that is needed to compile the mech and also ask for which options you want your mech to have. The options it asks for can only be changed at compile time, and not while the EnergyMech is running so make sure you make the right choice or you will have to recompile later on.

If the configure script exits before it is done, it was unable to locate some program or other component that is needed to be able to compile an EnergyMech. If it does, you are out of luck unless you can compile on another machine or if one of the pre-compiled packages works on your shell.

The options you have to choose from are the following:

DEBUG
This option makes the EnergyMech rather large, but can be quite useful when the EnergyMech doesnt act like its supposed to do.

SEEN
If you want the SEEN command you will have to enable this option. It is not recommended though, since the SEEN feature can use up a very large amount of memory.

LINKING
Enable this option to make it possible for EnergyMechs to link with eachother.

TELNET
Enable this option to include support for telnetting to the LINKPORT of an EnergyMech. This option requires that the LINKING option has been enabled (obvisouly, since there otherwise is no linkport to connect to).

DYNAMIC COMMAND LEVELS
If you enable this option you can change the levels required for doing commands at runtime. Without this option, the only way to change command levels is to change them in the source and recompile.

NEWBIE
The newbie option adds some extra help output and other miscellanious stuff. An experienced EnergyMech user would typically not need this newbie support.

ALIAS
If you enable this option, you may create aliases for EnergyMech commands. These aliases will have the same syntax and functionality as the aliased command.

WINGATE
If you want your EnergyMech to use wingates you have to enable this option.

SESSION
Enable this option to allow the EnergyMech to save changed settings, new channels, and other stuff to the mech.session file.

Once the configure script has finished setting up the configuration files, you may compile the EnergyMech by using the command make.

~$ make clean mech install
cd src ; make clean
make[1]: Entering directory `/home/mech/emech-2.7.0/src'
/bin/rm -f cfgfile.o channel.o com-ons.o combot.o commands.o dcc.o function.o link.o main.o
memory.o parse.o socket.o userlist.o vars.o xmech.o mech mcmd_gen mcmd_gen.o mcmd.h core
make[1]: Leaving directory `/home/mech/emech-2.7.0/src'
cd src ; make mech
make[1]: Entering directory `/home/mech/emech-2.7.0/src'
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c mcmd_gen.c
gcc -g -o mcmd_gen mcmd_gen.o
./mcmd_gen >  mcmd.h
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c cfgfile.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c channel.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c com-ons.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c combot.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c commands.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c dcc.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c function.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c link.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c main.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c memory.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c parse.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c socket.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c userlist.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c vars.c
gcc -pipe -g -Wshadow -Wall -O2 -m486 -c xmech.c
gcc -g -o mech cfgfile.o channel.o com-ons.o combot.o commands.o dcc.o function.o link.o
main.o memory.o parse.o socket.o userlist.o vars.o xmech.o  
make[1]: Leaving directory `/home/mech/emech-2.7.0/src'
cd src ; make install
make[1]: Entering directory `/home/mech/emech-2.7.0/src'
/bin/chmod 0700 mech
/bin/mv mech ..
make[1]: Leaving directory `/home/mech/emech-2.7.0/src'
~$ ls -l mech
-rwx------   1 mech     users      414384 Oct 26 07:15 mech*
~$

You should now have an executable named mech in your EnergyMech directory.

Configuring

The EnergyMech reads the file mech.set by default when it starts. This file contains all the configuration commands. A sample configuration file comes with the distribution archive (sample.set). You should not use the sample configuration file, but rather write your own from scratch.

You will need to configure a minimum of one bot and one server. If you want to find your bot when you are online you should also configure one channel for the bot.

Running

Oopps... havent come this far yet. So sue me!

Read more help on adding users if you don't know how to add yourself.