readme.txt

   1 Skyscraper 2.0 Alpha 10
   2 Copyright (C)2003-2016 Ryan Thoryk
   3 http://www.skyscrapersim.com
   4 http://sourceforge.net/projects/skyscraper
   5
   6 Contents
   7 1. Legal Notices
   8 2. Introduction
   9 3. Release Notes
  10 4. Building and Installing
  11 5. Usage
  12 6. Detailed Release Notes
  13 7. Contact
  14
  15
  16 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  17
  18 1. Legal Notices
  19
  20 This program is free software; you can redistribute it and/or
  21 modify it under the terms of the GNU General Public License
  22 as published by the Free Software Foundation; either version 2
  23 of the License, or (at your option) any later version.
  24
  25 This program is distributed in the hope that it will be useful,
  26 but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 GNU General Public License for more details.
  29
  30 You should have received a copy of the GNU General Public License
  31 along with this program; if not, write to the Free Software
  32 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  33
  34 For more information, see the LICENSE file.
  35
  36 This software utilizes the FMOD sound system
  37 FMOD Sound System, copyright (C) Firelight Technologies Pty, Ltd., 1994-2015.
  38
  39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  40
  41 2. Introduction
  42
  43 Skyscraper is a 3D virtual building simulator written in C++ using the OGRE graphics engine
  44 (previously Crystal Space) graphics engine.  The goal of the Skyscraper project is to create a
  45 fully-featured, modular, multiplatform 3D realtime building simulation engine, including
  46 gaming support (single and network multiplayer). Everything possible is planned to be simulated,
  47 including elevators, stairs, interfloor areas, ductwork, and more, all in first-person 3D.
  48 The simulator core is called the Scalable Building Simulator, or SBS. Buildings are stored
  49 in scripted text files that are loaded and generated in realtime by the simulator. A
  50 graphical building designer application is planned to assist in creating building data
  51 files.
  52
  53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  54
  55 3. Release Notes
  56
  57 This release is the tenth development release of the 2.0 series (which is a complete rewrite of
  58 the original 1.0 version), and is part of an ongoing effort towards a 2.0 stable release.
  59
  60 This software utilizes the OGRE rendering engine library (version 1.8 or later), the Bullet physics engine with some custom patches, the FMOD sound system, the wxWidgets library (version 3.0 or later), and the Caleum sky system addon for OGRE.
  61
  62 Skyscraper on Windows supports both DirectX and OpenGL.  To switch between them, simply delete the ogre.cfg file in Skyscraper's folder, run the program again, and choose from the OGRE rendering menu.
  63
  64 See the changelog for a detailed list of new features, fixes, and other changes in this release.
  65
  66 For third-party texture credits, see the file "license-info.txt" in the "data" folder.
  67
  68 See the bottom of this document for detailed release notes.
  69
  70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71
  72 4. Building and installing
  73
  74 Skyscraper uses the Cmake build system, and also includes Visual C++ project files.
  75
  76 See the compiling.txt file for information on how to build from source.
  77
  78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  79
  80 5. Usage
  81
  82 To use Skyscraper, run the program, and a main menu screen will appear with a button for each
  83 available building (and one button for loading user buildings). Choose the building to load, and in a few moments you will be walking around in that building. You can press F5 to switch between standard and freelook modes. The only buildings that are completely simulated in this release are "Simple" and "Triton Center". While in one of these buildings, you can click on objects such as elevator call buttons, etc to perform actions.  The recommended building to try out is the Triton Center, since it is the most complete official building, and also the Glass Tower, which has some of the more complex designs.  The "Simple" building is a minimalistic demo to basically show how to make your own buildings in the application's scripting language. Other user-created buildings are included, and can be loaded by choosing the "Other Building" button on the main screen.
  84
  85 ------------------------------------
  86 Keys currently used in the simulator:
  87
  88 On a Mac, the Control key is the Command key (to the right of the Option key), and Alt is the Option key
  89
  90 W or Up Arrow - move forwards
  91 S or Down Arrow - move backwards
  92 A or Left Arrow - move left
  93 D or Right Arrow - move right
  94 PgUp or P - Look upwards
  95 PgDown or L - Look downwards
  96 Space - Jump
  97 Home or O - Float upwards (or jump if collision detection is on)
  98 End or K - Float downwards (or crouch if collision detection is on)
  99 F1 - show control reference
 100 F2 - print render statistics on console
 101 F3 - Reset camera rotation and zoom to default
 102 F4 - Enable/disable wireframe mode
 103 F5 - Freelook (mouse look) mode
 104 F6 - Full camera reset (respawn)
 105 F7 - Show colliders
 106 F8 - Show mesh bounding boxes
 107 F10 - Fullscreen mode
 108 F11 - Take screenshot
 109 F12 - Open control panel
 110 Shift - Run (hold down with other keys)
 111 Control - Walk slowly (hold down with other keys)
 112 Alt + arrow keys - Strafe
 113 Alt + PgUp/P - Spin right
 114 Alt + PgDown/L - Spin left
 115 Plus or ] - Zoom in (decrease FOV angle)
 116 Minus or [ - Zoom out (increase FOV angle)
 117 Esc - exit to main menu
 118 V - Toggle noclip mode (gravity and collisions off)
 119 B - Binoculars mode (hold down), and reset FOV to default
 120 C - Pick up object (physics-enabled models)
 121 ; - (semicolon) - Load an additional building
 122 1 to 0 - (number keys) - Switch active camera to engine instance number (ex. 2 for building engine 2)
 123 Ctrl-R - Reload current building
 124 Ctrl-Alt-C - Crash program (throw exception) - used for testing handlers
 125
 126 --- Mouse actions ---
 127 -the selection order of controls (buttons and switches) can be reversed by right-clicking them
 128 -elevator shaft doors can be manually opened and closed by holding down the Shift key and clicking on them - note that this only works when the interlocks are released, which can be done in the elevator editor by clicking "Set" next to "Interlocks" on the related elevator
 129 -polygons (wall/floor sides) and other objects can be deleted by holding down both Ctrl and Alt, and clicking on the object
 130 -doors, controls/buttons, and call buttons can be locked/unlocked by holding down both the Ctrl and Shift keys while clicking on the side to lock, if you have the associated key
 131
 132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133
 134 6. Detailed Release Notes
 135
 136
 137 Information for this release:
 138 ------------------------------------
 139
 140 This release has a very large amount of bug fixes and stability fixes, which results in Alpha 10 being the most stable release of Skyscraper yet.  Many fixes were intended to make Skyscraper stable for dynamic creation and deletion of objects during runtime, in anticipation for a building designer.
 141
 142 Most objects can be deleted by pressing Ctrl and Alt together, and clicking on the object.  On a Mac, the keys are Command and Option.
 143
 144 Skyscraper has supported loading standard OGRE mesh models since the Alpha 8 release.  A couple couches and keys are loaded in the Simple building as an example, and there is a couch on the roof of the Triton Center to demonstrate physics.  See this forum thread on how to create models using Google Sketchup:
 145 http://forum.skyscrapersim.com/index.php?topic=5556.0
 146
 147 To optimize rendering speed, the main thing that will cause overall slowdowns is the type of texture filtering used.  The better the filtering, the better the visual quality but the slower the app.  Skyscraper defaults to anisotropic filtering at level 4.  Lower-quality filtering is available too in the forms of bilinear and trilinear filtering, so to improve rendering performance, either lower the anisotropic level in the INI file or switch to a different filtering method.  Also, the Vsync option normally locks the FPS at 60, but can cause abnormal slowdowns that can decrease the framerate below what it should (such as an FPS reading of 30 with vsync on, while one of 40 with it off).  These options can all be set in the INI file.
 148
 149 Caelum is used to create dynamic skies, including moving clouds, moving sun and moon, effects like fog and rain, stars at night, etc.  To use Caelum, choose (or create) a sky function from the data/caelum/sky.os script, and either add it to your building script using the DynamicSky command or in the INI file with the SkyName parameter.  See the script guide (designguide.html) for more information on the available options.  The Caelum sky-related time multiplier can be set in the Camera Control box, in order to quickly show day/night cycles.
 150
 151 To revert back to the old sky system, turn off Caelum in the skyscraper.ini file using the Skyscraper.Frontent.Caelum option.
 152
 153
 154 Major changes since the Alpha 9 release:
 155 ------------------------------------
 156
 157 Ogre 1.9 is now used instead of 1.8.1, which Alpha 9 used.  Model mesh files need to be upgraded to the newer format to prevent warning messages on startup - they'll still work fine though.
 158
 159 Modified keys:
 160 -------
 161 -------
 162
 163
 164 New commands/parameters:
 165
 166 New elevator actions:
 167
 168
 169
 170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 171
 172 7. Contact
 173
 174 Bug-Reports, suggestions, and requests should be posted to
 175 the Skyscraper forum at http://forum.skyscrapersim.com
 176 I can be contacted directly at ryan at skyscrapersim.com
 177