File: README

package info (click to toggle)
opencity 0.0.4stable-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 8,852 kB
  • ctags: 1,799
  • sloc: cpp: 13,913; sh: 3,435; ansic: 468; makefile: 285
file content (252 lines) | stat: -rw-r--r-- 8,380 bytes parent folder | download
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
------------------------------------------------------------------------------
README for OpenCity 0.0.4stable
------------------------------------------------------------------------------
Last modified:
	$Id: README,v 1.26 2006/01/26 10:53:18 neoneurone Exp $

Audience:
	# End-users:
		You can find a lot of useful information in this file. So read it !
	# Packagers:
		This file contains useful information about command line options.
		For compilation and installation notes please refer to the
		INSTALL file.

Description:
	This is just another city simulation. The idea is simple: you have
to build a city with 3 types of "zones" Residential, Commercial and
Industrial. They depend on each other during their development.
Try to give them what they need and watch your city growing up.


------------------------------------------------------------------------------
Hardware requirements:
------------------------------------------------------------------------------
Processor:
	never mind

Speed:
	whatever

Graphic card:
	3D accelerated card required.

Sound card:
	anything that can work with SDL_mixer

Network:
	experimental support


------------------------------------------------------------------------------
Software requirements:
------------------------------------------------------------------------------
Operating System:
	Linux
	or Mac OS
	or Win32
	or Wine

Graphic User Interface:
	X Windows with DRI activated (recommended)
	or Darwin
	or MS Windows
	or Wine

Libraries:
	GL (OpenGL)
	GLU
	SDL
	SDL_image
	SDL_net
	SDL_mixer (optional)


------------------------------------------------------------------------------
Linux autopackage release's notes:
------------------------------------------------------------------------------
	Have you just downloaded the "something.package" stuff ? Install OpenCity
by running it from the console or in a file browser like Konqueror. OpenCity
will be installed on your computer, and an icon will be created inside the
"Game" group.


------------------------------------------------------------------------------
Windows binary release's notes:
------------------------------------------------------------------------------
	In order to play the game, you must install it first. Once it's done,
click on the OpenCity's icon in the start menu to begin.


------------------------------------------------------------------------------
Keys' description
------------------------------------------------------------------------------
Hotkey:
		n: "Blank" tool
		r: Zone Residential tool
		c: Zone Commercial tool
		i: Zone Industrial tool
		p: Lay Paths tool
		l: Lay electric Lines tool
		x: Destroy tool
		q: Query tool
		e: Build a coal power plant
		ctrl: cancel the zoning tool action
	
		u / d: raise / lower cells tool

Navigation:
		up / down / left / right: translate the map
		pageup / pagedown: rotate the map
		insert / delete: zoom in/out
		alt: multiply the effects of the buttons above by 10
	
		h: as Home
		escape: quit immediately

Option:
		g: Toggle grid on/off
		k: Toggle compass on/off
		f: Toggle wire frame mode on/off
		o: Toggle perspective/orthogonal projection

Sound & music:
		z / b: play previous / next music
		m: music on / off
		s: sound on / off

Experimental:
		F2: Save
		F6: Load

Undocumented features, try it at your own risks:
		a: various test codes menu
		v: MAS test menu
		t: connect to local ZeN server


------------------------------------------------------------------------------
Autoscrolling
------------------------------------------------------------------------------
	Simple autoscrolling now comes with OpenCity. Just move your mouse
near to the window's edges and OpenCity will scroll the map
automatically for you.

	Autorotating is also implemented. Put your mouse cursor either
in the upper left or right corner to see how it works.

	For the moment, you can not disable them. I know, not everybody
like auto stuff.


------------------------------------------------------------------------------
Sound & music
------------------------------------------------------------------------------
	OpenCity uses SDL_mixer for playing sound & music. Thus, it supports
all file types that SDL_mixer supports.

	If you don't hear any sound, try to modify "sound.m3u" and
set the path accordingly to the "opencity" executable file. Please note
that OpenCity automatically appends a prefix to all the sound filenames.
The prefix is where the installation procedure has put all OpenCity's data
files.

	However, you can put a file called "music.m3u" in the "music" directory
and OpenCity will load and play your favorite musics. If you don't find
any "music" directory just create it then put your list "music.m3u" in it.

	I'd like to warn you that SDL_mixer is not that stable. It can hang
OpenCity while playing few kinds of ".mp3" song. Blame the SDL_mixer's 
guys not me ;) If you experience such a problem, just turn the music 
off (key 'm').


------------------------------------------------------------------------------
Mouse action
------------------------------------------------------------------------------
	From OpenCity 0.0.2, whenever you click the RMB (Right Mouse Button),
you will open the last toolcircle. Click RMB again to hide the opened
toolcircle. I try to make everything simple and handy. But sometimes you
still need your keyboard.

	OpenCity now understand the mouse's wheel ! Push the wheel forward
does a zoom in (as 'Insert' key) and roll the wheel backward does a
zoom out (as 'Delete' key).

	When you hold 'Shift' and play with your mouse's wheel you'll notice
that it translates the map in some direction. Whereas the 'Ctrl' button
translates the map along another axis.


------------------------------------------------------------------------------
Main config file "opencity.conf"
------------------------------------------------------------------------------
	See the in-line comments for more details.


------------------------------------------------------------------------------
Command-line options
------------------------------------------------------------------------------
NOTE: command-line options overwrite config file's options.

	--no-dl: 
	Don't use OpenGL display list for the grid. Sometimes, it's useful when
you play OpenCity under Windows which supports badly OpenGL
(hmm, I wonder why ?)

	--gl-version:
	Show the informations of the current available OpenGL implementation
on your machine

	--homedir newHomePath
	Specify to new path to OpenCity's data. For example:
		Under linux: --homedir /home/foo/bar/share/opencity/"
		Under win32: --homedir "C:/Program Files/OpenCity/share"

	--server: (experimental, work in progress feature)
	Launch the server version of OpenCity. Type Ctrl-C to quit. If you 
want to test the server on your computer, launch another OpenCity without
"--server" then type 't' to connect to the local OpenCity server.


------------------------------------------------------------------------------
Save/Load issues
------------------------------------------------------------------------------
	The following directory is used for save/load
		GNU/Linux:
			$HOME/.OpenCity/
		Windows:
			C:\Documents and Settings\username\Application Data\OpenCity\


------------------------------------------------------------------------------
Troubleshootings
------------------------------------------------------------------------------
	1) I have a ATI Radeon 9000 M video card on my machine.
When I tested the game with "EnablePageFlip" ( see man radeon )
the game works weirdly. If you encounter the same problem,
try to disable this feature of the XFree server ( see man XF86Config )

	2) With ATI Radeon 9000M video card, the SmoothVision(tm)
must be deactivated in order to run OpenCity correctly.

	3) Here is the version of my X server

 - XFree86 Version 4.3.0
 - Release Date: 9 May 2003
 - X Protocol Version 11, Revision 0, Release 6.6
 - Build Operating System: Linux 2.4.18-23mdksmp i686 [ELF]
 - Build Date: 10 September 2003

	It seems that the driver for my ATI Radeon 9000 M is
very buggy. If you experience any trouble, try to type this
in the shell (bash) before launching OpenCity.
		"export R200_NO_VTXFMT="

	Or you should try a newer XFree.


------------------------------------------------------------------------------
Duong-Khang (neoneurone) NGUYEN