README

   1 ABOUT
   2 =====
   3         Tuxanci is first tux shooter ere while inspired by well-known Czech
   4         game Bulanci. But it goes its own way now and it is much better.
   5
   6         Game supports 1 player and multiplayer game on one computer and also
   7         supports gameplay over network (LAN/Internet [IPv4 and IPv6]).
   8
   9         Goal in this game is to shoot enemy penguin before he does so. Penguin
  10         can shoot only in X and Y axes so no diagonal shooting is available yet.
  11
  12         Weapon list
  13         -----------
  14                 Pistol
  15                 ~~~~~~
  16                         Basic gun - one shot at the time
  17                 Two Pistols
  18                 ~~~~~~~~~~~
  19                         2x Basic gun - two shots at once
  20                 Machine gun
  21                 ~~~~~~~~~~
  22                         Few shots per fire, small intervals
  23                 Shot gun
  24                 ~~~~~~~~
  25                         5 shots per fire, high dispersion
  26                 Laser
  27                 ~~~~~
  28                         Shoots fast and long coherent light
  29                 Mine
  30                 ~~~~
  31                         Put them around, step on them *KABOOM*
  32                 Bomb ball
  33                 ~~~~~~~~~
  34                         Fires bomb which mirrors any obstacles and explodes only if it
  35                         hits penguin.
  36
  37         Bonus list
  38         ----------
  39                 Speedy tux: tux move faster
  40                 Infinite ammo: you have really big backpack of ammo (fire at will)
  41                 4way shoot: tux fire on shoot in every direction (cost only 1 ammo)
  42                 Teleport: if somebody shoots at Tux he teleport himself away
  43                 Ghost: Tux can move and shoot through obstacles.
  44                 Note
  45                 ~~~~
  46                         Bonuses last only few seconds and if tux take another bonus then
  47                         first one looses its effects.
  48
  49 HOWTO COMPILE
  50 =============
  51         This howto is written for linux. For other platforms please think about
  52         rather using binary modules.
  53         First of all we need some libraries:
  54                 (g)libc, SDL, SDL_image, SDL_ttf, optionally SDL_mixer,
  55                 optionally opengl, gettext, libzip
  56
  57         And some applications:
  58                 cmake version 2.6.0 and above
  59
  60         Now we have two options what we can do:
  61         (all commands are supposed to be written in tuxanci/build directory;
  62         If such does not exist just create it :])
  63
  64         NOTE: if you want to see all variable options definable by cmake just
  65         run ccmake instead of cmake.
  66         Building Client
  67         ---------------
  68                 $ cmake ..
  69                 $ make
  70                 # make install
  71         Building Server
  72         --------------
  73                 $ cmake .. -DBUILD_SERVER=1
  74                 $ make
  75                 # make install
  76         Removing current install
  77         -----------------------
  78                 Same for both client and server
  79                 # make uninstall
  80 GAME USAGE
  81 ==========
  82         Starting game is simple tuxanci-VERSION or tuxanci-server-V. based on what we
  83         compiled (based on presumption user installed into directories where path
  84         is set).
  85
  86         If you are using bundled binary and tuxanci are reporting "File not found!"
  87         error, you need to launch it directly from BIN directory
  88         (eg.: "$ cd tuxanci/bin && ./tuxanci-VERSION").
  89
  90         For client we create some configuration files in $HOME. There is created
  91         ".tuxanci" directory and in there are pretty selfexplaining .conf files.
  92
  93         For server we create directory /etc/tuxanci-server/server.conf where you could
  94         do some changes for it (again pretty selfexplaining).
  95
  96         Controls
  97         --------
  98                 Player one
  99                 ~~~~~~~~~~
 100                         movement: cursor arows
 101                         fire: zero [ 0 ] NumPad
 102                         change weapon: one [ 1 ] NumPad
 103                 Player two
 104                 ~~~~~~~~~~
 105                         movement: W(u) S(d) A(l) D(r)
 106                         fire: Q
 107                         change weapon: tab
 108                 Common
 109                 ~~~~~~
 110                         Fullscreen/window mode: F1 (dangerous with multiple monitors)
 111                         Save game: F2
 112                         Change splitting of screen: F3 (just in local
 113                                 multiplayer game in a big arena)
 114                         Pause: P
 115                         Quit: Esc
 116
 117 HAVE PROBLEM/FOUND BUG/ETC...
 118 =============================
 119         If you found some bug or have feature request please fill it into:
 120         http://www.tuxanci.org/buglist (you need account for that).
 121
 122         You need some help with install/etc... feel free to join us on our irc
 123         channel which is #tuxanci on server irc.freenode.net.
 124
 125 INFORMATIONS FOR TRANSLATORS
 126 ============================
 127         So you want to help us translating our perfect game :] What should you
 128         do is question you are asking i guess. It is pretty simple. We are using
 129         gettext so you only have to download our .pot file from git
 130         <http://repo.or.cz/w/tuxanci.git?a=blob_plain;f=po/tuxanci.pot;hb=HEAD>
 131         and translate every line into your desired language. MSGID is orginal
 132         message and MSGSTR is translated one. When you are done you rename
 133         tuxanci.pot to langcode.po (cs_CZ.po). For translating is needed only
 134         some text editor (advanced are kbabel, lokalize...) and some skills
 135         in your and english language. Final product of your effort mail onto our
 136         mail (team<-at->tuxanci.org). Ah and before I forget update some
 137         relevant informations into header of your .po file, examples can be
 138         found in our git too <http://repo.or.cz/w/tuxanci.git?a=tree;f=po;hb=HEAD>.
 139
 140 MORE
 141 ====
 142         More informations you can find on our website: http://www.tuxanci.org/