X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=shipsimu-docs%2FShip-Simu%20Ship-Simulator.mm;h=a78614fdcb0e8f3e6f6d36dc24316498ed35d256;hb=b9cbe0631119ca04b000fa1e01245953b9e4dca2;hp=b8ec1bc0e5e8d68ef170d958a9c5c563369ac41e;hpb=cb1278901d68be34ba0c15194fc7d38d59dc2245;p=shipsimu-docs.git

diff --git a/shipsimu-docs/Ship-Simu Ship-Simulator.mm b/shipsimu-docs/Ship-Simu Ship-Simulator.mm
index b8ec1bc..a78614f 100644
--- a/shipsimu-docs/Ship-Simu Ship-Simulator.mm	
+++ b/shipsimu-docs/Ship-Simu Ship-Simulator.mm	
@@ -1,361 +1,14 @@
 <map version="0.7.1">
 <node TEXT="Ship-Simu Ship-Simulation">
 <font NAME="SansSerif" BOLD="true" SIZE="18"/>
-<node TEXT="Browser-Game" POSITION="right">
+<node LINK="Browser Game.mm" TEXT="Browser-Game" POSITION="right">
 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
-<icon BUILTIN="messagebox_warning"/>
-<node TEXT="Tick-based simulation">
-<node TEXT="Cronological job (cron)">
-<node TEXT="Addional requirement for installation"/>
-</node>
-</node>
-<node TEXT="Click-based simulation">
-<node TEXT="User clicks a button, action performed"/>
-</node>
-<node TEXT="Pseudo-3D graphics">
-<node TEXT="Still graphics">
-<node TEXT="Different ships">
-<node TEXT="Passenger ship"/>
-<node TEXT="Oil tanker"/>
-<node TEXT="Container ship"/>
-<node TEXT="Misc small ships"/>
-</node>
-<node TEXT="Buildings">
-<node TEXT="Shipyard"/>
-<node TEXT="Dry dock"/>
-<node TEXT="Terminal building"/>
-</node>
-<node TEXT="Vehicles">
-<node TEXT="Container carrier"/>
-<node TEXT="Crane"/>
-</node>
-<node TEXT="All pics should be self-shooted">
-<node TEXT="This avoids copyright conflicts"/>
-<node TEXT="The requested buildings/vehicles must be found in reality"/>
-</node>
-</node>
-<node TEXT="Slightly moved graphics (GIF)">
-<node TEXT="Water surface"/>
-<node TEXT="Sky texture"/>
-</node>
-</node>
-<node TEXT="Fully XHTML 1.0">
-<node TEXT="Latest Internet standard"/>
-<node TEXT="Older browsers will make lesser trouble"/>
-<node TEXT="Should validate with the W3C HTML Validator">
-<node LINK="http://validator.w3.org" TEXT="http://validator.w3.org">
-<icon BUILTIN="attach"/>
-</node>
-</node>
-</node>
-<node TEXT="Design is CSS-based">
-<font NAME="SansSerif" SIZE="12"/>
-<node TEXT="Themes are possible"/>
-</node>
-<node TEXT="Nice AJAX features">
-<icon BUILTIN="idea"/>
-<icon BUILTIN="desktop_new"/>
-</node>
-<node TEXT="Website structure">
-<font NAME="SansSerif" BOLD="true" SIZE="14"/>
-<node TEXT="External guest area">
-<cloud/>
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-<node TEXT="News on the front page (home)">
-<node TEXT="The news source can be choosen from different">
-<node TEXT="Previously typed and stored in database"/>
-<node TEXT="Local XML files">
-<node TEXT="Hint: Created by external generators">
-<font NAME="SansSerif" SIZE="12"/>
-</node>
-</node>
-<node TEXT="Remote XMLs like RSS feeds"/>
-</node>
-<node TEXT="The typer can choose a category">
-<node TEXT="New categories can be suggested by the typer"/>
-<node TEXT="An admin can create new categories"/>
-</node>
-<node TEXT="Comments are allowable">
-<node TEXT="Logged-in users"/>
-<node TEXT="Guests as well">
-<icon BUILTIN="clanbomber"/>
-<node TEXT="Secured with CAPTCHA">
-<icon BUILTIN="messagebox_warning"/>
-</node>
-</node>
-</node>
-<node TEXT="One object for all news should be fine">
-<node TEXT="Do not use one object per news entry!">
-<icon BUILTIN="clanbomber"/>
-<icon BUILTIN="stop"/>
-</node>
-<node TEXT="The object receives a &quot;Requestable&quot; object">
-<node TEXT="Obtain page number and sent comment data from it"/>
-</node>
-</node>
-</node>
-<node TEXT="Registration form" STYLE="fork">
-<node TEXT="One single page"/>
-<node TEXT="Multiple pages"/>
-</node>
-<node TEXT="Login form">
-<node TEXT="With guest login (disable by the admin)">
-<icon BUILTIN="bell"/>
 <icon BUILTIN="idea"/>
 </node>
-<node TEXT="Password reminder"/>
-<node TEXT="Link to the registration form"/>
-<node TEXT="Different login methods configureable by admin:">
-<node TEXT="By username+password"/>
-<node TEXT="By email+password"/>
-<node TEXT="By username/email+password"/>
-</node>
-<node TEXT="Wether cookie-based or session-based login">
-<node TEXT="This shall be configureable by admin">
-<icon BUILTIN="messagebox_warning"/>
-</node>
-</node>
-</node>
-<node TEXT="Screenshot gallery">
-<node TEXT="Comments are allowable"/>
-<node TEXT="Should be kept simple"/>
-</node>
-<node TEXT="List of enabled features" STYLE="fork"/>
-<node TEXT="Statistics of the game (not whole network!)"/>
-<node TEXT="List of playing users">
-<node TEXT="With link to their public profiles"/>
-</node>
-<node TEXT="Pillory">
-<node TEXT="Username (who got locked)"/>
-<node TEXT="Date&amp;Time"/>
-<node TEXT="The admin"/>
-<node TEXT="Stated reason"/>
-</node>
-<node TEXT="Small extra pages">
-<node TEXT="Imprint (required in Germany)"/>
-<node TEXT="Privacy policy (required in some countries)"/>
-</node>
-</node>
-<node TEXT="Internal game area">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-<node TEXT="News on first login page">
-<node TEXT="Like on &quot;home&quot; page except that there is no captcha required"/>
-<node TEXT="Including history of recent events since last login"/>
-<node TEXT="Announcements in special sub-category for newly founded shipping/travel companies"/>
-</node>
-<node TEXT="Create new game character">
-<edge STYLE="bezier"/>
-<cloud/>
-<font NAME="SansSerif" SIZE="12"/>
-<icon BUILTIN="password"/>
-<node TEXT="The gamer can have all varriants">
-<node TEXT="This may be limitable by admin"/>
-<node TEXT="The player still cannot make contracts with own characters">
-<icon BUILTIN="messagebox_warning"/>
-</node>
-</node>
-<node TEXT="It should cost somewhere a fee">
-<node TEXT="The fee shall be payed from user account"/>
-</node>
-<node TEXT="For first character creation he shall have enougth game money plus some extra"/>
-<node TEXT="Types of characters">
-<node TEXT="Shipping company founder">
-<node TEXT="This includes the fee for funding new company"/>
-<node TEXT="A news for the community shall be placed">
-<node TEXT="The admin/mod can still moderate it"/>
-</node>
-</node>
-<node TEXT="Travel company founder">
-<node TEXT="Like shipping company..."/>
-</node>
-<node TEXT="Jobholder">
-<node TEXT="Starts unemployed"/>
-<node TEXT="Some money left for sending applications out"/>
-<node TEXT="May ask goverment for financial help"/>
-<node TEXT="Has to pay monthly fees">
-<icon BUILTIN="stop"/>
-<node TEXT="Rent for a &quot;fake&quot; house"/>
-<node TEXT="Meal and drinks (faked)"/>
-<node TEXT="Others costs like phone,electricity"/>
-</node>
-</node>
-<node TEXT="Merchant">
-<node TEXT="Raw resources"/>
-<node TEXT="Constructed ship parts"/>
-<node TEXT="Smaller complete ships"/>
-</node>
-<node TEXT="Marketing Agency">
-<node TEXT="Sells marketing/merchandising products"/>
-</node>
-</node>
-<node TEXT="This is only possible if account is activated">
-<font ITALIC="true" NAME="SansSerif" SIZE="12"/>
-<icon BUILTIN="messagebox_warning"/>
-</node>
-</node>
-<node TEXT="Load existing character">
-<cloud/>
-<font NAME="SansSerif" SIZE="12"/>
-<icon BUILTIN="password"/>
-<node TEXT="Contains link to &quot;Create new character&quot;"/>
-<node TEXT="Player sees some basic data about listed characters"/>
-<node TEXT="Locked characters should not be removed instead marked with &quot;Locked&quot;"/>
-</node>
-<node TEXT="Refill account points">
-<node TEXT="The admin may choose if the in-game can be converted with a low rate to account points"/>
-<node TEXT="This option might be disabled by admin">
-<node TEXT="Then the gamer can only refill in-game money per character"/>
-</node>
-</node>
-<node TEXT="Update gamer/user profile">
-<node TEXT="Enter the current account password"/>
-<node TEXT="Send email to the user only if no email has changed, or if ..."/>
-<node TEXT="Has the email been changed?">
-<icon BUILTIN="help"/>
-<node TEXT="Send new confirmation to new email"/>
-<node TEXT="Send notifier to old email"/>
-</node>
-</node>
-<node TEXT="Change account password">
-<node TEXT="Enter current account password"/>
-<node TEXT="Enter new password twice"/>
-<node TEXT="Send an email to the user"/>
-</node>
-</node>
-<node TEXT="General infrastructures">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-<node TEXT="Point system (in-game money)">
-<font NAME="SansSerif" SIZE="12"/>
-<icon BUILTIN="password"/>
-</node>
-<node TEXT="A.I. goverment">
-<cloud/>
-<icon BUILTIN="flag"/>
-<icon BUILTIN="password"/>
-<node TEXT="Shall help unemployed gamers staying alive (but not becoming rich)"/>
-<node TEXT="May later on collect taxes from companies">
-<node TEXT="For paying unemployed people"/>
-<node TEXT="Financial support for broken companies"/>
-</node>
-<node TEXT="May ofer social security services">
-<icon BUILTIN="xmag"/>
-<icon BUILTIN="pencil"/>
-</node>
-<node TEXT="Goverment is not playable at the moment">
-<font NAME="SansSerif" SIZE="12"/>
-<icon BUILTIN="messagebox_warning"/>
-<node TEXT="It should be &quot;played&quot; abstractly by the server"/>
-<node TEXT="Gamers may help each other with financial support"/>
-</node>
-</node>
-</node>
-</node>
-<node TEXT="Procedures">
-<font NAME="SansSerif" BOLD="true" SIZE="14"/>
-<node TEXT="Registration procedure">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-<node TEXT="Make sure the user account is only used once">
-<node TEXT="An AJAX request may give the user faster feedback"/>
-</node>
-<node TEXT="If required make also sure that the email is used once">
-<node TEXT="Another AJAX request might be helpful here"/>
-</node>
-<node TEXT="Both passwords must match as verification"/>
-<node TEXT="Non-required form fields are checked only if there is content for XSS or other bad things"/>
-<node TEXT="Encrypt/hash the password (should always be performed)"/>
-<node TEXT="Complete the registration by adding the user account to the database"/>
-<node TEXT="Registered partners shall be notified with different ways">
-<node TEXT="XML-RPC is the default"/>
-<node TEXT="Different notifiers shall also be possible"/>
-<node TEXT="This might be queueable to avoid long waiting times for slow partner pages">
-<icon BUILTIN="xmag"/>
-<icon BUILTIN="messagebox_warning"/>
-</node>
-</node>
-<node TEXT="Send out confirmation mail if requested by configuration"/>
-<node TEXT="Redirect the user to a new page">
-<node TEXT="Default is the &quot;Registration completed&quot; page"/>
-<node TEXT="Home page shall be chooseable"/>
-<node TEXT="Other URLs can be used as well"/>
-</node>
-<node TEXT="Alternatively login to the internal area">
-<node TEXT="The account is not useable if email is not confirmed"/>
-</node>
-</node>
-<node TEXT="Login procedure">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-</node>
-<node TEXT="General">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-<node TEXT="Most steps shall be done by an intercepting filter pattern"/>
-</node>
-</node>
-<node TEXT="Strict coding guidelines for clean PHP code">
-<font NAME="SansSerif" BOLD="true" SIZE="14"/>
-<icon BUILTIN="xmag"/>
-<node TEXT="General code structure">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-<icon BUILTIN="messagebox_warning"/>
-<node TEXT="Fully object-oriented">
-<node TEXT="Use of different but practical design patterns">
-<node TEXT="Factory-method pattern for smother initializing of objects"/>
-<node TEXT="Template method pattern where it matches"/>
-<node TEXT="MVC pattern for the website core"/>
-</node>
-<node TEXT="Only one index.php shall provide access to the whole game"/>
-<node TEXT="Slower in PHP5">
-<icon BUILTIN="clanbomber"/>
-</node>
-</node>
-</node>
-<node TEXT="Documentation">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-<node TEXT="In-line documentation">
-<node TEXT="Script header with full copyright and license as requested by GNU GPL 3"/>
-<node TEXT="Method headers with Doxygen compatible tags"/>
-<node TEXT="Comments above single lines for better understanding what is happening"/>
-</node>
-<node TEXT="Files in directory &quot;docs&quot;">
-<node TEXT="COPYING*">
-<node TEXT="License files"/>
-</node>
-<node TEXT="Conception">
-<node TEXT="As OpenDocument and later PDF as well"/>
-</node>
-<node TEXT="NEWS">
-<node TEXT="Latest news around the game (coeer and gamer)"/>
-</node>
-<node TEXT="README">
-<node TEXT="Includes installation instructions and general gaming guidelines"/>
-</node>
-<node TEXT="ArgoUML diagram">
-<node TEXT="For visualization of the class structure"/>
-</node>
-<node TEXT="FreeMind document">
-<node TEXT="...">
-<icon BUILTIN="ksmiletris"/>
-</node>
-</node>
-<node TEXT="THANKS">
-<node TEXT="All people helped in some direct or indirect way, less or more."/>
-</node>
-<node TEXT="minmap_yyyymmdd.html">
-<node TEXT="Exported FreeMind maps to HTML with CSS and JavaScript"/>
-</node>
-</node>
-</node>
-<node TEXT="Folding of the code">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-</node>
-<node TEXT="Tabs and spaces">
-<font NAME="SansSerif" BOLD="true" SIZE="12"/>
-</node>
-</node>
-</node>
 <node TEXT="How does a shipping/travel company work?" POSITION="left">
 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
 <icon BUILTIN="messagebox_warning"/>
-<node TEXT="Start as a founder by selecting a harbor">
+<node TEXT="Start as a founder by selecting a harbor" FOLDED="true">
 <cloud/>
 <node TEXT="Shipping company">
 <node TEXT="Construct neccessary buildings">
@@ -387,7 +40,7 @@
 </node>
 </node>
 </node>
-<node TEXT="Or start as an employee">
+<node TEXT="Or start as an employee" FOLDED="true">
 <cloud/>
 <node TEXT="Start as a simple sailor">
 <node TEXT="And end up as a captain">
@@ -418,10 +71,38 @@
 </node>
 <node TEXT="Ride constructed ships">
 <node TEXT="Make sail plans"/>
-<node TEXT="Transportate cargo or humans">
-<node TEXT="Make your passengers happy"/>
-<node TEXT="Load containers and bring them to other harbors"/>
-<node TEXT="Transportate oil from ricks to the refineries"/>
+<node TEXT="Transportate cargo or passengers">
+<node TEXT="Make your passengers happy/comfortable">
+<node TEXT="Discos"/>
+<node TEXT="Shops"/>
+<node TEXT="Kinder garden"/>
+<node TEXT="Cinema"/>
+<node TEXT="Baby station"/>
+<node TEXT="Internet Cafe"/>
+<node TEXT="Gambling Hall"/>
+</node>
+<node TEXT="Load containers and bring them to other harbors">
+<node TEXT="Containers content">
+<font ITALIC="true" NAME="SansSerif" SIZE="12"/>
+<node TEXT="Raw material"/>
+<node TEXT="Lifestock">
+<edge STYLE="bezier"/>
+<node TEXT="Exotic animals like dolphines et cetera"/>
+<node TEXT="Cows"/>
+<node TEXT="Horses"/>
+<node TEXT="Sheeps"/>
+</node>
+<node TEXT="Electronics"/>
+<node TEXT="Foods"/>
+</node>
+<node TEXT="Special container terminal"/>
+<node TEXT="May have temperatur control">
+<node TEXT="Organic frozen cargo"/>
+</node>
+</node>
+<node TEXT="Transportate oil from ricks to the refineries">
+<node TEXT="Or natural gas"/>
+</node>
 </node>
 <node TEXT="Depends on used client"/>
 </node>
@@ -436,7 +117,6 @@
 </node>
 <node TEXT="Multi-Player Mode" POSITION="right">
 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
-<icon BUILTIN="messagebox_warning"/>
 <node TEXT="Networked over hubs"/>
 <node TEXT="Big map which holds all harbors">
 <node TEXT="Seperated into small maps to cluster the load over the network"/>
@@ -453,7 +133,6 @@
 </node>
 <node TEXT="&quot;Faked&quot; Single-Player" POSITION="right">
 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
-<icon BUILTIN="messagebox_warning"/>
 <node TEXT="Locally installed version"/>
 <node TEXT="Does not connect to other hubs"/>
 <node TEXT="&quot;Save games&quot; should be incompatible with MP mode">
@@ -462,7 +141,6 @@
 </node>
 <node TEXT="Sand-Box Mode" POSITION="right">
 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
-<icon BUILTIN="messagebox_warning"/>
 <node TEXT="The player can test the game">
 <node TEXT="Some people like to &quot;explore&quot; the game"/>
 <node TEXT="Or just wanna have a look"/>
@@ -499,6 +177,9 @@
 </node>
 </node>
 </node>
+<node LINK="Payment-System.mm" TEXT="Payment system" POSITION="right">
+<font NAME="SansSerif" BOLD="true" SIZE="16"/>
+</node>
 <node TEXT="Data exchange protocol" POSITION="right">
 <node TEXT="Default is an own small format">
 <node TEXT="Reduces traffic between servers"/>
@@ -622,6 +303,7 @@
 </node>
 <node LINK="http://forum.ship-simu.org" TEXT="Forum (forum.ship-simu.org)"/>
 <node LINK="http://bugs.ship-simu.org" TEXT="Bug tracker (bugs.ship-simu.org)"/>
+<node LINK="http://stats.ship-simu.org" TEXT="SVN-Stats (stats.ship-simu.org)"/>
 </node>
 <node TEXT="Author">
 <font NAME="SansSerif" BOLD="true" SIZE="14"/>