Update map documentation
[openttd-joker.git] / README.md
blob30caf78ed3f0758efdf27f3c66941716ed625cdf
1 ## Joker's Patchpack version v1.26.1
3 This is a collection of patches applied to [OpenTTD](http://www.openttd.org/)
4 This patch pack is a collection of features created by various developers.
5 I added my own features to the collection and make the rest work together. 
6 But the credits for features or improvements not created by me 
7 goes to the original developers.
9 * * *
11 OpenTTD is a transport simulation game based upon the popular game Transport
12 Tycoon Deluxe, written by Chris Sawyer. It attempts to mimic the original
13 game as closely as possible while extending it with new features.
15 OpenTTD is licensed under the GNU General Public License version 2.0,
16 but includes some 3rd party software under different licenses. See the
17 section "Licensing" in readme.txt for details.
19 * * *
21 See [readme.txt](readme.txt) for the original OpenTTD readme.
23 The thread for this patchpack can be found [here](https://www.tt-forums.net/viewtopic.php?f=33&t=74365).
25 See [joker-changelog.md](joker-changelog.md) for changelog.
28 #### This patchpack contains the following
31 * Variable day length setting
33 * Show daytime next to date and use hours and minutes additional to ticks in the GUI (ticks_per_minute adjustable per client)
35 * 255 GRFs in single AND multiplayer mode
37 * Increase number of available rail track types from 16 to 32
39 * Automated timetables and separation with several different separation modes.
41 * Enhanced viewport with higher zoom levels and tool tips
43 * Template-based train replacement
45 * Plan drawing on the map
47 * Stations now keep a history of waiting cargo which can be displayed as a graph (last 48 days in 2 day increments)
49 * Filter the industry directory by accepted and produced cargo.
51 * Useful warnings are shown in timetable window, e.g. when using auto-separation on conditional or full load orders.
53 * Multiple rail-type sets should now be more compatible with each other.
55 * Rail types are sorted differently in the toolbar dropdown, first by compatibility, then by max speed.
57 * Routing restriction signals
59 * Logic signals
61 * Upgrade airports
63 * Vehicle group info
65 * Zoning Toolbar (overlay to mark Routing Restriction Signals, station catchment and other data)
67 * Departure boards for stations
69 * Town cargo generation factor
71 * Vehicles visible in tunnels (transparency setting)
73 * Signals in tunnels and on bridges (with support for path signals)
75 * Measurement tool in landscaping toolbar
77 * Timetabling waiting time in depots
79 * Minimap screenshots (extra button in the minimap window)
81 * Rating in town label
83 * Changed tree growth. Less trees at level 1 and approaching the tree line on mountains.
85 * Enable building rivers in game
87 * More conditional orders
89 * Include the most relevant information based on the selected sorting in the vehicle group 
91 * Include the train length and group name in the vehicle details window
93 * Flat minimap screenshots for traffic, terrain height, owner and industry map views
95 * Pause on savegame load if ctrl key is pressed.
97 * Reverse at waypoint orders
99 * Vehicle lifetime profit
101 * Hierarchical group collapse
103 * Ship collision avoidance
105 * Polyline rail track building tool
107 * Cargo type orders, this allows order load/unload types to be set per cargo type
109 * Towns can be connected by public roads during map creation
111 * When building tunnels, open new viewports at the far end of the tunnel when the 'v' key is pressed
113 * Custom bridge heads for road bridges
115 * Chunnels (tunnels under bodies of water)
117 * Improved train purchase window (can be activated in settings). Shows locomotives and wagons separately.
119 * Minimum distance between towns can be set during world creation
121 * Maximum height level for towns (no more big cities on mountain tops)
123 * Transfer payment is payed out once the cargo reaches its destination
125 * Better road vehicle overtaking behavior. They now mostly ignore opposing traffic but are now capable of truly using both lanes of one way roads. (Think highways)
127 * Level crossing improvements
128   * Adjacent level crossings now close
129   * Trains can no longer collide with road vehicles (reasoning behind this is that such crashes cannot be prevented.)
131 * Towns build bridges over rails
133 * Vehicles now only service in the depot in their orders list if there is one. Since trains can have a hard time finding their depot they go through their normal orders list (without loading at stations) until they reach it. If no depot is in the orders the default behavior is executed.
135 * Performance improvements (code by JGR from JGR Patch Pack)
137 * Multiple docks per station
139 * Cargo type filter in vehicle list windows
141 * Vehicle trip history window
143 * Better algorithm for river creation. Also longer rivers become wider than just one tile. (This works best with a map created with a custom heightmap since standard generated maps have too many small valleys and lakes)
145 * Station ratings now have helpful tooltips
147 * Station ratings now ignore time between vehicle arrival, so people playing with fewer longer trains are not punished more than people playing with more, shorter trains.
149 * Miscellaneous  
150   * The game now asks before allowing to bulldoze rail stations or industries (the latter with the magic bulldozer)
151   * Unused tracks are overgrown by grass (purely visual, can be deactivated in settings)
152   * Make 'cargo payment rates' graph more useful by basing it on vehicle speed
153   * Increase maximum setting limits for per-company vehicle-type limits.
154   * Increase maximum permitted vehicle name length, vehicle group name length, and depot/station name lengths
155   * Various minor fixes
156   * Rail fences can be hidden by a setting (In the settings dropdown)
157   * Taxes (a percentage of the company value) are payed by each company. This punished dead cash and rewards investment.
159 #### Compiler 
161 C++11 support is required.
163 Up-to-date versions of MSVC work best. I do not personally maintain any other compiler toolchain or other platforms than Windows. If you want to help with that, please create a pull request on GitHub.