1

Compiling OpenTTD using Microsoft Visual C++

     2

January 2, 2007

     3

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

     4

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

     5

     6

     7

SUPPORTED MSVC COMPILERS

     8

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

     9

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

    10

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

    11

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

    12

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

    13

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

    14

    15

    16

1) REQUIRED FILES

    17

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

    18

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

    19

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

    20

500MB each.

    21

Download the following files:

    22

    23

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

    24

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

    25

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

    26

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

    27

    28

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

    29

    30

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

    31

    32

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

    33

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

    34

    35

    36

2) INCLUDES AND LIBRARIES

    37

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

    38

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

    39

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

    40

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

    41

from the win64/ folder.

    42

    43

	* openttd-useful.zip\include\*

    44

	* afxresh.h

    45

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

    46

    47

	* openttd-useful.zip\lib\*

    48

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

    49

    50

Custom directories might be recommended, check 2.2)

    51

    52

    53

2.1) INCLUDES AND LIBRARIES - DIRECTX/PLATFORM SDK

    54

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

    55

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

    56

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

    57

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

    58

    59

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

    60

default header or library files.

    61

    62

    63

2.2) CUSTOM DIRECTORIES

    64

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

    65

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

    66

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

    67

    68

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

    69

    70

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

    71

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

    72

    73

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

    74

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

    75

    76

    77

2.3) DEBUGGING - WORKING DIRECTORY (MSVC 2003 ONLY!)

    78

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

    79

The very first time you check out and compile OpenTTD with Visual Studio 2003, running

    80

the binary will complain about missing files. You need to go into and change a setting

    81

    82

OpenTTD > Project > Properties > Configuration (All Configurations) > ...

    83

 Configuration Properties > Debugging >

    84

    85

	* Working Directory: ..\bin

    86

    87

VS 2005 works out of the box because Microsoft allowed a user to supply a humanly-

    88

readable defaults file (openttd_vs80.vcproj.user), whereas 2003 is braindead.

    89

    90

    91

3) TTD GRAPHICS FILES

    92

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

    93

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

    94

    95

	* sample.cat

    96

	* trg1r.grf

    97

	* trgcr.grf

    98

	* trghr.grf

    99

	* trgir.grf

   100

	* trgtr.grf

   101

   102

   103

4) COMPILING

   104

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

   105

Open trunk/openttd[_vs80].sln

   106

Set the build mode to 'Release' in

   107

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

   108

Compile...

   109

   110

If everything works well the binary should be in trunk/objs/[Win32]/Release/openttd.exe

   111

   112

   113

5) EDITING, CHANGING SOURCE CODE

   114

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

   115

Set the build mode (back to) 'Debug'

   116

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

   117

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

   118

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

   119

   120

   121

6) PROBLEMS?

   122

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

   123

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

   124

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

   125

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

   126

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

   127

   128

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

   129

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