6532beb33ab634ee8cd516b34b150f6b3b345726
[shipsimu.git] / docs / Ship-Simu Ship-Simulator.mm
1 <map version="0.7.1">
2 <node TEXT="Ship-Simu Ship-Simulation">
3 <font NAME="SansSerif" BOLD="true" SIZE="18"/>
4 <node TEXT="Browser-Game" POSITION="right">
5 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
6 <icon BUILTIN="messagebox_warning"/>
7 <node TEXT="Tick-based simulation">
8 <node TEXT="Cronological job (cron)">
9 <node TEXT="Addional requirement for installation"/>
10 </node>
11 </node>
12 <node TEXT="Click-based simulation">
13 <node TEXT="User clicks a button, action performed"/>
14 </node>
15 <node TEXT="Pseudo-3D graphics">
16 <node TEXT="Still graphics">
17 <node TEXT="Different ships">
18 <node TEXT="Passenger ship"/>
19 <node TEXT="Oil tanker"/>
20 <node TEXT="Container ship"/>
21 <node TEXT="Misc small ships"/>
22 </node>
23 <node TEXT="Buildings">
24 <node TEXT="Shipyard"/>
25 <node TEXT="Dry dock"/>
26 <node TEXT="Terminal building"/>
27 </node>
28 <node TEXT="Vehicles">
29 <node TEXT="Container carrier"/>
30 <node TEXT="Crane"/>
31 </node>
32 <node TEXT="All pics should be self-shooted">
33 <node TEXT="This avoids copyright conflicts"/>
34 <node TEXT="The requested buildings/vehicles must be found in reality"/>
35 </node>
36 </node>
37 <node TEXT="Slightly moved graphics (GIF)">
38 <node TEXT="Water surface"/>
39 <node TEXT="Sky texture"/>
40 </node>
41 </node>
42 <node TEXT="Fully XHTML 1.0">
43 <node TEXT="Latest Internet standard"/>
44 <node TEXT="Older browsers will make lesser trouble"/>
45 <node TEXT="Should validate with the W3C HTML Validator">
46 <node LINK="http://validator.w3.org" TEXT="http://validator.w3.org">
47 <icon BUILTIN="attach"/>
48 </node>
49 </node>
50 </node>
51 <node TEXT="Design is CSS-based">
52 <font NAME="SansSerif" SIZE="12"/>
53 <node TEXT="Themes are possible"/>
54 </node>
55 <node TEXT="Nice AJAX features">
56 <icon BUILTIN="idea"/>
57 <icon BUILTIN="desktop_new"/>
58 </node>
59 <node TEXT="Website structure">
60 <font NAME="SansSerif" BOLD="true" SIZE="14"/>
61 <node TEXT="News on the front page (home)">
62 <node TEXT="The news source can be choosen from different">
63 <node TEXT="Previously typed and stored in database"/>
64 <node TEXT="Local XML files">
65 <node TEXT="Hint: Created by external generators">
66 <font NAME="SansSerif" SIZE="12"/>
67 </node>
68 </node>
69 <node TEXT="Remote XMLs like RSS feeds"/>
70 </node>
71 <node TEXT="The typer can choose a category">
72 <node TEXT="New categories can be suggested by the typer"/>
73 <node TEXT="An admin can create new categories"/>
74 </node>
75 <node TEXT="Comments are allowable">
76 <node TEXT="Logged-in users"/>
77 <node TEXT="Guests as well">
78 <icon BUILTIN="clanbomber"/>
79 <node TEXT="Secured with CAPTCHA">
80 <icon BUILTIN="messagebox_warning"/>
81 </node>
82 </node>
83 </node>
84 <node TEXT="One object for all news should be fine">
85 <node TEXT="Do not use one object per news entry!">
86 <icon BUILTIN="clanbomber"/>
87 <icon BUILTIN="stop"/>
88 </node>
89 <node TEXT="The object receives a &quot;Requestable&quot; object">
90 <node TEXT="Obtain page number and sent comment data from it"/>
91 </node>
92 </node>
93 </node>
94 <node TEXT="Registration form">
95 <node TEXT="One single page"/>
96 <node TEXT="Multiple pages"/>
97 </node>
98 <node TEXT="Login form">
99 <node TEXT="With guest login (disable by the admin)"/>
100 <node TEXT="Password reminder"/>
101 <node TEXT="Link to the registration form"/>
102 </node>
103 <node TEXT="Screenshot gallery">
104 <node TEXT="Comments are allowable"/>
105 <node TEXT="Should be kept simple"/>
106 </node>
107 <node TEXT="List of enabled features"/>
108 <node TEXT="Statistics of the game (not whole network!)"/>
109 <node TEXT="Pillory">
110 <node TEXT="Username (who got locked)"/>
111 <node TEXT="Date&amp;Time"/>
112 <node TEXT="The admin"/>
113 <node TEXT="Stated reason"/>
114 </node>
115 <node TEXT="Small extra pages">
116 <node TEXT="Imprint (required in Germany)"/>
117 <node TEXT="Privacy policy (required in some countries)"/>
118 </node>
119 </node>
120 <node TEXT="Strict coding guidelines for better PHP code">
121 <font NAME="SansSerif" BOLD="true" SIZE="14"/>
122 <icon BUILTIN="xmag"/>
123 <node TEXT="General code structure">
124 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
125 <icon BUILTIN="messagebox_warning"/>
126 <node TEXT="Fully object-oriented"/>
127 <node TEXT="Use of different but practical design patterns"/>
128 </node>
129 <node TEXT="Documentation">
130 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
131 <node TEXT="In-line documentation">
132 <node TEXT="Script header with full copyright and license as requested by GNU GPL 3"/>
133 <node TEXT="Method headers with Doxygen compatible tags"/>
134 <node TEXT="Comments above single lines for better understanding what is happening"/>
135 </node>
136 <node TEXT="Files in directory &quot;docs&quot;">
137 <node TEXT="COPYING*"/>
138 <node TEXT="Conception"/>
139 <node TEXT="NEWS"/>
140 <node TEXT="README"/>
141 <node TEXT="ArgoUML diagram"/>
142 <node TEXT="FreeMind document"/>
143 <node TEXT="THANKS"/>
144 <node TEXT="minmap_yyyymmdd.html"/>
145 </node>
146 </node>
147 <node TEXT="Folding of the code">
148 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
149 </node>
150 <node TEXT="Tabs and spaces">
151 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
152 </node>
153 </node>
154 </node>
155 <node TEXT="How does a shipping company work?" POSITION="left">
156 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
157 <icon BUILTIN="messagebox_warning"/>
158 <node TEXT="Start as a founder by selecting a harbor">
159 <cloud/>
160 <node TEXT="Construct neccessary buildings">
161 <node TEXT="Make contract with construction companies"/>
162 </node>
163 <node TEXT="Order ship parts">
164 <node TEXT="Fron your partners"/>
165 <node TEXT="On global market"/>
166 </node>
167 <node TEXT="Make contracts with other companies">
168 <node TEXT="Construct ships for your partner"/>
169 <node TEXT="Drive constructed ships by your partner"/>
170 </node>
171 <node TEXT="Build ship parts and trade them"/>
172 <node TEXT="Become CEO and manage your company">
173 <node TEXT="Nominate department managers"/>
174 <node TEXT="Recruit new employees"/>
175 <node TEXT="Pay salery to your employees"/>
176 </node>
177 <node TEXT="Let other gamer manage your company"/>
178 <node TEXT="Compare prices">
179 <node TEXT="Make a purchase computation system"/>
180 </node>
181 <node TEXT="Manage a journey"/>
182 </node>
183 <node TEXT="Or start as an employee">
184 <cloud/>
185 <node TEXT="Start as a simple sailor">
186 <node TEXT="And end up as a captain">
187 <node TEXT="Control your ship (depends on client)"/>
188 </node>
189 </node>
190 <node TEXT="Or start as a shipbuilder">
191 <node TEXT="Repair ships">
192 <node TEXT="Renew the painting"/>
193 <node TEXT="Fix broken things"/>
194 </node>
195 <node TEXT="Build up new ships"/>
196 </node>
197 <node TEXT="As an officer">
198 <icon BUILTIN="idea"/>
199 <icon BUILTIN="help"/>
200 </node>
201 <node TEXT="As a cleaner"/>
202 </node>
203 <node TEXT="Create a board of managers">
204 <icon BUILTIN="idea"/>
205 <icon BUILTIN="help"/>
206 <node TEXT="Only for bigger companies"/>
207 </node>
208 <node TEXT="Design your own ships">
209 <node TEXT="From templates (default ships)"/>
210 <node TEXT="Or your complete freely designed layout"/>
211 </node>
212 <node TEXT="Ride constructed ships">
213 <node TEXT="Make sail plans"/>
214 <node TEXT="Transportate cargo or humans">
215 <node TEXT="Make your passengers happy"/>
216 <node TEXT="Load containers and bring them to other harbors"/>
217 <node TEXT="Transportate oil from ricks to the refineries"/>
218 </node>
219 <node TEXT="Depends on used client"/>
220 </node>
221 <node TEXT="Earn a lot (virtual/real) money">
222 <node TEXT="Sell a journey"/>
223 <node TEXT="Trade with goods"/>
224 <node TEXT="Construct ships for other companies"/>
225 </node>
226 <node TEXT="Play as a passenger">
227 <node TEXT="Order a jorney to your desired destionation"/>
228 </node>
229 </node>
230 <node TEXT="Multi-Player Mode" POSITION="right">
231 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
232 <icon BUILTIN="messagebox_warning"/>
233 <node TEXT="Networked over hubs"/>
234 <node TEXT="Big map which holds all harbors">
235 <node TEXT="Seperated into small maps to cluster the load over the network"/>
236 </node>
237 </node>
238 <node TEXT="Java client" POSITION="left">
239 <cloud/>
240 <icon BUILTIN="idea"/>
241 <node TEXT="Real-time simulation"/>
242 <node TEXT="OpenGL (3D Graphics)">
243 <node TEXT="JOGL"/>
244 </node>
245 <node TEXT="OpenAL (3D sound)"/>
246 </node>
247 <node TEXT="&quot;Faked&quot; Single-Player" POSITION="right">
248 <node TEXT="Locally installed version"/>
249 <node TEXT="Does not connect to other hubs"/>
250 <node TEXT="&quot;Save games&quot; should be incompatible with MP mode">
251 <node TEXT="Avoids cheating"/>
252 </node>
253 </node>
254 <node TEXT="Sand-Box Mode" POSITION="right">
255 <node TEXT="The player can test the game">
256 <node TEXT="Some people like to &quot;explore&quot; the game"/>
257 <node TEXT="Or just wanna have a look"/>
258 </node>
259 <node TEXT="There are no competitors">
260 <font NAME="SansSerif" SIZE="12"/>
261 </node>
262 </node>
263 <node TEXT="Modern-epoche game" POSITION="left">
264 <node TEXT="Age: 1950+"/>
265 <node TEXT="The abstraction level is kept low"/>
266 </node>
267 <node TEXT="Licences" POSITION="left">
268 <node TEXT="The game">
269 <node TEXT="Ship-Simu is licensed under the GNU GPL 3 or any newer version">
270 <node TEXT="See docs/COPYING.software"/>
271 </node>
272 </node>
273 <node TEXT="This document">
274 <node TEXT="This mind-map is licensed under the GNU FDL 1.2 or any newer version">
275 <node TEXT="See docs/COPYING.documents"/>
276 </node>
277 </node>
278 <node TEXT="Artworks like sounds/graphics">
279 <node TEXT="Some CC license">
280 <icon BUILTIN="xmag"/>
281 </node>
282 </node>
283 </node>
284 <node TEXT="Data exchange protocol" POSITION="right">
285 <node TEXT="Default is an own small format">
286 <node TEXT="Reduces traffic between servers"/>
287 </node>
288 <node TEXT="Easy rewriteable to e.g. XML">
289 <node TEXT="Other clients (Flash) can also connect"/>
290 </node>
291 <node TEXT="Java and browser client can play together"/>
292 </node>
293 <node TEXT="Optional Pillory" POSITION="left">
294 <node TEXT="To make e.g. nazi propaganda activity public"/>
295 <node TEXT="Shall keep bad players away"/>
296 <node TEXT="Requires some &quot;game-moderator&quot; access level to manage">
297 <node TEXT="The moderator shall have an extra flag e.g. &quot;pillory_accessable&quot;"/>
298 </node>
299 <node TEXT="Players, companies et cetera should be lockable">
300 <node TEXT="The moderator can choose wether to lock with pillory entry or just locking down"/>
301 </node>
302 </node>
303 <node LINK="http://www.ship-simu.org" TEXT="http://www.ship-simu.org" POSITION="right">
304 <icon BUILTIN="attach"/>
305 </node>
306 <node TEXT="How do you construct a ship?" POSITION="left">
307 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
308 <node TEXT="The technology">
309 <node ID="_Freemind_Link_34058737" TEXT="Ship">
310 <node ID="_Freemind_Link_970552884" TEXT="Size"/>
311 <node ID="_Freemind_Link_446463585" TEXT="Construction">
312 <node ID="_Freemind_Link_141857388" TEXT="Hull"/>
313 <node ID="_Freemind_Link_563134447" TEXT="Wheel house"/>
314 <node ID="_Freemind_Link_1490756383" TEXT="Support (meal) for crew/passenger"/>
315 <node ID="_Freemind_Link_38506335" TEXT="Rooms">
316 <node TEXT="Canteen"/>
317 <node TEXT="Cabin">
318 <node TEXT="Luxury cabin"/>
319 <node TEXT="Premier cabin"/>
320 <node TEXT="Economy cabin"/>
321 <node TEXT="Low cabin"/>
322 </node>
323 <node TEXT="Motor room"/>
324 <node TEXT="Special rooms">
325 <node TEXT="Cinema"/>
326 <node TEXT="Theatre"/>
327 <node TEXT="Disco"/>
328 <node TEXT="Bars/Cafes"/>
329 </node>
330 </node>
331 <node TEXT="Engine">
332 <node TEXT="Sail"/>
333 <node TEXT="Propeller"/>
334 </node>
335 <node TEXT="Decks">
336 <node TEXT="Car deck"/>
337 <node TEXT="Truck deck"/>
338 <node TEXT="Train deck"/>
339 </node>
340 </node>
341 <node TEXT="Crew (depending on ship type)">
342 <node TEXT="Sailor/captain"/>
343 <node TEXT="Cleaners"/>
344 <node TEXT="Security service"/>
345 <node TEXT="Maintenance staff"/>
346 <node TEXT="Catering staff">
347 <node TEXT="Cook"/>
348 <node TEXT="Steward (passenger ship)"/>
349 </node>
350 </node>
351 </node>
352 </node>
353 <node TEXT="The economics">
354 <node ID="_Freemind_Link_554040694" TEXT="Costs">
355 <node ID="_Freemind_Link_1671691099" TEXT="Ressources">
356 <node ID="_Freemind_Link_1385368958" TEXT="Wood">
357 <node TEXT="Coverage"/>
358 <node TEXT="Constructuon (all)"/>
359 </node>
360 <node ID="_Freemind_Link_799981169" TEXT="Financials"/>
361 <node ID="_Freemind_Link_1436100534" TEXT="Iron">
362 <node TEXT="Steel"/>
363 </node>
364 <node TEXT="Marmor"/>
365 <node TEXT="Color"/>
366 <node TEXT="Carpets"/>
367 </node>
368 <node ID="_Freemind_Link_511748963" TEXT="Work">
369 <node ID="_Freemind_Link_578404113" TEXT="Worker">
370 <node ID="_Freemind_Link_1864981448" TEXT="Qualified">
371 <node TEXT="Fast"/>
372 <node TEXT="Hight-quality work"/>
373 <node TEXT="Expensive"/>
374 </node>
375 <node ID="_Freemind_Link_894167206" TEXT="Helper (non-qualified)">
376 <node TEXT="Slow"/>
377 <node TEXT="Low-quality work"/>
378 <node TEXT="Cheap"/>
379 </node>
380 </node>
381 <node ID="_Freemind_Link_1901309571" TEXT="Employee morale"/>
382 <node TEXT="Salary"/>
383 </node>
384 </node>
385 </node>
386 <node TEXT="The research"/>
387 <node TEXT="Unsorted ideas">
388 <icon BUILTIN="pencil"/>
389 <node TEXT="All buildings shall gain a basic tech-level"/>
390 <node TEXT="Some parts of the ship or building are only available at or above a tech-level"/>
391 <node TEXT="Tech levels can be improved by research"/>
392 <node TEXT="General research complexes can increase tech-level of all types of buildings and ship parts"/>
393 <node TEXT="Doing resarch requires a lot money"/>
394 <node TEXT="Specialists must be hired for doing the research"/>
395 <node TEXT="Ship yards are highly required to construct ships">
396 <node TEXT="Without these facilities the gamer shall never be able to construct ships"/>
397 </node>
398 <node TEXT="Hired workers must be trained to do simple steps"/>
399 </node>
400 </node>
401 </node>
402 </map>