readme.txt

   1 Skyscraper 2.0 Alpha 5
   2 Copyright (C)2003-2009 Ryan Thoryk
   3 http://www.skyscrapersim.com
   4 http://sourceforge.net/projects/skyscraper
   5
   6 Contents
   7 1. Legal Notice
   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 Notice
  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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  36
  37 2. Introduction
  38
  39 Skyscraper is a 3D virtual building simulator written in C++ using the Crystal Space
  40 graphics engine.  The goal of the Skyscraper project is to create a fully-featured,
  41 modular, multiplatform 3D realtime building simulation engine, including gaming support (single
  42 and network multiplayer). Everything possible is planned to be simulated, including
  43 elevators, stairs, interfloor areas, ductwork, and more, all in first-person 3D. The
  44 simulator core is called the Scalable Building Simulator, or SBS. Buildings are stored
  45 in scripted text files that are loaded and generated in realtime by the simulator. A
  46 graphical building designer application is planned to assist in creating building data
  47 files.
  48
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 3. Release Notes
  52
  53 This release is the fifth development relase of the 2.0 series (which is a complete rewrite of
  54 the original 1.0 version), and is part of an ongoing effort towards a 2.0 stable release.
  55
  56 This software requires both the Crystal Space graphics engine library (version 1.4) which
  57 can be found at http://www.crystalspace3d.org, and the wxWidgets library (version 2.6.3 or
  58 later) which can be found at http://www.wxwidgets.org.  The Windows packages comes bundled
  59 with a custom-patched Crystal Space 1.4 (SVN snapshot) and wxWidgets 2.8.9 runtimes.  The custom patch for
  60 Crystal Space is included and is called cs12-poly3d.patch, which fixes a skybox issue.
  61
  62 See the changelog for new features, fixes, and other changes in this release.
  63
  64 For third-party texture credits, see the file "license-info.txt" in the "data" folder.
  65
  66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  67
  68 4. Building and installing
  69
  70 Skyscraper can be built on Unix, Msys/Mingw, and Cygwin using the Jam build
  71 tool. Microsoft Visual C++ users can build the project using the project files
  72 in the skyscraper/msvc directory.
  73
  74 4.1 Jam
  75
  76  The build system is based upon Jam rather than 'make'.  If you do not yet have
  77  Jam installed, then check your distribution for a Jam package or download the
  78  source and compile/install Jam yourself.  You can find the source here:
  79
  80     ftp://ftp.perforce.com/pub/jam/
  81
  82  You will need at least version 2.4.
  83
  84 4.1.1 Building
  85
  86  1. Go to the top-level directory in the project tree.
  87  2. Run "./configure", possibly with some options, if you wish.  You can see a
  88     list of available options by invoking configure with the "--help" option.
  89  3. Run "jam".
  90
  91 4.1.2 Installing
  92
  93  1. Build the project.
  94  2. Ensure that you have write permissions to the install directories. On Unix
  95     (GNU/Linux, MacOS/X, Darwin, BSD) this usually means that you need to be
  96     the 'root' user.
  97  3. Run "jam install".
  98
  99 4.2 Microsoft Visual C++
 100
 101  1. Set these system environment variables (usually from System Properties in Windows):
 102     CRYSTAL=(path to CS)
 103     ex: CRYSTAL=C:\CS
 104     WXWIN=(path to wxWidgets)
 105     wx: WXWIN=C:\wxWidgets-2.8.9
 106  2. Open the solution file skyscraper/msvc/skyscraper.sln.
 107  3. Choose "Release" or "Debug" build mode.
 108  4. Build the project.
 109
 110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 111
 112 5. Usage
 113
 114 To use Skyscraper, run the program, and a main menu screen will appear with a button for each
 115 available building (and one button for loading user buildings).  On Linux this main screen won't
 116 appear, and will only show a file selection dialog (same as pressing the "Other building..." button
 117 in the Windows version).
 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 one of the bunch.  The "Simple" building is a minimalistic demo to basically show how to make
 123 your own buildings in the application's scripting language.
 124
 125 Keys currently used in the simulator:
 126
 127 W or Up Arrow - move forwards
 128 S or Down Arrow - move backwards
 129 A or Left Arrow - move left
 130 D or Right Arrow - move right
 131 PgUp - Look upwards
 132 PgDown - Look downwards
 133 Space - Jump
 134 Home - Float upwards (or jump if collision detection is on)
 135 End - Float downwards (or crouch if collision detection is on)
 136 F2 - print FPS on console
 137 F3 - Reset camera rotation to default
 138 F4 - Enable/disable wireframe mode
 139 F11 - Take screenshot
 140 Shift - Run (hold down with other keys)
 141 Control - Walk slowly (hold down with other keys)
 142 Alt - Strafe (hold down with other keys)
 143
 144 --- Debug options ---
 145 Other functions are available via a Crystal Space plugin called BugPlug.
 146 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".)
 147 To select an object/mesh: type ctrl-s and then click on an object
 148
 149 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):
 150 ctrl-d e
 151 ctrl-d c
 152
 153 Disable wireframe mode:
 154 ctrl-d e
 155
 156 change gamma:
 157 ctrl-d g
 158
 159 show camera info:
 160 ctrl-d shift-c
 161
 162 dump info on all CS engine objects:
 163 ctrl-d d
 164
 165 dump all 3D info to an xml file (saves to world0.xml):
 166 ctrl-d f10
 167
 168 change FOV:
 169 ctrl-d f
 170
 171 change FOV angle:
 172 ctrl-d shift-f
 173
 174 move meshes:
 175 first select an object using ctrl-s
 176 then,
 177 ctrl-d shift-up = move up (+y)
 178 ctrl-d shift-down = move down (-y)
 179 ctrl-d shift-left = left (-x)
 180 ctrl-d shift-right = right (+x)
 181 ctrl-d shift-pgup = forward (+z)
 182 ctrl-d shift-pgdn = backward (-z)
 183
 184 screenshots:
 185 ctrl-d f11 = normal
 186 ctrl-d shift-f11 = large
 187
 188 show/hide FPS display:
 189 ctrl-d ctrl-alt-p
 190
 191 hide selected mesh:
 192 ctrl-d h
 193
 194 unhide selected mesh:
 195 ctrl-d shift-h
 196
 197 select mesh(es) by name:
 198 ctrl-d ctrl-alt-m
 199
 200 list loaded CS plugins:
 201 ctrl-d ctrl-alt-l
 202
 203
 204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 205
 206 6. Contact
 207
 208 Bug-Reports, suggestions, and requests should be send to
 209 ryan at tliquest dot net
 210
 211