TomeNET

(2.1b) Linux (custom/compilation)                                               
---------------------------------

Linux (using pre-compiled client):
----------------------------------
Make sure that ncurses and crypt libraries are installed, package names are
usually libncurses5 and libxcrypt (formerly libgcrypt11). Depending on your
system, there might or might not be numbers appended to the package names
(eg libxcrypt1 instead of libxcrypt), just do a generic search.
Enter the 'tomenet/' folder and type:
        ./tomenet
to start the game.

If you get a font-related error ("Font not found: 9x15") please see PROBLEM 56
in chapter Troubleshooting (9.8).


Linux (compiling from source):
------------------------------
There are additional distribution-specific information on Mikael's website at:
https://muuttuja.org/tomenet/installation-linux.php
(It's linked on www.tomenet.eu -> "Links".)

You can get the source from www.tomenet.eu, also see (1.1).

How to compile the game binary:
Go into '/tomenet/src' where the file 'makefile' is located.

Dependencies, that you must make sure you have installed:
C-devel, X11-devel, ncurses, ncurses-devel and crypt libraries.
The package names are usually (may vary depending on the build system):
build-essential, xorg-dev, libncurses5, libncurses5-dev, libc6-dev, libxcrypt
(formerly libgcrypt11) and libxcrypt-dev. Depending on your system, there might
or might not be numbers appended to the package names (eg libxcrypt1 instead of
libxcrypt), just do a generic search.

Since version 4.4.5 which supports music and sound via SDL2, you also need
libsdl2-mixer-devel, libsdl2, libsmpeg. Usual package names (SDL2, not SDL!):
libsdl2-mixer2.6, libsdl2-mixer2.6-dev, libsdl2debian, libsdl2-dev,
(preferably libsdl2debian-pulseaudio, eg under Ubuntu), libsmpeg0,
libsmpeg-dev and optionally more formats like libogg/libvorbis.
Sometimes instead of the libsdl2* packages your system might
provide the packages simply named 'sdl2' and 'sdl2_mixer' instead.
If you don't want to use audio, edit the makefile and compare the two
paragraphs titled 'Without SDL' and 'With SDL' and edit the makefile
accordingly, to compile it without SDL audio support.
NOTE: If you are compiling the above packages yourself, make sure that you
install the specific audio format libs (smpeg, ogg/vorbis/..) _before_ you
install libsdl2-mixer, so its configure script will recognize those formats
and enable support for the according file types.
Note that sdl2_mixer must be at least version 2.6!

Enter these two lines:
        make clean
        make tomenet
and the binary 'tomenet' will be created in this folder 'tomenet/src'.
IMPORTANT NOW: You need to move the binary 'tomenet' that was just created one
               level upwards, so it's placed in the 'tomenet/' folder!
After that, go up one level into your 'tomenet/' folder. There type:
        ./tomenet
to start the game.

If you get a font-related error ("Font not found: 9x15") please see PROBLEM 56
in chapter Troubleshooting (9.8).


Configure TomeNET on Linux by editing config files or setting environment vars:
(This is not really required. Most things can be configured by in-game menus or
by dragging/positioning the game windows with the mouse.)
-------------------------------------------------------------------------------
To configure which windows are visible and what font they use and all sorts of
other options, edit the file ".tomenetrc" which should be in your home folder
(or specify alternative location via -f command-line option, see below).

Note: If the game client's positioning of windows doesn't work on your system,
you can use other means such as KDE's native window positioning (right-click
the windows and modify the "special window settings" or "special application
settings") or the tool Devilspie (should be in your default repository) if
you're on Gnome or Xfce or anything else. 'gdevilspie' may also be available,
which is a graphical version of devilspie.

Alternatively to using the .tomenetrc file for window configuration, you can
also set environment variables. These settings will override .tomenetrc.
Environment Variables:
TOMENET_X11_FONT_SCREEN (height and width of main window cannot be changed)
TOMENET_X11_WID_MIRROR, TOMENET_X11_HGT_MIRROR, TOMENET_X11_FONT_MIRROR
TOMENET_X11_WID_CHOICE, TOMENET_X11_HGT_CHOICE, TOMENET_X11_FONT_CHOICE
TOMENET_X11_WID_RECALL, TOMENET_X11_HGT_RECALL, TOMENET_X11_FONT_RECALL
TOMENET_X11_WID_TERM_4, TOMENET_X11_HGT_TERM_4, TOMENET_X11_FONT_TERM_4
TOMENET_X11_WID_TERM_5, TOMENET_X11_HGT_TERM_5, TOMENET_X11_FONT_TERM_5
TOMENET_X11_WID_TERM_6, TOMENET_X11_HGT_TERM_6, TOMENET_X11_FONT_TERM_6
TOMENET_X11_WID_TERM_7, TOMENET_X11_HGT_TERM_7, TOMENET_X11_FONT_TERM_7
Use the 'export' command to set them, eg:
        export TOMENET_X11_FONT_SCREEN=8x13
        export TOMENET_X11_WID_TERM_4=80
        export TOMENET_X11_HGT_TERM_4=24
TOMENET_X11_FONT sets one font globally for all windows. It's overridden by
the window-specific font variables listed above though.
Depending on your system, some possible fonts are usually:
4x6, 5x7, 5x8, 6x9, 6x10, 6x12, 7x13, 7x14, 8x13, 9x15, 10x20, 12x24.

POSIX command-line options:
-h                      displays this list of command-line parameters
-c                      force command-line interface instead of X11 etc.
                        Use it if you want to run the client within a terminal.
-C                      compatibility mode for ancient servers (deprecated)
-e                      Create file 'tomenet.log' instead of displaying
                        error messages in the terminal
-i                      ignore the ~/.tomenetrc config file
                        This option must come before any -f options!
-f<config file>         source (use) a specified config file. This is actually
                        cumulative and does not cause the standard .tomenetrc
                        to not be loaded. To _only_ load this config file and
                        ignore .tomenetrc, specify -i option together with -f
                        option and make sure that -i comes first!
                        The last file that is read is used as default config
                        file and any changes that are saved will be saved to
                        this file.
-F <fps>                set client internal engine fps (default is 100)
-l<Account> <Password>  for example -lGandalf geheim
-N<character name>      for example -NMagnet
-R <character name>     character name to choose and auto-reincarnate it
-p<Port>                for example -p19348
-P <path to lib dir>    sets the path to TomeNET's 'lib' folder
-m                      skip motd (message of the day) on login
-q                      turns off loading/initializing of audio ('quiet mode')
-u                      disables automatic LUA script updating
                        (You should NOT use this option!)
-w                      disables weather effects
-v                      automatically save chat log on exit
-V                      automatically save complete message log on exit
-x                      don't save chat/message log on exit (don't prompt)
<ip address>            for example 37.187.75.24

Full command-line example:
        ./tomenet -p19348 -lGandalf geheim -NGandalf 37.187.75.24

If your name contains spaces, it is neccessary to put a '\' in front of each.
Example:
        ./tomenet -p18348 -lIron\ Man geheimer 37.187.75.24
..if your account name is 'Iron Man'.

(Skip down to (2.4) to continue reading.)