MrHuu / jfsw-3ds

Port of the 3D Realms game "Shadow Warrior"
http://www.jonof.id.au/jfsw
10 stars 1 forks source link

JonoF's Shadow Warrior Port

by Jonathon Fowler, with contributions by Ken Silverman and others

This is the source code for my port of 3D Realms' Shadow Warrior using my port of Ken Silverman's Build game engine.

Minimum system requirements

You will require game data from an original release of Shadow Warrior. Refer to the documentation on my website on what releases are suitable and where to locate their game files.

Compilation

Before you begin, clone this repository or unpack the source archive. If you cloned using Git, be sure to initialise the submodules of this repository (i.e. git submodule update --init).

Now, based on your chosen OS and compiler:

Linux and BSD

  1. Install the compiler toolchain and SDL2 development packages, e.g.
    • Debian 9: sudo apt-get install build-essential libsdl2-dev
    • FreeBSD 11: sudo pkg install gmake sdl2 pkgconf
  2. Install optional sound support development packages.
    • Debian 9: sudo apt-get install libvorbis-dev libfluidsynth-dev
    • FreeBSD 11: sudo pkg install libvorbis fluidsynth
  3. Install GTK+ 3 development packages if you want launch windows and editor file choosers, e.g.
    • Debian 9: sudo apt-get install libgtk-3-dev
    • FreeBSD 11: sudo pkg install gtk3
  4. Open a terminal, change into the source code directory, and compile the game with: make or gmake (BSD)
  5. Assuming that was successful, run the game with: ./sw

macOS

  1. Install Xcode from the Mac App Store.
  2. Fetch and install the SDL 2.0 development package:
    1. Fetch SDL2-2.0.x.dmg from http://libsdl.org/download-2.0.php.
    2. Copy SDL2.framework found in the DMG file to ~/Library/Frameworks. Create the Frameworks directory if it doesn't exist on your system.
  3. Open sw.xcodeproj from within the JFShadowWarrior source code's xcode folder.
  4. From the Product menu choose Run.

Windows using Microsoft Visual C++ 2015 (or newer) and NMAKE

  1. If needed, install Visual Studio Community 2017 for free from Microsoft. Terms and conditions apply. Install at minimum these components:
    • VC++ 2015.3 v140 toolset for desktop (x86,x64)
    • Windows Universal CRT SDK
    • Windows 8.1 SDK
  2. Open the command-line build prompt. e.g. VS2015 x64 Native Tools Command Prompt or VS2015 x86 Native Tools Command Prompt.
  3. Change into the JFShadowWarrior source code folder, then compile the game with: nmake /f Makefile.msvc
  4. Assuming success, run the game with: sw

Compilation options

Some engine features may be enabled or disabled at compile time. These can be passed to the MAKE tool, or written to a Makefile.user (Makefile.msvcuser for MSVC) file in the source directory.

These options are available:

Warnings

  1. You should exercise caution if you choose to use multiplayer features over untrustworthy networks with untrustworthy players.
  2. 3D Realms and Apogee do not support this port. Contact me instead.

Enjoy!

Jonathon Fowler