OpenTTD/os/emscripten
glx22 4eddec9e79 Add: [Emscripten] Support for bootstrapping 2023-08-31 12:59:12 +02:00
..
cmake Fix: [Emscripten] actually link against nlohmann_json (#11120) 2023-07-07 21:21:43 +00:00
Dockerfile Change: [CI] rework preview flow and use Cloudflare Pages to publish (#11116) 2023-07-08 12:30:27 +02:00
README.md Add: [CMake] JSON library (nlohmann) 2023-05-14 23:22:02 +02:00
emsdk-liblzma.patch Change: [CI] update emscripten and liblzma to the latest version (#10757) 2023-05-02 23:12:52 +02:00
emsdk-nlohmann-json.patch Add: [CMake] JSON library (nlohmann) 2023-05-14 23:22:02 +02:00
loading.png Add: support for emscripten (play-OpenTTD-in-the-browser) 2020-12-15 15:46:39 +01:00
pre.js Add: [Emscripten] Support for bootstrapping 2023-08-31 12:59:12 +02:00
shell.html Add: [Emscripten] Support for bootstrapping 2023-08-31 12:59:12 +02:00

README.md

How to build with Emscripten

Please use docker with the supplied Dockerfile to build for emscripten. It takes care of a few things:

  • Use a version of emscripten we know works
  • Patch in LibLZMA support (as this is not supported by upstream)
  • Patch in nlohmann-json support (as this is not supported by upstream)

First, build the docker image by navigating in the folder this README.md is in, and executing:

  docker build -t emsdk-openttd .

Next, navigate back to the root folder of this project.

Now we build the host tools first:

  mkdir build-host
  docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build-host emsdk-openttd cmake .. -DOPTION_TOOLS_ONLY=ON
  docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build-host emsdk-openttd make -j$(nproc) tools

Finally, we build the actual game:

  mkdir build
  docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build emsdk-openttd emcmake cmake .. -DHOST_BINARY_DIR=../build-host -DCMAKE_BUILD_TYPE=Release -DOPTION_USE_ASSERTS=OFF
  docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build emsdk-openttd emmake make -j$(nproc)

In the build folder you will now see openttd.html.

To run it locally, you would have to start a local webserver; something like:

  cd build
  python3 -m http.server

You can now play the game via http://127.0.0.1:8000/openttd.html .