More website structure details added
[shipsimu.git] / docs / Ship-Simu Ship-Simulator.mm
index 6532beb33ab634ee8cd516b34b150f6b3b345726..734ca18a333fc502c83f948662aee900ebc4962b 100644 (file)
@@ -58,6 +58,8 @@
 </node>
 <node TEXT="Website structure">
 <font NAME="SansSerif" BOLD="true" SIZE="14"/>
+<node TEXT="External guest area">
+<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"/>
@@ -91,7 +93,7 @@
 </node>
 </node>
 </node>
-<node TEXT="Registration form">
+<node TEXT="Registration form" STYLE="fork">
 <node TEXT="One single page"/>
 <node TEXT="Multiple pages"/>
 </node>
 <node TEXT="Comments are allowable"/>
 <node TEXT="Should be kept simple"/>
 </node>
-<node TEXT="List of enabled features"/>
+<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="Privacy policy (required in some countries)"/>
 </node>
 </node>
-<node TEXT="Strict coding guidelines for better PHP code">
+<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>
+<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>
+<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>
+<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="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="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="Comments above single lines for better understanding what is happening"/>
 </node>
 <node TEXT="Files in directory &quot;docs&quot;">
-<node TEXT="COPYING*"/>
-<node TEXT="Conception"/>
-<node TEXT="NEWS"/>
-<node TEXT="README"/>
-<node TEXT="ArgoUML diagram"/>
-<node TEXT="FreeMind document"/>
-<node TEXT="THANKS"/>
-<node TEXT="minmap_yyyymmdd.html"/>
+<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">
 <node TEXT="OpenAL (3D sound)"/>
 </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">
 </node>
 </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"/>
 <node TEXT="There are no competitors">
 <font NAME="SansSerif" SIZE="12"/>
 </node>
+<node TEXT="Creating characters is for free"/>
+<node TEXT="The game will not connect to network"/>
+<node TEXT="Characters are invalid to multi/single-player characters">
+<node TEXT="Prevents cheating a bit">
+<icon BUILTIN="clanbomber"/>
+</node>
+</node>
 </node>
 <node TEXT="Modern-epoche game" POSITION="left">
 <node TEXT="Age: 1950+"/>
 <node TEXT="The moderator can choose wether to lock with pillory entry or just locking down"/>
 </node>
 </node>
-<node LINK="http://www.ship-simu.org" TEXT="http://www.ship-simu.org" POSITION="right">
-<icon BUILTIN="attach"/>
-</node>
 <node TEXT="How do you construct a ship?" POSITION="left">
 <font NAME="SansSerif" BOLD="true" SIZE="16"/>
 <node TEXT="The technology">
 <node TEXT="Hired workers must be trained to do simple steps"/>
 </node>
 </node>
+<node TEXT="Misc" POSITION="right">
+<font NAME="SansSerif" BOLD="true" SIZE="16"/>
+<node TEXT="Websites">
+<font NAME="SansSerif" BOLD="true" SIZE="14"/>
+<node LINK="http://www.ship-simu.org" TEXT="Homepage (www.ship-simu.org)">
+<icon BUILTIN="gohome"/>
+</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>
+<node TEXT="Author">
+<font NAME="SansSerif" BOLD="true" SIZE="14"/>
+<node TEXT="Roland &quot;Quix0r&quot; Haeder">
+<node TEXT="Main author"/>
+<node LINK="mailto:webmaster@ship-simu.org" TEXT="webmaster@ship-simu.org"/>
+<node TEXT="8809296">
+<icon BUILTIN="licq"/>
+</node>
+</node>
+</node>
+<node TEXT="Ideas">
+<font NAME="SansSerif" BOLD="true" SIZE="14"/>
+<node TEXT="Roland &quot;Quix0r&quot; Haeder">
+<node TEXT="Main concept"/>
+<node TEXT="Translation of monakoianar&apos;s ideas to english"/>
+</node>
+<node TEXT="Dominik &quot;monakoianar&quot; Schmauder">
+<node TEXT="Helps finding a lot major ideas"/>
+<node LINK="mailto:dominikschmauder@gmx.de" TEXT="dominikschmauder@gmx.de"/>
+<node TEXT="268853027">
+<icon BUILTIN="licq"/>
+</node>
+</node>
+</node>
+</node>
 </node>
 </map>