- fixed problem with PREFIX
[tuxanci.git] / README
blobe5bd94290c7b39eaf2cf8e5291894f017f050d5b
1 ABOUT
2 =====
3         Tuxanci is first cushion shooter based on well-known Czech game Bulanci.
4         
5         Game supports 1 player and multiplayer game on one computer and also
6         supports gameplay over network (LAN/Internet [IPv4 and IPv6]).
7         
8         Goal in this game is to shoot enemy penguin before he does so. Penguin
9         can shoot only in X and Y axes so no diagonal shooting is availible.
11         Weapon list
12         -----------
13                 Pistol
14                 ~~~~~~
15                         Basic gun - one shot at the time
16                 Two Pistols
17                 ~~~~~~~~~~~
18                         2x Basic gun - two shots at once
19                 Machine gun
20                 ~~~~~~~~~~
21                         Few shots per fire, small intervals
22                 Shot gun
23                 ~~~~~~~~
24                         5 shots per fire, high dispersion
25                 Laser
26                 ~~~~~
27                         Shoots fast and long coherent light
28                 Mine
29                 ~~~~
30                         Put them around, stem on them *KABOOM*
31                 Bomb ball
32                 ~~~~~~~~~
33                         Fires bomb which mirrors any obstacles and explodes only if it
34                         hits penguin.
36         Bonus list
37         ----------
38                 Speedy tux: tux move faster
39                 Infinite ammo: you have really big backpack of ammo (fire at will)
40                 4way shoot: tux fire on shoot in every direction (cost only 1 ammo)
41                 Teleport: if somebody shoots at Tux he teleport himself away
42                 Ghost: Tux can move and shoot through obstracles
43                 Note
44                 ~~~~
45                         Bonuses last only few seconds and if tux take another bonus
46                         first loses its effects.
48 HOWTO COMPILE
49 =============
50         This howto is written for linux. For other platforms please think about
51         rather using binary modules.
52         First of all we need some libraries:
53                 (g)libc, SDL, SDL_image, SDL_ttf, optionally SDL_mixer
55         And some applications:
56                 cmake version 2.4.8 and above
58         Now we have two options what we can do:
59         (all commands are supposed to be written in tuxanci sources directory)
60         Building Client
61         ---------------
62                 $ cmake . -DNO_Audio=1  
63                 $ make
64                 # make install
65         Building Server
66         --------------
67                 $ cmake . -DServer=1
68                 $ make
69                 $ make install
70         Removing current install
71         -----------------------
72                 Same for both client and server
73                 # make uninstall
74         Notes
75         -----
76                 Option -DNO_AUDIO=1 says we want no audio support for client so change
77                 if you want so.
78                 Server and client can be both on same computer they use different
79                 folders.
80                 Cleaning data from previous compilation "$ make clean".
83 GAME USAGE
84 ==========
85         Starting game is simple tuxanci-ng or tuxanci-ng-server based on what we
86         compiled (based on presumption user installed into directories where path
87         is set).
89         For client we create some configuration files in $HOME. There is created
90         ".tuxanci-ng" directory and in there are pretty explaining .conf files.
92         For server we create directory /etc/tuxanci_ng/server.conf where you could
93         do some changes for it (again pretty selfexplaining).
95         Controls
96         --------
97                 Player one
98                 ~~~~~~~~~~
99                         movement: cursor arows
100                         fire: zero or rctrl
101                         change weapon: one or rshift
102                 Player two
103                 ~~~~~~~~~~
104                         movement: W(u) S(d) A(l) D(r)
105                         fire: Q
106                         change weapon: tab
107                 Common
108                 ~~~~~~
109                         Fullscreen/window mode: F1 (dangerous with multiple monitors)
110                         Pause: P
111                         Quit: Esc
112 HAVE PROBLEM/FOUND BUG/ETC...
113 =============================
114         If you found some bug or have feature request please fill it into: 
115         http://www.tuxanci.org/buglist (you need account for that).
117         You need some help with install/etc... feel free to join us on our irc
118         channel which is #tuxanci on server irc.tuxportal.cz. If you don't like
119         irc you can can contact us on our forum also: http://czf.tuxanci.org.
121 MORE
122 ====
123         More informations you can find on our website: http://www.tuxanci.org/