wesnoth

README.txt
==========

update 19.06.2013
Newer package versions for using a standalone project file can be downloaded from
http://sourceforge.net/projects/wesnoth/files/unofficial/Windows%20Compile%20Stuff/
They contain the usual needed headers/libs/dlls combination; the exact directory
names may be different, so you need to adapt your settings in MSVC which
reference them. Since dependencies may be added to wesnoth, older packages
may no longer work after some spot.

==========
NEW WAY (using cmake):

Wesnoth 1.9 (since r41888) and branches/1.8 (since r42011)
can be compiled using cmake+msvc9

   1. make sure that git (formerly svn) command-line executable is in your %PATH%
   2. for wesnoth 1.8 and early pre-1.9 versions: download
      ftp://ftp.terraninfo.net/wesnoth/msvc9/external.zip (55mb download) and
      unpack it into wesnoth's directory - so, there'll be an 'external'
      folder in there.
   3. for wesnoth 1.9: download
      ftp://ftp.terraninfo.net/wesnoth/msvc9/external_19.zip (59mb download)
      and unpack it into wesnoth's directory - so, there'll be an 'external'
      folder in there.
   4. install cmake http://www.cmake.org/cmake/resources/software.html and
      put it into %PATH% (that can be done by the installer)
   5. to allow the game to run, put full path to external/dll into %PATH%
   6. run external/msvc9-cmake.bat
   7. open generated project file in msvc9 and compile. the project should
      pick up changes in cmake files automatically. Also, you can re-run the
      .bat file to regenerate it.

==========
OLD WAY (using a standalone project file):
This is a HowTo guide to help setting up MSVC 2008 (aka VC9) to
compile Wesnoth.
The guide was written before the transition from svn to git.


1.	If you haven't already, install MSVC 2008


2.	Download and install TortoiseSVN if you intend on building from
	the WesnothSVN:
		http://tortoisesvn.net/downloads
	Otherwise skip this step.


3.	To download the trunk or a branch from the WesnothSVN follow the
	instructions here:
		http://www.wesnoth.org/wiki/SVN_on_Windows
	Alternatively get the source code from here:
		http://www.wesnoth.org/wiki/Download

	For convenience we'll assume that the target folder is:
		C:\projects\wesnoth\trunk


4.	In order to prevent extensive manual modifications to the
	wesnoth.vcproj and wesnothd.vcproj files, we'll set up two
	'General Folders' for libraries and includes to store most of
	the prerequisites. (Otherwise each configuration setting for
	each project would need to have each and every 'lib' and
	'include' folder added.)
		C:\projects\_include
		C:\projects\_lib


5.	We'll now start downloading and compiling/copying the
	prerequisites into the necessary folders:


5a. >=zlib-1.2.3 ( http://www.zlib.net/ )

	Download the zlib source code
		zlib123.zip
	and unpack it into the projects folder to get:
		C:\projects\zlib123\

	Open the file zlib.dsw in the folder
		C:\projects\zlib123\projects\visualc6\
	with MSVC and select 'Yes To All' to convert it into a VC9 project.

	Open the properties of the 'zlib' solution and in the
	'Configuration Properties' select the 'DLL Release'
	'Configuration'. Select 'OK' and then right-click the 'zlib'
	project and select 'Build'. After a successful Build, close that
	instance of MSVC.


5b. >=libsdl-1.2.7 ( http://www.libsdl.org )

	Download the development library file for Win32 as well as the
	source code
		SDL-1.2.13.zip
		SDL-devel-1.2.13-VC8.zip
	and unpack them into the projects folder to get:
		C:\projects\SDL-1.2.13\

	Copy the 'SDL.dll' and the 'SDL.lib' from the 'lib' folder
	and the contents of 'include' folder into the corresponding
	'General Folder' ( ...\_include\ resp. ...\_lib\ ).

	Unpack the 'VisualC.zip' and open the 'SDL.sln' file with MSVC.
	Follow the instructions to convert the project to VC9.

	Right-click the 'SDLmain' project and select 'Build'. After a
	successful Build, close that instance of MSVC.

	Copy 'SDLmain.lib' from
		C:\projects\SDL-1.2.13\VisualC\SDLmain\Debug
	into the 'lib' 'General Folder'.


5c. >=libboost-1.33.0 ( http://www.boost.org/ )

	Download Boost and unpack it into the folder
		C:\projects\

	This should give you a folder structure like
		C:\projects\boost_1_38_0\

	Download the pre-built bjam executable
		boost-jam-3.1.17-1-ntx86.zip
	from the bjam download page on sourceforge
		http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941
	and unpack and move the bjam executable it into the base folder
	of boost
		C:\projects\boost_1_38_0\

	Now start the command prompt (CMD.exe) and invoke the following
	commands:
		C:\> set ZLIB_SOURCE=C:\projects\zlib123\
		C:\> set ZLIB_LIBPATH=C:\projects\zlib123\projects\visualc6\Win32_DLL_Release
		C:\> set ZLIB_BINARY=zlib1.dll
		C:\> cd C:\projects\boost_1_38_0
		C:\projects\boost_1_38_0> bjam ^
		More? --toolset=msvc ^
		More? --build-type=complete ^
		More? --prefix="C:\projects\Boost\" install

	If the upper last command doesn't work, replace the last line with:
		--prefix="C:\projects\Boost" install

	Now bjam will compile all variants of the boost library binaries
	for MSVC 2008 and copies them into the folder
		C:\projects\Boost\lib\
	while all required headers are copied into
		C:\projects\Boost\include\boost-1_38\boost

	Use the time bjam is busy compiling (possibly several hours) as
	you wish. (It is possible to continue downloading and copying
	the include and lib files since all required compiling is done.)

	Once bjam has finished building/copying, you then can delete
	the folder
		C:\projects\boost_1_38_0\
	to free up space.


5d. >=sdl-image-1.2 (with PNG support)
		( http://www.libsdl.org/projects/SDL_image )

	Download the binary file for Win32
		SDL_image-devel-1.2.7-VC9.zip
	and unpack it into the projects folder to get:
		C:\projects\SDL_image-1.2.7\

	Copy the contents of each the 'lib' and the 'include' folder
	into the corresponding 'General Folder'.


5e. >=sdl-mixer-1.2 (with Vorbis support)
		( http://www.libsdl.org/projects/SDL_mixer )

	Download the binary file for Win32
		SDL_mixer-devel-1.2.8-VC8.zip
	and unpack it into the projects folder to get:
		C:\projects\SDL_mixer-1.2.8\

	Copy the contents of each the 'lib' and the 'include' folder
	into the corresponding 'General Folder'.


5f. >=sdl-net-1.2 ( http://www.libsdl.org/projects/SDL_net )

	Download the binary file for Win32
		SDL_net-devel-1.2.7-VC8.zip
	and unpack it into the projects folder to get:
		C:\projects\SDL_net-1.2.7\

	Copy the contents of each the 'lib' and the 'include' folder
	into the corresponding 'General Folder'.


5g. >=sdl-ttf-2.0.8 ( http://www.libsdl.org/projects/SDL_ttf )

	Download the binary file for Win32
		SDL_ttf-devel-2.0.9-VC8.zip
	and unpack it into the projects folder to get:
		C:\projects\SDL_ttf-2.0.9\

	Copy the contents of each the 'lib' and the 'include' folder
	into the corresponding 'General Folder'.


5h. >=libintl-0.14.4
		( http://gnuwin32.sourceforge.net/packages/gettext.htm )

	Download the 'Binaries', 'Dependencies' and the
	'Developer files'
		gettext-0.14.4-bin.zip
		gettext-0.14.4-dep.zip
		gettext-0.14.4-lib.zip
	and unpack them all into the projects folder to get:
		C:\projects\gettext-0.14.4\

	Copy the contents of each the 'lib' and the 'include' folder
	into the corresponding 'General Folder'.
	Copy all dll's from the 'bin' folder into the '_lib'
	'General Folder'.


5i. >=libfontconfig-2.4.1
		( http://www.gtk.org/download-windows.html )

	Download the 'Fontconfig' package 'Binaries' from the
	'Third Party Dependencies'
		fontconfig-2.4.2-tml-20071015.zip
	and unpack it into the projects folder to get:
		C:\projects\fontconfig-2.4.2\

	Copy the 'libfontconfig-1.dll' from the 'bin' folder into the
	'lib' 'General Folder'.


5j. >=lua-5.1.4 ( http://luabinaries.luaforge.net/download.html )

	Download the 'Windows x86 DLL and Includes (Visual C++ 2005
	Compatible)'
		lua5_1_4_Win32_dll8_lib.zip
	and unpack it into the projects folder to get:
		C:\projects\lua-5.1.4\

	Copy the dll's and the lib's into the 'lib' 'General Folder' and
	the content of the 'include' folder into the corresponding '
	General Folder'.


5k. >=pangocairo-1.24.4 ( http://www.gtk.org/download-windows.html )

	Download the following 'Binaryies' and 'Dev' packages from the
	'GTK+ individual packages'
		cairo_1.8.6-1_win32.zip
		cairo-dev_1.8.6-1_win32.zip
		glib_2.20.0-1_win32.zip
		glib-dev_2.20.0-1_win32.zip
		pango_1.24.0-1_win32.zip
		pango-dev_1.24.0-1_win32.zip
	and unpack them into the projects folder to get:
		C:\projects\pangocairo\

	Copy all dll's from the 'bin' folder into the '_lib'
	'General Folder'.
	Copy the contents (but not the subfolders) of the 'lib' folder
	into the corresponding 'General Folder'.
	Copy the 'glibconfig.h' file from
	C:\projects\pangocairo\lib\glib-2.0\include into the '_include'
	'General Folder'.
	Copy the contens (including subfolders) of the following folders
	into the '_include' 'General Folder':
		C:\projects\pangocairo\include\cairo
		C:\projects\pangocairo\include\glib-2.0
		C:\projects\pangocairo\include\pango-1.0


6.	MSVC needs to find all needed includes and libraries, so open
		Tools --> Options --> Projects and Solutions
			--> VC++ Directories

	In the 'Include file' directories add:
		C:\projects\_include
		C:\projects\Boost\include\boost-1_38\

	In the 'Library files' directories add:
		C:\projects\_lib
		C:\projects\Boost\lib\

	And to be able to launch wesnoth.exe and wesnothd.exe from
	within MSVC, we'll need to add the 'C:\projects\_lib' folder
	to windows PATH environment variable:

	Start the CMD.exe and type in the following command (adjusted
	to your own folder-structure!) and press enter.
		C:\> path = %PATH%;C:\projects\_lib

	Note that it is recommended to restart windows now in order to
	prevent issues with the compiled executables not finding
	required dll's.


7.	Open the 'wesnoth.sln' file in the
		C:\projects\wesnoth\trunk\projectfiles\VC9
	folder with MSVC.


You are now ready to build wesnoth and wesnothd with MSVC.