From: Roland Häder Date: Sat, 24 May 2008 09:25:58 +0000 (+0000) Subject: Documentation moved to new repository 'shipsimu-docs' X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=375d32104957e2401b7d2d5d20a48b32abc75831;p=hub.git Documentation moved to new repository 'shipsimu-docs' --- diff --git a/.gitattributes b/.gitattributes index ad4c031ca..073ef92f5 100644 --- a/.gitattributes +++ b/.gitattributes @@ -49,13 +49,9 @@ devel/class_Debug.php -text docs/COPYING -text docs/COPYING.documents -text docs/COPYING.software -text -docs/Conception[!!-~]-[!!-~]Ship-Simu[!!-~]0.0.1.odt -text docs/NEWS -text docs/README -text -docs/Ship-Simu[!!-~]ArgoUML[!!-~]Diagram.zargo -text -docs/Ship-Simu[!!-~]Ship-Simulator.mm -text docs/THANKS -text -docs/mindmap_20080517.html -text inc/.htaccess -text inc/classes.php -text inc/classes/.htaccess -text diff --git a/docs/Conception - Ship-Simu 0.0.1.odt b/docs/Conception - Ship-Simu 0.0.1.odt deleted file mode 100644 index 05a025efd..000000000 Binary files a/docs/Conception - Ship-Simu 0.0.1.odt and /dev/null differ diff --git a/docs/Ship-Simu ArgoUML Diagram.zargo b/docs/Ship-Simu ArgoUML Diagram.zargo deleted file mode 100644 index 690eea71d..000000000 Binary files a/docs/Ship-Simu ArgoUML Diagram.zargo and /dev/null differ diff --git a/docs/Ship-Simu Ship-Simulator.mm b/docs/Ship-Simu Ship-Simulator.mm deleted file mode 100644 index b03d985e4..000000000 --- a/docs/Ship-Simu Ship-Simulator.mm +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/mindmap_20080517.html b/docs/mindmap_20080517.html deleted file mode 100644 index 67a14c974..000000000 --- a/docs/mindmap_20080517.html +++ /dev/null @@ -1,755 +0,0 @@ - - -Ship-Simu Ship-Simulation - - - - - - -All + -All - -

Ship-Simu Ship-Simulation -

  • + - -Browser-Game -
    • + - -Tick-based simulation -
      • + - -Cronological job (cron) -
        • Addional requirement for installation - -
        • - -
        -
      • - -
      -
    • -
    • + - -Click-based simulation -
      • User clicks a button, action performed - -
      • - -
      -
    • -
    • + - -Pseudo-3D graphics -
      • + - -Still graphics -
        • + - -Different ships -
          • Passenger ship - -
          • -
          • Oil tanker - -
          • -
          • Container ship - -
          • -
          • Misc small ships - -
          • - -
          -
        • -
        • + - -Buildings -
          • Shipyard - -
          • -
          • Dry dock - -
          • -
          • Terminal building - -
          • - -
          -
        • -
        • + - -Vehicles -
          • Container carrier - -
          • -
          • Crane - -
          • - -
          -
        • -
        • + - -All pics should be self-shooted -
          • This avoids copyright conflicts - -
          • -
          • The requested buildings/vehicles must be found in reality - -
          • - -
          -
        • - -
        -
      • -
      • + - -Slightly moved graphics (GIF) -
        • Water surface - -
        • -
        • Sky texture - -
        • - -
        -
      • - -
      -
    • -
    • + - -Fully XHTML 1.0 -
      • Latest Internet standard - -
      • -
      • Older browsers will make lesser trouble - -
      • -
      • + - -Should validate with the W3C HTML Validator - -
      • - -
      -
    • -
    • + - -Design is CSS-based -
      • Themes are possible - -
      • - -
      -
    • -
    • Nice AJAX features - -
    • -
    • + - -News on the front page (home) -
      • + - -The news source can be choosen from different -
        • Previously typed and stored in database - -
        • -
        • + - -Local XML files -
          • Hint: Created by external generators - -
          • - -
          -
        • -
        • Remote XMLs like RSS feeds - -
        • - -
        -
      • -
      • + - -The typer can choose a category -
        • New categories can be suggested by the typer - -
        • -
        • An admin can create new categories - -
        • - -
        -
      • -
      • + - -Comments are allowable -
        • Logged-in users - -
        • -
        • + - -Guests as well -
          • Secured with CAPTCHA - -
          • - -
          -
        • - -
        -
      • -
      • + - -One object for all news should be fine -
        • Do not use one object per news entry! - -
        • -
        • + - -The object receives a "Requestable" object -
          • Obtain page number and sent comment data from it - -
          • - -
          -
        • - -
        -
      • - -
      -
    • -
    • + - -Strict coding guidelines for better PHP code -
      • + - -General code structure -
        • Fully object-oriented - -
        • -
        • Use of different but practical design patterns - -
        • - -
        -
      • -
      • + - -Documentation -
        • + - -In-line documentation -
          • Script header with full copyright and license as requested by GNU GPL 3 - -
          • -
          • Method headers with Doxygen compatible tags - -
          • -
          • Comments above single lines for better understanding what is happening - -
          • - -
          -
        • -
        • + - -Files in directory "docs" -
          • COPYING* - -
          • -
          • Conception - -
          • -
          • NEWS - -
          • -
          • README - -
          • -
          • ArgoUML diagram - -
          • -
          • FreeMind document - -
          • -
          • THANKS - -
          • -
          • minmap_yyyymmdd.html - -
          • - -
          -
        • - -
        -
      • -
      • Folding of the code - -
      • -
      • Tabs and spaces - -
      • - -
      -
    • - -
    -
  • -
  • + - -How does a shipping company work? -
    • + - -Start as a founder by selecting a harbor -
      • + - -Construct neccessary buildings -
        • Make contract with construction companies - -
        • - -
        -
      • -
      • + - -Order ship parts -
        • Fron your partners - -
        • -
        • On global market - -
        • - -
        -
      • -
      • + - -Make contracts with other companies -
        • Construct ships for your partner - -
        • -
        • Drive constructed ships by your partner - -
        • - -
        -
      • -
      • Build ship parts and trade them - -
      • -
      • + - -Become CEO and manage your company -
        • Nominate department managers - -
        • -
        • Recruit new employees - -
        • -
        • Pay salery to your employees - -
        • - -
        -
      • -
      • Let other gamer manage your company - -
      • -
      • + - -Compare prices -
        • Make a purchase computation system - -
        • - -
        -
      • -
      • Manage a journey - -
      • - -
      -
    • -
    • + - -Or start as an employee -
      • + - -Start as a simple sailor -
        • + - -And end up as a captain -
          • Control your ship (depends on client) - -
          • - -
          -
        • - -
        -
      • -
      • + - -Or start as a shipbuilder -
        • + - -Repair ships -
          • Renew the painting - -
          • -
          • Fix broken things - -
          • - -
          -
        • -
        • Build up new ships - -
        • - -
        -
      • -
      • As an officer - -
      • -
      • As a cleaner - -
      • - -
      -
    • -
    • + - -Create a board of managers -
      • Only for bigger comanpies - -
      • - -
      -
    • -
    • + - -Design your own ships -
      • From templates (default ships) - -
      • -
      • Or your complete freely designed layout - -
      • - -
      -
    • -
    • + - -Ride constructed ships -
      • Make sail plans - -
      • -
      • + - -Transportate cargo or humans -
        • Make your passengers happy - -
        • -
        • Load containers and bring them to other harbors - -
        • -
        • Transportate oil from ricks to the refineries - -
        • - -
        -
      • -
      • Depends on used client - -
      • - -
      -
    • -
    • + - -Earn a lot (virtual/real) money -
      • Sell a journey - -
      • -
      • Trade with goods - -
      • -
      • Construct ships for other companies - -
      • - -
      -
    • -
    • + - -Play as a passenger -
      • Order a jorney to your desired destionation - -
      • - -
      -
    • - -
    -
  • -
  • + - -Multi-Player Mode -
    • Networked over hubs - -
    • -
    • + - -Big map which holds all harbors -
      • Seperated into small maps to cluster the load over the network - -
      • - -
      -
    • - -
    -
  • -
  • + - -Java client -
    • Real-time simulation - -
    • -
    • + - -OpenGL (3D Graphics) -
      • JOGL - -
      • - -
      -
    • -
    • OpenAL (3D sound) - -
    • - -
    -
  • -
  • + - -"Faked" Single-Player -
    • Locally installed version - -
    • -
    • Does not connect to other hubs - -
    • -
    • + - -"Save games" should be incompatible with MP mode -
      • Avoids cheating - -
      • - -
      -
    • - -
    -
  • -
  • + - -Sand-Box Mode -
    • + - -The player can test the game -
      • Some people like to "explore" the game - -
      • -
      • Or just wanna have a look - -
      • - -
      -
    • -
    • There are no competitors - -
    • - -
    -
  • -
  • + - -Modern-epoche game -
    • Age: 1950+ - -
    • -
    • The abstraction level is kept low - -
    • - -
    -
  • -
  • + - -License -
    • + - -The game -
      • + - -Ship-Simu is licensed under the GNU GPL 3 or any newer version -
        • See docs/COPYING.software - -
        • - -
        -
      • - -
      -
    • -
    • + - -This document -
      • + - -This mind-map is licensed under the GNU FDL 1.2 or any newer version -
        • See docs/COPYING.documents - -
        • - -
        -
      • - -
      -
    • - -
    -
  • -
  • + - -Data exchange protocol -
    • + - -Default is an own small format -
      • Reduces traffic between servers - -
      • - -
      -
    • -
    • + - -Easy rewriteable to e.g. XML -
      • Other clients (Flash) can also connect - -
      • - -
      -
    • -
    • Java and browser client can play together - -
    • - -
    -
  • -
  • + - -Optional Pillory -
    • To make e.g. nazi activity public - -
    • -
    • Shall keep bad players away - -
    • -
    • + - -Requires some "game-moderator" access level to manage -
      • The moderator shall have an extra flag e.g. "pillory_accessable" - -
      • - -
      -
    • -
    • + - -Players, companies et cetera should be lockable -
      • The moderator can choose wether to lock with pillory entry or just locking down - -
      • - -
      -
    • - -
    -
  • -
  • ~ http://www.ship-simu.org - - -
  • - -
- -