1

Compiling OpenTTD using Microsoft Visual C++

     2

December 28, 2006

     3

--------------------------------------------

     4

PLEASE READ THE ENTIRE DOCUMENT BEFORE DOING ANY ACTUAL CHANGES!!

     5

     6

SUPPORTED MSVC COMPILERS

     7

------------------------

     8

OpenTTD includes projects for MSVC 2003.NET and MSVC 2005.NET. Both will

     9

compile out of the box, providing you have the required libraries/headers;

    10

which ones, see below. There is no support for VS6, you are therefore

    11

strongly encouraged to either upgrade to MSVC 2005 Express (free) or use GCC.

    12

MSVC 2002 probably works as well, but it has not been tested.

    13

    14

1) REQUIRED FILES

    15

-----------------

    16

You might already have some of the files already installed, so check before

    17

downloading; mostly because the DirectX SDK and Platform SDK are about

    18

500MB each.

    19

Download the following files:

    20

    21

	* openttd-useful.zip (http://sf.net/project/showfiles.php?group_id=103924&package_id=114307)

    22

	* DirectX 8.1 SDK (http://neuron.tuke.sk/~mizanin/eng/Dx81sdk-include-lib.rar) (or alternatively the latest DirectX SDK from Microsoft)

    23

	* MS Windows Platform SDK (http://www.microsoft.com/downloads/details.aspx?FamilyId=A55B6B43-E24F-4EA3-A93E-40C0EC4F68E5&displaylang=en)

    24

	* afxres.h (http://www-d0.fnal.gov/d0dist/dist/packages/d0ve/devel/windows/AFXRES.H)

    25

    26

...and of course the newest source from svn://svn.openttd.org/trunk

    27

    28

You need an SVN-client to download the source from subversion:

    29

    30

	* CLI Subversion (http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91)

    31

	* GUI TortoiseSVN (http://tortoisesvn.tigris.org/download.html)

    32

    33

2) INCLUDES AND LIBRARIES

    34

-------------------------

    35

Put the newly downloaded files in the VC lib\ and include\ directories; where

    36

"C:\Program Files\Microsoft Visual Studio 8\VC" is your location of Visual C.

    37

If you are compiling for an x64 system, use the include\ and lib\ directories

    38

from the win64/ folder.

    39

    40

	* openttd-useful.zip\include\*

    41

	* afxresh.h

    42

	to >	C:\Program Files\Microsoft Visual Studio 8\VC\Include

    43

    44

	* openttd-useful.zip\lib\*

    45

	to >	C:\Program Files\Microsoft Visual Studio 8\VC\Lib

    46

    47

Custom directories might be recommended, check 2.2)

    48

    49

    50

2.1) INCLUDES AND LIBRARIES - DIRECTX/PLATFORM SDK

    51

--------------------------------------------------

    52

Basically the same procedure as with the useful zip file, providing

    53

you are not using the Microsoft installer. Put the include files in the

    54

include\ directory and the library files to the Lib\ directory.

    55

    56

It is recommended to use custom directories so you don't overwrite any

    57

default header or library files.

    58

    59

2.2) CUSTOM DIRECTORIES

    60

-----------------------

    61

If you have put the above include and/or library files into custom folders,

    62

MSVC will not find them by default. You need to add these paths to VC through:

    63

    64

Tools > Options > Projects and Solutions > VC++ Directories > show directories for

    65

    66

	* Include files: Add the DirectX/Platform SDK include dir you've created

    67

	* Library files: Add the path to the SDK custom lib dir

    68

    69

NOTE: make sure that the directory for the DirectX SDK is the first one in the

    70

list, above all others, otherwise compilation will most likely fail!!

    71

    72

3) TTD GRAPHICS FILES

    73

---------------------

    74

Copy the following files from Transport Tycoon Deluxe to the data folder

    75

    76

	* sample.cat

    77

	* trg1r.grf

    78

	* trgcr.grf

    79

	* trghr.grf

    80

	* trgir.grf

    81

	* trgtr.grf

    82

    83

    84

4) COMPILING

    85

------------

    86

Open trunk/openttd[_vs80].sln

    87

Set the build mode to 'Release' in

    88

Build > Configuration manager > Active solution configuration > select "Release"

    89

Compile...

    90

    91

If everything works well the binary should be in trunk/Release/openttd.exe

    92

    93

5) EDITING, CHANGING SOURCE CODE

    94

--------------------------------

    95

Set the build mode (back to) 'Debug'

    96

Change the startup project to openttd by right-clicking the 'openttd' project

    97

in the Solution Explorer and selecting 'Set as Startup Project'. The 'openttd'

    98

project should now show up bold instead of 'strgen'.

    99

   100

6) PROBLEMS?

   101

------------

   102

If compilation fails, double-check that you are using the latest SVN (!)

   103

source. If it still doesn't work, check in on IRC (irc://irc.oftc.net/openttd),

   104

to ask about reasons; or just wait. The problem will most likely solve itself

   105

within a few days as the problem is noticed and fixed.

   106

   107

An up-to-date version of this README can be found on the wiki:

   108

http://wiki.openttd.org/index.php/MicrosoftVisualCExpress