INSTALL

   1 HOW TO INSTALL TUXANCI
   2 ======================
   3
   4 Client
   5 ------
   6 Requirements: cmake >= 2.6.0, SDL, SDL_image, SDL_ttf, (SDL_mixer), (OpenGL),
   7               (Gettext), libzip
   8 (Those in brackets are optional and can be omitted if you choose appropriate
   9 switches while building the game. But we recommend to have all of them.)
  10
  11 Note: you'll also need "-devel" versions of library packages.
  12
  13 The following how-to is written for GNU/Linux, but we are working on ports and
  14 how-tos for other platforms too. If you want to help us, feel free to contact
  15 us! We will really appreciate it.
  16
  17 Note: if you don't know all available cmake switches which can be used, you can
  18 run `ccmake` command (it seems to be ncurses based) instead of `cmake`. And
  19 please do enable the debug -- it helps us when you find a bug.
  20
  21 $ mkdir build
  22 $ cmake .. -DENABLE_DEBUG=1
  23 $ make
  24 # make install
  25
  26 Now it is installed in your system. And that's all. :c) You can run the game
  27 simply by running `tuxanci` command in the console (you'll see much of debug
  28 output, but that's ok).
  29
  30 Tip: please think about running this command too (before the game itself):
  31
  32 $ ulimit -c unlimited
  33
  34 It enables generating of coredumps which are very helpful when the game crashes
  35 as it contains much information about the crash which happend. You also need to
  36 have debug enabled when compiling -- otherwise the coredump won't contain any
  37 useful information for us.
  38
  39 Note: if you want to uninstall the game, run this command:
  40
  41 # make uninstall
  42
  43
  44 Server
  45 ------
  46 Requirements: cmake >= 2.6.0, libzip
  47
  48 Note: you'll also need "-devel" version of libzip library package.
  49
  50 The server is written for GNU/Linux and is not planned to be ported to other
  51 platforms (may be to BSD yes, but surely not to Windows ;c)).
  52
  53 Note: if you don't know all available cmake switches which can be used, you can
  54 run `ccmake` command (it seems to be ncurses based) instead of `cmake`. And
  55 please do enable the debug -- it helps us when you find a bug.
  56
  57 $ mkdir build
  58 $ cmake .. -DBUILD_SERVER=1 -DENABLE_DEBUG=1
  59 $ make
  60 # make install
  61
  62 Now it is installed in your system. You should configure it before running. The
  63 configuration file is situated in /etc/tuxanci-server/server.conf. It contains
  64 some kind of example configuration which is usable but you'll probably prefer
  65 your own one. Have a look to /etc/tuxanci-server/arena.conf -- there are listed
  66 all available arenas and at the end of each line is "network name" of each
  67 arena. This network name is to be used in server.conf file within "ARENA"
  68 property.
  69
  70 When you set IP6 property to ::, it will also accept IPv4 connections and IP4
  71 property won't be taken into account. LAN_ONLY means that the server will not
  72 register at MasterServer. You can let be the SUPPORT_CLIENTS property as it is
  73 going to be removed soon (default value is OK).
  74
  75 If you want to run more than one Tuxanci game server, you need to have more
  76 configuration files (one for each game server). Specify which one to use by
  77 --config-file switch (e.g. --config-file=/etc/tuxanci-server/server-2.conf)
  78 when running the server.
  79
  80 Note: RC script is not prepared yet. You have to write your own one.
  81
  82 The game server itself can be started with following:
  83
  84 $ tuxanci-server
  85
  86 (If you have set appropriate paths and port, you don't need to have root
  87 privileges to start the server. Note: droping privileges is not implemented
  88 yet.)
  89
  90 Tip: if you have enabled debug when compiling, please think about running this
  91 command before starting the game server:
  92
  93 $ ulimit -c unlimited
  94
  95 It enables generating of coredumps which are very helpful when the game server
  96 crashes as it contains much information about the crash which happend.
  97
  98 Note: if you want to uninstall the game server, run this command:
  99
 100 # make uninstall