readme.txt

   1 Skyscraper 2.0 Alpha 4
   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 third 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 (1.2 or later) 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.2.1 and wxWidgets 2.8.9 runtimes.  The custom patch for
  60 Crystal Space is included and is called cs12-poly3d.patch - it applies to Crystal Space 1.2.1.  It does
  61 not work correctly with version 1.4.  The patch fixes a skybox related issue.
  62
  63 See the changelog for new features, fixes, and other changes in this release.
  64
  65 For third-party texture credits, see the file "license-info.txt" in the "data" folder.
  66
  67 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68
  69 4. Building and installing
  70
  71 Skyscraper can be built on Unix, Msys/Mingw, and Cygwin using the Jam build
  72 tool. Microsoft Visual C++ users can build the project using the project files
  73 in the skyscraper/msvc directory.
  74
  75 4.1 Jam
  76
  77  The build system is based upon Jam rather than 'make'.  If you do not yet have
  78  Jam installed, then check your distribution for a Jam package or download the
  79  source and compile/install Jam yourself.  You can find the source here:
  80
  81     ftp://ftp.perforce.com/pub/jam/
  82
  83  You will need at least version 2.4.
  84
  85 4.1.1 Building
  86
  87  1. Go to the top-level directory in the project tree.
  88  2. Run "./configure", possibly with some options, if you wish.  You can see a
  89     list of available options by invoking configure with the "--help" option.
  90  3. Run "jam".
  91
  92 4.1.2 Installing
  93
  94  1. Build the project.
  95  2. Ensure that you have write permissions to the install directories. On Unix
  96     (GNU/Linux, MacOS/X, Darwin, BSD) this usually means that you need to be
  97     the 'root' user.
  98  3. Run "jam install".
  99
 100 4.2 Microsoft Visual C++
 101
 102  1. Set these system environment variables (usually from System Properties in Windows):
 103     CRYSTAL=(path to CS)
 104     ex: CRYSTAL=C:\CS
 105     WXWIN=(path to wxWidgets)
 106     wx: WXWIN=C:\wxWidgets-2.8.9
 107  2. Open the solution file skyscraper/msvc/skyscraper.sln.
 108  3. Choose "Release" or "Debug" build mode.
 109  4. Build the project.
 110
 111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 112
 113 5. Usage
 114
 115 To use Skyscraper, run the program, and a main menu screen will appear with a button for each
 116 available building (and one button for loading user buildings).  On Linux this main screen won't
 117 appear, and will only show a file selection dialog (same as pressing the "Other building..." button
 118 in the Windows version).
 119 Choose the building to load, and in a few moments you will be walking around in that building.
 120 The only buildings that are completely simulated in this release are "Simple" and "Triton Center".
 121 While in one of these buildings, you can click on objects such as elevator call buttons, etc
 122 to perform actions.  The recommended building to try out is the Triton Center, since it is the most
 123 complete one of the bunch.  The "Simple" building is a minimalistic demo to basically show how to make
 124 your own buildings in the application's scripting language.
 125
 126 Keys currently used in the simulator:
 127
 128 W or Up Arrow - move forwards
 129 S or Down Arrow - move backwards
 130 A or Left Arrow - move left
 131 D or Right Arrow - move right
 132 PgUp - Look upwards
 133 PgDown - Look downwards
 134 Space - Jump
 135 Home - Float upwards (or jump if collision detection is on)
 136 End - Float downwards (or crouch if collision detection is on)
 137 F2 - print FPS on console
 138 F3 - Reset camera rotation to default
 139 Shift - Run (hold down with other keys)
 140 Control - Walk slowly (hold down with other keys)
 141 Alt - Strafe (hold down with other keys)
 142
 143
 144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 145
 146 6. Contact
 147
 148 Bug-Reports, suggestions, and requests should be send to
 149 ryan at tliquest dot net
 150
 151