Getting Started

From Tombstone Engine Wiki
Jump to: navigation, search

Getting Started on Windows

Figure 1. This is how the Tombstone Engine installation folder should look after the Tombstone-xxx-Code.zip and Tombstone-xxx-Data.zip files have been extracted under Windows.

Follow these instructions to get started with the Tombstone Engine under 64-bit Windows 7/8/10.

Installation

The Tombstone Engine is distributed as two ZIP files named Tombstone-xxx-Code.zip and Tombstone-xxx-Data.zip, where xxx is the version number.

To install, first create a directory somewhere on your hard drive in which you'll store all of the Tombstone Engine files. Then copy the two ZIP files that you've downloaded to this new directory and extract them all. If you're using WinZip, choose “Extract to here” from the right click menu with each ZIP file selected. Once the files have been extracted, you no longer need the original ZIP files, and they may be deleted.

After extraction and removal of the original ZIP files, your Tombstone Engine directory should look like the folder shown in Figure 1.

The file named Xcode.zip contains Mac project files and can be safely deleted on Windows. Likewise, the folder named Linux contains Linux makefiles and can be safely deleted on Windows.

Building

The Tombstone Engine can be built with Visual Studio 2015. The free Community Edition can be downloaded from the following location:

Microsoft Visual Studio 2015 Community Edition

The project files for Visual Studio 2015 are located at the following place inside the Tombstone Engine folder.

VisualStudio2015/Tombstone/Tombstone.sln

After opening the project file in Visual Studio, select “Build Solution” from the Build menu to build the engine. This will cause several binaries to be built: Tombstone.exe, The31st.dll, and a bunch of DLLs that get stored in the Plugins directory.

Before building under Windows, make sure that you also have the DirectX SDK installed (June 2010 version). This may not be included by default with your version of Windows or Visual Studio. The SDK can be downloaded from the following MSDN web site:

DirectX SDK

Running

To run the Tombstone Engine, double-click on the Tombstone.exe application. You can also run from inside Visual Studio, but you will first need to set the working directory to ..\..\... This can be set by opening up the Properties window for the Engine project and going to the Debugging page. (If the working directory is not set, the debug build of the engine will alert you to this fact when you try to run from inside Visual Studio.)

Tip: When running from the Visual Studio debugger, Windows automatically enables memory heap debugging features that are used by the entire process being debugged, including external libraries such as the graphics drivers. This can cause significant delays that do not appear when not running in the debugger. To disable these debugging features, set the Environment property in the Debugging page to _NO_DEBUG_HEAP=1.

Getting Started on Mac OS X

Figure 2. This is how the Tombstone Engine installation folder should look after the Tombstone-xxx-Code.zip and Tombstone-xxx-Data.zip files have been extracted under Mac OS X.

Follow these instructions to get started with the Tombstone Engine under Mac OS X.

Installation

The Tombstone Engine is distributed as two ZIP files named Tombstone-xxx-Code.zip and Tombstone-xxx-Data.zip, where xxx is the version number. To install, first create a directory somewhere on your hard drive in which you'll store all of the Tombstone Engine files. Then copy the two ZIP files that you've downloaded to this new directory and extract them both by double-clicking on them. The Finder will create folders named Tombstone-xxx-Data and Tombstone-xxx-Code to contain the extracted files, but we want all of the files to be placed in the enclosing directories. Open the folders named Tombstone-xxx-Data and Tombstone-xxx-Code, select all of the files, and drag them to the enclosing folder. Once this is done, you can delete the now empty Tombstone-xxx-Data and Tombstone-xxx-Code folders. After this is done, your Tombstone Engine folder should look like the folder shown in Figure 2.

The folder named VisualStudio2015 contains Windows project files and can be safely deleted on the Mac. Likewise, the folder named Linux contains Linux makefiles and can be safely deleted on the Mac.

Double-click on the Xcode.zip file to extract the Xcode project files. (The Finder will create the Xcode folder. Do not copy its contents to the enclosing folder in this case.)

Building

The Tombstone Engine can be built with Xcode 8, which can be downloaded for free from the following location:

Apple Xcode

To open the Xcode project for the Tombstone Engine, open the Xcode folder and the Tombstone folder inside it. Double-click on the file Tombstone.xcodeproj to open the project in Xcode.

Set the Active Scheme to Build All Optimized by selecting it from the popup menu in the upper-left corner of the project window. Select Build from the Product menu, and the compiler will build the engine, the game modules, and the tools.

Running

To run the Tombstone Engine, double-click on the Tombstone.app application that is created in the Tombstone Engine folder when you build. You can also run from inside Xcode.

Getting Started on Linux

Figure 3. This is how the Tombstone Engine installation folder should look after the Tombstone-xxx-Code.zip and Tombstone-xxx-Data.zip files have been extracted under Linux.

Follow these instructions to get started with the Tombstone Engine under 64-bit Ubuntu Linux.

Installation

The Tombstone Engine is distributed as two ZIP files named Tombstone-xxx-Code.zip and Tombstone-xxx-Data.zip, where xxx is the version number.

To install, first create a directory somewhere on your hard drive in which you'll store all of the Tombstone Engine files. Then copy the two ZIP files that you've downloaded to this new directory and extract them all. Once the files have been extracted, you no longer need the original ZIP files, and they may be deleted.

After extraction and removal of the original ZIP files, your Tombstone Engine directory should look like the folder shown in Figure 3.

The folder named VisualStudio2015 contains Windows project files and can be safely deleted on Linux. Likewise, the file named Xcode.zip contains Mac project files and can be safely deleted on Linux.

Building

The Tombstone Engine can be built from the command line. Before building for the first time, execute the following commands to make sure the required libraries have been installed.

sudo apt-get update
sudo apt-get install build-essential libx11-dev libxrandr-dev mesa-common-dev libgl1-mesa-dev libasound2-dev

To build, change to the Linux directory in your Tombstone Engine Folder, and execute the following command.

make optimized -j 4

This command builds the optimized version of the engine. The parameter -j 4 specifies that the make system should use four concurrent jobs. The number 4 should be changed to the number of processor cores in your computer. To build the debug version of the engine, type debug instead of optimized.

Running

To run the Tombstone Engine, double-click on the Tombstone.exe program that is created in the Tombstone Engine folder when you build.