An open source re-implementation of Chris Sawyer's Locomotion. A construction and management simulation video game that simulates running a transport company.
- 1 - Introduction
- 2 - Downloading the game (pre-built)
- 3 - Contributing
- 4 - Compiling the game
- 4.1 - Building prerequisites
- 4.2 - Compiling and running
- 5 - Licence
- 6 - More information
| Windows / Linux | Download | |
|---|---|---|
| master |  |
 |
Feel free to join our Discord server to talk about developing the game, or for help getting it to run.
OpenLoco is an open-source re-implementation of Chris Sawyer's Locomotion (CSL), the spiritual successor to Transport Tycoon. OpenLoco aims to improve the game similar to how OpenTTD improved Transport Tycoon, and OpenRCT2 improved RollerCoaster Tycoon.
CSL was originally written in x86 assembly, building on top of the RollerCoaster Tycoon 2 engine. However, the engine has changed substantially enough that OpenLoco currently does not share its codebase with OpenRCT2.
The reimplementation efforts of OpenLoco are gradual, aiming to ultimately rewrite the entire game in C++. In the earlier years of the project, the in-game UI has been completely reimplemented, and most of the underlying data and object structures have been uncovered. Recent efforts have focussed on reimplementing the game (command) logic. Once this has been completed, it is our goal to get a solid multiplayer experience working in OpenLoco. It is also our goal to increase the map and vehicle limits. However, until all logic has been reimplemented, we are bound to the limits imposed by the CSL save format (SV5/SC5).
The latest releases can be downloaded from GitHub. Releases are currently provided only for Windows. For Linux and BSD distributions, we currently do not provide any builds. Please refer to the next section to compile the game manually. For macOS, we recommend using Wine.
Please note that OpenLoco requires the asset files of the original Chris Sawyer's Locomotion to play the game. It can be bought at e.g. Steam or GOG.com.
We warmly welcome any contributions to the project, e.g. for C++ code (game implementation, bug fixes, features) or localisation (new translations). Please have a look at our issues for newcomers.
For code contributions, please stick to our code style.
You can use clang-format to apply these guidelines automatically.
If you would like to contribute code to OpenLoco, please follow the instructions below to get started compiling the game. Alternatively, we have platform-specific guides for Ubuntu and macOS.
If you just want to play the game, you can just download the latest release from GitHub. Releases are currently only provided for Windows (32-bit only).
The following libraries/dependencies are required:
- libpng
- libzip
- OpenAL
- SDL2
- yaml-cpp (fetched during CMake generation)
- fmt (fetched during CMake generation)
- breakpad (only required on Windows)
- 7 / 8 / 10 / 11
- Visual Studio 2022
- Desktop development with C++ (ensure MFC component is selected)
- Dependencies are managed with vcpkg
- cmake 3.22+
- make or ninja
- 32-bit versions of the libraries mentioned above
Note: The game can currently only be built for 32-bit architectures.
- Check out the repository. This can be done using GitHub Desktop or other tools.
- With VS 2022 use the "Open a local folder" option to start the project file generation. This may take some time as it downloads dependencies.
- After successful generation of the project files open "build/windows-msvc/openloco.sln".
- Select a config Debug or Release and run Build -> Build Solution.
- Run the game from "build/windows-msvc//OpenLoco.exe" or within VS.
Alternatively using CMake use the following commands.
- Run
cmake --preset windows-msvc - Run
cmake --build --preset windows-msvc-release
The standard CMake build procedure is to install the required libraries, then:
cmake --preset linux
cmake --build --preset linux-release
Installing some packages can be problematic on desktop AMD64 distributions. To work around this, you can use our Docker images for compilation.
Note: Due to issues with distro yaml-cpp packages, its source release is downloaded during CMake generation.
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
For technical reasons OpenLoco can only be built as 32-bit x86 application, for which Apple dropped support in Mac OS 10.15. We can't provide MacOS builds at this time.
OpenLoco is licensed under the MIT License.