Go to file
Michał Janiszewski 55a4359749 Add mingw toolchain file for cmake 2018-01-29 00:00:53 +01:00
data/language ko-KR: Fully translated (#41) 2018-01-24 18:50:29 +00:00
distribution/linux Move Ubuntu 32 bit Dockerfile to common directory 2018-01-29 00:00:53 +01:00
dockerfiles Add Ninja to Fedora docker 2018-01-29 00:00:53 +01:00
scripts Run clang-format on CI 2018-01-23 23:11:58 +01:00
src/openloco Rework create_viewport function signature 2018-01-28 20:13:28 +01:00
.clang-format Add format 2018-01-23 23:11:58 +01:00
.gitignore [gitignore] Add .vscode 2018-01-27 14:46:52 +00:00
.travis.yml Make Travis keep building even after encountered errors 2018-01-25 14:45:47 +01:00
CHANGELOG.md Allow shift+click track / road construction 2018-01-16 15:27:32 +00:00
CMakeLists.txt Remove me-specific paths in CMakeLists 2018-01-25 18:07:44 +00:00
CMakeLists_mingw.txt Add mingw toolchain file for cmake 2018-01-29 00:00:53 +01:00
LICENSE Initial commit 2018-01-06 23:35:23 +00:00
README.md Fix readme.md 2018-01-23 08:35:44 +00:00
appveyor.yml Package AppVeyor-built dll as artifact (#31) 2018-01-23 23:24:48 +00:00
loco.exe Cleanup loco.exe file (#6) 2018-01-21 13:18:43 +00:00
openloco.common.props Don't deprecate POSIX names with MSVC 2018-01-24 15:05:54 +01:00
openloco.sln Add initial working wrapper 2018-01-07 03:18:38 +00:00

README.md

OpenLoco

An open source re-implementation of Chris Sawyer's Locomotion. A construction and management simulation video game that simulates running a transport company.


Contents


Build Status

Windows Linux / Mac Download
master AppVeyor Travis CI GitHub release

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.

Language Non Developer Developer
English Gitter Gitter

1 Introduction

OpenLoco is an open-source re-implementation of Chris Sawyer's Locomotion (CSL). CSL is the spiritual successor to Transport Tycoon and OpenLoco aims to improve the game similar to how OpenTTD improved Transport Tycoon and OpenRCT2 improved RollerCoaster Tycoon.

Chris Sawyer's Locomotion was written by Chris Sawyer in x86 assembly building on top of his RollerCoaster Tycoon 2 engine. Much of the code is 1:1 with RollerCoaster Tycoon 2. This means that only select areas of the game such as the update logic should be written. The engine code such as audio, drawing and the window system should be left alone as it would only repeat the work that has already been done for OpenRCT2. It is more beneficial to share as much code as possible between OpenRCT2 and OpenLoco.


2 Downloading the game (pre-built)

OpenLoco requires original files of Chris Sawyer's Locomotion to play. It can be bought at either Steam or GOG.com.

The latest release can be found on GitHub.


3 Building the game

3.1 Building prerequisites

OpenLoco requires original files of Chris Sawyer's Locomotion to play. It can be bought at either Steam or GOG.com.

Windows:

  • 7 / 8 / 10
  • Visual Studio 2017 update 5.5+
    • Desktop development with C++
    • Windows 10 SDK (10.0.14393.0)
  • SDL2
    • Development Libraries

Linux:

OpenLoco can not currently be built on Linux without a cross compiler. Pull requests are welcome to fix building for Linux. There are many function calls still to Win32 APIs. These require 'hooking' so that they can be replaced with cross-platform implementations. Scripts for linking in the loco.exe binary sections and remapping the address space can be found in the OpenRCT2 code base.

macOS:

See Linux.


3.2 Compiling and running

Windows:

  1. Check out the repository. This can be done using GitHub Desktop or other tools.
  2. Copy SDL2 into a sub directory called lib under the root, alternatively use vcpkg.
  3. Open a new Developer Command Prompt for VS 2017, then navigate to the repository (e.g. cd C:\GitHub\OpenRCT2).
  4. Run msbuild openloco.sln.
  5. Run the game, bin\openloco

Linux:

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

mkdir build
cd build
cmake ../
make

4 Licence

OpenLoco is licensed under the MIT License.


5 More information