mirror of
https://github.com/OpenRCT2/OpenRCT2
synced 2025-12-24 00:03:11 +01:00
285e0fc42e
- Feature: [#17782] The Flying Coaster now has access to boosters and can draw outside loops. - Feature: [#17997] The Log Flume can now draw steep pieces down (if vehicle allows it). - Feature: [#18312, objects#220, OpenSFX#13] New sound effects for the Hybrid and Single Rail roller coasters. - Feature: [#18675] [Plugin] Plugins can refer to g2 image icons by name. - Feature: [objects#173] Add alpine coaster vehicle. - Feature: [objects#221] Add two extra jungle walls. - Feature: [objects#225] Add log cabin roofs. - Feature: [OpenMusic#14, OpenMusic#15, OpenMusic#18] Added Galaxy, Acid and Dodgems ride music styles. - Improved: [#18013, #18016, #18018, #18019, #18514, objects#224] Added colour presets to Spiral Slide, Dodgems, Boat Hire, Flying Saucers, and Car Ride. - Improved: [#18024] Clearer error messages when loading incompatible .park files. - Improved: [#18192] Tycoon Park has been added to the Extras tab. - Improved: [#18214] Competition scenarios have received their own section. - Improved: [#18250] Added modern style file and folder pickers on Windows. - Improved: [#18332] Allow Inverted Roller Coaster to draw boosters. - Improved: [#18350] Changed ride vehicle list to have less padding. - Improved: [#18422] Allow adding images to music objects. - Improved: [#18428] [Plugin] Add widget description interfaces to documentation. - Improved: [#18487] Mini Helicopters track can now draw spinning tunnels. - Improved: [#18591] Order RollerCoaster Tycoon 2 scenarios by difficulty. - Improved: [#18607] A new tab for all UCES Scenarios, if it’s installed. - Improved: [#18621] OpenGL performance. - Change: [#17677] Open campaign window from finished campaign news. - Change: [#17998] Show cursor when using inverted mouse dragging. - Change: [#18230] Make the large flat to steep pieces available on the corkscrew roller coaster without cheats. - Change: [#18381] Convert custom invisible paths to the built-in ones. - Change: [OpenSFX#11, OpenMusic#19] First implementation of official replacement asset packs for sound effects & music. - Fix: [#1491] Clearance of the Cash Machine is too low (original bug). - Fix: [#1519] “See-through rides” doesn't affect all rides (original bug). - Fix: [#6341] “Unlock vehicle limits” does not allow setting fewer vehicles than the vehicle type requires. - Fix: [#14312] Research ride type message incorrect. - Fix: [#14425] Ride ratings do not skip unallocated ride ids. - Fix: [#15969] Guests heading for ride use vanilla behaviour - Fix: [#17067] Random Staff Patrol Area clicks. - Fix: [#17316] Sides of River Rapids’ corners overlay other parts of the track. - Fix: [#17657] When switching from buying land rights to buying construction rights, grid disables and won't re-enable afterwards. - Fix: [#17763] Missing validation on invalid characters in file name. - Fix: [#17853] Invention name tears while being dragged. - Fix: [#18064] Unable to dismiss notification messages. - Fix: [#18070] Underground entrance/exit shows through terrain walls (original bug). - Fix: [#18094] Underground shops & facilities don't show when adjacent to non-underground path (original bug). - Fix: [#18122] Ghosts count towards “Great scenery!” guest thought. - Fix: [#18134] Underground on-ride photo section partially clips through adjacent terrain edge. - Fix: [#18244] Invention DragWindow's starting position is inconsistent. - Fix: [#18245] Guests stopping dead in their tracks at railway crossings. - Fix: [#18257] Guests ‘waiting’ on extended railway crossings. - Fix: [#18354] Overwrite alert does not show when save name has different casing on Windows. - Fix: [#18379] Tunnel entrances for underground Mini Golf Hole E are not rendered correctly. - Fix: [#18442] About window background is clickable. - Fix: [#18449] [Plugin] Change type of listview widgets from 'scroll_view' to 'listview'. - Fix: [#18453] Slow walking guests don't get across level crossings in time. - Fix: [#18469] Land rights window buttons incorrectly disabled and markers remain visible indefinitely. - Fix: [#18459] ‘Highlight path issues’ hides fences for paths with additions. - Fix: [#18552] Trains clipping through helixes. - Fix: [#18576] Cannot open parks with certain types of corrupt tile elements. - Fix: [#18606] JSON objects do not take priority over the DAT files they supersede. - Fix: [#18620] [Plugin] Crash when reading widget properties from windows that have both static and tab widgets. - Fix: [#18653] Negative ratings multipliers do not appear in Vehicle tab. - Fix: [#18696] Construction rights cannot be viewed after all are purchased. - Fix: [#18720] Upwards helix is enabled for the Alpine Coaster, even when cheats are off. - Fix: [#18755] Ferris Wheel and Circus ghosts not coloured correctly. - Fix: [#18802] Game could crash when determining if a mechanic is heading to fix the ride blocking the path.
267 lines
17 KiB
Markdown
267 lines
17 KiB
Markdown
|
|
|
|
<p align="center">
|
|
<a href="https://openrct2.io">
|
|
<img src="https://raw.githubusercontent.com/OpenRCT2/OpenRCT2/develop/resources/logo/icon_x128.png" style="width: 128px;" alt="OpenRCT2 logo"/>
|
|
</a>
|
|
</p>
|
|
|
|
<h1 align="center">OpenRCT2</h1>
|
|
|
|
<h3 align="center">An open-source re-implementation of RollerCoaster Tycoon 2, a construction and management simulation video game that simulates amusement park management.</h3>
|
|
|
|
---
|
|
|
|
|
|
|
|
---
|
|
|
|
### Download
|
|
| Latest release | Latest development build |
|
|
|-----------------------------------------------------------------------------------------------------------------------|--------------------------|
|
|
| [](https://openrct2.org/downloads/master/latest) | [](https://openrct2.org/downloads/develop/latest) |
|
|
|
|
---
|
|
|
|
### Chat
|
|
Chat takes place on Discord. You will need to create a Discord account if you don't yet have one.
|
|
|
|
If you want to help *make* the game, join the developer channel.
|
|
|
|
If you need help, want to talk to the developers, or just want to stay up to date then join the non-developer channel for your language.
|
|
|
|
If you want to help translate the game to your language, please stop by the Localisation channel.
|
|
|
|
| Language | Non Developer | Developer | Localisation | Asset Replacement |
|
|
| -------- | ------------- | --------- | ------------ | ----------------- |
|
|
| English | [](https://discord.gg/ZXZd8D8) </br> [](https://discord.gg/vJABqGGTEt) | [](https://discord.gg/fsEwSWs) | [](https://discord.gg/sxnrvX9) | [](https://discord.gg/aM2Pchscnp) </br> [](https://discord.gg/tuz3QBBWJf)
|
|
| Nederlands | [](https://discord.gg/cQYSXzW) | | |
|
|
|
|
---
|
|
|
|
# Contents
|
|
- 1 - [Introduction](#1-introduction)
|
|
- 2 - [Downloading the game (pre-built)](#2-downloading-the-game-pre-built)
|
|
- 3 - [Building the game](#3-building-the-game)
|
|
- 3.1 - [Building prerequisites](#31-building-prerequisites)
|
|
- 3.2 - [Compiling and running](#32-compiling-and-running)
|
|
- 4 - [Contributing](#4-contributing)
|
|
- 4.1 - [Bug fixes](#41-bug-fixes)
|
|
- 4.2 - [New features](#42-new-features)
|
|
- 4.3 - [Translation](#43-translation)
|
|
- 4.4 - [Graphics](#44-graphics)
|
|
- 4.5 - [Audio](#45-audio)
|
|
- 4.6 - [Scenarios](#46-scenarios)
|
|
- 5 - [Licence](#5-licence)
|
|
- 6 - [More information](#6-more-information)
|
|
- 7 - [Sponsors](#7-sponsors)
|
|
|
|
---
|
|
|
|
# 1. Introduction
|
|
|
|
**OpenRCT2** is an open-source re-implementation of RollerCoaster Tycoon 2 (RCT2). The gameplay revolves around building and maintaining an amusement park containing attractions, shops and facilities. The player must try to make a profit and maintain a good park reputation whilst keeping the guests happy. OpenRCT2 allows for both scenario and sandbox play. Scenarios require the player to complete a certain objective in a set time limit whilst sandbox allows the player to build a more flexible park with optionally no restrictions or finance.
|
|
|
|
RollerCoaster Tycoon 2 was originally written by Chris Sawyer in x86 assembly and is the sequel to RollerCoaster Tycoon. The engine was based on Transport Tycoon, an older game which also has an equivalent open-source project, [OpenTTD](https://openttd.org). OpenRCT2 attempts to provide everything from RCT2 as well as many improvements and additional features, some of these include support for modern platforms, an improved interface, improved guest and staff AI, more editing tools, increased limits, and cooperative multiplayer. It also re-introduces mechanics from RollerCoaster Tycoon that were not present in RollerCoaster Tycoon 2. Some of those include; mountain tool in-game, the *"have fun"* objective, launched coasters (not passing-through the station) and several buttons on the toolbar.
|
|
|
|
---
|
|
|
|
# 2. Downloading the game (pre-built)
|
|
|
|
OpenRCT2 requires original files of RollerCoaster Tycoon 2 to play. It can be bought at either [Steam](https://store.steampowered.com/app/285330/) or [GOG.com](https://www.gog.com/game/rollercoaster_tycoon_2). If you have the original RollerCoaster Tycoon and its expansion packs, you can [point OpenRCT2 to these](https://github.com/OpenRCT2/OpenRCT2/wiki/Loading-RCT1-scenarios-and-data) in order to play the original scenarios.
|
|
|
|
[OpenRCT2.org](https://openrct2.org/downloads) offers precompiled builds and installers of the latest master and the develop branch. There is also a cross platform [Launcher](https://github.com/LRFLEW/OpenRCT2Launcher/releases) available that will automatically update your build of the game so that you always have the latest version.
|
|
|
|
[Flathub](https://flathub.org/) offers flatpaks for Linux distributions that support this application distribution system:
|
|
* [Latest release](https://flathub.org/apps/details/io.openrct2.OpenRCT2)
|
|
|
|
Some Linux distributions offer native packages already. These packages are usually third-party, but we're trying to resolve issues they are facing.
|
|
* ArchLinux: [openrct2-git](https://aur.archlinux.org/packages/openrct2-git) (AUR) and [openrct2](https://archlinux.org/packages/community/x86_64/openrct2/) (Community)
|
|
* Ubuntu PPA: [`develop` branch](https://launchpad.net/~openrct2/+archive/ubuntu/nightly) (nightly builds)
|
|
* openSUSE OBS: [games/openrct2](https://software.opensuse.org/download.html?project=games&package=openrct2)
|
|
* Gentoo (main portage tree): [games-simulation/openrct2](https://packages.gentoo.org/packages/games-simulation/openrct2)
|
|
* NixOS (`nixos-unstable` channel): [openrct2](https://github.com/NixOS/nixpkgs/blob/master/pkgs/games/openrct2/default.nix)
|
|
* Fedora 28 i386/amd64: [openrct2](https://copr.fedorainfracloud.org/coprs/nauticalnexus/openrct2/)
|
|
|
|
Some \*BSD operating systems offer native packages. These packages are usually third-party, but we're trying to resolve issues they are facing.
|
|
* FreeBSD: [games/openrct2](https://www.freshports.org/games/openrct2)
|
|
* OpenBSD: [games/openrct2](https://openports.se/games/openrct2)
|
|
|
|
---
|
|
|
|
# 3. Building the game
|
|
|
|
## 3.1 Building prerequisites
|
|
|
|
OpenRCT2 requires original files of RollerCoaster Tycoon 2 to play. It can be bought at either [Steam](https://store.steampowered.com/app/285330/) or [GOG.com](https://www.gog.com/game/rollercoaster_tycoon_2).
|
|
|
|
### Windows:
|
|
- Visual Studio 2022 (Enterprise / Professional / [Community (Free)](https://www.visualstudio.com/vs/community/))
|
|
- Desktop development with C++
|
|
- MSYS2 MinGW Toolchain. The toolchains with supported dependencies are `mingw-x86_64`, `mingw-xi686`, `ucrt-x86_64`, `clang-x86_64`, and `clang-xi686`, each of these require the `$MINGW_PACKAGE_PREFIX` and `msys` and `clangarm-64` are lacking packages for some dependencies
|
|
- sdl2 (only for UI client)
|
|
- freetype (can be disabled)
|
|
- fontconfig (can be disabled)
|
|
- libzip (>= 1.0)
|
|
- libpng (>= 1.2)
|
|
- speexdsp (only for UI client)
|
|
- curl (only if building with http support)
|
|
- nlohmann-json (>= 3.6.0)
|
|
- openssl (>= 1.0; only if building with multiplayer support)
|
|
- icu (>= 59.0)
|
|
- zlib
|
|
- gl (commonly provided by Mesa or GPU vendors; only for UI client, can be disabled)
|
|
- cmake
|
|
- benchmark (optional)
|
|
- innoextract (optional runtime dependency; used for GOG installer extraction during setup)
|
|
- libogg
|
|
- libvorbis
|
|
- flac
|
|
|
|
See the wiki for [the actual package names used in pacman](https://github.com/OpenRCT2/OpenRCT2/wiki/Building-OpenRCT2-on-MSYS2-MinGW).
|
|
|
|
### macOS:
|
|
- Xcode Command Line Tools
|
|
- [Homebrew](https://brew.sh)
|
|
- CMake (available through Homebrew)
|
|
|
|
### Linux:
|
|
- gcc (>= 7.1) or clang (>= 8.0.0) (for C++17 support)
|
|
- sdl2 (only for UI client)
|
|
- freetype (can be disabled)
|
|
- fontconfig (can be disabled)
|
|
- libzip (>= 1.0)
|
|
- libpng (>= 1.2)
|
|
- speexdsp (only for UI client)
|
|
- curl (only if building with http support)
|
|
- nlohmann-json (>= 3.6.0)
|
|
- openssl (>= 1.0; only if building with multiplayer support)
|
|
- icu (>= 59.0)
|
|
- zlib
|
|
- gl (commonly provided by Mesa or GPU vendors; only for UI client, can be disabled)
|
|
- cmake
|
|
- innoextract (optional runtime dependency; used for GOG installer extraction during setup)
|
|
|
|
Refer to https://github.com/OpenRCT2/OpenRCT2/wiki/Building-OpenRCT2-on-Linux#required-packages-general for more information about installing the packages.
|
|
|
|
---
|
|
|
|
## 3.2 Compiling and running
|
|
### Windows:
|
|
1. Check out the repository. This can be done using [GitHub Desktop](https://desktop.github.com) or [other tools](https://help.github.com/articles/which-remote-url-should-i-use).
|
|
2. Open a new Developer Command Prompt for VS 2022, then navigate to the repository (e.g. `cd C:\GitHub\OpenRCT2`).
|
|
3. To build the 64-bit version, use `msbuild openrct2.proj /t:build /p:platform=x64`.
|
|
|
|
To build the 32-bit version, use `msbuild openrct2.proj /t:build /p:platform=Win32`.
|
|
4. Run the game, `bin\openrct2`
|
|
|
|
Once you have ran msbuild once, further development can be done within Visual Studio by opening `openrct2.sln`. Make sure to select the correct target platform for which you ran the build in point #3 (`Win32` for the 32-bit version, `x64` for the 64-bit version), otherwise the build will fail in Visual Studio.
|
|
|
|
Other examples:
|
|
```
|
|
set platform=x64
|
|
msbuild openrct2.proj /t:clean
|
|
msbuild openrct2.proj /t:rebuild /p:configuration=release
|
|
msbuild openrct2.proj /t:g2
|
|
msbuild openrct2.proj /t:PublishPortable
|
|
```
|
|
|
|
### macOS:
|
|
#### CMake:
|
|
CMake can build either a self-contained application bundle, which includes all the necessary game files and dependencies, or it can build a command line version that links against system installed dependencies. CMake will retrieve the dependencies from [Dependencies](https://github.com/OpenRCT2/Dependencies/) automatically. You can build the macOS app using CMake using the following commands:
|
|
```
|
|
cmake -S . -B build
|
|
cmake --build build --target install
|
|
```
|
|
Then you can run the game by opening `OpenRCT2.app`
|
|
|
|
To build the command line version, you'll need to disable the macOS app bundle:
|
|
```
|
|
|
|
cmake -S . -B build -DMACOS_BUNDLE=off
|
|
cmake --build build
|
|
cmake --build build --target install
|
|
ln -s ../data data
|
|
```
|
|
Then you can run the game by running `./openrct2`.
|
|
|
|
To link against system dependencies instead of letting CMake download the dependencies from [Dependencies](https://github.com/OpenRCT2/Dependencies), add `-DMACOS_USE_DEPENDENCIES=off` to your cmake args.
|
|
|
|
Detailed instructions can be found on [Building OpenRCT2 on macOS using CMake](https://github.com/OpenRCT2/OpenRCT2/wiki/Building-OpenRCT2-on-macOS-using-CMake).
|
|
|
|
### Linux:
|
|
The standard CMake build procedure is to install the [required libraries](https://github.com/OpenRCT2/OpenRCT2#linux), then:
|
|
```
|
|
cmake -S . -B build -DCMAKE_INSTALL_PREFIX=. # set your standard cmake options, e.g. build type here - For example, -DCMAKE_BUILD_TYPE=RelWithDebInfo
|
|
cmake --build build # you can parallelise your build job with e.g. -j 8 or consider using ninja
|
|
cmake --build build --target install # the install target creates all the necessary files in places we expect them
|
|
```
|
|
|
|
You can also use Ninja in place of Make using `-G Ninja` in the first command, if you prefer, see Wiki for details.
|
|
|
|
Detailed instructions can be found on [Building OpenRCT2 on Linux](https://github.com/OpenRCT2/OpenRCT2/wiki/Building-OpenRCT2-on-Linux).
|
|
|
|
Note: the `cmake -S . -B build` syntax is available for CMake >= 3.14. For older versions use:
|
|
```
|
|
mkdir build
|
|
cd build
|
|
cmake .. -DCMAKE_INSTALL_PREFIX=. # set your standard cmake options, e.g. build type here - For example, -DCMAKE_BUILD_TYPE=RelWithDebInfo
|
|
cmake --build . --target install
|
|
```
|
|
|
|
---
|
|
|
|
# 4. Contributing
|
|
OpenRCT2 uses the [gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows#gitflow-workflow). If you are implementing a new feature or logic from the original game, please branch off and perform pull requests to ```develop```. If you are fixing a bug for the next release, please branch off and perform pull requests to the correct release branch. ```master``` only contains tagged releases, you should never branch off this.
|
|
|
|
Please read our [contributing guidelines](https://github.com/OpenRCT2/OpenRCT2/blob/develop/CONTRIBUTING.md) for information.
|
|
|
|
## 4.1 Bug fixes
|
|
A list of bugs can be found on the [issue tracker](https://github.com/OpenRCT2/OpenRCT2/issues). Feel free to work on any bug and submit a pull request to the develop branch with the fix. Mentioning that you intend to fix a bug on the issue will prevent other people from trying as well.
|
|
|
|
## 4.2 New features
|
|
Please talk to the OpenRCT2 team first before starting to develop a new feature. We may already have plans for or reasons against something that you'd like to work on. Therefore contacting us will allow us to help you or prevent you from wasting any time. You can talk to us via Discord, see links at the top of this page.
|
|
|
|
## 4.3 Translation
|
|
You can translate the game into other languages by editing the language files in ```data/language``` directory. Please join discussions in the [#localisation channel on Discord](https://discordapp.com/invite/sxnrvX9) and submit pull requests to [OpenRCT2/Localisation](https://github.com/OpenRCT2/Localisation).
|
|
|
|
## 4.4 Graphics
|
|
You can help create new graphics for the game by visiting the [OpenGraphics project](https://github.com/OpenRCT2/OpenGraphics). 3D modellers needed!
|
|
|
|
## 4.5 Audio
|
|
You can help create the music and sound effects for the game. Check out the OpenMusic repository and drop by our [#open-sound-and-music channel on Discord](https://discord.gg/9y8WbcX) to find out more.
|
|
|
|
## 4.6 Scenarios
|
|
We would also like to distribute additional scenarios with the game, when the time comes. For that, we need talented scenario makers! Check out the [OpenScenarios repository](https://github.com/PFCKrutonium/OpenRCT2-OpenScenarios).
|
|
|
|
---
|
|
|
|
# 5. Licence
|
|
**OpenRCT2** is licensed under the GNU General Public License version 3.
|
|
|
|
---
|
|
|
|
# 6. More information
|
|
- [GitHub](https://github.com/OpenRCT2/OpenRCT2)
|
|
- [OpenRCT2.org](https://openrct2.org)
|
|
- [Forums](https://openrct2.org/forums/)
|
|
- [Facebook](https://www.facebook.com/OpenRCT2)
|
|
- [RCT subreddit](https://www.reddit.com/r/rct/)
|
|
- [OpenRCT2 subreddit](https://www.reddit.com/r/openrct2/)
|
|
|
|
## Similar Projects
|
|
|
|
| [OpenLoco](https://github.com/OpenLoco/OpenLoco) | [OpenTTD](https://github.com/OpenTTD/OpenTTD) | [openage](https://github.com/SFTtech/openage) | [OpenRA](https://github.com/OpenRA/OpenRA) |
|
|
|:------------------------------------------------:|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------:|
|
|
| [](https://github.com/OpenLoco/OpenLoco) | [](https://github.com/OpenTTD/OpenTTD) | [](https://github.com/SFTtech/openage) | [](https://github.com/OpenRA/OpenRA) |
|
|
| Chris Sawyer's Locomotion | Transport Tycoon Deluxe | Age of Empires 2 | Red Alert |
|
|
|
|
# 7. Sponsors
|
|
|
|
Companies that kindly allow us to use their stuff:
|
|
|
|
| [DigitalOcean](https://www.digitalocean.com/) | [JetBrains](https://www.jetbrains.com/) | [Backtrace](https://backtrace.io/) |
|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| [](https://www.digitalocean.com/) | [](https://www.jetbrains.com/) | [](https://backtrace.io/) |
|
|
| Hosting of various services | CLion and other products | Minidump uploads and inspection |
|