== ATTENTION ==
The client circumvents the OpenTTD version checks to be able to join unpatched multiplayer games.
Because of this, if you encounter any bug, report it to CityMania team as it may be connected to patches included.
Unless you encouter the same bug on unpatched OpenTTD client do not report it to OpenTTD development team.


== INSTALL ==
Unlike Novapolis client Citymania one is shipped as a complete package, not
just a patch, so it no longer needs vanila OpenTTD installation to work.
But it can also be installed in the same old way described below.

If you have shared OpenTTD folder, you can just unzip anywhere and launch
If you dont use shared folder, unzip into your OpenTTD folder
innerhighlight.grf in data folder is required, copy it to data or content_download/data folder


== PRO INSTALL ==
WINDOWS
Possible situations:
1) Installing stable release from openttd.org, install also with graphics and sound sets (only graphic are required)
	Install the package. It will create game files in %Program Files%/OpenTTD and user files in %USER_PROFILE%/Documents/OpenTTD
	To gain advantage of shared folder, copy all files except LANG folder and OPENTTD.EXE from %Program Files%/OpenTTD to %USER_PROFILE%/Documents/OpenTTD
	Now if you can unzip this client anywhere and if openttd.exe stays with its lang/folder, you can launch it from any place
	This will also you enable you to use any number or openttd versions/clients
2) Installing stable release from zip
	Download zip and also graphics set zip.
	Unzip both into the same folder. Graphics set belong to BASESET or DATA folder
	Launch the openttd.exe (if there is openttd.cfg already, delete it)
	Quit OpenTTD. Now it created user files in your User profile
	Copy all files except LANG folder and OPENTTD.EXE into User profile folder called OpenTTD
	This will enable you to use any number or openttd versions/clients under condition you keep openttd.exe and its lang files in one folder (every client comes with binary and lang folder at least)
LINUX
CityMania does not ship linux client. Your only chance is to download source package and compile it by yourself.
Process is easy and simple guide is at http://wiki.openttd.org/Compiling_on_(GNU/)Linux_and_*BSD


== LOGIN SYSTEM ==
Community Login system - login window. Atm accessible only by defining hotkey for it.
- Please read carefully about new login system if you intend to use it
- new login system for CityMania and also for n-ice and BTPro, login date are stored in new config file citymania.cfg
	- login window can be opened via landinfo dropdown mene or a hotkey can be associated with it, for example CTRL+L

	- login is saved by entering text via OpenTTD forms. Remember that OpenTTD shows real letters when entering any text
	- TODO citymania password is stored encrypted and login string is sent via ingame chat privately to server
		so no one can see it
	- n-ice and BTPro uses token system. In order to retrieve the token, client has to log to their websites
		obtain the token here and enter it in ingame chat
		Alternatively both communities implemented a system, that one can open a dedicated webpage
		and enter username and password there to obtain the token, which is used in n-ice and BTPro
		patched OpenTTD client and CityMania client uses it too.
		Once token is retrieved, it is sent via ingame chat privately to server
		so no one can see it

		!!! Be aware, that the token login webpage needs decrypted password, so this decrypted password
		is stored in citymania.cfg file and send decrypted via OpenTTD to their website
		Thus do not provide citymaina.cfg file to any one!
		N-ice and BTPro are 3rd side and CityMania cannot guarantee safety of the login to their community
		and should they change the login system, CityMania client login will not work for both of them


== SCRIPTS ==
autoexec.scr contains some predefined aliases for connecting on CityMania server
In game press ~ (above tab key) and write "cm<number>", e.g. "cm1". This will connect you to desired server
This is usable for any OpenTTD servers

If you want to use login alias, you will have to rewrite "nick" and "password" to your actual CityMania account.
However bear in mind, if you accidentally launch this alias on another server, you will uncover your password


== OPENTTD.CFG ==
In openttd.cfg.example are lines you can add to your openttd.cfg to have CityMania servers available in multiplayer menu all the time without searching for games
This is usable for any OpenTTD servers


== CHANGELOG ==

*** 1.10.3 (10 Aug 2020) ***
- Show preview when building a rail depot.
- Add an option to enable shading trees on slopes for better looks.
- Add an option to show APM counter on the status bar.
- Fix order hotkeys adding extra no load/unload orders.
- Allow to use TAB as a hotkey.
- Add hotkey to toggle minimap.
- Make a usinghotkey to close news and errors configurable (still defaults to SPACE).
- Remove custom hotkey keycodes that were added to vanilla.
- Make modifier key (ctrl/alt/shift) functions configurable.
- Allow toggling removal mode with modifier key on station and signal building tools if it's different from the Fn modifier (otherwise fn takes priority).
- Add "cmtreemap" console command to plant trees according to a heightmap image (scenario editor only).
- Add "cmexport" console command to export various in-game data in JSON format (for developers).
- Add "cmstep" console command to advance the game for n ticks (singleplayer only).
- Make land info tool work with right-click tooltip setting and/or disabled extra tooltip settings.
- Make station rating tooltips work with right-click tooltip setting
- Split extra (land) tooltips setting in config into 3 for industries, stations, and houses separately.
- Add an option to pause games after loading.
- Fix town HR counter.
- Allow spectators to open the industry funding window from the menu.
- Fix graphical glitches after switching location with a hotkey.
- Make new tint highlights work with 32bpp sprites.
- Fix: sprite preview in sprite aligner is too small with scaled UI.
- Slightly improve funding highlight update.
- Remove cargo color icons from income and delivered cargo graphs to avoid confusion with company colors.
- Fix delivered cargo graph displaying units as money.

*** 1.10.2 (5 Jun 2020) ***
- Add new minimap mode showing industries, height and farms at the same time.
- Rename "CB town border" zone to "CB cargo acceptance", switch it to a new colored highlight and fix for new CB mode.
- Rename "New CB borders" zone to "CB town limit" and switch it to a new colored highlight. Remove old "CB borders" zone.
- In CB modes added CB town limit to outer town zones highlight (red border).
- Show engine id in build window in newgrf developer mode.
- Add hotkeys (unset by default) to remember locations and scroll back to them.
- Fixed automatic funding and advertisement wasting money.
- Fixed crash on selecting tram station build tool.
- Fixed zoning hotkeys.
- Fixed tooltip width on empty stations.
- Fixed checkboxes in toolbar menu items.
- Fixed CityMania login in server login window.

*** 1.10.1 (15 Apr 2020) ***
- Add a setting to autoopen vehicle window when cloning vehicles while sharing orders.
- Add a setting to autoopen orders window along with a vehicle window for new vehicles.

*** 1.10.0 (1 Apr 2020) ***
- OpenTTD update.

*** 1.10.0-RC1 (18 Mar 2020) ***
- When cloning from vehicle window skip orders to same position.
- Always open vehicle window when ctrl-cloning a vehicle (like it was before 1.9).
- Impove rendering performance on high resolutions (about 50% improvement on 4k).
- A new way of highlighting tiles by coloring them. Some zoning and 1.10.0 default highlights switched to this new way.
- Experimental way of building and joining stations (unfinished).

*** 1.10.0-beta2 (6 Jan 2020) ***
- OpenTTD update.

*** 1.10.0-beta1 (5 Nov 2019) ***
- Show company goals in CB window if there is no CB info provided by server.
- Make zoning UI use new cleaner highlight style for town zones and station catchment outer zoning.
- Show closest town and advertisement zone in station building window.

*** 1.9.3 (16 Sep 2019) ***
- OpenTTD update.

*** 1.9.3-RC1 (8 Sep 2019) ***
- OpenTTD update.

*** 1.9.2 (12 Jul 2019) ***
- OpenTTD update.
- Fixed order hotkeys with Shift key.
- Fixed crash on game save.

*** 1.9.1 (8 Apr 2019) ***
- OpenTTD update.

*** 1.9.0 (1 Apr 2019) ***
- OpenTTD update.
- Added treedozer tool (Ctrl+D) that destroys trees in an area - by Corns McGowan.
- Depot building tools now close after placement (hold Ctrl to keep them). Enable "Interface->Construction->Keep depot building tools active after usage" to revert to original behaviour.
- Removed vehicle measurements from framerate counter (massive performance improvement in some cases compared to vanilla).
- Improved performance of up authority and advertisement zoning.
- Improved cargo legend looks in charts.

*** 1.8.0 (17 Apr 2018)
- OpenTTD update.

*** 1.7.1 (15 Jun 2017) ***
- OpenTTD update.

*** 1.7.0 (15 Apr 2017) ***
- Polyline patch updated to version 11a
- Always autorotate drive-through road/tram stops when placed on roads.
- Added industry type id to newgrf debug window (may be useful for newgrf developers)
- Added a trick to join servers that have diffirent game version. Hold Ctrl while clicking greyed-out join button and it will work. But still may fail version check later as not all versions are supported. And even if you do manage to join the game keep in mind that it's not supposed to work like that and is highly likely to desync or crash at some point.

*** 1.6.1-2 (29 Jul 2016) ***
- Fixed crash when joining ECS servers on windows

*** 1.6.1 (24 Jul 2016) ***
- Minor bugfixes

*** 1.6.0 (2 Apr 2016) ***
- Added active stations highlight to town zoning. Outlines stations that have been serviced in last ~50 days (as in checks for authority rating and town growth rate).
- Fixed next counter in town window (was always showing -1 in case of custom growth rate). Also show * after GR value for a custom rate (set by GameScript or server patch).
- Detailed station ratings tooltip (hover over rating in station window).
- Make cargo window look better, especially in double/quad interface size.
- Added real population to town directory, towns can be sorted by it too.
- Added experimental "New CB border" zone in zoning tool. Meant to replace old CB borders for new game modes, but is not used anywhere just yet.

*** 1.5.3 (3 Dec 2015) ***
- Update to OpenTTD 1.5.3
- Fixed crash when pressing Ctrl while building tramways.

*** 1.5.3-RC1 (3 Nov 2015) ***
- Update to OpenTTD 1.5.3-RC1

*** 1.5.2/30 (2 Sep 2015) ***
- Fixed fast server change buttons
- Fixed extra data saving (crashed when opening saves).

*** 1.5.1-2/29 (16 Jun 2015) ***
- Stores most of CityMania client extra data in savegame
	- Includes CB info (deliveries/requirements/etc.), RTM/DTM, CS/HS/HR and town growth zoning.
	- It also means that all of these are now synchronized when you join CityMania servers.
	- Savegame is compatible with unmodified clients (they obviously don't understand extra data, but preserve it intact).
- Fixed OpenTTD version detection in source package.

*** v28-151 (3 Jun 2015)***
- Renamed to CityMania client as successor of Novapolis, community-related things changed accordingly.
- Now is shipped in a complete package, similar to vanila OpenTTD, so no longer require it to be installed first.
- Providing complete source pack instead of just diff
- Also note that town growth mechanics is changed a bit in 1.5.1. It's now safe (no CS) to keep depots and extra roadbits in town. And previously HS cases become CS. Now HS can only happen when town is allowed to build roads and decides to build one instead of house.
- Show houses count in towns list, towns can be sorted by it too.

*** v27-150 ***
- Land info tool works as tooltip, can also be used to mesure distances by dragging
- land_info hotkey (no default)
- Money and houses settings for powerfunding
- Setting to disable "runway too short" warning
- Some visual improvements for double/quad interface sizes and rtl languages

*** v26-150rc1 ***
Prepared by dp

Update to 1.5.0-RC1
- Regular advertisement and powerfunding (in CB window)
- Regular funding is now smarter
- Full tile autoroad is replaced with CB autoroad which is more like regular autoroad, but also tries to avoid half-tile dead ends and redundant roadbits
- station_sized and station_dragdrop hotkeys to start building station directly in fixed size or drag&drop mode
- toggle_fullscreen hotkey
- zoning hotkeys can be global
- Industry funding window has option to highlight tiles where industry can't be build regardless of terrain. Note that it works quite slow and can cause lags so use with caution
- GR and next displays once again show proper values
- Polyrail tool updated to version 10b, noticable changes:
--- Ending line with double click no longer interferes with building quickly so setting for disabling it was removed
--- Tool can now be started in non-snapping mode (new line) with new_polyline hotkey (CTRL+SHIFT+A)
--- No longer shows error if no new tracks were built, only changes snap point

*** v25-150b2 ***
Update to 1.5.0-beta2

*** v24-150b1 ***
Update to 1.5.0-beta1

*** v23-144 ***
Town gui - hotkey for building statue
Statue will be also built when doing Ctrl + click on town name
Fixing bugs in login window
- no crash on doubleclick
- now working with non asci characters in login entries

*** v22-144 ***
- Community login system - read above
- hotkeys for industry funding, adv. settings window, newgrf window and login window, by default not assigned
- added setting to choose finishing polyrail by double click
- cb window updated more often
- Fund regularly button in CB window is toggled when clicked
- Cargo commands gui in commands window are changed and one is added
- Town window
	-Houses under construction are hopefully diplayed properly and houses under reconstruction are showed only per month

*** v21-144 ***
Zoning tool
 - window made smaller - removed unnecessary lines, clicking on selected button will deselect it
 - hotkeys for all buttons, default is SHIFT+{number}
Town window
 - new line: Houses: UC - under construction, UR - under reconstruction (being rebuilt), DTM - demolished this month
 - hotkeys for buttons. No default key is set. Hotkey for CB button will open CB window for any town even in single player
CB window
 - added more lines (from Town window)
 - added hotkeys for small and medium advertisement (not set by default)
 - added Fund regularly button
Fund regularly feature
 - Can be de/activated in CB window only
 - Will fund buildings whenever fund buildings goes down to 0 months. Company needs money to use it
 - any number of towns can have this activated, but it is costly
 - !!! Use with caution as it drains money away

*** v20-144 ***
Update to 1.4.4
Zoning gui revised. Zoning tiles are more colourful.
Zoning hotkey (default none, recommended CTRL+Z)
New innerhighlight.grf

*** v19-143 ***
Update to 1.4.3

*** v18-142 ***
Extended tooltips inspired by MJP's patch (http://www.tt-forums.net/viewtopic.php?f=33&t=53394)
 - hover over industry or station to see cargos and its ratings
 - can be disabled in gui setting
More hotkeys
 - close vehicle order window
 - refit and clone vehicle from vehicle window while in depot
 - tree hotkey switches tree window between active/inactive
Changes
 - local authority detail for all companies in town authority window
 - potential population and authority detail number moved from header to town details part ot town window

*** v17-141 ***
Hotkeys for town management removed from town view window


*** v16-140 ***
Option for depots and road stations to automatically choose direction
Fixed width of companies dropdown in toolbar
Fixed client version in diff

*** v15-140 ***
Update to 1.4.0
New autoroad tool that builds only full tile roads
Show potential town population (including unfinished buildings) in town view window toolbar
Hotkey for borrowing all money (no default binding)
Double click in polyrail mode no longer finishes current line

*** v14-140b5 ***
1.4.0-beta5 client

*** v13-133 ***
Fixed 32bit binary (problem in WinXP)
Fix crash when pressed trees hotkey in spectating mode
Fixed gui problem with extra sprites, when too many new sprites were loaded
Fixed login query. Input is now both '<name> <password>'

*** v12-133 ***
New town growth counters and zones (for zoning GUI) Unfinished wiki article
Replaced "from" column in CB GUI with storage usage %
Vehicle cloning hotkey in depot(no default), advertise hotkeys for town authority and town info windows (CTRL+V for large advertisemetn), funding hotkey for town info window(CTRL+F).
Zoning GUI changes: new advertisement range and CB town borders zones, "town borders" renamed to "town zones" and now shows more zones.
CB GUI fixed

*** v11-133 ***
Fix nova client extra hotkeys

*** v10-133 ***
Update to 1.3.3
Added quick button for NS16
Town gui new GR/next/flag calculation

*** v9-132 ***
New innerhighlight.grf file !!!
Added goal gui button to toolbar. You can now easily access it and also see other companies goal progress (partially backported from official trunk)
Moved watch gui to toolbar
Added teamchat option to watch gui - when clicked on dot next to company colour, you will teamchat with that company
Goal gui height is adjusted according to current number of goals (lines)
Zoning gui fixes and unused parts reduction (thanks to dp for fixes)

*** v8-132 ***
Added:
Watchgui patch by Muxy

*** v7-132 ***
New Client Version check - upon joining Novapolis server, a message will pop up if there is update available
CB gui - When you join Novapolis City builder server, there will be a new button in town window with cargos delivered (merged from city builder client)
       - this works only on Novapolis City builder servers
New button in Novapolis commands gui (HELP topic 6)

*** v6-132 ***
New hotkeys, changes to hotkeys (can be altered in hotkeys.cfg)
'R' Build new vehicle, when vehicle purchase list is active
CTRL+'F' START/STOP all vehicles in active depot
'B' Open Vehicle purchase list from Depot window
'G' Open orders window when a vehicle window is active
'Z' START/STOP vehicle when a vehicle window is active
CTRL+'S' Build statue in active town
CTRL+'F' Fund buildings in active town

*** v5-132 ***
64bit version package
New hotkeys:
'G' Open orders window when a vehicle window is active
'X' START/STOP vehicle when a vehicle window is active
'CTRL+X' Start all vehicles in depot
NS8 quick connect button added

*** v4-132 ***
Update to 1.3.2
New buttons: quick connect to NSX3, login data input, autologin (requires login data input first)
Due to new support of Brahmic languages, some language libraries are required and binary is a little bigger.

*** v3-131 ***
new buttons to commands gui
filter for Novapolis servers in server list
polyline patch fix (fixes missing coverage area for dock)

*** v2-131 ***
Hotkeys for several events: defaults: N:Commands windows, CTRL+H:build HQ, CTRL+F4:goal gui, CTRL+F2:cargo table
Updated direct server connect buttons to new IP

*** v1-130 ***
Client created

Patch
Watch Company Gui - by Muxy http://www.openttd.fr/
Polyline patch - by adf88 http://www.tt-forums.net/viewtopic.php?f=33&t=57080&hilit=polyline
Zoning patch - by Svip http://www.tt-forums.net/viewtopic.php?f=33&t=33701&start=40
Orders control with alt/ctrl/shift and setting gui - by blup
Transported cargo table - by Honza_ http://www.tt-forums.net/viewtopic.php?f=33&t=62339
City names in different colour - by Honza_ http://www.tt-forums.net/viewtopic.php?f=33&t=63844
Novapolis commands gui - by xi (found under question mark menu, only available when connected on Novapolis servers)

Option to select old depot train length display - by The Dude
Income and delivery graph can display data of individual cargos - by The Dude
Industry directory filter - author unknown
Rating in town label - by Terkhen http://www.tt-forums.net/viewtopic.php?f=33&t=42598&hilit=rating+label
Manhatten and square distance of vehicle route in orders gui - by The Dude
Count of cities/towns - by The Dude
Hotkey for Goal Gui and HQ placement - by The Dude

Script
Aliases for connecting to Novapolis servers
Aliases for login on Novapolis servers



Special thanks to authors of the patched included and to OpenTTD development team for developing the game further.
