summaryrefslogtreecommitdiff
path: root/README
blob: 34af75fb660cf53a6e0a016a37613362065f5caa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
ABOUT
=====
	Tuxanci is first cushion shooter based on well-known Czech game Bulanci.
	
	Game supports 1 player and multiplayer game on one computer and also
	supports gameplay over network (LAN/Internet [IPv4 and IPv6]).
	
	Goal in this game is to shoot enemy penguin before he does so. Penguin
	can shoot only in X and Y axes so no diagonal shooting is availible.

	Weapon list
	-----------
		Pistol
		~~~~~~
			Basic gun - one shot at the time
		Two Pistols
		~~~~~~~~~~~
			2x Basic gun - two shots at once
		Machine gun
		~~~~~~~~~~
			Few shots per fire, small intervals
		Shot gun
		~~~~~~~~
			5 shots per fire, high dispersion
		Laser
		~~~~~
			Shoots fast and long coherent light
		Mine
		~~~~
			Put them around, step on them *KABOOM*
		Bomb ball
		~~~~~~~~~
			Fires bomb which mirrors any obstacles and explodes only if it
			hits penguin.

	Bonus list
	----------
		Speedy tux: tux move faster
		Infinite ammo: you have really big backpack of ammo (fire at will)
		4way shoot: tux fire on shoot in every direction (cost only 1 ammo)
		Teleport: if somebody shoots at Tux he teleport himself away
		Ghost: Tux can move and shoot through obstracles
		Note
		~~~~
			Bonuses last only few seconds and if tux take another bonus
			first loses its effects.

HOWTO COMPILE
=============
	This howto is written for linux. For other platforms please think about
	rather using binary modules.
	First of all we need some libraries:
		(g)libc, SDL, SDL_image, SDL_ttf, optionally SDL_mixer

	And some applications:
		cmake version 2.4.6 and above

	Now we have two options what we can do:
	(all commands are supposed to be written in tuxanci sources directory)
	Building Client
	---------------
		$ cmake .
		$ make
		# make install
	Building Server
	--------------
		$ cmake .
		$ make
		# make install
	Removing current install
	-----------------------
		Same for both client and server
		# make uninstall
	Notes
	-----
		Compilation on windows is little bit tricky. You need MinGW
		<http://www.mingw.org/> and CMake <http://www.cmake.org/>. Then follow
		those steps above. Only add cmake option -G "MinGW Makefiles". If cmd
		say that no make.exe command found you need to use absolute path. Do
		not specify PREFIX!! There is also known bug when in path to game dir
		is space separator -> Compilation will die with error file not found,
		you have to place source to some directory with no space in its path.

		# ADDITIONAL OPTIONS FOR CMAKE
		# -DServer=1			# build server
		# -DNO_Audio=1 			# disable audio
		# -DDebug=1			# enable debug
		# -DCMAKE_C_FLAGS=-Wall		# modification for CFLAGS
		# -DWin=1			# build windows port
		# -DNLS=1			# enable Gettext NLS
		# -DApple=1			# build apple port
		# -DCMAKE_INSTALL_PREFIX=/bla/	# install prefix
		# -DCMAKE_DATA_PATH=/other/bla/	# install path for data
		# -DCMAKE_CONF_PATH=/etc	# install path for data
		# -DLIB_INSTALL_DIR=/other/bla	# install path for data


GAME USAGE
==========
	Starting game is simple tuxanci or tuxanci-server based on what we
	compiled (based on presumption user installed into directories where path
	is set).
	
	If we are using bundled binary and tuxanci are reporting "File not found!"
	error, you need to launch it directly from BIN directory 
	(eg.: "$ cd tuxanci/bin && ./tuxanci").

	For client we create some configuration files in $HOME. There is created
	".tuxanci" directory and in there are pretty selfexplaining .conf files.

	For server we create directory /etc/tuxanci/server.conf where you could
	do some changes for it (again pretty selfexplaining).

	Controls
	--------
		Player one
		~~~~~~~~~~
			movement: cursor arows
			fire: zero [ 0 ] NumPad
			change weapon: one [ 1 ] NumPad
		Player two
		~~~~~~~~~~
			movement: W(u) S(d) A(l) D(r)
			fire: Q
			change weapon: tab
		Common
		~~~~~~
			Fullscreen/window mode: F1 (dangerous with multiple monitors)
			Pause: P # not working yet
			Quit: Esc
HAVE PROBLEM/FOUND BUG/ETC...
=============================
	If you found some bug or have feature request please fill it into: 
	http://www.tuxanci.org/buglist (you need account for that).

	You need some help with install/etc... feel free to join us on our irc
	channel which is #tuxanci on server irc.tuxportal.cz. If you don't like
	irc you can can contact us on our forum also: http://czf.tuxanci.org.

MORE
====
	More informations you can find on our website: http://www.tuxanci.org/