readme.txt

   1 Skyscraper 2.0 Alpha 8
   2 Copyright (C)2003-2011 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. Contact
  13
  14
  15 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16
  17 1. Legal Notices
  18
  19 This program is free software; you can redistribute it and/or
  20 modify it under the terms of the GNU General Public License
  21 as published by the Free Software Foundation; either version 2
  22 of the License, or (at your option) any later version.
  23
  24 This program is distributed in the hope that it will be useful,
  25 but WITHOUT ANY WARRANTY; without even the implied warranty of
  26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27 GNU General Public License for more details.
  28
  29 You should have received a copy of the GNU General Public License
  30 along with this program; if not, write to the Free Software
  31 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  32
  33 For more information, see the LICENSE file.
  34
  35 This software utilizes the FMOD sound system
  36 FMOD Sound System, copyright (C) Firelight Technologies Pty, Ltd., 1994-2010.
  37
  38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  39
  40 2. Introduction
  41
  42 Skyscraper is a 3D virtual building simulator written in C++ using the OGRE graphics engine
  43 (previously Crystal Space) graphics engine.  The goal of the Skyscraper project is to create a
  44 fully-featured, modular, multiplatform 3D realtime building simulation engine, including
  45 gaming support (single and network multiplayer). Everything possible is planned to be simulated,
  46 including elevators, stairs, interfloor areas, ductwork, and more, all in first-person 3D.
  47 The simulator core is called the Scalable Building Simulator, or SBS. Buildings are stored
  48 in scripted text files that are loaded and generated in realtime by the simulator. A
  49 graphical building designer application is planned to assist in creating building data
  50 files.
  51
  52 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  53
  54 3. Release Notes
  55
  56 This release is the eighth development relase of the 2.0 series (which is a complete rewrite of
  57 the original 1.0 version), and is part of an ongoing effort towards a 2.0 stable release.
  58
  59 This software requires both the OGRE graphics engine library (version 1.7) which
  60 can be found at http://www.ogre3d.org, the Bullet physics engine with some custom patches,
  61 available at http://www.skyscrapersim.com/downloads/dev/other_apps/ and the wxWidgets
  62 library (version 2.6.3 or later)  which can be found at http://www.wxwidgets.org.
  63
  64 See the changelog for 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  69
  70 4. Building and installing
  71
  72 Skyscraper can be built on Unix, Msys/Mingw, and Cygwin using the Jam build
  73 tool. Microsoft Visual C++ users can build the project using the project files
  74 in the skyscraper/msvc directory.
  75
  76 4.1 Jam
  77
  78  The build system is based upon Jam rather than 'make'.  If you do not yet have
  79  Jam installed, then check your distribution for a Jam package or download the
  80  source and compile/install Jam yourself.  You can find the source here:
  81
  82     ftp://ftp.perforce.com/pub/jam/
  83
  84  You will need at least version 2.4.
  85
  86 4.1.1 Building
  87
  88  1. Go to the top-level directory in the project tree.
  89  2. Run "./configure", possibly with some options, if you wish.  You can see a
  90     list of available options by invoking configure with the "--help" option.
  91  3. Run "jam".
  92
  93 4.1.2 Installing
  94
  95  1. Build the project.
  96  2. Ensure that you have write permissions to the install directories. On Unix
  97     (GNU/Linux, MacOS/X, Darwin, BSD) this usually means that you need to be
  98     the 'root' user.
  99  3. Run "jam install".
 100
 101 4.2 Microsoft Visual C++
 102
 103  1. Set these system environment variables (usually from System Properties in Windows):
 104     CRYSTAL=(path to CS)
 105     ex: CRYSTAL=C:\CS
 106     WXWIN=(path to wxWidgets)
 107     wx: WXWIN=C:\wxWidgets-2.8.9
 108  2. Open the solution file skyscraper/msvc/skyscraper.sln.
 109  3. Choose "Release" or "Debug" build mode.
 110  4. Build the project.
 111
 112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 113
 114 5. Usage
 115
 116 To use Skyscraper, run the program, and a main menu screen will appear with a button for each
 117 available building (and one button for loading user buildings).
 118 Choose the building to load, and in a few moments you will be walking around in that building.
 119 The only buildings that are completely simulated in this release are "Simple" and "Triton Center".
 120 While in one of these buildings, you can click on objects such as elevator call buttons, etc
 121 to perform actions.  The recommended building to try out is the Triton Center, since it is the most
 122 complete official building.  The "Simple" building is a minimalistic demo to basically show how to make
 123 your own buildings in the application's scripting language.  Other user-created buildings are included,
 124 and can be loaded by choosing the "Other Building" button on the main screen.
 125
 126 ------------------------------------
 127 Keys currently used in the simulator:
 128
 129 W or Up Arrow - move forwards
 130 S or Down Arrow - move backwards
 131 A or Left Arrow - move left
 132 D or Right Arrow - move right
 133 PgUp - Look upwards
 134 PgDown - Look downwards
 135 Space - Jump
 136 Home - Float upwards (or jump if collision detection is on)
 137 End - Float downwards (or crouch if collision detection is on)
 138 F2 - print FPS on console
 139 F3 - Reset camera rotation and zoom to default
 140 F4 - Enable/disable wireframe mode
 141 F5 - Freelook (mouse look) mode
 142 F6 - Full camera reset (respawn)
 143 F10 - Fullscreen mode
 144 F11 - Take screenshot
 145 F12 - Open control panel
 146 Shift - Run (hold down with other keys)
 147 Control - Walk slowly (hold down with other keys)
 148 Alt + arrow keys - Strafe
 149 Alt + PgUp - Spin right
 150 Alt + PgDown - Spin left
 151 Plus - Zoom in (decrease FOV angle)
 152 Minus - Zoom out (increase FOV angle)
 153 Esc - exit to main menu
 154 R - Toggle noclip mode (gravity and collisions off)
 155 Ctrl-Alt-C - Crash program (throw exception) - used for testing handlers
 156
 157 --- Mouse actions ---
 158 -elevator shaft doors can be manually opened and closed by holding down the Shift key and clicking on them
 159 -hallway call buttons can be lit and unlit also by holding down Shift and clicking on them (this does not call an elevator, but just changes the light status)
 160 -polygons (wall/floor sides) can be deleted by holding down Ctrl and clicking on the object
 161
 162 --- Debug options ---
 163 Other functions are available via a Crystal Space plugin called BugPlug.
 164 To type a debug command: type ctrl-d and then press the bugplug key (so for wireframe mode, you'd press ctrl-d, the screen will prompt you for a command, and then you'd type "e".)
 165 To select an object/mesh: type ctrl-s and then click on an object
 166
 167 Show wireframe mode (the second command is needed due to a quirk with the wxGL plugin - also make sure you turn off the sky when doing this):
 168 ctrl-d e
 169 ctrl-d c
 170
 171 Disable wireframe mode:
 172 ctrl-d e
 173
 174 change gamma:
 175 ctrl-d g
 176
 177 show camera info:
 178 ctrl-d shift-c
 179
 180 dump info on all CS engine objects:
 181 ctrl-d d
 182
 183 dump all 3D info to an xml file (saves to world0.xml):
 184 ctrl-d f10
 185
 186 change FOV:
 187 ctrl-d f
 188
 189 change FOV angle:
 190 ctrl-d shift-f
 191
 192 move meshes:
 193 first select an object using ctrl-s
 194 then,
 195 ctrl-d shift-up = move up (+y)
 196 ctrl-d shift-down = move down (-y)
 197 ctrl-d shift-left = left (-x)
 198 ctrl-d shift-right = right (+x)
 199 ctrl-d shift-pgup = forward (+z)
 200 ctrl-d shift-pgdn = backward (-z)
 201
 202 screenshots:
 203 ctrl-d f11 = normal
 204 ctrl-d shift-f11 = large
 205
 206 show/hide FPS display:
 207 ctrl-d ctrl-alt-p
 208
 209 hide selected mesh:
 210 ctrl-d h
 211
 212 unhide selected mesh:
 213 ctrl-d shift-h
 214
 215 select mesh(es) by name:
 216 ctrl-d ctrl-alt-m
 217
 218 list loaded CS plugins:
 219 ctrl-d ctrl-alt-l
 220
 221
 222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 223
 224 6. Contact
 225
 226 Bug-Reports, suggestions, and requests should be posted to
 227 the Skyscraper forum at http://forum.skyscrapersim.com
 228 I can be contacted directly at ryan at tliquest dot net
 229