(svn r7773) -(r7759) Update MSVC documentation for (mainly) VS2003 users (needs special human intervention to work because MS decided to use some completely braindead user-datafile that you can't edit outside the development environment)
--- a/docs/Readme_Windows_MSVC.txt Tue Jan 02 21:48:33 2007 +0000
+++ b/docs/Readme_Windows_MSVC.txt Tue Jan 02 21:58:51 2007 +0000
@@ -1,8 +1,9 @@
Compiling OpenTTD using Microsoft Visual C++
-December 28, 2006
+January 2, 2007
--------------------------------------------
PLEASE READ THE ENTIRE DOCUMENT BEFORE DOING ANY ACTUAL CHANGES!!
+
SUPPORTED MSVC COMPILERS
------------------------
OpenTTD includes projects for MSVC 2003.NET and MSVC 2005.NET. Both will
@@ -11,6 +12,7 @@
strongly encouraged to either upgrade to MSVC 2005 Express (free) or use GCC.
MSVC 2002 probably works as well, but it has not been tested.
+
1) REQUIRED FILES
-----------------
You might already have some of the files already installed, so check before
@@ -30,6 +32,7 @@
* CLI Subversion (http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91)
* GUI TortoiseSVN (http://tortoisesvn.tigris.org/download.html)
+
2) INCLUDES AND LIBRARIES
-------------------------
Put the newly downloaded files in the VC lib\ and include\ directories; where
@@ -56,6 +59,7 @@
It is recommended to use custom directories so you don't overwrite any
default header or library files.
+
2.2) CUSTOM DIRECTORIES
-----------------------
If you have put the above include and/or library files into custom folders,
@@ -69,9 +73,24 @@
NOTE: make sure that the directory for the DirectX SDK is the first one in the
list, above all others, otherwise compilation will most likely fail!!
+
+2.3) DEBUGGING - WORKING DIRECTORY (MSVC 2003 ONLY!)
+----------------------------------------------------
+The very first time you check out and compile OpenTTD with Visual Studio 2003, running
+the binary will complain about missing files. You need to go into and change a setting
+
+OpenTTD > Project > Properties > Configuration (All Configurations) > ...
+ Configuration Properties > Debugging >
+
+ * Working Directory: ..\bin
+
+VS 2005 works out of the box because Microsoft allowed a user to supply a humanly-
+readable defaults file (openttd_vs80.vcproj.user), whereas 2003 is braindead.
+
+
3) TTD GRAPHICS FILES
---------------------
-Copy the following files from Transport Tycoon Deluxe to the data folder
+Copy the following files from Transport Tycoon Deluxe to the bin/data folder
* sample.cat
* trg1r.grf
@@ -88,7 +107,8 @@
Build > Configuration manager > Active solution configuration > select "Release"
Compile...
-If everything works well the binary should be in trunk/Release/openttd.exe
+If everything works well the binary should be in trunk/objs/[Win32]/Release/openttd.exe
+
5) EDITING, CHANGING SOURCE CODE
--------------------------------
@@ -97,6 +117,7 @@
in the Solution Explorer and selecting 'Set as Startup Project'. The 'openttd'
project should now show up bold instead of 'strgen'.
+
6) PROBLEMS?
------------
If compilation fails, double-check that you are using the latest SVN (!)