TomeNET

(2) Installation & setup                                                        
========================

(2.1) Installing/updating TomeNET (Windows/Linux/OSX)                           
-----------------------------------------------------

Basic installation:
-------------------
Go to https://www.tomenet.eu/ (or one of our personal pages) to download the
latest client. It is recommended to use the installer package if available for
your OS (especially Windows).
If you choose an archive file instead, extract it to a new directory and make
sure the pathnames are preserved.
Then just run..

Windows:        'TomeNET.exe' (or double-click the desktop TomeNET icon,
                               provided you used the installer download.)

                If you use a foreign IME setting, eg korean or japanese, switch
                it to US-EN IME (compare problem 54 in the troubleshooting
                section (9.8)) or you might not be able to use most keys aside
                from arrow keys for basic movement.

Linux:          the 'tomenet' binary.

OS X:           'TomeNET.command' (which prepares and runs 'tomenet'.)


Updating via reinstallation:
----------------------------
If you want to update your existing TomeNET and cannot/don't want to use the
TomeNET-Updater, you can also just download the latest TomeNET version again
and install it over your existing TomeNET installation.
This process will not delete any of your macros, screenshots, or configuration
files - EXCEPT for your 'lib/xtra/sound' and 'lib/xtra/music' folders if you
install a TomeNET package that comes with a sound pack or music pack
respectively. Those will then be replaced.

So if you have done custom changes to your sound and/or music pack that you
want to keep, you should rename those folders prior to reinstallation.
This is not a hack but actually the official way TomeNET handles multiple
audio packs and allows you to switch between them in the = X menu! The only
convention you must follow is that music pack folders must start with 'music'
and sound pack folders must start with 'sound'.
For example rename your customized 'music' folder to 'music.myown' and it will
be safe to install a new version of TomeNET over it, the custom music folder
will be left untouched and automatically be recognized by TomeNET afterwards,
allowing you to switch between your music.myown pack and the official pack that
was just installed by pressing '=' key (options menu) followed by Shift+X.

If you install a TomeNET version that comes with sound or music pack over an
existing installation that doesn't have one of these, you will end up with
an audio-wise "upgraded" installation that now features sound and/or music
as it should (depending on what you installed).


Updating via the TomeNET-Updater:
---------------------------------
Starting with version 4.5.7a, TomeNET comes with an updater tool that should
work on most platforms. If it doesn't on yours, please contact us and provide
details about which operating system you are using.

To update your TomeNET client or the sound pack or music pack, just run the
'TomeNET-Updater' and click on the according button.
The only prerequisite is that you must have '7-Zip' installed, a great, free,
open source archiver that beats WinRAR and WinZIP easily. You can get it from
www.7-zip.org.
Important: You should exit the game before attempting to update it!
Note for LINUX:
The Linux version of the TomeNET-Updater no longer requires 7zG (the graphical
user interface of 7-zip), so you do not need to compile it yourself if your
repository packages don't provide it. If you want to compile it anyway then
see (2.2) and there "a) Automatic audio pack installation - LINUX". That
paragraph has short instructions on how to compile 7-zip from source in Linux.

If you didn't have a sound or music pack installed yet, by "updating" it from
the TomeNET-Updater these will actually be installed.


Optional dependencies on Windows:
---------------------------------
To make use of all features of the game, there are the following optional
programs you can install on Windows:
- explorer and xcopy (these are already installed by default in any Windows
  version): For installing/updating audio packs and opening URLs and folders
  from within the knowledge (~) menu.
- 7-zip (www.7-zip.org): For installing or updating audio packs.
- Firefox or Chrome or Chromium: For making PNG screenshots.

Optional dependencies on Linux:
-------------------------------
To make use of all features of the game, there are the following optional
packages you can install on Linux:
- xdg-utils (for xdg-open) on X11: For opening folders and URLs from whithin
  the knowledge (~) menu.
- xclip: For using copy/paste capabilities.
- coreutils (for readlink) and Firefox or Chrome or Chromium:
  For making PNG screenshots.
- 7-zip: 7zG on X11, 7z on GCU. For installing or updating audio packs.


Installation details / custom installation:
-------------------------------------------
If you want to read up about installation specifics, command-line options,
compiling your own client, using an archive file for extraction instead of a
self-running installer etc., read on here.

If you choose an archive file, extract it to a new directory and make sure the
pathnames are preserved.

Note: If you decide to download the 'test client' instead of the client of the
latest stable version number, be aware that it might stop working correctly
unexpectedly because it's undergoing development, possibly forcing you to
redownload it.

Covered in the following are Windows, Linux, OS X, FreeBSD and Android: