|
|
@@ -8,53 +8,32 @@ It can be compiled using:
|
|
|
- MSVC++ 14.0 (Visual Studio 2015)
|
|
|
- Clang
|
|
|
|
|
|
+Use CMake to generate a VS solution, makefile or other type of build file. CMake root file is available at Source/CMakeLists.txt.
|
|
|
+
|
|
|
Banshee currently only compiles on Windows, but Mac & Linux ports are coming soon.
|
|
|
|
|
|
-To compile follow these steps:
|
|
|
- 1. Download source code
|
|
|
- 2. Download [data files](#data) and extract them into the source directory
|
|
|
- 3. Set up [third party dependencies](#dependencies)
|
|
|
- 4. Generate a build file (e.g. Visual Studio solution or a Makefile) using CMake
|
|
|
- - You can customize your build by choosing options like render API (DirectX, OpenGL), audio module and whether to build the entire editor or just the engine.
|
|
|
- 5. Compile using your favorite tool
|
|
|
+# Third party dependencies
|
|
|
+Aside from the source code you will also need various third party dependencies. You may retrieve/compile those dependencies yourself by following a guide in "CompilingDependenciesManually.txt" (provided with the source code).
|
|
|
|
|
|
-# <a name="data"></a>Data files
|
|
|
-Data files are non-code resources like images, shaders, etc. needed to run the editor, engine and example projects.
|
|
|
+Optionally, if you are using VS2015 you can avoid compiling dependencies by downloading the archive below, containing a set of pre-compiled dependencies. These should be extracted in the root of the directory containing Banshee source code.
|
|
|
|
|
|
-[Download data files (Latest)] (http://bearishsun.thalassa.feralhosting.com/BansheeData_v0.3.0.zip)
|
|
|
+[Download dependencies (VS2015)] (http://bearishsun.thalassa.feralhosting.com/BansheeDependencies_VS2015_v0.3.0.zip)
|
|
|
|
|
|
For older versions check the git release tag descriptions for links.
|
|
|
-
|
|
|
-# <a name="dependencies"></a>Third party dependencies
|
|
|
-Banshee relies on a variety of third party dependencies. We provide a set of pre-compiled dependencies needed for Visual Studio 2015, to save you the hassle of compiling them yourself. If you are not using VS2015 or want to compile the dependencies yourself, a guide is provided as well.
|
|
|
|
|
|
-## Pre-compiled dependencies
|
|
|
-If going with the pre-compiled dependencies route, download the file below and extract it to the source directory.
|
|
|
+## Windows dependencies
|
|
|
+For Windows additional dependencies not included in the dependencies package are needed.
|
|
|
|
|
|
-[Download dependencies (VS2015)] (http://bearishsun.thalassa.feralhosting.com/BansheeDependencies_VS2015_v0.3.0.zip)
|
|
|
+Make sure to:
|
|
|
+ - Install Windows SDK if on Windows 8 or higher.
|
|
|
+ - Install DirectX SDK.
|
|
|
+ - Set up DXSDK_DIR environment variable to point to the SDK install directory.
|
|
|
+ - Install DirectX Debug Layer in Windows 10:
|
|
|
+ - Settings panel->System->Apps & features->Manage optional Features->Add a feature->Select "Graphics Tools"
|
|
|
|
|
|
-For older versions check the git release tag descriptions for links.
|
|
|
+# Data files
|
|
|
+You will also need data files (non-code resources like images, shaders, etc.) in order to run the editor, engine and example projects.
|
|
|
|
|
|
-You will also need to install the following dependencies manually:
|
|
|
-
|
|
|
-**DirectX SDK**
|
|
|
- - Only for Windows 7 or earlier if using DirectX 11 render API
|
|
|
- - Or for all Windows versions if using DirectX 9 render API
|
|
|
- - Set up DXSDK_DIR environment variable pointing to the DirectX instalation
|
|
|
-
|
|
|
-**Windows SDK**
|
|
|
- - Only for Windows 8 or later if using DirectX 11 render API
|
|
|
-
|
|
|
-**DirectX Debug Layer**
|
|
|
- - Only for Windows 10 if using DirectX 11 render API
|
|
|
- - Go to Settings panel (type "Settings" in Start)->System->Apps & features->Manage optional Features->Add a feature->Select "Graphics Tools"
|
|
|
-
|
|
|
-**FMOD Low Level Programmer API**
|
|
|
- - Only if using the FMOD audio module (not selected by default)
|
|
|
- - http://www.fmod.org/download/
|
|
|
- - If CMake complains it cannot find FMOD, manually set the FMOD_INSTALL_DIRS to your installation directory
|
|
|
- - Copy the dynamic libraries from {INSTALLDIR}/api/lowlevel/lib into /bin folder in Banshee source code folder
|
|
|
- - Use logging libraries for the Debug builds, and non-logging for OptimizedDebug and Release builds
|
|
|
-
|
|
|
-## Compiling dependencies manually
|
|
|
+[Download data files] (http://bearishsun.thalassa.feralhosting.com/BansheeData_v0.3.0.zip)
|
|
|
|
|
|
+For older versions check the git release tag descriptions for links.
|