jonof / jfbuild

Port of the Build game engine by Ken Silverman
http://www.jonof.id.au/jfbuild
Other
101 stars 29 forks source link

Build Engine Port

by Jonathon Fowler, Ken Silverman, and others

This is the source code for my port of Ken Silverman's Build game engine to make the engine functional on modern hardware and operating systems.

Minimum system requirements

Compilation of the KenBuild test game

Before you begin, clone this repository or unpack the source archive.

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 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
  3. Open a terminal, change into the kenbuild subdirectory of this cloned repository, and compile the test game with: make or gmake (BSD)
  4. Assuming that was successful, run the test game with: ./data/game

macOS

  1. Install Xcode from the Mac App Store.
  2. Open game.xcodeproj from within the JFBuild source code's xcode folder.
  3. From the Product menu choose Run.

The project will automatically download the SDL2 framework to xcode/frameworks upon first build. If there are problems with this process, you can manually fetch SDL2-2.x.y.dmg from http://libsdl.org/download-2.0.php and copy SDL2.framework found in the .dmg file to xcode/frameworks.

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 kenbuild subfolder of this cloned repository and compile the test game with: nmake /f Makefile.msvc
  4. Assuming that was successful, run the test game with: data\game

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:

Test game configuration

Settings for the KenBuild test game and its editor can be found in these locations depending on your operating system:

Credits and Thanks

Enjoy!

Jonathon Fowler