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 availible 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 obstracles
  44                 Note
  45                 ~~~~
  46                         Bonuses last only few seconds and if tux take another bonus
  47                         first loses 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                 gettext, libzzip
  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         Notes
  81         -----
  82                 Compilation on windows is little bit tricky. You need MinGW
  83                 <http://www.mingw.org/> and CMake <http://www.cmake.org/>. Then follow
  84                 those steps above. Only add cmake option -G "MinGW Makefiles". If cmd
  85                 say that no make.exe command found you need to use absolute path. Do
  86                 not specify PREFIX!! There is also known bug when in path to game dir
  87                 is space separator -> Compilation will die with error file not found,
  88                 you have to place source to some directory with no space in its path.
  89
  90                 # ADDITIONAL OPTIONS FOR CMAKE
  91                 #option(ENABLE_IPV6      "Build with the ipv6 support"               OFF)
  92                 #option(BUILD_SERVER      "Build the server instead of client"        OFF)
  93                 #option(WITH_AUDIO       "Build with audio enabled"                  ON)
  94                 #option(ENABLE_DEBUG     "Build debug features"                      OFF)
  95                 #option(WITH_NLS         "Build the translations"                    ON)
  96                 #option(Apple            "Build some apple quirks. USE ONLY ON MAC!" OFF)
  97                 #option(WITH_OPENGL      "Use opengl as renderer instead of SW"      ON)
  98
  99 GAME USAGE
 100 ==========
 101         Starting game is simple tuxanci-VERSION or tuxanci-server-V. based on what we
 102         compiled (based on presumption user installed into directories where path
 103         is set).
 104
 105         If you are using bundled binary and tuxanci are reporting "File not found!"
 106         error, you need to launch it directly from BIN directory
 107         (eg.: "$ cd tuxanci/bin && ./tuxanci-VERSION").
 108
 109         For client we create some configuration files in $HOME. There is created
 110         ".tuxanci" directory and in there are pretty selfexplaining .conf files.
 111
 112         For server we create directory /etc/tuxanci-server/server.conf where you could
 113         do some changes for it (again pretty selfexplaining).
 114
 115         Controls
 116         --------
 117                 Player one
 118                 ~~~~~~~~~~
 119                         movement: cursor arows
 120                         fire: zero [ 0 ] NumPad
 121                         change weapon: one [ 1 ] NumPad
 122                 Player two
 123                 ~~~~~~~~~~
 124                         movement: W(u) S(d) A(l) D(r)
 125                         fire: Q
 126                         change weapon: tab
 127                 Common
 128                 ~~~~~~
 129                         Fullscreen/window mode: F1 (dangerous with multiple monitors)
 130                         Save game: F2
 131                         Change splitting of screen: F3 (just in local
 132                                 multiplayer game in a big arena)
 133                         Pause: P
 134                         Quit: Esc
 135
 136 HAVE PROBLEM/FOUND BUG/ETC...
 137 =============================
 138         If you found some bug or have feature request please fill it into:
 139         http://www.tuxanci.org/buglist (you need account for that).
 140
 141         You need some help with install/etc... feel free to join us on our irc
 142         channel which is #tuxanci on server irc.tuxportal.cz. If you don't like
 143         irc you can can contact us on our forum also: http://czf.tuxanci.org.
 144
 145 INFORMATIONS FOR TRANSLATORS
 146 ============================
 147         So you want to help us translating our perfect game :] What should you
 148         do is question you are asking i guess. It is pretty simple. We are using
 149         gettext so you only have to download our .pot file from git
 150         <http://repo.or.cz/w/tuxanci.git?a=blob_plain;f=po/tuxanci.pot;hb=HEAD>
 151         and translate every line into your desired language. MSGID is orginal
 152         message and MSGSTR is translated one. When you are done you rename
 153         tuxanci.pot to langcode.po (cs_CZ.po). For translating is needed only
 154         some text editor (advanced are kbabel, lokalize...) and some skills
 155         in your and english language. Final product of your effort mail onto our
 156         mail (team<-at->tuxanci.org). Ah and before I forget update some
 157         relevant informations into header of your .po file, examples can be
 158         found in our git too <http://repo.or.cz/w/tuxanci.git?a=tree;f=po;hb=HEAD>.
 159
 160 MORE
 161 ====
 162         More informations you can find on our website: http://www.tuxanci.org/