OpenRCT2/readme.md

226 lines
14 KiB
Markdown
Raw Normal View History

2014-04-15 01:50:20 +02:00
# OpenRCT2
2016-06-19 02:55:36 +02:00
An open-source re-implementation of RollerCoaster Tycoon 2. A construction and management simulation video game that simulates amusement park management.
2014-04-15 01:50:20 +02:00
---
![OpenRCT2.org Group Park 5](https://i.imgur.com/e7CK5Sc.png)
---
2016-03-21 13:46:40 +01:00
### Build Status
2016-06-13 20:27:40 +02:00
| | Windows | Linux / Mac | Download |
2016-03-22 18:56:30 +01:00
|-------------|---------|-------------|----------|
Release 0.2.4 - Feature: [#9285] Remember current group in scenario list window. - Feature: [#9918] Increase image list capacity by about 100k units. - Change: [#1349] Increase the number of ride music played simultaneously from 2 to 32. - Fix: [#4927] Giant screenshot cut off at bottom and top. - Fix: [#7572] Queue paths connect to regular paths through fences. - Fix: [#7690] Problem with guests freezing on certain tiles of path. - Fix: [#7883] Headless server log is stored incorrectly if server name contains CJK in Ubuntu - Fix: [#8136] Excessive lateral G penalty is too excessive. - Fix: [#8584] Duck spawning function does not check tiles with x or y coordinate of 0..64 (Original bug) - Fix: [#9179] Crash when modifying a ride occasionally. - Fix: [#9533] Door sounds not playing. - Fix: [#9574] Text overflow in scenario objective window when using CJK languages. - Fix: [#9603] Don't render audio when master volume is turned off. - Fix: [#9625] Show correct cost in scenery selection. - Fix: [#9669] The tile inspector shortcut key does not work with debugging tools disabled. - Fix: [#9675] Guest entry point limit can be bypassed in scenario editor. - Fix: [#9683] Cannot raise water level if part of the tool's area of effect is off of the map. - Fix: [#9684] Entering custom size for water/land tool allows confirmation with main enter key, but not numpad enter key. - Fix: [#9690] The keyboard shortcut for rotating the game view can be set to Enter or KP Enter, but not both. - Fix: [#9717] Scroll bars do not render correctly when using OpenGL renderer. - Fix: [#9729] Peeps do not take into account height difference when deciding to pathfind to a ride entrance (original bug). - Fix: [#9902] Doors/Portcullis do not check to make sure doors are open causing double opens. - Fix: [#9926] Africa - Oasis park has wrong peep spawn (original bug). - Fix: [#9953] Crash when hacked rides attempt to find the closest mechanic. - Fix: [#9955] Resizing map in while pause mode does not work and may result in freezes. - Fix: [#9957] When using 'no money' cheat, guests complain of running out of cash. - Fix: [#9970] Wait for quarter load fails. - Fix: [#9994] Game action tick collision during server connect and map load. - Fix: [#10017] Ghost elements influencing ride excitement. - Fix: [#10036] Do not allocate large chunks of memory for save file classification. - Fix: [#10106] Ride circuits should not be used for modes that do not support it. - Fix: [#10149] Desync in headless mode with rides that create smoke particles. - Improved: [#9466] Add the rain weather effect to the OpenGL renderer. - Improved: [#9987] Minimum load rounding. - Improved: [#10125] Better support for high DPI screens.
2019-10-28 21:18:47 +01:00
| **master** | [![AppVeyor](https://ci.appveyor.com/api/projects/status/7efnemxhon6i5n34/branch/master?svg=true)](https://ci.appveyor.com/project/IntelOrca/openrct2-ject9) | [![Travis CI](https://travis-ci.org/OpenRCT2/OpenRCT2.svg?branch=master)](https://travis-ci.org/OpenRCT2/OpenRCT2) | [![OpenRCT2.org](https://img.shields.io/badge/master-v0.2.4-green.svg)](https://openrct2.org/downloads/master/latest) |
| **develop** | [![AppVeyor](https://ci.appveyor.com/api/projects/status/7efnemxhon6i5n34/branch/develop?svg=true)](https://ci.appveyor.com/project/IntelOrca/openrct2-ject9) | [![Travis CI](https://travis-ci.org/OpenRCT2/OpenRCT2.svg?branch=develop)](https://travis-ci.org/OpenRCT2/OpenRCT2) | [![OpenRCT2.org](https://img.shields.io/badge/develop-v0.2.4+-blue.svg)](https://openrct2.org/downloads/develop/latest) |
2014-08-16 18:05:57 +02:00
---
2016-03-21 13:46:40 +01:00
### Chat
2018-10-01 21:04:53 +02:00
You only need a [GitHub](https://github.com/), [GitLab](https://gitlab.com), or [Twitter](https://twitter.com) account to access these channels.
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 |
|----------|---------------|-----------|--------------|
| English | [![Gitter](https://img.shields.io/badge/gitter-general-blue.svg)](https://gitter.im/OpenRCT2/OpenRCT2/non-dev) | [![Gitter](https://img.shields.io/badge/gitter-development-yellowgreen.svg)](https://gitter.im/OpenRCT2/OpenRCT2) | [![Gitter](https://img.shields.io/badge/gitter-localisation-green.svg)](https://gitter.im/OpenRCT2/Localisation) |
| Nederlands | [![Gitter](https://img.shields.io/badge/gitter-general-blue.svg)](https://gitter.im/OpenRCT2/OpenRCT2/Nederlands) | | |
---
2014-11-03 19:24:43 +01:00
2014-04-15 01:50:20 +02:00
# Contents
- 1 - [Introduction](#1-introduction)
2016-06-19 02:55:36 +02:00
- 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)
2018-10-19 09:28:22 +02:00
- 4.4 - [Graphics](#44-graphics)
- 4.5 - [Audio](#45-audio)
- 4.6 - [Scenarios](#46-scenarios)
2016-06-19 02:55:36 +02:00
- 5 - [Licence](#5-licence)
- 6 - [More information](#6-more-information)
2018-03-01 23:36:57 +01:00
- 7 - [Sponsors](#7-sponsors)
2014-04-15 01:50:20 +02:00
---
# 1. Introduction
2014-04-15 01:50:20 +02:00
2016-06-19 02:55:36 +02:00
**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.
2014-04-15 01:50:20 +02:00
2016-07-13 11:00:01 +02:00
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](http://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.
2014-04-15 01:50:20 +02:00
---
# 2. Downloading the game (pre-built)
2014-04-15 01:50:20 +02:00
OpenRCT2 requires original files of RollerCoaster Tycoon 2 to play. It can be bought at either [Steam](http://store.steampowered.com/app/285330/) or [GOG.com](http://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.
2014-04-15 01:50:20 +02:00
[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.
Some Linux distributions offer native packages already. These packages are usually third-party, but we're trying to resolve issues they are facing.
* ArchLinux AUR: [openrct2-git](https://aur.archlinux.org/packages/openrct2-git) and [openrct2](https://aur.archlinux.org/packages/openrct2)
* 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.
* OpenBSD: [games/openrct2](http://openports.se/games/openrct2)
---
# 3. Building the game
2015-03-21 19:18:45 +01:00
2016-06-19 02:55:36 +02:00
## 3.1 Building prerequisites
2014-04-15 01:50:20 +02:00
2016-06-19 02:55:36 +02:00
OpenRCT2 requires original files of RollerCoaster Tycoon 2 to play. It can be bought at either [Steam](http://store.steampowered.com/app/285330/) or [GOG.com](http://www.gog.com/game/rollercoaster_tycoon_2).
2014-05-23 14:29:09 +02:00
### Windows:
- Visual Studio 2019 (Enterprise / Professional / [Community (Free)](https://www.visualstudio.com/vs/community/))
- Desktop development with C++
2016-10-24 10:58:10 +02:00
### macOS:
- Xcode 8
The program can also be built as a command line program using CMake. This type of build requires:
- Xcode Command Line Tools
- [Homebrew](http://brew.sh)
2016-10-24 10:58:10 +02:00
- CMake (available through Homebrew)
2014-08-17 22:01:05 +02:00
2016-10-24 10:58:10 +02:00
### Linux:
- 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)
- jansson (>= 2.5)
- openssl (>= 1.0; only if building with multiplayer support)
2018-05-15 22:41:49 +02:00
- icu (>= 59.0)
- zlib
- gl (commonly provided by Mesa or GPU vendors; only for UI client, can be disabled)
- cmake
2014-05-23 14:29:09 +02:00
---
2016-06-19 02:55:36 +02:00
## 3.2 Compiling and running
2014-05-23 14:29:09 +02:00
### Windows:
2016-07-28 13:19:40 +02:00
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).
2020-02-03 16:45:19 +01:00
2. Open a new Developer Command Prompt for VS 2019, 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`.
2016-11-24 00:43:38 +01:00
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.
2016-08-26 00:58:43 +02:00
Other examples:
```
2016-11-24 00:42:23 +01:00
set platform=x64
2016-08-26 00:58:43 +02:00
msbuild openrct2.proj /t:clean
2016-11-24 00:42:23 +01:00
msbuild openrct2.proj /t:rebuild /p:configuration=release
2016-08-26 00:58:43 +02:00
msbuild openrct2.proj /t:g2
msbuild openrct2.proj /t:PublishPortable
```
2014-04-15 01:50:20 +02:00
2016-10-24 10:58:10 +02:00
### macOS:
#### Xcode:
The recommended way of building OpenRCT2 for macOS is with Xcode. The Xcode build will create a self-contained application bundles which include all the necessary game files and dependencies. Open the project file OpenRCT2.xcodeproj in Xcode and build from there. Building this way will handle the dependencies for you automatically. You can also invoke an Xcode build from the command line using `xcodebuild`.
2015-12-12 13:53:16 +01:00
2016-10-24 10:58:10 +02:00
#### CMake:
A command line version of OpenRCT2 can be built using CMake. This type of build requires you to provide the dependencies yourself. The supported method of doing this is with [Homebrew](http://brew.sh). Once you have Homebrew installed, you can download all the required libraries with this command:
```
brew install cmake openssl jansson libpng sdl2 speexdsp libzip freetype pkg-config
2016-10-24 10:58:10 +02:00
```
2015-12-12 13:53:16 +01:00
2016-10-24 10:58:10 +02:00
Once you have the dependencies installed, you can build the project using CMake using the following commands:
```
mkdir build
cd build
cmake ..
make
ln -s ../data data
2014-08-17 22:01:05 +02:00
```
2016-10-24 10:58:10 +02:00
Then you can run the game by running `./openrct2`.
2014-08-17 22:01:05 +02:00
2014-05-23 14:29:09 +02:00
### Linux:
2016-10-24 10:58:10 +02:00
The standard CMake build procedure is to install the [required libraries](https://github.com/OpenRCT2/OpenRCT2#mac--linux), then:
```
mkdir build
cd build
cmake ../ # set your standard cmake options, e.g. build type here - For example, -DCMAKE_BUILD_TYPE=RelWithDebInfo
make # you can parallelise your build job with e.g. -j8 or consider using ninja
DESTDIR=. make install # the install target creates all the necessary files in places we expect them
```
You can also use Ninja in place of Make, if you prefer, see Wiki for details.
Detailed instructions can be found on our [wiki](https://github.com/OpenRCT2/OpenRCT2/wiki/Building-OpenRCT2-on-Linux).
2014-05-23 14:29:09 +02:00
---
# 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.
2014-04-15 01:50:20 +02:00
2015-09-09 19:25:48 +02:00
Please read our [contributing guidelines](https://github.com/OpenRCT2/OpenRCT2/blob/develop/CONTRIBUTING.md) for information.
2016-06-19 02:55:36 +02:00
## 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.
2014-04-15 01:50:20 +02:00
2016-06-19 02:55:36 +02:00
## 4.2 New features
Please talk to the OpenRCT2 team first before starting to develop a new feature. We may already have plans or reasons against it, therefore contacting us will allow us to help you or prevent you from wasting any time. You can talk to us via gitter, see links at the top of this page.
2014-04-15 01:50:20 +02:00
2016-06-19 02:55:36 +02:00
## 4.3 Translation
You can translate the game into other languages by editing the language files in ```data/language``` directory. Please join discussions and submit pull requests to [OpenRCT2/Localisation](https://github.com/OpenRCT2/Localisation).
2015-02-17 19:49:29 +01:00
2018-10-19 09:28:22 +02:00
## 4.4 Graphics
You can help create new graphics for the game by visiting the [OpenGraphics project](https://gitter.im/OpenRCT2/OpenGraphics). 3D modellers needed!
2018-10-19 09:28:22 +02:00
## 4.5 Audio
You can help create the music and sound effects for the game, drop by [the OpenMusic chat](https://gitter.im/OpenRCT2/OpenMusic) to find out more.
2018-10-19 09:28:22 +02:00
## 4.6 Scenarios
2018-10-19 09:28:22 +02:00
We also need need scenarios to distribute with the game, when the time comes. For that, we need talented scenario makers! Come chat with us [over here](https://gitter.im/PFCKrutonium/OpenRCT2-OpenScenarios)!
---
# 5. Licence
2014-04-25 17:07:07 +02:00
**OpenRCT2** is licensed under the GNU General Public License version 3.
2014-12-09 19:31:46 +01:00
---
# 6. More information
2015-06-24 18:14:07 +02:00
- [GitHub](https://github.com/OpenRCT2/OpenRCT2)
- [OpenRCT2.org](https://openrct2.org)
- [Forums](https://openrct2.org/forums/)
2014-12-09 19:31:46 +01:00
- [Facebook](https://www.facebook.com/OpenRCT2)
- [RCT subreddit](http://www.reddit.com/r/rct/)
- [OpenRCT2 subreddit](http://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) |
|:------------------------------------------------:|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------:|
| [![icon_x128](https://user-images.githubusercontent.com/604665/53047651-2c533c00-3493-11e9-911a-1a3540fc1156.png)](https://github.com/OpenLoco/OpenLoco) | [![](https://github.com/OpenTTD/OpenTTD/raw/850d05d24d4768c81d97765204ef2a487dd4972c/media/openttd.128.png)](https://github.com/OpenTTD/OpenTTD) | [![](https://user-images.githubusercontent.com/550290/36507534-4693f354-175a-11e8-93a7-faa0481474fb.png)](https://github.com/SFTtech/openage) | [![](https://raw.githubusercontent.com/OpenRA/OpenRA/bleed/packaging/linux/icons/ra_128x128.png)](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/) |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| [![do_logo_vertical_blue svg](https://user-images.githubusercontent.com/550290/36508276-8b572f0e-175c-11e8-8622-9febbce756b2.png)](https://www.digitalocean.com/) | [![jetbrains](https://user-images.githubusercontent.com/550290/36413299-0e0985ea-161e-11e8-8a01-3ef523b5905b.png)](https://www.jetbrains.com/) | [![backtrace](https://user-images.githubusercontent.com/550290/47113259-d0647680-d258-11e8-97c3-1a2c6bde6d11.png)](https://backtrace.io/) |
| Hosting of various services | CLion and other products | Minidump uploads and inspection |