Appendix A: Building/Installing from Source

This Appendix gives information on how to build and install Knights from the source code.

Linux

For Linux a Makefile is provided. Most users should just be able to type "make" followed by "make install" to build and install respectively.

Before compiling, make sure you have the necessary dependencies installed. The game requires Boost, SDL, libcurl, Freetype and Fontconfig. On Debian systems the following packages will satisfy the requirements:

• libboost-dev
• libboost-thread-dev
• libsdl-dev
• libcurl4-openssl-dev or libcurl4-gnutls-dev
• libfreetype6-dev
• libfontconfig-dev

If you only want to build the server (and not the game itself) then you only need the first three of the above.

Also, make sure that you have at least version 1.35 of Boost. Some Linux distributions come with older versions, which will not work with Knights. Also, if your Boost is installed in a non-standard location, you may need to edit CPPFLAGS and/or BOOST_LIBS to get it to build.

You can install only parts of the game by using the following:

• make install_knights – install only the game (and its data files)
• make install_server – install only the server (and its data files)
• make install_docs – install only the documentation files.

By default the game installs the "knights" and "knights_server" executables to /usr/local/bin/, data files to /usr/local/share/knights/, and documentation files to /usr/local/share/doc/knights/. The default install directory can be changed by setting the PREFIX variable, e.g. to install in your home directory use "make PREFIX=$HOME" and "make install PREFIX=$HOME". (The PREFIX should agree between the make and make install commands, otherwise the game will not work!)

For finer control of installation directories, use the following variables:

• BIN_DIR: location of the Knights binary (default: $(PREFIX)/bin)
• DATA_DIR: location of the Knights data files (default: $(PREFIX)/share/knights)
• DOC_DIR: location of the documentation files (default: $(PREFIX)/share/doc/knights)
• KNIGHTS_BINARY_NAME: name of the Knights executable (default: knights)
• SERVER_BINARY_NAME: name of the server executable (default: knights_server)

It is possible to build a version without sound support by editing the Makefile and adding "-DDISABLE_SOUND" to the CPPFLAGS. This might be useful if you are having trouble getting sound to work on your system.

The Makefile also supports "make uninstall" (but make sure you pass the correct PREFIX or DIR variables, e.g. "make uninstall PREFIX=$HOME", if you changed these from their default values).

If you are developing, you may like to know that the Makefile is generated automatically from the Visual Studio project files (see makemakefile.py in the python directory). The Makefile also uses the "Advanced Auto-Dependency Generation" technique described here: http://web.archive.org/web/20080123214633/make.paulandlesley.org/autodep.html.

Windows

Most Windows users will use the pre-packaged installer, however if you want to try building the game from source code, then read on.

Project and solution files for Visual Studio are included. (You can get the Visual Studio Express Edition for free from Microsoft.)

Before building, certain dependencies must be obtained. These are:

• Boost: You'll need to install Boost on your computer – the simplest way is to download the latest installer (see the Getting Started section on the Boost website, or go directly to http://www.boostpro.com/download).
• SDL: Download both the "runtime libraries for Win32" and the "development libraries for Win32".
• libcurl: Download the latest curl "source archive".
• Freetype: Download the latest stable release of freetype2.

Extract the Knights source code to a directory of your choice. Then extract the above dependencies as follows:

• Run the Boost installer. (Note that this is a change from the previous version of Knights, where the Boost files were just copied into the source directory. This won't work any more because we now need the Boost.Threads libraries as well as just the header files.) You'll also need to set the include and library directories in Visual Studio. Go to Tools -> Options, then Projects and Solutions -> VC++ Directories, and select "Show directories for: Include files". Add the path for the Boost root directory e.g. "C:\Program Files\boost\boost_1_39". Then select "Show directories for: Library files" and add the "lib" subdirectory of Boost e.g. "C:\Program Files\boost\boost_1_39\lib".
• Unpack the SDL development libraries directly to "knights_016_src". Rename the "SDL-1.2.x" folder to just "SDL".
• Unpack libcurl directly to "knights_016_src". Rename the "curl-7.x.x" folder to just "curl".
• Unpack the Freetype archive directly to "knights_016_src". Rename the "freetype-2.x.x" folder to just "freetype".
• Unpack the SDL runtime libraries. Only the file "SDL.dll" from this is required; copy it to the "knights_016_src\" folder.

You should now have a directory structure as follows:

knights_016_src\
  curl\
    docs\
    include\
    ...
  freetype\
    builds\
    devel\
    ...
  SDL\
    docs\
    include\
    ...
  SDL.dll
  ...

Now you can build Knights as follows:

1. Go into the msvc\ folder and open the Knights.sln.
2. The project conversion wizard may appear (Visual Studio wants to convert the Freetype project file to the latest version). Click "Finish" to let this run.
3. Right-click the Freetype project and select Properties. Set the Configuration to Release and open the C/C++ -> Code Generation page. Change Runtime Library to "Multi-Threaded (/MT)".
4. Right-click the libcurl project and select Properties. Set the Configuration to Release. Under C/C++, add HTTP_ONLY and CURL_STATICLIB to the Preprocessor Definitions. Under Code Generation, change Runtime Library to "Multi-Threaded (/MT)".
5. Build the solution in Release mode – this will create the client and server executables. It also copies Knights.exe to $(SolutionDir) as a post-build action.

If you want to run Knights.exe from within the IDE then you will need to edit the project settings for KnightsMain: go to Debugging under Configuration Properties and change Command to $(SolutionDir)/Knights.exe (or $(SolutionDir)/Knights_Debug.exe for the Debug build). This is because the game looks in its own directory for the "knights_data" folder at startup, so running it from the standard Debug or Release locations won't work. You will also need to set the StartUp Project to KnightsMain.

The server is built by the KnightsSvrMain project and is named KnightsSvrMain.exe by default.

If you want to build the installer you must install Inno Setup. Then go to the knights_016_src directory and issue the following command:

"c:\program files\inno setup 5\iscc" /O"." /F"knights_016_installer" installer.iss

This will build the "knights_016_installer.exe" in the current directory.

Scons

The Scons build files, present in earlier versions of Knights, have now been removed and are no longer supported.