An open source re-implementation of Roller Coaster Tycoon 2.
Pull request Compare This branch is 888 commits behind OpenRCT2:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Release 0.1.2 Mar 18, 2018
.vs Revert accidental deletion May 1, 2018
.vscode Add gtest include directory [ci skip] Apr 10, 2018
OpenRCT2.xcodeproj Update Xcode IDEWorkspaceChecks May 2, 2018
data Merge Localisation/master into OpenRCT2/develop. May 7, 2018
debian Explicitly require libzip>=1.0.0 for debian Mar 27, 2018
distribution Add changelog entry May 3, 2018
dockerfiles Update Ubuntu docker image to use clang 5 Mar 21, 2018
resources Fix #5339: Change scenery eyedropper to use a relevant icon. Mar 19, 2018
scripts Collect coverage on Travis Apr 23, 2018
src Add namespace closing comments May 4, 2018
test Add namespace closing comments May 4, 2018
.clang-format Sync clang-format with OpenLoco May 5, 2018
.codecov.yml Turn off codecov comments on PRs Apr 25, 2018
.dockerignore Add dockerfile for openrct2-cli Feb 1, 2018
.editorconfig Add .editorconfig Apr 16, 2018
.gitattributes Added Xcode Project Dec 20, 2015
.gitignore Add objectsversion to .gitignore May 2, 2018
.travis.yml Merge pull request #7414 from OpenRCT2/refactor/string-conversions Apr 25, 2018
CMakeLists.txt Update objects to version 1.0.1 Apr 30, 2018
CMakeLists_mingw.txt Fix mingw cross-compiler prefix Jan 28, 2018
CONTRIBUTING.md Compile localisation folder as C++ Jan 6, 2018
appveyor.yml Enable integration tests on CI Apr 10, 2018
contributors.md [ci skip] Update contributors May 1, 2018
licence.txt (test commit for travis please ignore) May 25, 2014
openrct2.common.props Enable full debug information for MSVC Apr 17, 2018
openrct2.exe patch exe to remove DirectDraw, DirectInput and DirectPlay dependencies. Aug 18, 2015
openrct2.proj Update objects to version 1.0.1 Apr 30, 2018
openrct2.sln Add libopenrct2 as a dependency of openrct2-cli in VS solution Mar 27, 2018
openrct2.targets Fix DownloadDependency task for VS2017 RC Dec 17, 2016
readme.md Update readme to include new Fedora Copr repo Apr 25, 2018

readme.md

OpenRCT2

An open-source re-implementation of RollerCoaster Tycoon 2. A construction and management simulation video game that simulates amusement park management.


OpenRCT2.org Group Park 5


Build Status

Windows Linux / Mac Download
master AppVeyor Travis CI OpenRCT2.org
develop AppVeyor Travis CI OpenRCT2.org

Chat

You only need a GitHub or Twitter 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 Gitter Gitter
Nederlands Gitter

Contents


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. 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 or GOG.com. If you have the original RollerCoaster Tycoon and its expansion packs, you can point OpenRCT2 to these in order to play the original scenarios.

OpenRCT2.org offers precompiled builds and installers of the latest master and the develop branch. There is also a cross platform Launcher 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.

Some *BSD operating systems offer native packages. These packages are usually third-party, but we're trying to resolve issues they are facing.


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 or GOG.com.

Windows:

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
  • CMake (available through Homebrew)

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)
  • iconv (part of glibc on Linux)
  • zlib
  • gl (commonly provided by Mesa or GPU vendors; only for UI client, can be disabled)
  • cmake

3.2 Compiling and running

Windows:

  1. Check out the repository. This can be done using GitHub Desktop or other tools.
  2. Open a new Developer Command Prompt for VS 2017, then navigate to the repository (e.g. cd C:\GitHub\OpenRCT2).
  3. Run msbuild openrct2.proj /t:build /p:platform=x64.
  4. Run the game, bin\openrct2

Once you have ran msbuild once, further development can be done within Visual Studio by opening openrct2.sln.

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:

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.

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. 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

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

Then you can run the game by running ./openrct2.

Linux:

The standard CMake build procedure is to install the required libraries, then:

mkdir build
cd build
cmake ../
make

Detailed instructions can be found on our wiki.


4. Contributing

OpenRCT2 uses the 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 for information.

4.1 Bug fixes

A list of bugs can be found on the issue tracker. 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 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.

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.


5. Licence

OpenRCT2 is licensed under the GNU General Public License version 3.


6. More information

Similar Projects

OpenLoco OpenTTD openage OpenRA
art128_wide
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 JetBrains AppVeyor Travis-CI
do_logo_vertical_blue svg jetbrains AppVeyor Travis
Hosting of various services CLion and other products MSVC CI Linux + macOS CI