Include and link physfs properly.
[tuxanci.git] / README
blob321da392b105cbfaeea2ff8dfdf7be2b6e06bf2b
1 ABOUT TUXANCI
2 =============
3 Tuxanci is first tux shooter. In the absolute beginning it was inspired by
4 a well-known Czech game Bulanci. Today Tuxanci goes its own way and is much
5 better then Bulanci (except the graphics though).
7 Game supports 1 player and 2 players game on one computer and also supports
8 gameplay over network (LAN/Internet [IPv4 and IPv6]).
10 Goal in this game is to shoot enemy Tux before he does so. Tux can shoot only
11 in X and Y axes so no diagonal shooting is available yet (in fact it is even
12 not being planned at the moment).
14         Weapon list
15         -----------
16                 Pistol
17                 ~~~~~~
18                         Basic gun - one shot at the time
19                 Two Pistols
20                 ~~~~~~~~~~~
21                         2x Basic gun - two shots at once
22                 Machine gun
23                 ~~~~~~~~~~
24                         Few shots per fire, small intervals
25                 Shot gun
26                 ~~~~~~~~
27                         5 shots per fire, high dispersion
28                 Laser
29                 ~~~~~
30                         Shoots fast and long coherent light
31                 Mine
32                 ~~~~
33                         Put them around, step on them *KABOOM*
34                 Bomb ball
35                 ~~~~~~~~~
36                         Fires bomb which mirrors any obstacles and explodes only if it
37                         hits penguin.
39         Bonus list
40         ----------
41                 Speedy tux: tux move faster
42                 Infinite ammo: you have really big backpack of ammo (fire at will)
43                 4way shoot: tux fire on shoot in every direction (cost only 1 ammo)
44                 Teleport: if somebody shoots at Tux he teleport himself away
45                 Ghost: Tux can move and shoot through obstacles.
46                 Note
47                 ~~~~
48                         Bonuses last only few seconds and if tux take another bonus then
49                         first one looses its effects.
51 GAME USAGE
52 ==========
53         Starting game is simple tuxanci-VERSION or tuxanci-server-V. based on what we
54         compiled (based on presumption user installed into directories where path
55         is set).
56         
57         If you are using bundled binary and tuxanci are reporting "File not found!"
58         error, you need to launch it directly from BIN directory 
59         (eg.: "$ cd tuxanci/bin && ./tuxanci-VERSION").
61         For client we create some configuration files in $HOME. There is created
62         ".tuxanci" directory and in there are pretty selfexplaining .conf files.
64         For server we create directory /etc/tuxanci-server/server.conf where you could
65         do some changes for it (again pretty selfexplaining).
67         Controls
68         --------
69                 Player one
70                 ~~~~~~~~~~
71                         movement: cursor arows
72                         fire: zero [ 0 ] NumPad
73                         change weapon: one [ 1 ] NumPad
74                 Player two
75                 ~~~~~~~~~~
76                         movement: W(u) S(d) A(l) D(r)
77                         fire: Q
78                         change weapon: tab
79                 Common
80                 ~~~~~~
81                         Fullscreen/window mode: F1 (dangerous with multiple monitors)
82                         Save game: F2
83                         Change splitting of screen: F3 (just in local
84                                 multiplayer game in a big arena)
85                         Pause: P
86                         Quit: Esc
88 HAVE PROBLEM/FOUND BUG/ETC...
89 =============================
90         If you found some bug or have feature request please fill it into: 
91         http://www.tuxanci.org/buglist (you need account for that).
93         You need some help with install/etc... feel free to join us on our irc
94         channel which is #tuxanci on server irc.freenode.net.
96 INFORMATIONS FOR TRANSLATORS
97 ============================
98         So you want to help us translating our perfect game :] What should you
99         do is question you are asking i guess. It is pretty simple. We are using
100         gettext so you only have to download our .pot file from git
101         <http://repo.or.cz/w/tuxanci.git?a=blob_plain;f=po/tuxanci.pot;hb=HEAD>
102         and translate every line into your desired language. MSGID is orginal
103         message and MSGSTR is translated one. When you are done you rename
104         tuxanci.pot to langcode.po (cs_CZ.po). For translating is needed only
105         some text editor (advanced are kbabel, lokalize...) and some skills
106         in your and english language. Final product of your effort mail onto our
107         mail (team<-at->tuxanci.org). Ah and before I forget update some
108         relevant informations into header of your .po file, examples can be
109         found in our git too <http://repo.or.cz/w/tuxanci.git?a=tree;f=po;hb=HEAD>.
111 MORE
112 ====
113         More informations you can find on our website: http://www.tuxanci.org/