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="News on the front page (home)">
  60 <node TEXT="The news source can be choosen from different">
  61 <node TEXT="Previously typed and stored in database"/>
  62 <node TEXT="Local XML files">
  63 <node TEXT="Hint: Created by external generators">
  64 <font NAME="SansSerif" SIZE="12"/>
  65 </node>
  66 </node>
  67 <node TEXT="Remote XMLs like RSS feeds"/>
  68 </node>
  69 <node TEXT="The typer can choose a category">
  70 <node TEXT="New categories can be suggested by the typer"/>
  71 <node TEXT="An admin can create new categories"/>
  72 </node>
  73 <node TEXT="Comments are allowable">
  74 <node TEXT="Logged-in users"/>
  75 <node TEXT="Guests as well">
  76 <icon BUILTIN="clanbomber"/>
  77 <node TEXT="Secured with CAPTCHA">
  78 <icon BUILTIN="messagebox_warning"/>
  79 </node>
  80 </node>
  81 </node>
  82 <node TEXT="One object for all news should be fine">
  83 <node TEXT="Do not use one object per news entry!">
  84 <icon BUILTIN="clanbomber"/>
  85 <icon BUILTIN="stop"/>
  86 </node>
  87 <node TEXT="The object receives a &quot;Requestable&quot; object">
  88 <node TEXT="Obtain page number and sent comment data from it"/>
  89 </node>
  90 </node>
  91 </node>
  92 <node TEXT="Strict coding guidelines for better PHP code">
  93 <font NAME="SansSerif" BOLD="true" SIZE="14"/>
  94 <icon BUILTIN="xmag"/>
  95 <node TEXT="General code structure">
  96 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
  97 <icon BUILTIN="messagebox_warning"/>
  98 <node TEXT="Fully object-oriented"/>
  99 <node TEXT="Use of different but practical design patterns"/>
 100 </node>
 101 <node TEXT="Documentation">
 102 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
 103 <node TEXT="In-line documentation">
 104 <node TEXT="Script header with full copyright and license as requested by GNU GPL 3"/>
 105 <node TEXT="Method headers with Doxygen compatible tags"/>
 106 <node TEXT="Comments above single lines for better understanding what is happening"/>
 107 </node>
 108 <node TEXT="Files in directory &quot;docs&quot;">
 109 <node TEXT="COPYING*"/>
 110 <node TEXT="Conception"/>
 111 <node TEXT="NEWS"/>
 112 <node TEXT="README"/>
 113 <node TEXT="ArgoUML diagram"/>
 114 <node TEXT="FreeMind document"/>
 115 <node TEXT="THANKS"/>
 116 <node TEXT="minmap_yyyymmdd.html"/>
 117 </node>
 118 </node>
 119 <node TEXT="Folding of the code">
 120 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
 121 </node>
 122 <node TEXT="Tabs and spaces">
 123 <font NAME="SansSerif" BOLD="true" SIZE="12"/>
 124 </node>
 125 </node>
 126 </node>
 127 <node TEXT="How does a shipping company work?" POSITION="left">
 128 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
 129 <icon BUILTIN="messagebox_warning"/>
 130 <node TEXT="Start as a founder by selecting a harbor">
 131 <cloud/>
 132 <node TEXT="Construct neccessary buildings">
 133 <node TEXT="Make contract with construction companies"/>
 134 </node>
 135 <node TEXT="Order ship parts">
 136 <node TEXT="Fron your partners"/>
 137 <node TEXT="On global market"/>
 138 </node>
 139 <node TEXT="Make contracts with other companies">
 140 <node TEXT="Construct ships for your partner"/>
 141 <node TEXT="Drive constructed ships by your partner"/>
 142 </node>
 143 <node TEXT="Build ship parts and trade them"/>
 144 <node TEXT="Become CEO and manage your company">
 145 <node TEXT="Nominate department managers"/>
 146 <node TEXT="Recruit new employees"/>
 147 <node TEXT="Pay salery to your employees"/>
 148 </node>
 149 <node TEXT="Let other gamer manage your company"/>
 150 <node TEXT="Compare prices">
 151 <node TEXT="Make a purchase computation system"/>
 152 </node>
 153 <node TEXT="Manage a journey"/>
 154 </node>
 155 <node TEXT="Or start as an employee">
 156 <cloud/>
 157 <node TEXT="Start as a simple sailor">
 158 <node TEXT="And end up as a captain">
 159 <node TEXT="Control your ship (depends on client)"/>
 160 </node>
 161 </node>
 162 <node TEXT="Or start as a shipbuilder">
 163 <node TEXT="Repair ships">
 164 <node TEXT="Renew the painting"/>
 165 <node TEXT="Fix broken things"/>
 166 </node>
 167 <node TEXT="Build up new ships"/>
 168 </node>
 169 <node TEXT="As an officer">
 170 <icon BUILTIN="idea"/>
 171 <icon BUILTIN="help"/>
 172 </node>
 173 <node TEXT="As a cleaner"/>
 174 </node>
 175 <node TEXT="Create a board of managers">
 176 <icon BUILTIN="idea"/>
 177 <icon BUILTIN="help"/>
 178 <node TEXT="Only for bigger comanpies"/>
 179 </node>
 180 <node TEXT="Design your own ships">
 181 <node TEXT="From templates (default ships)"/>
 182 <node TEXT="Or your complete freely designed layout"/>
 183 </node>
 184 <node TEXT="Ride constructed ships">
 185 <node TEXT="Make sail plans"/>
 186 <node TEXT="Transportate cargo or humans">
 187 <node TEXT="Make your passengers happy"/>
 188 <node TEXT="Load containers and bring them to other harbors"/>
 189 <node TEXT="Transportate oil from ricks to the refineries"/>
 190 </node>
 191 <node TEXT="Depends on used client"/>
 192 </node>
 193 <node TEXT="Earn a lot (virtual/real) money">
 194 <node TEXT="Sell a journey"/>
 195 <node TEXT="Trade with goods"/>
 196 <node TEXT="Construct ships for other companies"/>
 197 </node>
 198 <node TEXT="Play as a passenger">
 199 <node TEXT="Order a jorney to your desired destionation"/>
 200 </node>
 201 </node>
 202 <node TEXT="Multi-Player Mode" POSITION="right">
 203 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
 204 <icon BUILTIN="messagebox_warning"/>
 205 <node TEXT="Networked over hubs"/>
 206 <node TEXT="Big map which holds all harbors">
 207 <node TEXT="Seperated into small maps to cluster the load over the network"/>
 208 </node>
 209 </node>
 210 <node TEXT="Java client" POSITION="left">
 211 <cloud/>
 212 <icon BUILTIN="idea"/>
 213 <node TEXT="Real-time simulation"/>
 214 <node TEXT="OpenGL (3D Graphics)">
 215 <node TEXT="JOGL"/>
 216 </node>
 217 <node TEXT="OpenAL (3D sound)"/>
 218 </node>
 219 <node TEXT="&quot;Faked&quot; Single-Player" POSITION="right">
 220 <node TEXT="Locally installed version"/>
 221 <node TEXT="Does not connect to other hubs"/>
 222 <node TEXT="&quot;Save games&quot; should be incompatible with MP mode">
 223 <node TEXT="Avoids cheating"/>
 224 </node>
 225 </node>
 226 <node TEXT="Sand-Box Mode" POSITION="right">
 227 <node TEXT="The player can test the game">
 228 <node TEXT="Some people like to &quot;explore&quot; the game"/>
 229 <node TEXT="Or just wanna have a look"/>
 230 </node>
 231 <node TEXT="There are no competitors">
 232 <font NAME="SansSerif" SIZE="12"/>
 233 </node>
 234 </node>
 235 <node TEXT="Modern-epoche game" POSITION="left">
 236 <node TEXT="Age: 1950+"/>
 237 <node TEXT="The abstraction level is kept low"/>
 238 </node>
 239 <node TEXT="License" POSITION="left">
 240 <node TEXT="The game">
 241 <node TEXT="Ship-Simu is licensed under the GNU GPL 3 or any newer version">
 242 <node TEXT="See docs/COPYING.software"/>
 243 </node>
 244 </node>
 245 <node TEXT="This document">
 246 <node TEXT="This mind-map is licensed under the GNU FDL 1.2 or any newer version">
 247 <node TEXT="See docs/COPYING.documents"/>
 248 </node>
 249 </node>
 250 </node>
 251 <node TEXT="Data exchange protocol" POSITION="right">
 252 <node TEXT="Default is an own small format">
 253 <node TEXT="Reduces traffic between servers"/>
 254 </node>
 255 <node TEXT="Easy rewriteable to e.g. XML">
 256 <node TEXT="Other clients (Flash) can also connect"/>
 257 </node>
 258 <node TEXT="Java and browser client can play together"/>
 259 </node>
 260 <node TEXT="Optional Pillory" POSITION="left">
 261 <node TEXT="To make e.g. nazi activity public"/>
 262 <node TEXT="Shall keep bad players away"/>
 263 <node TEXT="Requires some &quot;game-moderator&quot; access level to manage">
 264 <node TEXT="The moderator shall have an extra flag e.g. &quot;pillory_accessable&quot;"/>
 265 </node>
 266 <node TEXT="Players, companies et cetera should be lockable">
 267 <node TEXT="The moderator can choose wether to lock with pillory entry or just locking down"/>
 268 </node>
 269 </node>
 270 <node LINK="http://www.ship-simu.org" TEXT="http://www.ship-simu.org" POSITION="right">
 271 <icon BUILTIN="attach"/>
 272 </node>
 273 </node>
 274 </map>