{"id":13531020,"url":"https://github.com/OpenLoco/OpenLoco","last_synced_at":"2025-04-01T19:31:05.941Z","repository":{"id":37359217,"uuid":"116523281","full_name":"OpenLoco/OpenLoco","owner":"OpenLoco","description":"An open source re-implementation of Chris Sawyer's Locomotion","archived":false,"fork":false,"pushed_at":"2025-03-29T07:45:55.000Z","size":19146,"stargazers_count":1479,"open_issues_count":360,"forks_count":164,"subscribers_count":44,"default_branch":"master","last_synced_at":"2025-03-29T08:28:18.495Z","etag":null,"topics":["c-plus-plus","cmake","game","hacktoberfest","help-wanted","linux","locomotion","macos","sdl2","simulation","trains","transport","transport-tycoon","windows"],"latest_commit_sha":null,"homepage":"https://openloco.io/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenLoco.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-06T23:35:23.000Z","updated_at":"2025-03-29T07:45:59.000Z","dependencies_parsed_at":"2023-10-02T23:13:04.203Z","dependency_job_id":"780c024a-8dcf-4953-a992-becbbeff1a24","html_url":"https://github.com/OpenLoco/OpenLoco","commit_stats":{"total_commits":3249,"total_committers":61,"mean_commits":53.26229508196721,"dds":0.708833487226839,"last_synced_commit":"3856b7cc2e41696bc25b0f4a9cf7a78d5d6db01e"},"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLoco%2FOpenLoco","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLoco%2FOpenLoco/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLoco%2FOpenLoco/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLoco%2FOpenLoco/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenLoco","download_url":"https://codeload.github.com/OpenLoco/OpenLoco/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246700215,"owners_count":20819837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-plus-plus","cmake","game","hacktoberfest","help-wanted","linux","locomotion","macos","sdl2","simulation","trains","transport","transport-tycoon","windows"],"created_at":"2024-08-01T07:00:59.092Z","updated_at":"2025-04-01T19:31:00.931Z","avatar_url":"https://github.com/OpenLoco.png","language":"C++","readme":"# OpenLoco\nAn open source re-implementation of Chris Sawyer's Locomotion. A construction and management simulation video game that simulates running a transport company.\n\n---\n\n![](https://user-images.githubusercontent.com/604665/55420349-1a2aea00-5577-11e9-87da-78fe5cdb09e1.png)\n\n# Contents\n- 1 - [Introduction](#1-introduction)\n- 2 - [Downloading the game (pre-built)](#2-downloading-the-game-pre-built)\n- 3 - [Contributing](#3-contributing)\n- 4 - [Compiling the game](#4-compiling-the-game)\n  - 4.1 - [Building prerequisites](#41-building-prerequisites)\n  - 4.2 - [Compiling and running](#42-compiling-and-running)\n- 5 - [Licence](#5-licence)\n- 6 - [More information](#6-more-information)\n\n---\n\n### Build Status\n|             | Windows / Linux | Download |\n|-------------|-----------------|----------|\n| **master**  | ![CI](https://github.com/OpenLoco/OpenLoco/workflows/CI/badge.svg) | [![GitHub release](https://img.shields.io/github/release/OpenLoco/OpenLoco.svg)](https://github.com/OpenLoco/OpenLoco/releases) |\n\n### Chat\n\nFeel free to join our Discord server to talk about developing the game, or for help getting it to run.\n\n[![Discord](https://img.shields.io/discord/689445672390361176)](https://discord.gg/vEuNRHD)\n\n\n# 1 Introduction\n\n**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](https://openttd.org) improved *Transport Tycoon*, and [OpenRCT2](https://openrct2.io) improved *RollerCoaster Tycoon*.\n\nCSL 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.\n\nThe 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).\n\n---\n\n# 2 Downloading the game (pre-built)\n\nThe latest releases can be [downloaded from GitHub](https://github.com/OpenLoco/OpenLoco/releases). Releases are currently provided only for Windows.\nFor 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](https://github.com/OpenLoco/OpenLoco/wiki/Running-OpenLoco-on-macOS).\n\nPlease note that OpenLoco requires the asset files of the original Chris Sawyer's Locomotion to play the game.\nIt can be bought at e.g. [Steam](https://store.steampowered.com/app/356430/) or [GOG.com](https://www.gog.com/game/chris_sawyers_locomotion).\n\n---\n\n# 3 Contributing\n\nWe warmly welcome any contributions to the project, e.g. for C++ code (game implementation, bug fixes, features) or localisation (new translations).\nPlease have a look at our [issues for newcomers](https://github.com/OpenLoco/OpenLoco/issues?q=is%3Aopen+label%3A%22good+first+issue%22%2C%22hacktoberfest%22).\n\nFor code contributions, please stick to our [code style](https://github.com/OpenLoco/OpenLoco/wiki/Coding-Style).\nYou can use `clang-format` to apply these guidelines automatically.\n\n---\n\n# 4 Compiling the game\n\nIf you would like to contribute code to OpenLoco, please follow the instructions below to get started compiling the game.\nAlternatively, we have platform-specific guides for [Ubuntu](https://github.com/OpenLoco/OpenLoco/wiki/Building-on-Ubuntu) and [macOS](https://github.com/OpenLoco/OpenLoco/wiki/Building-on-macOS).\n\nIf you just want to play the game, you can just [download the latest release](https://github.com/OpenLoco/OpenLoco/releases) from GitHub.\nReleases are currently only provided for Windows (32-bit only).\n\n## 4.1 Building prerequisites\n\nThe following libraries/dependencies are required:\n- [libpng](http://www.libpng.org/pub/png/libpng.html)\n- [libzip](https://libzip.org)\n- [OpenAL](https://www.openal.org/)\n- [SDL2](https://www.libsdl.org/download-2.0.php)\n- [yaml-cpp](https://github.com/jbeder/yaml-cpp) (fetched during CMake generation)\n- [fmt](https://github.com/fmtlib/fmt) (fetched during CMake generation)\n- [breakpad](https://github.com/google/breakpad) (only required on Windows)\n\n### Windows\n- 7 / 8 / 10 / 11\n- [Visual Studio 2022](https://www.visualstudio.com/vs/community/)\n  - Desktop development with C++ (ensure MFC component is selected)\n  - Dependencies are managed with [vcpkg](https://github.com/Microsoft/vcpkg)\n\n### Linux\n- cmake 3.22+\n- make or ninja\n- 32-bit versions of the libraries mentioned above\n\n---\n\n## 4.2 Compiling and running\n\nNote: The game can currently only be built for 32-bit architectures.\n\n### Windows:\n\n1. Check out the repository. This can be done using [GitHub Desktop](https://desktop.github.com) or [other tools](https://help.github.com/articles/which-remote-url-should-i-use).\n2. 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.\n3. After successful generation of the project files open \"build/windows-msvc/openloco.sln\".\n4. Select a config Debug or Release and run Build -\u003e Build Solution.\n4. Run the game from \"build/windows-msvc/\u003cconfig\u003e/OpenLoco.exe\" or within VS.\n\nAlternatively using CMake use the following commands.\n\n1. Run `cmake --preset windows-msvc`\n2. Run `cmake --build --preset windows-msvc-release`\n\n### Linux:\n\nThe standard CMake build procedure is to install the required libraries, then:\n```\ncmake --preset linux\ncmake --build --preset linux-release\n```\n\nInstalling some packages can be problematic on desktop AMD64 distributions. To work around this, you can use [our Docker images](https://github.com/OpenLoco/openloco-docker-build) for compilation.\n    \nNote: Due to issues with distro yaml-cpp packages, its source release is downloaded during CMake generation.\n\nRunning the game will need the data directory from the root of the source code next to the binary. Assuming you're in `$SRC/build`, \n```\nln -s ../data\nOR\ncp -r ../data ./data \n```\n\n### MacOS\n\nFor 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.\n\n---\n\n# 5 Licence\n**OpenLoco** is licensed under the MIT License.\n\n---\n\n# 6 More information\n- [GitHub](https://github.com/OpenLoco/OpenLoco)\n- [TT-Forums](https://www.tt-forums.net)\n- [Locomotion subreddit](https://www.reddit.com/r/locomotion/)\n","funding_links":[],"categories":["Strategy","C++"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenLoco%2FOpenLoco","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenLoco%2FOpenLoco","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenLoco%2FOpenLoco/lists"}