TTWiki - User contributions [en-gb]

SandBox

2011-06-15T23:44:25Z

Hgnmu128: moved SandBox to TTWiki:Sandbox: More appropriate location, and referenced on Main page.

#REDIRECT [[TTWiki:Sandbox]]

TTWiki:Sandbox

2011-06-15T23:44:25Z

Hgnmu128: moved SandBox to TTWiki:Sandbox: More appropriate location, and referenced on Main page.

'''''The Sandbox.'''''

=The Sandbox=

This is where you can practise how the Wiki system works without breaking anything.

You don't even need to login, simply click the "edit" tab at the top and start playing.  For accessing markup, try the Quicklinks in the edit screen, or the "Wiki quick help" tab if your browser supports DHTML.

The Sandbox is cleaned twice daily, so don't put anything important here, or it will disappear at 3am and 3pm CST.

'''Do not put advertising or spam here, it will be removed as soon as it is noticed!'''

==Try it out!==

21 '''23''' ''24'' '''''26'''''

[[PoweredWagons]] and [http://www.tt-wiki.net/wiki/PoweredWagons PoweredWagons]

Powered wagons

2011-06-15T22:58:20Z

Hgnmu128: Added intro.

How to make trains which have powered wagons

==Settings and properties==
In TTD, train locomotives (engines) are powered and train wagons are not, and this is generalized, contrary to real-life trains where individual wagons might have power. The NFO action used to implement powered wagons is [http://newgrf-specs.tt-wiki.net/wiki/Action0 Action0], which defines properties for different features in TTD (trains, RVs, industries, stations etc.).

If we set property 0B to any non-zero value, the wagons won't just have power when connected to engines. Instead, they start to act as engines. To make the wagons have power '''''only''''' when they're connected to a specific engine, property 1B has to be used. Setting the property 1B of the ''engine'' (not the wagon), defines the amount of power each wagon connected to that engine adds to the train.

Note: this works only for wagons with a '''Graphics override''' for this engine. The weight each wagon adds is defined in property 23.

==Using wagon override==
There is a special case of [http://newgrf-specs.tt-wiki.net/wiki/Action3 Action3], which makes the look of wagons (i.e. changes their livery) when attached to certain engines. This is called '''Wagon graphics override''' or '''Wagon override'''. This feature finds its use in train sets, when the look of wagons need to match that of engines.

When the <n-id> byte in an Action3 has bit-7 set (80 added to the actual value), all wagons in that Action3 will have wagon override and will use the graphics defined in the <def-cid> byte. The Action3 of the wagons should immediately follow the Action3 of the engine for wagon override to work, and any number of wagons can have an override for an engine.

==Example==
Here's an example of a passenger carriage, mail van and armoured van wagon override for the train engine with ID 28. The graphics for the engine have been defined in action 2 ID 00, those for the passenger carriage in ID 01, and mail van and armoured van use the same graphics defined in ID 02.
23 * 7 03 00 01 28 00 00 00 // engine at vehicle ID 28
24 * 7 03 00 81 1B 00 01 00 // passenger carriage ID 1B
25 * 7 03 00 82 1C 37 00 02 00 // mail and armoured carriages ID 1C, 37, respectively

Powered wagons

2011-06-15T22:54:56Z

Hgnmu128: Added sections, Example copied from NewGRFSpecs archive.

==Settings and properties==
In TTD, train locomotives (engines) are powered and train wagons are not, and this is generalized, contrary to real-life trains where individual wagons might have power. The NFO action used to implement powered wagons is [http://newgrf-specs.tt-wiki.net/wiki/Action0 Action0], which defines properties for different features in TTD (trains, RVs, industries, stations etc.).

If we set property 0B to any non-zero value, the wagons won't just have power when connected to engines. Instead, they start to act as engines. To make the wagons have power '''''only''''' when they're connected to a specific engine, property 1B has to be used. Setting the property 1B of the ''engine'' (not the wagon), defines the amount of power each wagon connected to that engine adds to the train.

Note: this works only for wagons with a '''Graphics override''' for this engine. The weight each wagon adds is defined in property 23.

==Using wagon override==
There is a special case of [http://newgrf-specs.tt-wiki.net/wiki/Action3 Action3], which makes the look of wagons (i.e. changes their livery) when attached to certain engines. This is called '''Wagon graphics override''' or '''Wagon override'''. This feature finds its use in train sets, when the look of wagons need to match that of engines.

When the <n-id> byte in an Action3 has bit-7 set (80 added to the actual value), all wagons in that Action3 will have wagon override and will use the graphics defined in the <def-cid> byte. The Action3 of the wagons should immediately follow the Action3 of the engine for wagon override to work, and any number of wagons can have an override for an engine.

==Example==
Here's an example of a passenger carriage, mail van and armoured van wagon override for the train engine with ID 28. The graphics for the engine have been defined in action 2 ID 00, those for the passenger carriage in ID 01, and mail van and armoured van use the same graphics defined in ID 02.
23 * 7 03 00 01 28 00 00 00 // engine at vehicle ID 28
24 * 7 03 00 81 1B 00 01 00 // passenger carriage ID 1B
25 * 7 03 00 82 1C 37 00 02 00 // mail and armoured carriages ID 1C, 37, respectively

TTWiki:Sandbox

2011-06-15T22:29:00Z

Hgnmu128: Link test.

ECS Houses. Houses

2011-06-15T21:46:52Z

Hgnmu128: Fix style

Houses implemented by the ECS Houses Vector by George

==Regular Houses==

Regular houses which do not provide any support for special cargoes

==[http://ru.wikipedia.org/wiki/%D0%A1%D1%82%D0%B0%D0%BB%D0%B8%D0%BD%D0%BA%D0%B8|Stalinka]==

Drawn by George

Based on the house at [http://www.citywalls.ru/house9459.html|Trefoleva street, 3].

===Available===

Eras 1,2 or in 1938 - 1959 (if eras are off).

Town zones: 1-4.

No same house 3 squares around allowed.

Not allowed in desert.

At least 512 inhabitants in town required.

A road at SE required.

===Acceptance===

Accepts passengers.

===Cargo generation===

Default cargo generation.

===Features===

255 rating required for removal.

Minimal age before removal - 50 years.

The last one in the town is protected.

Supports snow.

==Courthouse==

Drawn by George, inspired by Das Gericht by MHz

===Available===

Eras 1-4 or in 1920 - ... (if eras are off).

Town zones: 1-4.

No same house 15 squares around allowed.

Not allowed in desert.

At least 1024 inhabitants in town required.

A road at SE required.

===Acceptance===

Accepts passengers.

===Cargo generation===

Generates 128 passengers a month.

===Features===

255 rating required for removal.

Minimal age before removal - 50 years.

The last one in the town is protected.

Supports snow.

ECS Vectors Translations

2011-06-14T14:13:56Z

Hgnmu128: Edited link.

'''''ECS Vectors Translations'''''

=ECS Vectors Translations=

This section is created to help ECS Vectors to speak your native languages. Please add translations to the sections. Also please check the existing one. May be it has mistakes.

{toc}

=How to translate=

The following instructions are based on [[Action4|Action 4]] description

Note: All strings should be UTF-8

==What to translate==

Find a general string. If would look like

21 * 34 04 0A '''FF''' 01 '''00 D0''' 94 80 " should be built in towns" 00

'''FF''' (FFh = 80h + 7Fh) indicates a general string, that is used when translation is not defined. You need to translate it.

if a string like

22 * 43 04 0A '''82''' 01 '''00 D0''' 94 80 " muss in einer Stadt gebaut werden" 00

goes below, than it means that a German ('''82''' = 80h + 02h, where 02h is German) translation is represented (here '''00 D0''' is the string ID, translation is applied to the string with the same ID)

If the string is wrong, you can modify it. If the string is not represented, you can add it.

The list of languages is represented [[Action4|here]]

==How to modify a string==

Change the string you need

1 * 1 04 0A 82 01 00 D0 '''94 80 " muss in einer Stadt gebaut werden" 00'''

==How to add a new string==

You should not care about the string number nor length. you can simply use

'''1 * 1'''

because NFOrenum would fix it. All you need is to add a right language (+80h if you translate FF string, and a language code if 7F).

1 * 1 04 0A '''82''' 01

at the right ID

1 * 1 04 0A 82 01 '''00 D0'''

Then you put a new string

The number of strings and string class is copied from string, which you are translating

1 * 1 '''04 0A''' 82 '''01''' 00 D0

Then you add you new string

1 * 1 04 0A 82 01 00 D0 '''94 80 " muss in einer Stadt gebaut werden" 00'''

You have to use the same string codes as string, which you are translating. The order is important. The place in text is important for decoration code, is not important for string and numbers

1 * 1 04 0A 82 01 00 D0 '''94 80''' " muss in einer Stadt gebaut werden" '''00'''

String codes are described [http://newgrf-specs.tt-wiki.net/wiki/StringCodes here].

TTWiki:Sandbox

2011-06-14T14:08:32Z

Hgnmu128: /* The Sandbox */

Talk:Railway Dictionary

2011-06-14T13:33:31Z

Hgnmu128: Your link was mislead. Corrected.

I was wondering whether someone (OP prefered) could attempt to import [http://en.wikipedia.org/wiki/Template:flagicon] so the flags would (easily) work properly.--[[User:Lord Aro|Lord Aro]] 09:59, 14 June 2011 (UTC)

Main Page

2011-06-14T01:50:08Z

Hgnmu128: Added hint to create page.

{| cellspacing="0" class="mainpagetable" align="center" style="background-color: #FFFFFF;" style="border: 1px solid #C0C090;"
|- valign="top"
|colspan="2" style="background-color: #F8EABA;text-align:center;"|
<center>
'''Welcome to the TT-Wiki!'''

Welcome to the TT-Forums Wiki. This wiki aims to be the one stop for TTD players, veteran and beginner alike. It will eventually contain guides to the smallest things, such as building your first train line, and purchasing your first locomotive. That's the theory at least - it's still quite the work in progress!
</center>
|- valign="top"
|colspan="2" style="border-bottom:1px solid #C0C090; background-color: #F8EABA;text-align:center;"|
<center>
'''[[TT Meet 2011]]''' 
Initial planning for the TT Meet of 2011 in '''Manchester, UK'''

'''Other pages''' 
This wiki is currently being redesigned to incorporate the [[TTDPatch]] wiki. You can also find the [[NewGRF]] specifications [http://newgrf-specs.tt-wiki.net/ on their own wiki].
</center>
|- valign="top"
|width="50%"|
<center>'''Contribute''' </center>
Please help us make this a definitive [[Transport Tycoon]] related wiki. Read the '''[[Manual of Style]]'''  and '''[[LocalStyleGuide]]''' before editing. See the [[TTWiki:Requested Articles|Requested articles]] page to request an article or fulfill a request.

Please do any experimentation in the [[TTWiki:Sandbox|Sandbox]], or create a Draft page under your user name, for larger projects.

'''NOTE:''' Unregistered users can no longer edit pages, due to significant amounts of spam being posted. If you wish to edit pages, please register.

|width="50%"|
<center>'''Read''' </center>
To begin, search for a term in the search box on the left, or see [[TTWiki:Searching|Searching]]. Alternatively, use the [[Special:Randompage|Random page]] feature and follow article links.

If you're interested in real-life meet-ups of TT-Forums members, check out the [[:Category:TT Meets|TT-Forums meets]]!

If you're interested in Locomotion, there is a [[Loco:Main_Page|Locomotion Wiki]].

|}

==TTDPatch Wiki==

Content authors please read the [[LocalStyleGuide]] to make sure that your work fits in and is useful. If you're looking for something to do, check out the [[ThingsToDo]].

==Welcome==

Hi!

This is the wiki for [[TTDPatch]], an unofficial gameplay-enhancing and bug-fixing patch for the game Transport Tycoon Deluxe, written by Chris Sawyer. TTDPatch was originally written by Josef Drexler, but today we have a whole Patch Team working on it! For something bleeding-edge from the individual members, check out their Patch Versions (NB: These may not be more recent than the latest official builds)

If you don't know what a Wiki is, ask [http://www.wikipedia.org/wiki/Wiki Wikipedia]. Basically, it's a documentation system where anyone can contribute and add new content.

What can you find here? The main focus at the moment are
* The TTDPatch [[Manual]]
* [http://wiki.ttdpatch.net/tiki-list_faqs.php The FAQs]
* various [[Tutorials]]
* ways of running [[TTDonLinux|TTD on Linux]]
* information about the '''Extended Cargo Scheme ([[ECS]])''' and George's implementation of ECS vectors
* the [[RailwayDictionary]] for newgrf set authors

The NewGRF specifications can now be found [http://newgrf-specs.tt-wiki.net/ on their own wiki].

Hopefully, this wiki will soon get filled with all sorts of useful information about TTDPatch (and Transport Tycoon, of course), but if you can't find what you're looking for here, try looking at [http://www.tt-forums.net/ The Transport Tycoon Forums], which also hosts the official forums for [[TTDPatch]].

If you're looking for a specific page, try the [[List of pages]] (you can search for a page name there too).

If you register and login, you can create new pages, and edit existing pages to add more content. When registering, the email address is optional but useful to have the password sent to you if you forget. The address won't be shown to anyone else unless you enable that in your profile.

Hint: to create new pages:

* link to them somewhere, then click on the link to edit them. The best way of creating links is through using WikiWords, i.e. RunningWordsTogether. The name should make sense when read in and out of context. You can use the SandBox to play with and test how things work, even without having to register. This feature can be especially useful if you are making a considerably long article from scratch and do not want the article page until it is (almost) finished, or
* search for the page name you want to create, then click [[Create this page]] link. All rules above apply.

Have fun!

LocalStyleGuide

2011-06-14T01:31:07Z

Hgnmu128: /* Local Style Guide* */

TTDPatch Wiki Local Style Guide*

===Use of '''Preview'''===

ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them. Do lots of edits and then save, not lots of saves while you edit.

To find out what markup you can use in addition to the stuff available from the sidebar and [[Help:Editing|Editing help]]  when editing, see the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet] page for now, which is the MediaWiki syntax and formatting help page. New pages specific to [http://www.tt-wiki.net/wiki/Main_Page The Transport Tycoon Wiki] will be created and linked in the nick of time.

===Use of the Summary field===

When editing a page, put something helpful in the "'''Summary'''" field (when you go to make an edit, it's directly beneath the big edit box - see?) to make it easier for all concerned to see who did what at-a-glance. The idea for the comments list is that someone can look at a version comment, and establish '''without''' having to look at individual diffs and comparisons to see what changed between versions. It also facilitates transparency, one of the reasons why Wikis even exist.

Examples of useful comments:

<pre>Fixed some typos. (Tells us what you did)

Expanded upon first paragraph. (Tells us where you did it)

Removed obsolete information about Thisthat & Theother, plc. (Does exactly what it says on the tin)

Updated revision dates. (Brief, but hopefully there won't be much of those on the given page to be updated)</pre>

Examples of not-so-useful comments:

<pre> (Empty comment - people have to check the diffs for each version)

Written by xyz. (You don't say? It's not as if the "history" list already shows who wrote it ...)

Added more information. (Oh, well isn't that helpful? Tells everything doesn't it?)</pre>

Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.

<nowiki><nowiki>* Not inspired by the author's use of TeX. Honestly ...</nowiki></nowiki>

PlantManyTrees

2011-06-14T01:30:22Z

Hgnmu128: Removed *cold hard markup* bold introduction

Plant a rectangular area of trees

==Switch==

Configuration file: plantmanytrees

Command line: -Yp

==Description==

It is a bit switch. To find out how that works, see [[BitSwitches|Bit Switches]], or simply add up the values of the options you want:

||Bit|Value|Name|Meaning

0|1|morethanonepersquare|Allow adding trees to a tile

1|2|rectangular|Plant rectangular area with Ctrl

2|4|morethanonerectangular|Rectangular planting adds trees to tile||

The first option allows you to plant trees on a tile which already has trees. However, currently this does not impress the local authority; for that you need to plant trees on empty tiles. Also, the new trees have to be fully grown (due to an  internal restriction of TTD), so they cost more.

The second option allows you to plant a large rectangular area with trees. First, you plant a tree in one corner of the rectangle. Then you hold down Ctrl, and plant a tree in the opposite corner of the rectangle. Now all empty fields in the rectangle will be filled with trees. If the tree type is the same in both corners, the whole rectangle will be filled with that type of tree. If the tree types differ, the rectangle will be filled with random trees.

If you enable the third option, this rectangular planting will add trees to tiles which contain trees already, whereas otherwise it only plants on empty tiles.

This patch was contributed by Csaba Varga.

Railway Dictionary

2011-06-14T01:27:24Z

Hgnmu128: Reformat

==The TTD Railway Dictionary==

is a collection of railway-related terms which should be helpful for newgrf set authors when making available sets for different languages. For easy access, it's divided into a couple of categories:

- the [[RailwayDictionaryGeneral|General section]] should be the place for everything which doesn't fit in any of the other categories,

- in the [[RailwayDictionaryTrain|Train section]] you'll find everything related to trains and consists, except terms for locomotives or coaches and wagons,

- the [[RailwayDictionaryService|Services section]] contains terms related to train services,

- and the [[RailwayDictionaryLocomotive|Locomotive section]] holds everything related to locomotives and rail cars, being further divided into subcategories representing the various types of locomotives (steam, diesel, electric),

- the [[RailwayDictionaryCoaches|Coach section]] is concerned with coaches and passengers,

- and the [[RailwayDictionaryFreight|Freight section]] deals with information about freight and freight wagons,

- the [[RailwayDictionarySuperstructure|Track section]] is responsible for track terminology,

- and the [[RailwayDictionarySignals|Signal section]] covers signalling and signal systems,

- the [[RailwayDictionaryStation|Station section]] handles station-related stuff,

- and the [[RailwayDictionaryDepot|Depot section ]] gives attention to terms related to depots,

- last but not least, the [[RailwayDictionaryCatenary|Catenary section]] - well, you got it. ;)

Each of these categories is sorted alphabetically, the rank of languages being the same as used elsewhere on the [[Action4|TTDPatch Wiki]].

The TTD Railway Dictionary uses national flag symbols to indicate the language of entries. There is already a number of flag images contained in the Dictionary, their file names being derived from international country codes, so in case you'll have to upload a new symbol for a yet absent language, you may stick to that convention.

These are already available:

[http://wiki.ttdpatch.net/img/wiki_up/GB.png]] GB - Great Britain

[http://wiki.ttdpatch.net/img/wiki_up/D.png] D - Germany

[http://wiki.ttdpatch.net/img/wiki_up/F.png] F - France

[http://wiki.ttdpatch.net/img/wiki_up/E.png] E - Spain

[http://wiki.ttdpatch.net/img/wiki_up/RUS.png] RUS - Russia

[http://wiki.ttdpatch.net/img/wiki_up/CZ.png] CZ - Czech Republic

[http://wiki.ttdpatch.net/img/wiki_up/GR.png] GR - Greece

[http://wiki.ttdpatch.net/img/wiki_up/NL.png] NL - Netherlands

[http://wiki.ttdpatch.net/img/wiki_up/H.png] H - Hungary

[http://wiki.ttdpatch.net/img/wiki_up/I.png] I - Italy

[http://wiki.ttdpatch.net/img/wiki_up/RO.png] RO - Romania

[http://wiki.ttdpatch.net/img/wiki_up/DK.png] DK - Denmark

[http://wiki.ttdpatch.net/img/wiki_up/S.png] S - Sweden

[http://wiki.ttdpatch.net/img/wiki_up/N.png] N - Norway

[http://wiki.ttdpatch.net/img/wiki_up/PL.png] PL - Poland

[http://wiki.ttdpatch.net/img/wiki_up/EST.png] EST - Estonia

[http://wiki.ttdpatch.net/img/wiki_up/SF.png] SF - Finland

[http://wiki.ttdpatch.net/img/wiki_up/P.png] P - Portugal

[http://wiki.ttdpatch.net/img/wiki_up/HR.png] HR - Croatia

[http://wiki.ttdpatch.net/img/wiki_up/TR.png] TR - Turkey

i.e., the flag symbol for English language is available as "http://wiki.ttdpatch.net/img/wiki_up/GB.png", etc.

Well, and now ... don't hesitate to feed the Dictionary!

PlantManyTrees

2011-06-14T01:10:15Z

Hgnmu128: Reformat

'''Plant a rectangular area of trees'''

==Switch==

Configuration file: plantmanytrees

Command line: -Yp

==Description==

It is a bit switch. To find out how that works, see [[BitSwitches|Bit Switches]], or simply add up the values of the options you want:

||Bit|Value|Name|Meaning

0|1|morethanonepersquare|Allow adding trees to a tile

1|2|rectangular|Plant rectangular area with Ctrl

2|4|morethanonerectangular|Rectangular planting adds trees to tile||

The first option allows you to plant trees on a tile which already has trees. However, currently this does not impress the local authority; for that you need to plant trees on empty tiles. Also, the new trees have to be fully grown (due to an  internal restriction of TTD), so they cost more.

The second option allows you to plant a large rectangular area with trees. First, you plant a tree in one corner of the rectangle. Then you hold down Ctrl, and plant a tree in the opposite corner of the rectangle. Now all empty fields in the rectangle will be filled with trees. If the tree type is the same in both corners, the whole rectangle will be filled with that type of tree. If the tree types differ, the rectangle will be filled with random trees.

If you enable the third option, this rectangular planting will add trees to tiles which contain trees already, whereas otherwise it only plants on empty tiles.

This patch was contributed by Csaba Varga.

StyleGuide

2011-06-14T00:24:52Z

Hgnmu128: Added redirect

#REDIRECT [[Manual of Style]]

Main Page

2011-06-14T00:17:15Z

Hgnmu128: Style edits, link corrections etc.

{| cellspacing="0" class="mainpagetable" align="center" style="background-color: #FFFFFF;" style="border: 1px solid #C0C090;"
|- valign="top"
|colspan="2" style="background-color: #F8EABA;text-align:center;"|
<center>
'''Welcome to the TT-Wiki!'''

Welcome to the TT-Forums Wiki. This wiki aims to be the one stop for TTD players, veteran and beginner alike. It will eventually contain guides to the smallest things, such as building your first train line, and purchasing your first locomotive. That's the theory at least - it's still quite the work in progress!
</center>
|- valign="top"
|colspan="2" style="border-bottom:1px solid #C0C090; background-color: #F8EABA;text-align:center;"|
<center>
'''[[TT Meet 2011]]''' 
Initial planning for the TT Meet of 2011 in '''Manchester, UK'''

'''Other pages''' 
This wiki is currently being redesigned to incorporate the [[TTDPatch]] wiki. You can also find the [[NewGRF]] specifications [http://newgrf-specs.tt-wiki.net/ on their own wiki].
</center>
|- valign="top"
|width="50%"|
<center>'''Contribute''' </center>
Please help us make this a definitive [[Transport Tycoon]] related wiki. Read the '''[[Manual of Style]]'''  and '''[[LocalStyleGuide]]''' before editing. See the [[TTWiki:Requested Articles|Requested articles]] page to request an article or fulfill a request.

Please do any experimentation in the [[TTWiki:Sandbox|Sandbox]], or create a Draft page under your user name, for larger projects.

'''NOTE:''' Unregistered users can no longer edit pages, due to significant amounts of spam being posted. If you wish to edit pages, please register.

|width="50%"|
<center>'''Read''' </center>
To begin, search for a term in the search box on the left, or see [[TTWiki:Searching|Searching]]. Alternatively, use the [[Special:Randompage|Random page]] feature and follow article links.

If you're interested in real-life meet-ups of TT-Forums members, check out the [[:Category:TT Meets|TT-Forums meets]]!

If you're interested in Locomotion, there is a [[Loco:Main_Page|Locomotion Wiki]].

|}

==TTDPatch Wiki==

Content authors please read the [[LocalStyleGuide]] to make sure that your work fits in and is useful. If you're looking for something to do, check out the [[ThingsToDo]].

==Welcome==

Hi!

This is the wiki for [[TTDPatch]], an unofficial gameplay-enhancing and bug-fixing patch for the game Transport Tycoon Deluxe, written by Chris Sawyer. TTDPatch was originally written by Josef Drexler, but today we have a whole Patch Team working on it! For something bleeding-edge from the individual members, check out their Patch Versions (NB: These may not be more recent than the latest official builds)

If you don't know what a Wiki is, ask [http://www.wikipedia.org/wiki/Wiki Wikipedia]. Basically, it's a documentation system where anyone can contribute and add new content.

What can you find here? The main focus at the moment are
* The TTDPatch [[Manual]]
* [http://wiki.ttdpatch.net/tiki-list_faqs.php The FAQs]
* various [[Tutorials]]
* ways of running [[TTDonLinux|TTD on Linux]]
* information about the '''Extended Cargo Scheme ([[ECS]])''' and George's implementation of ECS vectors
* the [[RailwayDictionary]] for newgrf set authors

The NewGRF specifications can now be found [http://newgrf-specs.tt-wiki.net/ on their own wiki].

Hopefully, this wiki will soon get filled with all sorts of useful information about TTDPatch (and Transport Tycoon, of course), but if you can't find what you're looking for here, try looking at [http://www.tt-forums.net/ The Transport Tycoon Forums], which also hosts the official forums for [[TTDPatch]].

If you're looking for a specific page, try the [[List of pages]] (you can search for a page name there too).

If you register and login, you can create new pages, and edit existing pages to add more content. When registering, the email address is optional but useful to have the password sent to you if you forget. The address won't be shown to anyone else unless you enable that in your profile.

Hint: to create new pages, link to them somewhere, then click on the link to edit them. The best way of creating links is through using WikiWords, i.e. RunningWordsTogether. The name should make sense when read in and out of context. You can use the SandBox to play with and test how things work, even without having to register. This feature can be especially useful if you are making a considerably long article from scratch and do not want the article page until it is (almost) finished.

Have fun!

LocalStyleGuide

2011-06-14T00:06:51Z

Hgnmu128: Style edits, corrected links, added

=Local Style Guide*=

===Use of '''Preview'''===

ALWAYS, and we mean '''ALWAYS''', use the Preview feature to check on your edits before committing them. Do lots of edits and then save, not lots of saves while you edit.

To find out what markup you can use in addition to the stuff available from the sidebar and [[Help:Editing|Editing help]]  when editing, see the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet] page for now, which is the MediaWiki syntax and formatting help page. New pages specific to [http://www.tt-wiki.net/wiki/Main_Page The Transport Tycoon Wiki] will be created and linked in the nick of time.

===Use of the Summary field===

When editing a page, put something helpful in the "'''Summary'''" field (when you go to make an edit, it's directly beneath the big edit box - see?) to make it easier for all concerned to see who did what at-a-glance. The idea for the comments list is that someone can look at a version comment, and establish '''without''' having to look at individual diffs and comparisons to see what changed between versions. It also facilitates transparency, one of the reasons why Wikis even exist.

Examples of useful comments:

<pre>Fixed some typos. (Tells us what you did)

Expanded upon first paragraph. (Tells us where you did it)

Removed obsolete information about Thisthat & Theother, plc. (Does exactly what it says on the tin)

Updated revision dates. (Brief, but hopefully there won't be much of those on the given page to be updated)</pre>

Examples of not-so-useful comments:

<pre> (Empty comment - people have to check the diffs for each version)

Written by xyz. (You don't say? It's not as if the "history" list already shows who wrote it ...)

Added more information. (Oh, well isn't that helpful? Tells everything doesn't it?)</pre>

Be warned -- if you do not include a useful comment with an edit, that page may be rolled back and your edit UNDONE.

<nowiki><nowiki>* Not inspired by the author's use of TeX. Honestly ...</nowiki></nowiki>

DrawingSprites

2011-06-13T23:50:11Z

Hgnmu128: Style edits, corrected links etc.

'''''How to draw new sprites'''''

'''NOTE TO AUTHORS''': Read the [[LocalStyleGuide]], otherwise the page is rolled back to the last well-commented edit.

To write:

- how to work with PCX and palettes

- efficient pixel editing

- working with TTD's special colours (link to other pages?)


==Introduction==

===Ratios===

First step, you have to do when are starting to draw a new graphics is to determinate its' size. You have to remember, that TTD uses non-proportional graphics and you have to somehow fit in with you graphics. You have to decide, what sizes you use. For example, my long bus is longer, than a big house. In reality, the bus is 12-15 meters, a big house is at least 50 meters, but in TTD scale houses are diminished in comparison with road vehicles.

===Limitations===

Some objects are size limited. For example, train cars. The game hard codes their sizes. TTDPatch allows you to make them shorter, but not longer. The same problem is with buildings, industries. You can draw sprites larger, than intended, but it leads to the graphical glitches. Long vehicles, for example, have glitches in tunnels, on slopes, bridges. Decide, what glitches are you ready for. If you want no glitches, you have to fit the size of the default objects.

{img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/toowidebankglitch.png</nowiki> width= height= align= desc= link= }

===Scale and proportions===

To make sure your graphics look good, you need to make it self-proportional. Additionally, you need to keep proportions to always nearby units, for example, wagons and trains have to be proportional. Remember, objects with graphics size limitations have different proportions in different directions, you have follow them.

A useful thing, that can help you, is a scale. When you know the size of the object, you draw, you can select the best scale and draw elements in it. It makes the graphics look right. For long vehicles I use 3.3 pixels per meter scale. For diagonal view I use the factor of 0.(6) for 0X projection and 0.(3) for 0Y projection. Zoom uses 2.5 pixels per meter, but traces it bad (for example, 12 meter MAZ-103 lost 3 pixels in horizontal direction). Be careful. Michael Blunk uses 1.58 px/m scale for DB set trains in horizontal direction, because the trains graphics limitations. In perspective view he uses 1.333 ratio (that has to be 1.4 by ISO, but due TTD limitation it is not).

==Tutorial==
===Step 1. Dimensions===

Now, when you've chosen the size of you graphics, draw the simple dimensional box to fit your graphics it. Put him the primary colors to specify the right colors allocation. If your object consists of several parts, make the base blocks for all of them. It can be also a cylinder, sphere ore some other geometrical object. It is required to make you fill your object better.

{img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/pic3.png</nowiki> width= height= align= desc= link= }

===Step 2. Textures===

The next step is to paint your blank into the real object. You can draw over the blank or cut parts of the existing graphics and put them over the blank - up to you.

''Example''

Having the specification sizes (Dimension: Length 11162mm, Width 2450mm, Height 3376mm) and selected scale ration (3.3 in case of long vehicles), we got the blank base box for drawing textures. The box has the size of 37px '''x''' 8px '''x''' 11px

Now we need some prototypes for textures. The good solution is to have side photos of the object, you are currently drawing. I usually use both side views, front and rear view, and some diagonal views for better filling of the proportion.

{img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/texthelp3.png</nowiki> width= height= align= desc= link= {img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/texthelp4.png</nowiki> width= height= align= desc= link= {img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/texthelp5.png</nowiki> width= height= align= desc= link= {img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/texthelp2.png</nowiki> width= height= align= desc= link= }

The next step is to place main allocation objects, which will be used to allocate other objects. Usually, I use wheels and doors for this aim. For good allocation of the base objects I use the following method:
# select the good photo for the side, I'm drawing
# calculate the aspect ratio between the base box and photo. Here, the ratio of 0.0984, because 37px (the base box length) divide 376px (the photo length)
# the location of any object can be calculated from the photo's object's position by multiplied to the ratio. Here, the door ends at 3.5 pixels from the front, because 36px multiplied by 0.0984

The same way I calculate all the required positions and get the first iterating.

After that I draw all the side views, depending on the positions of the default objects.

When I made all the side views, I start to draw diagonal views. If you have a box style object, for example, a bus, you can use a little automation to save your time.

'''Note:''' ''Do not use this way for rounded objects. For example, it did not work with Spitzer Colani.''

The batch cuts and moves parts with specific diagonal ratio. I have an easy one of 1.5, but the script can be made for any one. The macros gives prototypes for side parts of diagonal view. Because of the ratio of 1.5, there are only 3 basic prototypes can be generated. Then I have to select the best one.

{img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/text5.png</nowiki> width= height= align= desc= link= }

After that I compile the parts and fix the place of their connection.

The next step is adding the roof.

===Step 3. Effects (lights, shadings, decoration)===

Now you have to make your graphics nice. You have to put shades, add the effects, the small decoration elements (stickers, inscriptions, lightings). Make you graphics shining.

{img<nowiki>src=http://george.zernebok.net/graphicstutorial/img/pic6.png</nowiki> width= height= align= desc= link= }

===Step 4. Convergence===

If you have the independent graphics, you work is done. But if your graphics is part of picture, you need to check it with the other. In most cases you'll need to fix it a little for better conformity of the graphics and a good graphics balance.

==External links==
Tutorial: Drawing new graphics
[http://george.zernebok.net/graphicstutorial/ Tutorial: Drawing new graphics] by [http://www.tt-forums.net/memberlist.php?mode=viewprofile&u=1077 George]

OwenRudge

2011-06-13T23:39:10Z

Hgnmu128: Removed heading. Redundant.

Owen Rudge has been a fan of the TT games since 1998, and has written a number of tools for the game. He currently owns and maintains [http://www.owenrudge.net/TT/ttdalter TTDAlter 4.x], [http://www.owenrudge.net/TT/ttsgm Transport Tycoon Saved Game Manager], [http://www.owenrudge.net/TT/ttdxedit TTDX Editor], as well as several web sites, including [http://www.owenrudge.net/TT/ Owen's Transport Tycoon Station], [http://misc.owenrudge.net/ttgame/|The Ultimate Transport Tycoon Game Repository] and [http://www.tt-forums.net/ The Transport Tycoon Forums]. He is also an operator on [[TheIrcChannel]].

OwenRudge

2011-06-13T23:38:46Z

Hgnmu128: Style edits. Corrected link pipes.

'''''Owen Rudge'''''

Owen Rudge has been a fan of the TT games since 1998, and has written a number of tools for the game. He currently owns and maintains [http://www.owenrudge.net/TT/ttdalter TTDAlter 4.x], [http://www.owenrudge.net/TT/ttsgm Transport Tycoon Saved Game Manager], [http://www.owenrudge.net/TT/ttdxedit TTDX Editor], as well as several web sites, including [http://www.owenrudge.net/TT/ Owen's Transport Tycoon Station], [http://misc.owenrudge.net/ttgame/|The Ultimate Transport Tycoon Game Repository] and [http://www.tt-forums.net/ The Transport Tycoon Forums]. He is also an operator on [[TheIrcChannel]].

UnReservePBSTrack:alpha

2011-06-13T23:36:42Z

Hgnmu128: Style edits

'''''Unreserve PBS reserved tracks on sign tile'''''

This sign cheat was introduced in TTDPatch 2.6 alpha 0 r1725.

==Usage==

Cht: ))UnReservePBSTrack[[]]UnReservePBSTrack[[

==Description==

This sign cheat unreserves any and all PBS-reserved track pieces on the current tile.

The purpose of this cheat is primarily for track reservation errors, where an isolated track piece has been left reserved, which subsequently blocks the affected track piece indefinitely, unless a train is ordered to ignore signals, which is highly unsafe, or if the affected tile is totally demolished and rebuilt, which is not always feasible, or desirable.

This typically occurs during a train crash clear-up, during certain types of reversing manoeuvres, or other abnormal train movement.

Supported tile types currently include: track, level crossings, PBS signals, tunnel entrances (and enhanced tunnel track), and track under and on bridges.

This cheat should be used with caution, as improper usage may result in train crashes.

UnReservePBSTrack:alpha

2011-06-13T23:36:11Z

Hgnmu128: /* Unreserve PBS reserved track */

'''''Unreserve PBS reserved tracks on sign tile'''''

'''Unreserve PBS reserved track'''

This sign cheat was introduced in TTDPatch 2.6 alpha 0 r1725.

==Usage==

Cht: ))UnReservePBSTrack[[]]UnReservePBSTrack[[

==Description==

This sign cheat unreserves any and all PBS-reserved track pieces on the current tile.

The purpose of this cheat is primarily for track reservation errors, where an isolated track piece has been left reserved, which subsequently blocks the affected track piece indefinitely, unless a train is ordered to ignore signals, which is highly unsafe, or if the affected tile is totally demolished and rebuilt, which is not always feasible, or desirable.

This typically occurs during a train crash clear-up, during certain types of reversing manoeuvres, or other abnormal train movement.

Supported tile types currently include: track, level crossings, PBS signals, tunnel entrances (and enhanced tunnel track), and track under and on bridges.

This cheat should be used with caution, as improper usage may result in train crashes.

ChangeSemaphores

2011-06-13T23:33:02Z

Hgnmu128: /* Usage */

'''''Change to or from semaphore signals'''''

==Usage==

Cht: Semaphores 0/1 <nowiki>[tracktype]</nowiki>

==Description==

This sets all signals to be light signals (if 0) or semaphores (if 1). Optionally you can restrict the conversion to the given track type. Note that to see the semaphores, the "semaphores" option has to be turned on and you must have loaded the semaphore graphics.

ChangeSemaphores

2011-06-13T23:32:37Z

Hgnmu128: Style edits

'''''Change to or from semaphore signals'''''

==Usage==

Cht: Semaphores 0/1 <nowiki><nowiki>[tracktype]</nowiki></nowiki>

==Description==

This sets all signals to be light signals (if 0) or semaphores (if 1). Optionally you can restrict the conversion to the given track type. Note that to see the semaphores, the "semaphores" option has to be turned on and you must have loaded the semaphore graphics.

CompilingTTDPatchOnLinux

2011-06-13T23:30:24Z

Hgnmu128: Style edits

'''''How to compile TTDPatch on Linux'''''

This page tells you what you need to do to compile TTDPatch on Linux. This won't make actual Linux binaries, so you still need to run it through Wine or VMWare or similar. However, it makes it possible to do all the development work without having to boot Windows.

First of all, get the sources for TTDPatch 2.0.1 alpha 49 or higher. The Makefile included with older versions isn't set up to support cross compiliation on Linux.

When you're ready, edit Makefile.local (make will create it on first run if you don't have one yet) to use the following definitions:

<pre>-+WINCC = CROSS+-

-+HOST = INTEL+-</pre>

After that, it should automatically use the right compiler and settings. If your mingw32 is not 3.4.0 or higher, you'll also have to uncomment the last line that changes -mtune to -mcpu (but make sure it changes CFLAGS-CROSS not CFLAGS-CYGWIN). Finally, if you don't have the upx executable packer, uncomment the NOUPX line.

==Part 1 - Compiling the Windows version of TTDPatch==

===If your distribution has a mingw32 gcc cross compiler===
#Install the mingw32 gcc cross compiler together with the corresponding binutils and runtime. E.g. on debian-based distros, try "apt-get install mingw32 mingw32-binutils mingw32-runtime".
#The patch Makefile assumes that this compiler is called i686-pc-mingw32-gcc. If it has a different name (try "-+find /usr -name \*mingw32\*gcc+-" to find out), you need to edit the Makefile
**For patch sources 2.5 beta 2 or higher, define the compiler prefix in Makefile.local. This should be the filename you found above minus the -gcc part. The following example works for Ubuntu:

++<pre>-+CROSS-PREFIX = i586-mingw32msvc+-</pre>
**For patch sources before 2.5 beta 2, you need to change Makefile.setup: modify all occurences of "i686-pc-mingw32" to match your compiler prefix.

===If you don't have a mingw32 gcc cross compiler===

If your distribution doesn't comes with one, the following instructions tell you how to make one. They assume that you already have a working mingw32 compiler from the cygwin suite, or at least the mingw32 headers and runtime libraries.

If you don't have Cygwin installed, you can just download the packages "w32api" and "mingw-runtime" from a Cygwin mirror and install them manually. In that case, use these packages instead of files from /mnt/d/cygwin below. (This is just a shortcut to avoid having to compile the runtime and libraries as well.)
# this assumes you have cygwin installed in /mnt/d/cygwin and the TTDPatch source tree in /mnt/d/ttdpatch, and that the cross compiler will be installed in /usr/i686-pc-mingw32 with executables in /usr/bin having an i686-pc-mingw32 prefix. Modify as appropriate.
# get the GNU binutils source, unpack, change to source dir; it needs to be a version no older than 2005 for correct linking of the Windows executables
# configure, compile and install (for the latter you probably need to be root or use sudo):

+ <pre>~pp~./configure --prefix=/usr --target=i686-pc-mingw32

make

make install

~/pp~</pre>
# setup the includes and libraries for mingw32 from your cygwin installation

+ <pre>~pp~cd /usr/i686-pc-mingw32

mkdir -p include sys-include lib

cp -a /mnt/d/cygwin/usr/include/mingw/* include

cp -a /mnt/d/cygwin/usr/include/w32api/* sys-include

cp -a /mnt/d/cygwin/lib/mingw/* lib

cp -a /mnt/d/cygwin/lib/w32api/* lib

~/pp~</pre>
# get the gcc-core source, unpack, change to source dir. (I used gcc-core-3.4.1-1-src.tar.bz2 from the cygwin archives, untared it, untared the gcc-core-3.4.1.tar.bz2 contained but didn't apply the patch)
# compile it, pick the same prefix as above obviously:

+ <pre>~pp~./configure --prefix=/usr --target=i686-pc-mingw32

make

make install~/pp~</pre>
# put the nasm executable distributed with alpha 50 or higher in your path before any other nasm executables (or overwrite any existing ones in /usr/bin or wherever it is). If this doesn't work for you e.g. due to library incompatibilities, get the nasm sources (0.98.39 or higher), unpack, change to the source dir
** install the TTDPatch nasm patches

++ <pre>-+zcat /mnt/d/ttdpatch/nasm/*.gz|patch -p1+-</pre>
** compile nasm:

++ <pre>~pp~./configure --prefix=/usr

make

make install

~/pp~</pre>
# make sure the patch Makefile.local has WINCC set to LINUX (default is CYGWIN) and set the HOST as appropriate to INTEL or PPC depending on the CPU of the computer you're compiling on
# now try compiling the patch with

+ <pre>-+make allw+-</pre>
Please [http://www.ttdpatch.net/email.php?Compiling%20on%20Linux report] any problems, errors or other difficulties so I may update and improve these instructions

==Part 2 - Compiling the DOS version of TTDPatch==

This can be done by building the ))OpenWatcom[[]]OpenWatcom[[ compiler for Linux. ))OpenWatcom[[]]OpenWatcom[[ automatically supports all targets, so you just build it as a regular compiler. Here are the steps that worked for compiling ))OpenWatcom[[]]OpenWatcom[[ 1.4 on Linux.
# get the .tar.bz2 version of the latest [http://www.openwatcom.org/ftp/source/ OpenWatcom source], and unpack it. (note, you'll need about 400-500 MB space to compile it)
# run the compiler bootstrap

+ <pre>-+. build.sh+- (if that doesn't work, try -+./build.sh+-)</pre>
# build the rest of the stuff we need and copy to rel2:

+ <pre>~pp~. setvars.sh

cd clib

builder rel2

cd ../mathlib

builder rel2

cd ../emu86

builder rel2

~/pp~</pre>

+ building the clib takes a while, there should be a way to make only the libs for a certain target system but I couldn't figure it out
# copy the binaries, headers and libraries:

+ <pre>~pp~cd rel2

cp -a binl binw h lh lib286 /usr/local/openwatcom

~/pp~</pre>
# copy setvars.sh to /usr/local/openwatcom/setvars and edit these:

+ <pre>~pp~export OWROOT=/usr/local/openwatcom

export WATCOM=$OWROOT

export LIB=$OWROOT/lib286

export INCLUDE=$OWROOT/h

~/pp~</pre>

+ leave the rest as they are
# test that you can compile TTDPatch now

+ <pre>~pp~. /usr/local/openwatcom/setvars

make alld

~/pp~</pre>
# if everything works you can remove the ))OpenWatcom[[]]OpenWatcom[[ source directory, or run

+ <pre>~pp~cd bld

builder clean

~/pp~</pre>

+ to clean up everything you don't need, which saves about 200-250 MB.
Please [http://www.ttdpatch.net/email.php?Compiling%20on%20Linux report] any problems, errors or other difficulties so I may update and improve these instructions

Now that you can compile the DOS patch, you also need to actually be able to run it, in order to generate memsize.h. This file needs to be correct when distributing the DOS patch, so that the patch knows when it needs to swap out, and when not memory is available to run TTD safely.

It does this by running the patch, and then the patch itself runs the DOS command mem.exe to display the size of ttdpatch.exe in memory.

It's easy to manually do this every time by getting ttdpatch.exe to run in VMWare, dosemu or dosbox, and manually enter the required commands to recreate memsize.h:
* within DOS: <pre>-+ttdpatch -!t-m-f-s-c mem.exe /c > mem.out+-</pre>
* within your development environment: <pre>-+perl perl/memsize.pl < mem.out > memsize.h+-</pre>

However, it's also quite possible to automate this using dosemu. This is probably a good idea if you have dosemu working anyway, and are going to compile the DOS version more than once. Here's what you do:
* to get this working, you first need a working installation of [http://www.dosemu.org/ dosemu]. Make sure it is able to run mem.exe, and that a drive where ttdpatch.exe can be found is mounted within dosemu.
* get dosemu to run the commands given on the dosemu command line. I did it by adding the following at the end of autoexec.bat:

+ <pre>~pp~unix -e

if not errorlevel 1 exitemu

~/pp~</pre>

+ (if no -E commands are given, this will display an error message and return to the DOS prompt, else the emulator will exit after running the command)
* create a batch file called ttdpatch.bat somewhere in the DOS PATH, with the following contents:

+ <pre>~pp~d:

cd \ttdpatch

shift

ttdpatch %0 %1 %2 %3 %4 %5 %6 %7 %8 %9 > ttdpatch.out

~/pp~</pre>

+ this assumes that your patch development directory is accessible as "d:\ttdpatch" in dosemu
* now try running it, to test that everything works

+ <pre>-+dosemu -E "ttdpatch -h"+-</pre>

+ this should put the TTDPatch help output in /mnt/d/ttdpatch/ttdpatch.out; if it does not, fix whatever is wrong
* now create a shell script called "dos", and put in it the following lines:

+ <pre>~pp~
#!/bin/sh

dosemu -dumb -E "$*" < /dev/null &> /dev/null

cat /mnt/d/ttdpatch/ttdpatch.out

rm /mnt/d/ttdpatch/ttdpatch.out

~/pp~</pre>

+ this calls dosemu, has it execute the command line given to it, discards all output from dosemu but replays the output of the command that was put in /mnt/d/ttdpatch/ttdpatch.out
* make sure the WINDIR environment variable (for make) is set such that $WINDIR/command/mem.exe points to mem.exe in dosemu, for example set it to "d:" and put mem.exe in d:/command/.

Now, after making a DOS executable for distribution (e.g. "make DEBUG=0 remake dos"), delete memsize.h and run "make memsize.h". This should, hopefully, invoke the above script, thus calling ttdpatch.exe within dosemu and capturing its output, which is then parsed by a Perl script to produce memsize.h. Then make a final pass of "make DEBUG=0 dos" to recompile dos.c with this new size information.

AutoSlope

2011-06-13T23:25:01Z

Hgnmu128: /* Switch */

'''''Enable automatic foundation construction while landscaping'''''

'''TTDPatch 2.0.1 alpha 63 or later'''

==Switch==

Configuration file: autoslope on|off|<cost>

Command line: N/A

==Description==

Normally, it is not possible to raise or lower land on which for example rail tracks have been built. With this switch, it becomes possible to do this, and it will automatically add or remove foundations as possible. The only limitation is that the new land shape must be suitable for the objects that are built on the tile, i.e. the foundations must be possible to build for the new shape.

<cost> may be 1(default), 2, or 3, and is the cost multiplier.

This feature was contributed by Oskar Eisemuth.

AutoSlope

2011-06-13T23:24:45Z

Hgnmu128: /* AutoSlope */

NewNetworkProtocol

2011-06-13T23:19:45Z

Hgnmu128: Style edits

'''''Specifications of the new asynchronous Network Protocol'''''

Instead having a DirectX based network system, we use a dedicated Server.

The Server component is only responsible to broadcast messages between the Clients so all TTDPatch Clients work in sync. Unlike traditional TTD, network joining will work while the first player is already in a game, the other players will get synced.

Both Server and Client have a framecounter, every action will take place at a certain framenumber.

A client sends actions to the server, which then decides at what frame the action on a client should take place. (The client doesn't cache the data, so the server has to send the data back.) The server is as well responsible to initiate a client sync and as well check the random gen number of the clients from time to time, if they are in sync, if not the server initiate a sync.

A client will only advance to the next frame if the server sends a heartbeat packet.

The heartbeat packet is created every 27ms, at a configurable duration the heartbeat packet with randomgen request is send, a client then has to answer with a random gen number package and the server checks each active client if the random number matches with the other client.

Note: The action data for a frame has to arrive directly before the heartbeat package for that frame number.

==Packets==

A network packet has a variable length and is always in little endian format.

Each package start with:

'''<u32 framenumber> <u8 type>'''

'''Gamestate Packets:'''

||'''Type'''|'''Name'''|'''Description'''|'''Following Data'''

0x01|Action Data|The raw action data of ttd follows| <u8 len> <u8 data*len>

0x02|Action Data End Marker|Send after all actions of this frame got send|-||

'''Service Packets:'''

||'''Type'''|'''Name'''|'''Description'''|'''Following Data'''

0x30|Heartbeat|Send by the server to a client| -

0x31|Heartbeat with rnd request|with additional requesting a random number|-

'''Syncing'''

0x40|Random gen value|Answer to packet 0x31|<u32 random>

0x44|Get sync package|Request by the server to get the Gameplay data|-

0x45|Sync Package|Gameplay (Savegame) data|<u32 len> <u8*len of gamedata>

0x46|Sync heartbeat|Only send when a client gets resyced|-

'''Server Management'''

0x80|Quit Server|Quits the server application|<u8*16 server password>

0x81|KickBan|Kicks the player x from the server and deny reconnection|<u8 playerslot> <u8*16 server password>

0x82|Kick|Kicks the player x from the server|<u8 playerslot> <u8*16 server password>

'''Client connect'''

0xF0|Server Password|Sends the server password to join|<u8*16 server password for joining>

0xF1|Free Slot Messages|Server shows current slots|<u32 len of following data> <u8 free slot mask> <u8 password mask> <zero terminated strings follow for all player slots>

0xF2|Set Player Slot|Client requests a player|<u8 player slot to use> <16x u8 password> <u8 len of string> <string: Name> <00>

Password is filled with zero to match 16 Bytes, all zero means no password.

0xF3|Player Accepted|If the slot is free and the password is right

0xF4|Player Not Accepted|If there is an error, slot not free|<u16 error id>

0xF5|Newgrfmap|A map of used grfs|<u32 len of following data> Pairs of <u8*16 md5sum> <string: newgrf filename> <0x00> <string: grf name> <0x00>

0xFF|Connect Error|Sends an error to the client|<u16 error id>||

==Client connecting to server==

Each connecting has some kind of identifier, the document calls it connection id.

After a client connects, it's in the handshake phase.

The client sends hard coded string, "TTDPATCH" + <u32 version of TTDPatch>

If the server doesn't get this string in 30secs after a established connection, it closes the connection.

The server then answers with "TTDPATCHSERVER" + <u32 serverversion> + <u16 error id>

If there is an error, this means an error id <> 0, the server will terminate the connection.

The server now accepts service packets in the range 0xF0 till 0xFF.

The server sends now it's current newgrfmap via packet 0xF5, if it's the first client, this will be simple a empty map, with the length of 0.

The client sends it's own newgrfmap (0xF5) to the server or terminates the connection.

The server may now send 0xFF Connect error to the client and disconnect if the newgrfs of the client don't fit.

The server sends a free slot message (0xF1) telling the client what Player slots are free.

Each free Player Slot sets the bit field, if a player slot has a password, it sets the password bit field.

As soon as the server receives a Set Player Slot (0xF2) it checks the password if it matches,

and sends (0xF3) if it matches or (0xF4) if it's wrong.

If there is already a game, the player will now get synced,

otherwise the connection id will be set for this the player slot.

==Syncing on the server==

The connection id will removed from the player slot.

The server broadcasts a Slot (0x44) message to all other player slots with a framenumber.

All Action Data a server transmits will be recorded now.

The server waits to get a (0x45) Sync Package, this will be transmitted to the new/re synced client.

Additional all ActionData will be transmitted with sync heartbeats (0x46, no 27ms wait) up to the framenumber.

The connection id will be restored from the player slot.

==Heartbeats on the server==

If the heartbeat is enabled, every 27ms:

Server Framenumber is increased.

If there is closed buffered action date , in all buffered packets the framenumber will be set to the new server Framenumber.

The buffered data is broadcasts to all player slots.

A heartbeat package will be send, every 100 heartbeat packets the Heartbeat type 0x31 is used, otherwise 0x30.

If heartbeat 0x31 is used, every player with a connection id has to send the random gen value (0x40) for the framenumber that 0x31 specified. The server looks if there is one client which has a different value. If a client has a different random gen value, it needs a re sync.

==Server receives Data from Client==

It stores the Action Data (0x01) packages in a buffer until it reaches an end of action data marker (0x02). It then closes the buffer so it can be send by the heartbeat part.

==Clients==

A client sends player Action Data with it's current frame number but doesn't execute this Action Data. If a frame ends and there was Action Data send, it sends an 0x02 message to indicate the end.

Instead doing the 27ms wait, it checks for the next heartbeat, sync or action data packet.

If it receives an 0x45 sync package, it will load the gamedata.

If it receives a get savegame message, it will create an 0x45 sync package.

As soon as the Heartbeat package arrives, the remaining time for 27ms wait will be waited if it's an normal heartbeat package otherwise (a 0x46 package) there is no wait , the frame gets executed and all received action for this frame number will be applied.

It will send the random gen number if the heartbeat package was 0x31.

If there is no heartbeat package in the network timeout, the connection is lost.

==Client leaves the server==

The server removes the connection id from this player slot.

==Error id==

0x0000 = means no error

Manual of Style

2011-06-13T23:10:02Z

Hgnmu128: /* Updating pages from TTDPatch Wiki */

Welcome to the TT-Wiki '''Manual of Style'''. Here you can learn what style to use when editing articles.

==Updating pages from TTDPatch Wiki==

Pages imported from the TTDPatch Wiki will often be in bad shape. In tidying them up, we recommend the following actions be taken:

* Remove the "strapline" (typically the first line) which was used in TikiWiki for a page description. This is generally redundant.
* Remove the page header. Again, this is redundant.
* Replace any instances of "&nbsp;" or "&quot;" with normal spaces and quotes, unless required for formatting reasons.
* Migrate wikicode.
* Add categories (typically, add all pages to the TTDPatch category, and add a general category for each section (e.g., Introduction, Usage, Patches, etc)
* Fix links - TikiWiki would automatically wikify CamelCase links. We have to explicitly create links. All links with a text similar to [http://www.tt-wiki.net] should have their own link text, not a sequential Wiki-generated link ID. [Please not that outside links and text to be displayed are seperated by a space (0x20), whereas links within the Wiki and the link text are seperated by a pipe (0x7c).]

In the future, the intention will also be to mass rename pages to remove the ugly CamelCase. It'll be easier to do it all at once and send a bot to go and rename all the links, though, rather than trying to do it manually.

For more complex pages, you may wish to use [http://devs.openttd.org/~planetmaker/patches/fixwiki.sh this script] with [http://devs.openttd.org/~planetmaker/patches/wikised this data file] to try to tidy up the page first.

Always compare the page against the original page on the [http://wiki.ttdpatch.net/ old wiki] to ensure all content is transferred. Pictures will need to be re-uploaded.

Ideally it'd be good to add some better navigation features to manual pages, similar to those you may see on Wikipedia or the OpenTTD wiki (infoboxes, etc).

Manual of Style

2011-06-13T23:09:08Z

Hgnmu128: /* Updating pages from TTDPatch Wiki */

Welcome to the TT-Wiki '''Manual of Style'''. Here you can learn what style to use when editing articles.

==Updating pages from TTDPatch Wiki==

Pages imported from the TTDPatch Wiki will often be in bad shape. In tidying them up, we recommend the following actions be taken:

* Remove the "strapline" (typically the first line) which was used in TikiWiki for a page description. This is generally redundant.
* Remove the page header. Again, this is redundant.
* Replace any instances of "&nbsp;" or "&quot;" with normal spaces and quotes, unless required for formatting reasons.
* Migrate wikicode.
* Add categories (typically, add all pages to the TTDPatch category, and add a general category for each section (e.g., Introduction, Usage, Patches, etc)
* Fix links - TikiWiki would automatically wikify CamelCase links. We have to explicitly create links. All links with a text similar to [http://www.tt-wiki.net] should have their own link text, not sequential Wiki-generated link number. [Please not that outside links and text to be displayed are seperated by a space (0x20), whereas links within the Wiki and the link text are seperated by a pipe (0x7c).]

In the future, the intention will also be to mass rename pages to remove the ugly CamelCase. It'll be easier to do it all at once and send a bot to go and rename all the links, though, rather than trying to do it manually.

For more complex pages, you may wish to use [http://devs.openttd.org/~planetmaker/patches/fixwiki.sh this script] with [http://devs.openttd.org/~planetmaker/patches/wikised this data file] to try to tidy up the page first.

Always compare the page against the original page on the [http://wiki.ttdpatch.net/ old wiki] to ensure all content is transferred. Pictures will need to be re-uploaded.

Ideally it'd be good to add some better navigation features to manual pages, similar to those you may see on Wikipedia or the OpenTTD wiki (infoboxes, etc).

TTDonLinux

2011-06-13T22:59:42Z

Hgnmu128: Edited links, Style edits, etc.

The most reliable ways of running TTD on Linux are
* The Windows version of TTD+TTDPatch using [http://www.winehq.com/ Wine]
* The DOS or Windows versions of TTD (with or without the patch) on [http://www.vmware.com/ VMWare Workstation 5.0]

If you have a method, or suggestion for a method, create it on a new page here on the wiki, and put a link to it down below in the relevant section (e.g. a method using WineX goes under WineX).

'''NOTE''': A method is classified as "'''Has Worked'''" if you know it works. It counts as "'''Working'''" once lots of other people have got it working.

==Wine==

'''Working''', requires 2.0.1 '''alpha 16''' or later

Wine versions up to 20041201 or after 20050531 (latest CVS snapshot) work. 0.9.2 may cause some issues with sound.

For details on getting it working, see [[TTDWineDave]]

==WineX/Cegeda==

'''Has worked''', but needs testing with recent alphas.


Methods under consideration:
* Using a binary package, for those willing to pay: [[TTDWinexHan]]
* Using CVS, for cheapskates like the author of this method: [[TTDWinexChris]] and [[TTDWineXOskar]]

Phil has some screenshots of successfully running TTDPatch Alpha 25 under WineX: [[TTDWinexPhil]]

==VMWare==
'''Working''', in [http://www.vmware.com/ VMWare Workstation 5.0]

Both the DOS and Windows versions work well. For the Windows version, disable the VMWare Tools and install a native mouse driver so that TTD can move the mouse cursor about. Otherwise right-click scrolling will be extremely sensitive.

==dosemu==

'''Has Worked''', with dosemu 1.2.1; tested with TTDPatch 2.0.1 alpha 51.

The patch is not needed, the game works fine without it too

If you do use the patch,
* Make sure to give dosemu lots of memory if you want to use the a fair number of new graphics sets (the default 16 MB is not enough).
* Deactivate the CPU saver feature: either set `-+miscmods.notimegiveaway on+-' or run the game with `-+ttdpatch --miscmods.notimegiveaway on+-'

==dosbox==

'''Has Worked''', using the dos version of ttd+patch

==Bochs==

Untested.

==ttdload==

This is a port of [[TTDPatch]] and the latest information suggests that it is not up-to-date (based on one of the pre-2.0 betas)

(Any word from the PatchTeam on whether this will be maintained along with DOS and Windows if it proves successful? - C.)

==LoadTycoon==

[http://pasky.or.cz/~pasky/dev/ttd|LoadTycoon LoadTycoon] is native loader for TTDX, originally done by Daniel Mantione, then shortly maintained by Petr "pasky" Baudis. It requires SDL and a native framebuffer and it does not support sounds, music and multiplayer.

LostVehicles

2011-06-13T22:47:01Z

Hgnmu128: MoS edits

'''''Give warning messages if vehicles are lost.'''''

'''TTDPatch 2.0.1 alpha 9 or later'''

==Switch==

Configuration file: losttrains on|off|<time>

Configuration file: lostrvs on|off|<time>

Configuration file: lostships on|off|<time>

Configuration file: lostaircraft on|off|<time>

==Description==

If can often happen that a vehicle becomes lost and is unable to find the station it is supposed to go to. For example, trains and road vehicles might be going in circles, or ships might get stuck in a bay and not find a way out.

With these switches, you can enable warning message for lost vehicles, that is, vehicles which haven't visited a station on their schedule in a given amount of time. You can set the amount of days for each vehicle type, with the default being 150 days for trains and road vehicles, 400 for ships and 60 for planes. Minimum value for <time> is 5, maximum 1000 days.

This feature was contributed by Csaba Varga.

GameSpeed

2011-06-13T22:44:51Z

Hgnmu128: /* Description */

'''''Allow for the game speed to be changed dynamically using keyboard hotkeys'''''

'''TTDPatch version 2.0.1 alpha 23 or later'''

==Switch==

Configuration file: gamespeed on|off|<speed>

Command line: -Yg

==Description==

This switch lets you change the speed of the game ingame, ranging from one-eighth of normal speed to as fast as your computer can run the simulation. It uses the [[MoreHotkeys]] mechanism to change the speed, so that switch must be enabled as well. Since TTDPatch 2.0.1 alpha 49, it takes an optional parameter <speed> that controls the initial setting, from -3 (slowest) to +3 (fastest).

By default you can use the "Q" key to slow the game down by a factor 2, the "E" key to speed up the game by a factor 2 and the "Q" key to reset the game to normal speed.

These keys can be changed to your liking using the `ttdptxt' mechanism described in [[MoreHotkeys]] and in [[CustomIngameTexts]]

If you have a ttdpttxt.txt file from an older version of TTDPatch, you have to change the "hotkeylistwin" line. Change the characters between the "x" and the "!" to be "qwe", for example change this:

<pre>-+hotkeylistwin="x !@#$t%1234567890-=`\\\00"+-</pre>

into this:

<pre>-+hotkeylistwin="xqwe!@#$t%1234567890-=`\\\00"+-</pre>

After this, run mkpttxt.exe again.

This feature was contributed by Sander van Schouwenburg.

GameSpeed

2011-06-13T22:44:04Z

Hgnmu128: MoS edits

'''''Allow for the game speed to be changed dynamically using keyboard hotkeys'''''

'''TTDPatch version 2.0.1 alpha 23 or later'''

==Switch==

Configuration file: gamespeed on|off|<speed>

Command line: -Yg

==Description==

This switch lets you change the speed of the game ingame, ranging from one-eighth of normal speed to as fast as your computer can run the simulation. It uses the [[MoreHotkeys]] mechanism to change the speed, so that switch must be enabled as well. Since TTDPatch 2.0.1 alpha 49, it takes an optional parameter <speed> that controls the initial setting, from -3 (slowest) to +3 (fastest).

By default you can use the "Q" key to slow the game down by a factor 2, the "E" key to speed up the game by a factor 2 and the "Q" key to reset the game to normal speed.

These keys can be changed to your liking using the `ttdptxt' mechanism described in [[MoreHotkeys]] and in [[CustomIngameTexts]]

If you have a ttdpttxt.txt file from an older version of TTDPatch, you have to change the "hotkeylistwin" line. Change the characters between the "!" and the "!" to be "qwe", for example change this:

<pre>-+hotkeylistwin="x !@#$t%1234567890-=`\\\00"+-</pre>

into this:

<pre>-+hotkeylistwin="xqwe!@#$t%1234567890-=`\\\00"+-</pre>

After this, run mkpttxt.exe again.

This feature was contributed by Sander van Schouwenburg.

Presignals

2011-06-12T23:25:05Z

Hgnmu128:

'''''An improved signalling technique for very efficient networks and stations'''''


==Switch==

Configuration file: presignals

Command line: -w

Configuration file: extpresignals

Command line: -Xw

==Description==

These switches introduce a new type of signal to TTD, the "pre-signal."  This signal is in some sense similar to an advance signal, but it's not quite the same. For a detailed description of how pre-signals work and in what cases they are useful, please see [[Presignalsdetailed|Pre-signals (detailed]]).

Note that you need to load -+signals.grf+- to be able to distinguish pre-signals from regular signals.  See [[NewGraphics|New Graphics]] for more details.

The idea of pre-signals is quite simple:  a pre-signal shows a green light if, and only if, one of the exit signals from the block behind it shows a green light.  This means that trains will only enter the pre-signal block if there is a green exit.  As a result, the block will only be entered for short times and trains will leave it immediately, allowing for a very efficient layout.  This is particularly useful for station  entrances, but can also be applied in other cases.

The presignals switch activates ''automatic'' pre-signal configurations. Using this options, your signals will be converted to pre-signals and pre-signal exits whenever a train enters a block that qualifies as an automatic pre-signal block.  For a definition of what this needs to look like, please see [[Presignalsdetailed|Pre-signals (detailed]]).  Whenever you modify the block (i.e. add rails, remove them, etc.), the automatic signals will revert to regular signals.  Note that in no case will your manual settings (see below) be modified.

With extpresignals, you will be able to ''manually'' modify each signal, and force it to be either a pre-signal or a plain signal, no matter whether it is in a valid automatic pre-signal block.  The way to change them is the same as switching between one-way and two-way signals, but you hold down the Ctrl key while doing so.  That is, you select the "buy signal" option from the railway menu, press the Ctrl key, and click on the signal you want to change.  Its appearance should change as a result, and you can verify the setting by using the query tool.

You can also remove your manual selection by choosing "buy signal" and the bulldozer, and then clicking on the signal while holding Ctrl.  In other words, you do as if you would remove a signal from the track, but with the Ctrl key pressed.

You can also specify both options, in which case you will get automatic signals but can override them using the manual selection.

Please read [[Presignalsdetailed|Pre-signals (detailed]]) for a more detailed description of how pre-signals work and what types of setups are useful.

Presignals

2011-06-12T23:23:29Z

Hgnmu128:

'''''An improved signalling technique for very efficient networks and stations'''''

/* =Pre-signals=
An improved signalling technique for very efficient networks and stations */

==Switch==

Configuration file: presignals

Command line: -w

Configuration file: extpresignals

Command line: -Xw

==Description==

These switches introduce a new type of signal to TTD, the "pre-signal."  This signal is in some sense similar to an advance signal, but it's not quite the same. For a detailed description of how pre-signals work and in what cases they are useful, please see [[Presignalsdetailed|Pre-signals (detailed]]).

Note that you need to load -+signals.grf+- to be able to distinguish pre-signals from regular signals.  See [[NewGraphics|New Graphics]] for more details.

The idea of pre-signals is quite simple:  a pre-signal shows a green light if, and only if, one of the exit signals from the block behind it shows a green light.  This means that trains will only enter the pre-signal block if there is a green exit.  As a result, the block will only be entered for short times and trains will leave it immediately, allowing for a very efficient layout.  This is particularly useful for station  entrances, but can also be applied in other cases.

The presignals switch activates ''automatic'' pre-signal configurations. Using this options, your signals will be converted to pre-signals and pre-signal exits whenever a train enters a block that qualifies as an automatic pre-signal block.  For a definition of what this needs to look like, please see [[Presignalsdetailed|Pre-signals (detailed]]).  Whenever you modify the block (i.e. add rails, remove them, etc.), the automatic signals will revert to regular signals.  Note that in no case will your manual settings (see below) be modified.

With extpresignals, you will be able to ''manually'' modify each signal, and force it to be either a pre-signal or a plain signal, no matter whether it is in a valid automatic pre-signal block.  The way to change them is the same as switching between one-way and two-way signals, but you hold down the Ctrl key while doing so.  That is, you select the "buy signal" option from the railway menu, press the Ctrl key, and click on the signal you want to change.  Its appearance should change as a result, and you can verify the setting by using the query tool.

You can also remove your manual selection by choosing "buy signal" and the bulldozer, and then clicking on the signal while holding Ctrl.  In other words, you do as if you would remove a signal from the track, but with the Ctrl key pressed.

You can also specify both options, in which case you will get automatic signals but can override them using the manual selection.

Please read [[Presignalsdetailed|Pre-signals (detailed]]) for a more detailed description of how pre-signals work and what types of setups are useful.

User:Brianetta

2011-06-12T23:18:31Z

Hgnmu128: /* OpenTTD servers */

[http://www.tt-forums.net/memberlist.php?mode=viewprofile&u=1601 Forum profile] - [http://ppcis.org/standard/ OpenTTD server]

==Brian Ronald==
The real name of Brianetta, who picked that name up from some girls at university. Married to the rather tasty [[User:Brianetta/Wife|Helen]]. Has played Transport Tycoon, Transport Tycoon Deluxe or OpenTTD since 1994.

==OpenTTD==
===OpenTTD servers===
Brianetta's first major server was known as Brianetta's Nightly, and was the first server controlled by [http://www.openttdcoop.org/wiki/Autopilot autopilot], a Tcl/Expect script for managing OpenTTD servers.

Due to the insane workload of keeping a nightly server up to date and playable, the server was pulled, and later reborn as [http://ppcis.org/standard/ Brianetta's Standard], which is back after a hiatus.

At one point, as a side project, Brianetta ran a "deathmatch" server, which featured a tiny map and absolutely no rules of fair play. Those who approached in the right frame of mind found this one to be quite good fun.

===Autopilot===
I'm going to add details here when I can be bothered. Until now, check the OpenTTDCoop wiki, as linked above.

AutoReplace

2011-06-12T23:09:56Z

Hgnmu128:

'''''Automatically replace and upgrade vehicles'''''

'''For TTDPatch 2.0.1 alpha 63 or later'''

==Switch==

Configuration file: autoreplace on|off|<reliab>

Command line: N/A

==Quick Info==

AutoReplace enables the game to automatically upgrade your engines through the use of a GRF file.  It will upgrade old engines that are nearly expired to newer ones if the situation meets three requirements:
*The newer vehicle is available to the player (Either normally, or as a trial use)
*The vehicle meets the reliability requirement specified (defaults to 80)
*The player has enough money to replace the locomotive.

When AutoReplacing engines, each engine is replaced at the same time with the same engine, regardless of the length of the new engines.  This may cause some trains to stick out of stations where they did not before.  That must be fixed manually for each train.

This switch requires the [[AutorenewalOfOldVehicles|autorenew]] switch.

==Detailed Info==

This switch is an improved version of the [[AutorenewalOfOldVehicles|AutoRenew]] switch, and requires "AutoRenew on" to work.

Instead of merely replacing vehicles with a new version of the same model, AutoReplace can also upgrade vehicles if better models are available.

To decide what models are both better and at the same time a suitable upgrade for the current vehicle, the patch requires support from grf files to provide this information. This means that each vehicle set will determine the upgrade path for its vehicles. Currently, there is no user interaction possible, all upgrades are predetermined by the respective grf file.

To prevent the purchase of vehicles with low reliabilities, you can use the switch parameter to set a minimum required reliability for upgrades. The reliability is specified in percent, with 80% being the default.

When deciding on models to upgrade to, the patch will pick the best model that is available to the player (either regularly or through for exclusive testing) that has the required reliability. If the model is too expensive, the patch will wait a short while for the money to become available. If no better model is available, the patch will AutoRenew the current model.

The AutoReplace upgrades happen whenever the AutoRenew switch would otherwise renew the vehicle, so the AutoRenew time setting also applies to the AutoReplace switch.

Note that for trains, it is possible that a locomotive is replaced by one that is longer than the original model (e.g. because of a tender), and as a result the train may not fit in all stations. This must be resolved manually by removing a wagon or two, or making the stations larger. If a train is multiheaded, all engines will be replaced by the new model, even if they are not the same type as the main engine. Depending on the AutoReplace scheme defined by the respective grf file, the patch may or may not upgrade from a steam/diesel locomotive to an electric one.

SaveOptionalData

2011-06-12T23:09:27Z

Hgnmu128:

'''''Store additional information in savegames'''''

==Switch==

Configuration file: saveoptionaldata

Command line: -Xx

==Description==

In order to function properly, the patch has to save extra data in savegames in certain cases (for example if the extended town data are collected, see [[MoreTownStatistics|More Town Statistics]]).

However you can also tell the patch to save more information that isn't actually required.  This includes for example the vehicle data.  If enabled, the patch will store and load back the current values of all vehicle data, e.g. the top speed, power, weight, capacity and so on.  This is especially important and useful if you use new graphics files, which change the vehicle data.  With this switch on, TTDPatch  will record which graphics files were active in the game, and then use this  information to prevent activation of incompatible graphics sets.   See [[NewGraphics|New Graphics]] for more information.

It is recommended that you turn this switch on unless you have a good reason not to use it.

This patch was contributed by Marcin Grzegorczyk.

SaveOptionalData

2011-06-12T23:07:58Z

Hgnmu128: /* Save Optional Data */

'''''Store additional information in savegames'''''

Store additional information in savegames

=Switch=

Configuration file: saveoptionaldata

Command line: -Xx

=Description=

In order to function properly, the patch has to save extra data in savegames in certain cases (for example if the extended town data are collected, see [[MoreTownStatistics|More Town Statistics]]).

However you can also tell the patch to save more information that isn't actually required.  This includes for example the vehicle data.  If enabled, the patch will store and load back the current values of all vehicle data, e.g. the top speed, power, weight, capacity and so on.  This is especially important and useful if you use new graphics files, which change the vehicle data.  With this switch on, TTDPatch  will record which graphics files were active in the game, and then use this  information to prevent activation of incompatible graphics sets.   See [[NewGraphics|New Graphics]] for more information.

It is recommended that you turn this switch on unless you have a good reason not to use it.

This patch was contributed by Marcin Grzegorczyk.

AutoReplace

2011-06-12T23:04:35Z

Hgnmu128:

'''''Automatically replace and upgrade vehicles'''''

'''For TTDPatch 2.0.1 alpha 63 or later'''

=Switch=

Configuration file: autoreplace on|off|<reliab>

Command line: N/A

=Quick Info=

AutoReplace enables the game to automatically upgrade your engines through the use of a GRF file.  It will upgrade old engines that are nearly expired to newer ones if the situation meets three requirements:
*The newer vehicle is available to the player (Either normally, or as a trial use)
*The vehicle meets the reliability requirement specified (defaults to 80)
*The player has enough money to replace the locomotive.

When AutoReplacing engines, each engine is replaced at the same time with the same engine, regardless of the length of the new engines.  This may cause some trains to stick out of stations where they did not before.  That must be fixed manually for each train.

This switch requires the [[AutorenewalOfOldVehicles|autorenew]] switch.

=Detailed Info=

This switch is an improved version of the [[AutorenewalOfOldVehicles|AutoRenew]] switch, and requires "AutoRenew on" to work.

Instead of merely replacing vehicles with a new version of the same model, AutoReplace can also upgrade vehicles if better models are available.

To decide what models are both better and at the same time a suitable upgrade for the current vehicle, the patch requires support from grf files to provide this information. This means that each vehicle set will determine the upgrade path for its vehicles. Currently, there is no user interaction possible, all upgrades are predetermined by the respective grf file.

To prevent the purchase of vehicles with low reliabilities, you can use the switch parameter to set a minimum required reliability for upgrades. The reliability is specified in percent, with 80% being the default.

When deciding on models to upgrade to, the patch will pick the best model that is available to the player (either regularly or through for exclusive testing) that has the required reliability. If the model is too expensive, the patch will wait a short while for the money to become available. If no better model is available, the patch will AutoRenew the current model.

The AutoReplace upgrades happen whenever the AutoRenew switch would otherwise renew the vehicle, so the AutoRenew time setting also applies to the AutoReplace switch.

Note that for trains, it is possible that a locomotive is replaced by one that is longer than the original model (e.g. because of a tender), and as a result the train may not fit in all stations. This must be resolved manually by removing a wagon or two, or making the stations larger. If a train is multiheaded, all engines will be replaced by the new model, even if they are not the same type as the main engine. Depending on the AutoReplace scheme defined by the respective grf file, the patch may or may not upgrade from a steam/diesel locomotive to an electric one.