OpenRCT2/distribution
Gymnasiast c6302a1dae
Release v0.4.0
- Headline feature: [#10664] New save format with increased limits.
- Feature: [#714] Allow up to 255 trains per ride.
- Feature: [#2253] Path surfaces and railings can be mixed and matched, like in RCT1.
- Feature: [#2766] The Fruity Ices Stall can now be recoloured, like in RCT1.
- Feature: [#4933] Allow map sizes of 999 × 999 (up from 254 × 254).
- Feature: [#7660] Custom music objects that are distributed with the save.
- Feature: [#8407] Ride platforms can be made invisible.
- Feature: [#12793] Add Excitement/Intensity/Nausea ratings to Ride List view with sorting.
- Feature: [#13858] Flatride bases can be made invisible.
- Feature: [#14676] [Plugin] Allow plugins to store data in .park files.
- Feature: [#15367] Individual track elements can now be drawn as another ride type.
- Feature: [#15901] [Plugin] Add ‘map.getAllEntitiesOnTile’ to API.
- Feature: [#16029] [Plugin] Add ‘TrackElement.rideType’ to API.
- Feature: [#16097] The Looping Roller Coaster can now draw all elements from the LIM Launched Roller Coaster.
- Feature: [#16132, #16389] The Corkscrew, Twister and Vertical Drop Roller Coasters can now draw inline twists.
- Feature: [#16144] [Plugin] Add ‘ImageManager’ to API.
- Feature: [#16707] [Plugin] Implement intransient plugins.
- Feature: [#16707] [Plugin] New API for current mode, ‘map.change’ hook and toolbox menu items on title screen.
- Feature: [#16731] [Plugin] New API for fetching and manipulating a staff member’s patrol area.
- Feature: [#16800] [Plugin] Add lift hill speed properties to API.
- Feature: [#16806] Parkobj can load sprites from RCT image archives.
- Feature: [#16831] Allow tertiary colours for small and large scenery objects.
- Feature: [#16872] [Plugin] Add support for custom images.
- Improved: [#3517] Cheats are now saved with the park.
- Improved: [#10150] Ride stations are now properly checked if they’re sheltered.
- Improved: [#10664, #16072] Visibility status can be modified directly in the Tile Inspector’s list.
- Improved: [#16251] Plugin API handles null values better.
- Improved: [#16251] openrct2.d.ts: mark ‘callback’ argument of queryAction and executeAction as optional.
- Improved: [#16251] openrct2.d.ts: change ‘network.status’ to ‘network.mode’ in network API docs.
- Improved: [#16251] openrct2.d.ts: added previously undocumented ‘GroupBoxWidget.text’ property.
- Improved: [#16251] openrct2.d.ts: removed unused ‘LabelWidget.onChange’ property.
- Improved: [#16258] Increased image limit in the engine.
- Improved: [#16408] Improve ‘--version’ cli option to report more compatibility information.
- Improved: [#16740] Allow staff patrol areas to be defined with individual tiles rather than groups of 4x4.
- Improved: [#16764] [Plugin] Add hook ‘map.save’, called before the map is saved.
- Improved: [#16925] The queue length of 1000 guests is lifted, and a warning for too long queues is added instead.
- Change: [#14484] Make the Heartline Twister coaster ratings a little bit less hateful.
- Change: [#16077] When importing SV6 files, the RCT1 land types are only added when they were actually used.
- Change: [#16424] Following an entity in the title sequence no longer toggles underground view when it’s underground.
- Change: [#16493] Boat Hire and Submarine Ride support costs now match their visual appearance.
- Change: [#16710] Changed default view of Guest List to ‘Thoughts’ and selected tab will default to ‘Summarised’ (when opened from the menu).
- Change: [#16859] Guests with umbrellas no longer always avoid going into a Maze.
- Change: [#16912] Tired or nauseated guests will no longer jump in a Maze.
- Fix: [#6767] Black screen after Alt-Tabbing back into the game.
- Fix: [#11752] Track pieces with fractional cost are too cheap to build.
- Fix: [#12556] Allow game to run without audio devices.
- Fix: [#12774] [Plugin] Scripts will not be re-initialised when a new scenario is loaded from within a running scenario.
- Fix: [#13336] Can no longer place Bumble Bee track design (reverts #12707).
- Fix: [#14155] Map Generator sometimes places non-tree objects as trees.
- Fix: [#14674] Recent Messages only shows first few notifications.
- Fix: [#14920] Ghosts for rides and shops do not auto-elevate when obscured.
- Fix: [#15413] Modifying park rating with plugins desyncs park rating history from actual park rating.
- Fix: [#15571] Non-ASCII characters in scenario description get distorted while saving.
- Fix: [#15830] Objects with RCT1 images are very glitchy if OpenRCT2 is not linked to an RCT1 install.
- Fix: [#15909] Text can overflow in ‘Select ride design’ windows.
- Fix: [#15947, #15960] Removing a flat ride results in an error message and duplicate structures.
- Fix: [#15998] Cannot set map size to the actual maximum.
- Fix: [#16007] Scenario Editor “Entry Price” appears to the right of the value field.
- Fix: [#16008] Tile Inspector can select elements from last tile without reselecting it.
- Fix: [#16024] Go-Karts with more than 32 vehicles do not colour themselves correctly.
- Fix: [#16026] Newly created rides with “Disable vehicle limits” cheat always get 32 trains with 12 cars each.
- Fix: [#16063] Object Selection preview for objects with glass is broken.
- Fix: [#16075] Exporting track designs saves scenery in incorrect locations.
- Fix: [#16087] The Looping Roller Coaster booster is now always drawn correctly.
- Fix: [#16140] The ‘Follow this’ option is now disabled when the ride view is set to ‘overall’ or a station.
- Fix: [#16162] Go Karts speeds are not correctly randomised, they only go very fast or very slow.
- Fix: [#16188] Medium-size banked turns on the Twister and Vertical Roller Coaster have incorrect support placement (partly original bug).
- Fix: [#16264, #16572] Placing saved track design crashes game.
- Fix  [#16308] Crash when trying to place down a ride on Android.
- Fix: [#16327] Crash on malformed network packet.
- Fix: [#16449] [Plugin] Viewport doesn't hide when switching tabs.
- Fix: [#16450] Banner style not copied when using tile inspector.
- Fix: [#16535] Entering construction mode unblocks all paths.
- Fix: [#16542] “Same price throughout park” status not correctly imported for RCT1 saves.
- Fix: [#16572] Crash when trying to place track designs.
- Fix: [#16591] [Plugin] ‘setInterval’ and ‘setTimeout’ is not disposed when map unloads.
- Fix: [#16711] [Plugin] ‘Car.rideObject’ overflowing with more than 256 ride types.
- Fix: [#16779] Fix case where title music doesn't unmute properly.
- Fix: [#16808] Incorrect track design serialisation causing vehicle object replacement.
- Fix: [#16869] Soft Toy Stall cannot be recoloured, but shows a recolouring option anyway (original bug).
- Fix: [#16995] Native Linux dialog windows do not open if the path contains single quotes.
- Fix: [objects#165] Glitch when Bengal Tiger Cars go through a corner.
2022-04-25 19:21:38 +02:00
..
linux Release v0.4.0 2022-04-25 19:21:38 +02:00
macos Release v0.4.0 2022-04-25 19:21:38 +02:00
man Fix #16365: Broken link referenced in manpages and help output 2022-03-20 17:54:53 +01:00
windows Fix #12701: Disable upgrade pop-up at slient install (#12709) 2020-08-18 14:58:01 +01:00
changelog.txt Release v0.4.0 2022-04-25 19:21:38 +02:00
openrct2.d.ts Add draw to image API 2022-03-24 22:37:22 +00:00
readme.txt Release v0.4.0 2022-04-25 19:21:38 +02:00
scripting.md Update scripting readme 2022-03-21 21:43:02 +00:00

readme.txt

Last updated:    2022-04-25
Release version: 0.4.0
------------------------------------------------------------------------


Table of contents
-----------------
1.0) About
2.0) Contacting
 * 2.1) Reporting bugs
3.0) Supported platforms
4.0) Installing and running OpenRCT2
5.0) Development
6.0) Translation
7.0) Troubleshooting
8.0) Licensing
9.0) Credits

1.0) About
---- -----
OpenRCT2 is an amusement park simulation game based upon the popular game
RollerCoaster Tycoon 2, written by Chris Sawyer. It attempts to mimic the
original game as closely as possible while extending it with new features.

OpenRCT2 is licensed under the GNU General Public License version 3.0, but
includes some 3rd party software under different licenses. See the section
"Licensing" below for details.

2.0) Contacting
---- ----------
The easiest way to contact the OpenRCT2 team is by submitting issues on GitHub
(https://github.com/OpenRCT2/OpenRCT2) in the form of questions or bug reports.
You can also chat with us on Discord (https://discordapp.com/invite/fsEwSWs).

2.1) Reporting bugs
---- --------------
GitHub is used for tracking bugs in OpenRCT2. Please check if the bug has
already been reported using the search functionality before submitting.

When you are sure it is not already reported you should:
 * Make sure you are running a recent version, i.e. run the latest stable or
   nightly based on where you found the bug.
 * Make sure you are not running a non-official binary, like a fork.
   When you are playing with a fork you should report any bugs to the bug
   tracker for that fork which is most likely another GitHub repository.
 * Make it reproducible for the developers. In other words, create a savegame
   in which you can reproduce the issue once loaded. It is very useful to give
   us the dump file as well, and a screenshot.
 * Check whether the bug is already reported on our bug tracker. This includes
   searching for recently closed bug reports as the bug might already be fixed.

After you have done all that you can report the bug. Please include the
following information in your bug report:
 * OpenRCT2 version (PLEASE test the latest git develop build)
 * Bug details, including instructions how to reproduce it
 * Platform (Windows, Linux, FreeBSD, ...) and compiler (including version) if
   you compiled OpenRCT2 yourself.
 * The processor architecture of your OS (x86 Windows, x86-64 Windows,
   Android on an ARM, Linux on a PowerPC, ...)
 * The language and culture your operating system is using.
 * Attach a saved game *and* a screenshot if possible
 * If this bug only occurred recently please note the last version without
   the bug and the first version including the bug. That way we can fix it
   quicker by looking at the changes made.
 * Attach a crash dump (if your game crashed or froze).

3.0) Supported platforms
---- -------------------
OpenRCT2 is currently supported on Windows Vista and above, many distributions of
Linux, macOS 10.13 or higher, Android, FreeBSD and OpenBSD. OpenRCT2 will only work on
little-endian architectures.
Further instructions can be found on GitHub.

4.0) Installing and running OpenRCT2
---- ------------------------------
Installing OpenRCT2 is fairly straightforward. Either you have downloaded an
archive which you have to extract to a directory where you want OpenRCT2 to
be installed, or you have downloaded an installer, which will automatically
extract OpenRCT2 in the given directory.

OpenRCT2 requires an installation of RollerCoaster Tycoon 2 (RCT2) to run. You
must have either installed the original RCT2 disc, the GOG version or the Steam
version. Alternatively you can manually specify the location of where your RCT2
data files are. These may be directly copied off of the original disc and placed in
a directory of your choice.

When you start OpenRCT2 for the first time, it will look for the RCT2 data files
in the following locations:
  - C:\Program Files\Infogrames\RollerCoaster Tycoon 2,
  - C:\Program Files (x86)\Infogrames\RollerCoaster Tycoon 2,
  - C:\Program Files\Infogrames Interactive\RollerCoaster Tycoon 2,
  - C:\Program Files (x86)\Infogrames Interactive\RollerCoaster Tycoon 2,
  - C:\Program Files\Atari\RollerCoaster Tycoon 2,
  - C:\Program Files (x86)\Atari\RollerCoaster Tycoon 2,
  - C:\GOG Games\RollerCoaster Tycoon 2 Triple Thrill Pack,
  - C:\Program Files\GalaxyClient\Games\RollerCoaster Tycoon 2 Triple Thrill Pack,
  - C:\Program Files (x86)\GalaxyClient\Games\RollerCoaster Tycoon 2 Triple Thrill Pack,
  - C:\Program Files\Steam\steamapps\common\Rollercoaster Tycoon 2,
  - C:\Program Files (x86)\Steam\steamapps\common\Rollercoaster Tycoon 2,
  - The location of the openrct2.exe (where OpenRCT2 was extracted/installed)

If none of these locations are found, OpenRCT2 will ask you to manually specify
the directory. Alternatively after running OpenRCT2 for the first time, you can
edit config.ini in the OpenRCT2 sub directory of your documents folder to set
the RCT2 install path.

OpenRCT2 supports setting a DPI scale in increments of .25. To set it, open the Options menu.

If you wish to use Steam Overlay or capture game for video recording or
streaming, you might have to enable hardware display in the options window.
This will still render the graphics on the CPU but the pixel data will be
displayed using either DirectX or OpenGL. This may also enable vertical
synchronisation if supported by your graphics card and you have enabled
"Uncap FPS".

5.0) Development
---- -----------
OpenRCT2 is an open-source collaborative project. It is developed voluntarily
and hosted on GitHub. If you would like to contribute to the development of
OpenRCT2, please read the readme file in the OpenRCT2 repository or on the main
GitHub page at (https://github.com/OpenRCT2/OpenRCT2). This gives more detailed
information about the project, its roadmap and how to compile the source code.

6.0) Translation
---- -----------
For more information about the game's translation and how to contribute, please
visit the GitHub page and wiki at (https://github.com/OpenRCT2/Localisation).

7.0) Troubleshooting
---- ---------------
If you are having problems running OpenRCT2, you can run OpenRCT2 in verbose
mode to view a detailed diagnostic log. This can be activated by running the
game via Command Prompt or PowerShell with the command line switch --verbose.

This log can help pinpoint where a problem exists and is a useful resource if
you wish to ask online for help.

8.0) Licensing
---- ---------
OpenRCT2 is licensed under the GNU General Public Licence version 3.0. For
the complete licence text, see the file 'licence.txt'. This licence applies
to all files in this distribution, except as noted below.

dukglue          | MIT licence.
duktape          | MIT licence.
libcURL          | MIT (or Modified BSD-style) licence.
libicu           | Unicode licence.
libpng           | libpng licence.
libspeex         | BSD-style licence.
libzip           | BSD 3 clause licence.
nlohmann-json    | MIT licence.
OpenSSL          | OpenSSL Licence
SDL2             | zlib licence.
zlib             | zlib licence.
Google Test      | BSD 3 clause licence.
Google Benchmark | Apache 2.0 licence.

Licences for sub-libraries used by the above may vary. For more information, visit the libraries' respective official websites.

9.0) Credits
---- -------
For the full list of contributors to OpenRCT2, see the file 'contributors.md'.