summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Readme_Windows_MSVC.txt23
-rw-r--r--docs/obm_format.txt22
2 files changed, 32 insertions, 13 deletions
diff --git a/docs/Readme_Windows_MSVC.txt b/docs/Readme_Windows_MSVC.txt
index 65701e0e8..00896f00b 100644
--- a/docs/Readme_Windows_MSVC.txt
+++ b/docs/Readme_Windows_MSVC.txt
@@ -1,27 +1,24 @@
Compiling OpenTTD using Microsoft Visual C++
-Last updated: 2010-01-03
+Last updated: 2018-03-21
--------------------------------------------
PLEASE READ THE ENTIRE DOCUMENT BEFORE DOING ANY ACTUAL CHANGES!!
SUPPORTED MSVC COMPILERS
------------------------
-OpenTTD includes projects for MSVC 2005.NET and MSVC 2008.NET. Both will
-compile out of the box, providing you have the required libraries/headers;
-which ones, see below. There is no support for VS6 or MSVC 2002, or
-MSVC 2003.NET. You are therefore strongly encouraged to either upgrade to
-MSVC 2008 Express (free) or use GCC.
+OpenTTD includes projects for Microsoft Visual Studio 2005 and later.
+This is the earliest compiler supported, Visual C++ 2003, Visual C++ 6.0,
+or earlier, will not compile OpenTTD.
+You can download the free Visual Studio Community Edition from Microsoft.
1) REQUIRED FILES
-----------------
You might already have some of the files already installed, so check before
-downloading; mostly because the DirectX SDK and Platform SDK are about
-500MB each.
+downloading; mostly because the Platform SDK is about 500MB.
Download the following files:
* openttd-useful.zip (http://binaries.openttd.org/extra/openttd-useful/)
- * DirectX 8.1 SDK (http://neuron.tuke.sk/~mizanin/eng/Dx81sdk-include-lib.rar) (or alternatively the latest DirectX SDK from Microsoft)
* MS Windows Platform SDK (http://www.microsoft.com/downloads/details.aspx?FamilyId=A55B6B43-E24F-4EA3-A93E-40C0EC4F68E5&displaylang=en)
* afxres.h (http://www-d0.fnal.gov/d0dist/dist/packages/d0ve/devel/windows/AFXRES.H)
@@ -81,12 +78,16 @@ See section 4.1 of README.md for the required 3rdparty files and how to install
4) COMPILING
------------
-Open trunk/openttd_vs[89]0.sln
+Open the appropriate "sln" (Solution) file for your version of Visual Studio:
+ - VS 2005: projects/openttd_vs80.sln
+ - VS 2008: projects/openttd_vs90.sln
+ - VS 2010: projects/openttd_vs100.sln
+ - VS 2015: projects/openttd_vs140.sln
Set the build mode to 'Release' in
Build > Configuration manager > Active solution configuration > select "Release"
Compile...
-If everything works well the binary should be in trunk/objs/Win[32|64]/Release/openttd.exe
+If everything works well the binary should be in objs/Win[32|64]/Release/openttd.exe
5) EDITING, CHANGING SOURCE CODE
diff --git a/docs/obm_format.txt b/docs/obm_format.txt
index 40f829a52..45fe5f879 100644
--- a/docs/obm_format.txt
+++ b/docs/obm_format.txt
@@ -45,12 +45,15 @@ description.en_US = howdie
; The file names are case sensitive.
; You can have empty file names; in that case no song will be loaded
; for that 'entry'.
+; If you want to load music from the MPS DOS music driver "cat" format,
+; specify just the name of the .cat file the song is located in, then
+; fill out the "catindex" section.
[files]
; The theme song for OpenTTD
theme = THEME_SONG.GM
; The songs in the 'old style' category
-old_0 =
-old_1 =
+old_0 = GM.CAT
+old_1 = GM.CAT
old_2 =
old_3 =
old_4 =
@@ -86,9 +89,17 @@ ezy_9 =
; Note that the list of files is case sensitive. Each file listed in the
; files section must be listed here with it's song name, otherwise you
; will get a lot of warnings when starting OpenTTD.
+; You don't need to fill this out for "cat" format music, the song names
+; are loaded directly from the file in that case.
[names]
THEME_SONG.GM = Tycoon DELUXE Theme
+; If you are loading music from the DOS version "cat" format, specify
+; which index into the file the song has.
+[catindex]
+old_0 = 1
+old_1 = 3
+
; The md5s section lists the MD5 checksum for the files that replace them.
; Note that the list of files is case sensitive. Each file listed in the
; files section must be listed here with it's MD5 checksum, otherwise you
@@ -96,6 +107,13 @@ THEME_SONG.GM = Tycoon DELUXE Theme
[md5s]
THEME_SONG.GM = 45cfec1b9d8c7a0ad45e755833cbf221
+; If a song needs to have parts of the start or end cut off to avoid long
+; silences, you can specify MIDI tick codes for start:end of the actual
+; music part for each file here.
+; Not all music drivers might support this feature.
+[timingtrim]
+THEME_SONG.GM = 768:53760
+
; The origin section provides the possibility to put and extra line into
; the warning that a file is missing/corrupt. This can be used to tell
; them where to find it. It works on the filename specified in the