An open source re-implementation of RollerCoaster Tycoon 2.
C C++ Objective-C CMake XC NSIS Other
Latest commit 41bab04 Jan 18, 2017 @Gymnasiast Gymnasiast committed on GitHub Log number of exported objects as verbose, fixes #5063
Permalink
Failed to load latest commit information.
.github Start v0.0.6 Dec 27, 2016
.vscode Add vscode launch configuration Dec 12, 2016
OpenRCT2.xcodeproj Combine drawing of the Spiral and Mini RC (#5025) Jan 9, 2017
data Merge Localisation/master into OpenRCT2/develop. Jan 16, 2017
debian Start v0.0.6 Dec 27, 2016
distribution Ensure object list pointer is updated after realloc Jan 12, 2017
dockerfiles Add Dockerfiles with Ubuntu 16.04 for mingw, i686, amd64 Dec 15, 2016
resources CppCheck fixes Dec 24, 2016
scripts Fix #5010 windows builds not pushed Jan 7, 2017
src Log number of exported objects as verbose, fixes #5063 Jan 18, 2017
test Test vertical tunnels properly Jan 17, 2017
.clang-format clang-format: better pattern for common.h Jan 14, 2017
.gitattributes Added Xcode Project Dec 20, 2015
.gitignore Update VS project files Jan 4, 2017
.travis.yml Have at least one Travis job in release configuration Jan 13, 2017
CMakeLists.txt Merge pull request #5044 from janisozaur/ninja Jan 16, 2017
CMakeLists_mingw.txt Fix CMakeLists for MinGW cross-compilation Dec 28, 2015
CONTRIBUTING.md Update CONTRIBUTING.md Jan 1, 2017
appveyor.yml Use editbin instead to change subsystem Jan 10, 2017
contributors.md Update contributors.md for pathfinding improvements. Nov 6, 2016
licence.txt (test commit for travis please ignore) May 25, 2014
openrct2.common.props More warning fixes, more warnings disabled Jan 12, 2017
openrct2.exe patch exe to remove DirectDraw, DirectInput and DirectPlay dependencies. Aug 18, 2015
openrct2.proj msbuild: Fix building g2 with spacy paths Jan 16, 2017
openrct2.sln Rename openrct2-lib to libopenrct2 Jan 10, 2017
openrct2.targets Fix DownloadDependency task for VS2017 RC Dec 17, 2016
readme.md Minor: Homebrew package update for SpeexDSP Jan 14, 2017

readme.md

OpenRCT2

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

Build Status

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

Chat

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

OpenRCT2.org offers precompiled builds and installers of the latest stable 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.

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:

  • 7 / 8 / 10
  • Visual Studio 2015 Update 3 or 2017 RC (Enterprise / Professional / Community (Free))
  • 7-Zip (for deployment only)
  • NSIS (for deployment only)

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
  • sdl2-ttf (can be disabled)
  • fontconfig (can be disabled)
  • libzip (>= 1.0)
  • libpng (>= 1.2)
  • speexdsp
  • 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; 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 VS2015, 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 sdl2_ttf speexdsp libzip

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