|
|
OpenTTD readme
|
|
|
Last updated: 2011-04-01
|
|
|
Last updated: 2011-05-19
|
|
|
Release version: 1.1.0
|
|
|
------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
Table of contents
|
|
|
-----------------
|
|
|
1.0) About
|
|
|
2.0) Contacting
|
|
|
* 2.1) Reporting bugs
|
|
|
* 2.2) Reporting desyncs
|
|
|
3.0) Supported platforms
|
|
|
4.0) Installing and running OpenTTD
|
|
@@ -240,49 +240,71 @@ download system download the tar file an
|
|
|
AI needs libraries you'll have to download those too and put them in the
|
|
|
ai/library/ directory. All AIs and AI Libraries that have been uploaded to
|
|
|
the content download system can be found at http://noai.openttd.org/downloads/
|
|
|
The AIs and libraries can be found their in the form of .tar.gz packages.
|
|
|
OpenTTD can read inside tar files but it does not extract .tar.gz files by
|
|
|
itself.
|
|
|
To figure out which libraries you need for an AI you have to start the AI and
|
|
|
wait for an error message to pop up. The error message will tell you
|
|
|
"couldn't find library 'lib-name'". Download that library and try again.
|
|
|
|
|
|
4.2) OpenTTD directories
|
|
|
---- -------------------
|
|
|
The required 3rd party files listed in the section 4.1 "(Required) 3rd party files"
|
|
|
as well as other non-compulsory extensions (NewGRFs, AI, heightmaps, scenarios) can be
|
|
|
placed in a few different locations:
|
|
|
OpenTTD uses its own directory to store its required 3rd party base set files (see section
|
|
|
4.1 "Required 3rd party files") and non-compulsory extension and configuration files. See
|
|
|
below for their proper place within this OpenTTD main data directory.
|
|
|
|
|
|
The main OpenTTD directories can be found in various locations, depending on your operating
|
|
|
system:
|
|
|
1. The current working directory (from where you started OpenTTD)
|
|
|
For non-Windows operating systems OpenTTD will not scan for files in this
|
|
|
directory if it is your personal directory, i.e. "~/", or when it is the
|
|
|
root directory, i.e. "/".
|
|
|
2. Your personal directory
|
|
|
Windows: C:\My Documents (95, 98, ME)
|
|
|
C:\Documents and Settings\<username>\My Documents\OpenTTD (2000, XP)
|
|
|
C:\Users\<username>\Documents\OpenTTD (Vista, 7)
|
|
|
Mac OSX: ~/Documents/OpenTTD
|
|
|
Linux: ~/.openttd
|
|
|
3. The shared directory
|
|
|
Windows: C:\Documents and Settings\All Users\Shared Documents\OpenTTD (2000, XP)
|
|
|
C:\Users\Public\Documents\OpenTTD (Vista, 7)
|
|
|
Mac OSX: /Library/Application Support/OpenTTD
|
|
|
Linux: not available
|
|
|
4. The binary directory (where the OpenTTD executable is)
|
|
|
Windows: C:\Program Files\OpenTTD
|
|
|
Linux: /usr/games
|
|
|
5. The installation directory (Linux only)
|
|
|
Linux: /usr/share/games/openttd
|
|
|
6. The application bundle (Mac OSX only)
|
|
|
It includes the OpenTTD files (grf+lng) and it will work as long as they aren't touched
|
|
|
It includes the OpenTTD files (grf+lng) and it will work as long as they aren't
|
|
|
touched
|
|
|
|
|
|
Different types of data or extensions go into different subdirectories of the chosen main
|
|
|
OpenTTD directory:
|
|
|
Config File: (no subdirectory)
|
|
|
Screenshots: (no subdirectory)
|
|
|
Base Graphics: data (or a subdirectory thereof)
|
|
|
Sound Sets: data (or a subdirectory thereof)
|
|
|
NewGRFs: data (or a subdirectory thereof)
|
|
|
32bpp Sets: data (or a subdirectory thereof)
|
|
|
Music Sets: gm (or a subdirectory thereof)
|
|
|
AIs: ai (or a subdirectory thereof)
|
|
|
AI Libraries: ai/libraries (or a subdirectory thereof)
|
|
|
Savegames: save
|
|
|
Automatic Savegames: save/autosave
|
|
|
Scenarios: scenario
|
|
|
|
|
|
The (automatically created) directory content_download is for OpenTTD's internal use and
|
|
|
no files should be added to it or its subdirectories manually.
|
|
|
|
|
|
Notes:
|
|
|
- Linux in the previous list means .deb, but most paths should be similar for others.
|
|
|
- The previous search order is also used for NewGRFs and openttd.cfg.
|
|
|
- If openttd.cfg is not found, then it will be created using the 2, 4, 1, 3, 5 order.
|
|
|
- Savegames will be relative to the config file only if there is no save/
|
|
|
directory in paths with higher priority than the config file path, but
|
|
|
autosaves and screenshots will always be relative to the config file.
|
|
|
|
|
|
The preferred setup:
|
|
|
Place 3rd party files in shared directory (or in personal directory if you don't
|
|
|
have write access on shared directory) and have your openttd.cfg config file in
|
|
@@ -348,25 +370,25 @@ Information logged:
|
|
|
|
|
|
No personal information is stored.
|
|
|
|
|
|
You can show the game log by typing 'gamelog' in the console or by running
|
|
|
OpenTTD in debug mode.
|
|
|
|
|
|
|
|
|
6.0) Configuration file
|
|
|
---- ------------------
|
|
|
The configuration file for OpenTTD (openttd.cfg) is in a simple Windows-like
|
|
|
.INI format. It's mostly undocumented. Almost all settings can be changed
|
|
|
ingame by using the 'Advanced Settings' window.
|
|
|
When you can not find openttd.cfg you should look in the directories as
|
|
|
When you cannot find openttd.cfg you should look in the directories as
|
|
|
described in section 4.2. If you do not have an openttd.cfg OpenTTD will
|
|
|
create one after closing.
|
|
|
|
|
|
|
|
|
7.0) Compiling
|
|
|
---- ---------
|
|
|
Windows:
|
|
|
You need Microsoft Visual Studio .NET. Open the project file
|
|
|
and it should build automatically. In case you want to build with SDL support
|
|
|
you need to add WITH_SDL to the project settings.
|
|
|
PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these
|
|
|
to work you need their development files. For best results, download the
|
|
@@ -410,25 +432,26 @@ DOS:
|
|
|
Allegro, zlib and libpng, which all can be downloaded from the DJGPP
|
|
|
website. Compilation is straight forward: use make, but do a "./configure"
|
|
|
before the first build. The build binary will need cwsdpmi.exe to be in
|
|
|
the same directory as the openttd executable. cwsdpmi.exe can be found in
|
|
|
the os/dos subdirectory. If you compile with stripping turned on a binary
|
|
|
will be generated that does not need cwsdpmi.exe by adding the cswdstub.exe
|
|
|
to the created OpenTTD binary.
|
|
|
|
|
|
7.1) Required/optional libraries
|
|
|
---- ---------------------------
|
|
|
The following libraries are used by OpenTTD for:
|
|
|
- libSDL/liballegro: hardware access (video, sound, mouse)
|
|
|
- zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads, heightmaps
|
|
|
- zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads,
|
|
|
heightmaps
|
|
|
- liblzo2: (de)compressing of old (pre 0.3.0) savegames
|
|
|
- liblzma: (de)compressing of savegames (1.1.0 and later)
|
|
|
- libpng: making screenshots and loading heightmaps
|
|
|
- libfreetype: loading generic fonts and rendering them
|
|
|
- libfontconfig: searching for fonts, resolving font names to actual fonts
|
|
|
- libicu: handling of right-to-left scripts (e.g. Arabic and Persian) and
|
|
|
natural sorting of strings.
|
|
|
|
|
|
OpenTTD does not require any of the libraries to be present, but without
|
|
|
liblzma you cannot open most recent savegames and without zlib you cannot
|
|
|
open most older savegames or use the content downloading system.
|
|
|
Without libSDL/liballegro on non-Windows and non-MacOS X machines you have
|
|
@@ -446,25 +469,26 @@ The following compilers are known to com
|
|
|
- Microsoft Visual C++ (MSVC) 2005, 2008 and 2010.
|
|
|
Version 2005 gives bogus warnings about scoping issues.
|
|
|
- GNU Compiler Collection (GCC) 3.3 - 4.7.
|
|
|
Versions 4.1 and earlier give bogus warnings about uninitialised variables.
|
|
|
Versions 4.4 and later give bogus warnings about freeing non-heap objects.
|
|
|
- Intel C++ Compiler (ICC) 12.0.
|
|
|
|
|
|
The following compilers are known not to compile OpenTTD:
|
|
|
- Microsoft Visual C++ (MSVC) 2003 and earlier.
|
|
|
- GNU Compiler Collection (GCC) 3.2 and earlier.
|
|
|
These old versions fail due to OpenTTD's template usage.
|
|
|
- Intel C++ Compiler (ICC) 11.1 and earlier.
|
|
|
Version 10.0 and earlier fail a configure check and fail with recent system headers.
|
|
|
Version 10.0 and earlier fail a configure check and fail with recent system
|
|
|
headers.
|
|
|
Version 10.1 fails to compile station_gui.cpp.
|
|
|
Version 11.1 fails with internal error when compiling network.cpp.
|
|
|
- Clang/LLVM 2.8 and earlier.
|
|
|
- (Open) Watcom.
|
|
|
|
|
|
If any of these compilers can compile OpenTTD again, please let us know.
|
|
|
Patches to support more compilers are welcome.
|
|
|
|
|
|
|
|
|
8.0) Translating
|
|
|
---- -----------
|
|
|
See http://www.openttd.org/development for up-to-date information.
|
|
@@ -533,34 +557,43 @@ look at http://wiki.openttd.org/index.ph
|
|
|
|
|
|
The most frequent problem is missing data files. Please install OpenGFX and
|
|
|
possibly OpenSFX and OpenMSX. See section 4.1.1 for more information.
|
|
|
|
|
|
Under certain circumstance, especially on Ubuntu OpenTTD can be extremely slow
|
|
|
and/or freeze. See known-bugs.txt for more information and how to solve this
|
|
|
problem on your computer.
|
|
|
|
|
|
Under Windows 98 and lower it is impossible to use a dedicated server; it will
|
|
|
fail to start. Perhaps this is for the better because those OSes are not known
|
|
|
for their stability.
|
|
|
|
|
|
With the added support for font-based text selecting a non-latin language will
|
|
|
result in garbage (lots of '?') shown on screen. Please open your configuration
|
|
|
file and add a desired font for small/medium/-and large_font. This can be a font
|
|
|
name like "Tahoma" or a path to a font.
|
|
|
With the added support for font-based text selecting a non-latin language can
|
|
|
result in lots of question marks ('?') being shown on screen. Please open your
|
|
|
configuration file (openttd.cfg - see Section 4.2 for where to find it)
|
|
|
and add a suitable font for the small, medium and / or large font, e.g.:
|
|
|
small_font = "Tahoma"
|
|
|
medium_font = "Tahoma"
|
|
|
large_font = "Tahoma"
|
|
|
You should use a font name like "Tahoma" or a path to the desired font.
|
|
|
|
|
|
Any NewGRF file used in a game is stored inside the savegame and will refuse
|
|
|
to load if you don't have that NewGRF file available. A list of missing files
|
|
|
will be output to the console at the moment, so use the '-d' flag (on windows)
|
|
|
to see this list. You just have to find the files (http://grfcrawler.tt-forums.net/)
|
|
|
put them in the data/ folder and you're set to go.
|
|
|
can be viewed in the NewGRF window accessible from the file load dialogue window.
|
|
|
|
|
|
You can try to obtain the missing files from that NewGRF dialogue or - if they
|
|
|
are not available online - you can search manually through our forum's graphics
|
|
|
development section (http://www.tt-forums.net/viewforum.php?f=66) or GrfCrawler
|
|
|
(http://grfcrawler.tt-forums.net/). Put the NewGRF files in OpenTTD's data folder
|
|
|
(see section 4.2 "OpenTTD directories") and rescan the list of available NewGRFs.
|
|
|
Once you have all missing files, you are set to go.
|
|
|
|
|
|
|
|
|
X.X) Credits
|
|
|
---- -------
|
|
|
The OpenTTD team (in alphabetical order):
|
|
|
Albert Hofkamp (Alberth) - GUI expert
|
|
|
Jean-François Claeys (Belugas) - GUI, newindustries and more
|
|
|
Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework
|
|
|
Christoph Elsenhans (frosch) - General coding
|
|
|
Loïc Guilloux (glx) - Windows Expert
|
|
|
Michael Lutz (michi_cc) - Path based signals
|
|
|
Owen Rudge (orudge) - Forum host, OS/2 port
|