Go to file
Michael Steenbeek c0a64265e6 Add .desktop file for Linux 2021-01-03 12:52:58 +01:00
.github Migrate Linux CI jobs to GitHub Actions (#701) 2021-01-02 19:06:33 +01:00
cmake Add CMake option to build with CCache 2020-10-25 11:15:05 +01:00
data/language Optionally disable AI companies entirely (#569) 2020-08-20 17:01:01 +02:00
distribution Add .desktop file for Linux 2021-01-03 12:52:58 +01:00
dockerfiles Remove Boost from Fedora Dockerfile. 2020-03-19 00:55:49 +01:00
resources Titlecasev files openloco (#604) 2020-09-07 06:42:02 +01:00
scripts rename Thirdparty/FileSystem.hpp (#619) 2020-09-11 08:07:54 +01:00
src Implement arrangeStructs (#686) 2021-01-03 07:44:02 +00:00
.clang-format Update .clang-format for new version of clang-format 2020-03-17 21:02:25 +00:00
.gitignore Add CMake build/ directory to gitignore 2020-06-20 10:49:24 +02:00
.travis.yml Migrate Linux CI jobs to GitHub Actions (#701) 2021-01-02 19:06:33 +01:00
CHANGELOG.md Fix #151: Mouse moves out of window when looking around (#703) 2021-01-02 21:40:36 +01:00
CMakeLists.txt Add .desktop file for Linux 2021-01-03 12:52:58 +01:00
CMakeLists_mingw.txt Add mingw toolchain file for cmake 2018-01-29 00:00:53 +01:00
CONTRIBUTORS.MD Implement window open function and draw rating bar 2020-05-05 20:13:58 +01:00
LICENSE Update license to reflect project state. (#281) 2019-02-24 22:54:39 +00:00
README.md Fixed Readme typo (#539) 2020-07-11 18:27:55 +01:00
docker-compose.yml Use OpenLoco's docker images 2020-03-18 23:38:10 +01:00
loco.exe Cleanup loco.exe file (#6) 2018-01-21 13:18:43 +00:00
openloco.common.props Update readme 2020-04-24 13:44:15 +01:00
openloco.sln Rename /src/OpenLoco folder (#624) 2020-09-13 22:15:38 +01: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 CI Travis CI GitHub release

Chat

Feel free to join our Discord server to talk about developing the game, or for help getting it to run.

Discord

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 originally 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. However, the engine has changed substantially enough that OpenLoco currently does not share its codebase with OpenRCT2.

Recent implementation efforts have focussed on re-implementing the UI, so that the data structures involved may be better understood. Once this is done, it is our hope the game logic will be easier to understand and implement.


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.

Regardless of platform, the following libraries/dependencies are required:

Windows

Linux / macOS

  • cmake
  • make or ninja
  • 32-bit versions of the libraries mentioned above

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 2019, then navigate to the repository (e.g. cd C:\GitHub\OpenLoco).
  3. Run msbuild openloco.sln /t:restore;build
  4. Run mklink /D bin\data ..\data or xcopy data bin\data /EIY
  5. Run the game, bin\openloco

Linux / macOS:

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

mkdir build
cd build
CXXFLAGS="-m32" cmake ..
make

Running the game will need the data directory from the root of the source code next to the binary. Assuming you're in $SRC/build,

ln -s ../data
OR
cp -r ../data ./data 

4 Licence

OpenLoco is licensed under the MIT License.


5 More information