1BStone 2====== 3 4A source port of Blake Stone: Aliens of Gold and Blake Stone: Planet Strike. 5 6 7Contents 8======== 9 101. Disclaimer 112. Overview 123. Profile 134. Compiling 145. Command-line options 156. Cheat key 167. Debug keys 178. Third party use 189. Credits 1910. Links 20 21 221 - Disclaimer 23============== 24 25Copyright (c) 1992-2013 Apogee Entertainment, LLC 26Copyright (c) 2013-2015 Boris I. Bendovsky (<bibendovsky@hotmail.com>) 27 28This program is free software; you can redistribute it and/or 29modify it under the terms of the GNU General Public License 30as published by the Free Software Foundation; either version 2 31of the License, or (at your option) any later version. 32 33This program is distributed in the hope that it will be useful, 34but WITHOUT ANY WARRANTY; without even the implied warranty of 35MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 36GNU General Public License for more details. 37 38You should have received a copy of the GNU General Public License 39along with this program; if not, write to the Free Software 40Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 41 42For a copy of the GNU General Public License see file LICENSE. 43For an original source code license see file "Blake Stone source code license.doc". 44 45 462 - Overview 47============ 48 49BStone is a source port of Blake Stone game series: Aliens of Gold and Planet Strike. 50 51Features: 52* High resolution rendering of world (extended vanilla engine) 53* Modern and vanilla controls 54* Allows to customize control bindings 55* Separate volume control of sound effects and music 56 57Supported games: 58* Aliens of Gold v1.0 full 59* Aliens of Gold v2.0 full 60* Aliens of Gold v2.1 full 61* Aliens of Gold v3.0 full 62* Aliens of Gold v3.0 shareware 63* Planet Strike v1.0 64* Planet Strike v1.1 65 66 673 - Profile 68=========== 69 70The port stores configuration file, saved game files, etc. in user's profile. 71The path to those files depends on platform. 72To override the path use --profile_dir option. 73 74On Windows, the path might look like: 75"C:\\Users\\john\\AppData\\Roaming\\bibendovsky\\bstone\\" 76 77On Linux, the path might look like: 78"/home/john/.local/share/bibendovsky/bstone/" 79 80On Mac OS X, the path might look like: 81"/Users/john/Library/Application Support/bibendovsky/bstone/" 82 83Configuration file name: bstone_config 84Log file name: bstone_log.txt 85High scores file name: bstone_game_high_scores 86Saved game file name: bstone_game_saved_game 87 88Where "game" is: 89* aog_sw - Aliens of Gold (shareware) 90* aog_full - Aliens of Gold (full) 91* ps - Planet Strike 92 93 944 - Compiling 95============= 96 97Minimum requirements: 98* C++11 compatible compiler. 99 100* CMake 2.8 101 (<http://cmake.org/>) 102 103* pkg-config 104 (<http://pkg-config.freedesktop.org/>) 105 (only for non Visual C++ compiler) 106 107* SDL v2.0.1 (non-Windows) / SDL v2.0.3 (Windows) 108 (<http://www.libsdl.org/>) 109 110Tested platforms: 111 * Windows 10 x64 112 Visual C++ v19.10.25019 (Visual Studio 2017 Community Edition) 113 CMake x64 v3.9.0 114 SDL v2.0.5 115 116 * Ubuntu Desktop x64 16.04.4 117 GCC v5.4.0 118 CMake x64 v3.5.1 119 SDL v2.0.4 120 121CMake variables: 122* CMAKE_BUILD_TYPE 123 Selects wich build(s) to compile. 124 Use semicolon to separate entries. 125 Usually it's Debug or Release. 126 For other values see CMake documentation. 127 128* BSTONE_PANDORA 129 If enabled prepares build for Open Pandora. 130 131* BSTONE_USE_PCH 132 If enabled utilizes precompiled headers to speed up compilation. 133 Note: Visual C++ only 134 135* BSTONE_USE_STATIC_LINKING 136 If enabled links modules statically to avoid dependency on 137 system and custom libraries at run-time. 138 139* SDL2_INCLUDE_DIRS 140 Defines directory with SDL2 headers. 141 Note: Visual C++ only 142 143* SDL2_LIBRARIES 144 Defines list of SDL2 libraries. 145 Use semicolon to separate entries. 146 Note: Visual C++ only 147 148Notes: 149* Use ON value to enable option and value OFF to disable option. 150 151 1525 - Command-line options 153======================== 154 155* --version 156 Outputs the port's version to standard output and 157 into message box. 158 159* --aog_sw 160 Switches the port to Blake Stone: Aliens of Gold (shareware, v3.0) mode. 161 If appropriate data files will not be found the port will fail. 162 Default switch strategy: AoG (full) -> AoG (SW) -> PS 163 164* --aog_10 165 Switches the port to Blake Stone: Aliens of Gold (full, v1.0) mode. 166 If appropriate data files will not be found the port will fail. 167 Default switch strategy: AoG (full) -> AoG (SW) -> PS 168 169* --aog_2x 170 Switches the port to Blake Stone: Aliens of Gold (full, v2.0/v2.1) mode. 171 If appropriate data files will not be found the port will fail. 172 Default switch strategy: AoG (full) -> AoG (SW) -> PS 173 174* --aog_30 175 Switches the port to Blake Stone: Aliens of Gold (full, v3.0) mode. 176 If appropriate data files will not be found the port will fail. 177 Default switch strategy: AoG (full) -> AoG (SW) -> PS 178 179* --ps 180 Switches the port to Blake Stone: Planet Strike (full, v1.0/v1.1) mode. 181 If appropriate data files will not be found the port will fail. 182 Default switch strategy: AoG (full) -> AoG (SW) -> PS 183 184* --no_screens 185 Skips start-up screens (AoG/PS) and ending promo pages (AoG SW only). 186 187* --cheats 188 Enables so called "debug mode" without much fuss. 189 190* --data_dir path_to_data 191 Specifies location to the game's data files. 192 Default: current working directory. 193 194* --profile_dir path 195 Overrides default location of the game's profile files. 196 197* --vid_renderer [d3d|ogl|ogles|ogles2|soft] 198 Forces to use a specified SDL renderer. 199 "d3d" selects a Direct3D renderer. 200 "ogl" selects an OpenGL renderer. 201 "ogles" selects an OpenGL ES renderer. 202 "ogles2" selects an OpenGL ES 2.0 renderer. 203 "soft" selects a software renderer. 204 Fallback renderer: soft. 205 Default order without this option: d3d, ogl, ogles, ogles2, soft. 206 207* --vid_windowed 208 Runs the game in windowed mode. 209 Default video mode: 640x480 210 211* --vid_mode width height 212 Selects the specified resolution for windowed mode. 213 Without this option the game will use desktop's resolution. 214 Minimum width: 640 215 Minimum height: 480 216 217* --vid_scale factor 218 Refinement factor. The higher a value the greater internal resolution 219 mode will be used to render a scene. The dimensions of the resolution mode 220 are proportional to the original one (320x200) by 'factor' value. 221 This option can greatly affect the performance of a renderer (especially a 222 software one). 223 Minimum factor: 1 (identical to the original game) 224 Default factor: depends on the game's resolution mode. 225 226* --vid_window_x offset 227 Sets a horizontal offset from the left side of the desktop screen. 228 Applicable for windowed mode only. 229 230* --vid_window_y offset 231 Sets a vertical offset from the top side of the desktop screen. 232 Applicable for windowed mode only. 233 234* --snd_rate sampling_rate 235 Specifies sampling rate of mixer in hertz. 236 Default: 44100 Hz 237 Minimum: 11025 Hz 238 239* --snd_mix_size duration 240 Specifies mix data size in milliseconds. 241 Default: 40 ms 242 Minimum: 20 ms 243 244 2456 - Cheat key 246============= 247 248[J] [A] [M] [Enter] 249Press specified keys sequentially. 250Shows message "NOW you're jammin'!!", and gives to you all keys, 251all weapons and restores health to 100% but zeroes score points. 252Not available in shareware version. 253 254 2557 - Debug keys 256============== 257 258Add option "--cheats" to enable these keys. 259 260* [Backspace]+[A] 261 Toggles visibility of actors on auto-map. 262 263* [Backspace]+[C] 264 Shows counts of total static objects, in use static objects, 265 doors, total actors, active actors. 266 267* [Backspace]+[D] 268 Toggles player's invisibility. 269 270* [Backspace]+[E] 271 Win mission instantly. 272 273* [Backspace]+[F] 274 Shows player's coordinates and direction. 275 276* [Backspace]+[G] 277 Toggles god mode. 278 279* [Backspace]+[H] 280 Hurt yourself by 1%. 281 282* [Backspace]+[I] 283 Each usage adds 99% health, 5 tokens, 50 ammo, one new weapon. 284 285* [Backspace]+[K] 286 Shows total counts of enemies, points and informants on the map. 287 288* [Backspace]+[M] 289 Memory information. 290 291* [Backspace]+[O] 292 Shows push walls on auto-map. 293 294* [Backspace]+[Q] 295 Instant quit. 296 297* [Backspace]+[R] 298 Shows full map. 299 300* [Backspace]+[S] 301 Slow motion. 302 303* [Backspace]+[U] 304 Unlocks all maps. 305 306* [Backspace]+[W] 307 Warps to specified map. 308 309* [Backspace]+[Shift/Caps Lock]+[W] 310 Warps to specified map but loads it from scratch 311 rather from a saved game file/memory. 312 313* [Backspace]+[Home] 314 Selects previous ceiling texture. 315 316* [Backspace]+[Page Up] 317 Selects next ceiling texture. 318 319* [Backspace]+[End] 320 Selects previous flooring texture. 321 322* [Backspace]+[Page Down] 323 Selects next flooring texture. 324 325* [Backspace]+[-] 326 Decreases shading depth. 327 328* [Backspace]+[=] 329 Increases shading depth. 330 331* [Backspace]+['['] 332 Decreases shading drop off. 333 334* [Backspace]+[']'] 335 Increases shading drop off. 336 337 3388 - Third party use 339=================== 340 341* Simple DirectMedia Library (v2) 342 <http://libsdl.org/> 343 See file COPYING-SDL2.txt for a license information. 344 345* DOSBox 346 <http://www.dosbox.com/> 347 See file dosbox/COPYING for a license information. 348 Note: The source port uses only an OPL emulation code. 349 350 3519 - Credits 352=========== 353 354* id Software 355 Developing Wolfenstein 3D engine. 356 <http://www.idsoftware.com/> 357 358* JAM Productions 359 Developing the game. 360 361* Apogee Entertainment, LLC 362 Publishing the game and releasing a source code. 363 <http://www.apogeesoftware.com/> 364 365* Boris I. Bendovsky 366 Author of the source code. 367 <bibendovsky@hotmail.com> 368 369* Scott Smith 370 Adaptation to Pandora console, various fixes. 371 372* Filipe Tolhuizen 373 Testing the port. 374 375 37610 - Links 377========== 378 379* Home page: 380 <http://bibendovsky.github.io/bstone/> 381 382* Apogee's article about releasing of an original source code: 383 <http://www.apogeesoftware.com/uncategorized/apogee-releases-blake-stone-source-code> 384