Doc: update changelog

chinese (simplified): 2 changes by WenSimEHRP

.dorpsgek.yml

@@ -14,3 +14,7 @@ notifications:
   pull-request:
   issue:
   tag-created:
+  workflow-run:
+    only:
+    - .github/workflows/release.yml
+    - .github/workflows/ci-nightly.yml

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,13 @@
+<!--
+Commit message:
+
+- Please use Feature / Add / Change / Fix for player-facing changes. E.g.: "Feature: My cool new feature".
+- Please use Feature / Add / Change / Fix followed by "[NewGRF]" or "[Script]" for moddable changes. E.g.: "Feature: [NewGRF] My cool new NewGRF addition".
+- Please use Codechange / Codefix for developer-facing changes. E.g.: "Codefix #1234: Validate against nullptr properly".
+
+See https://github.com/OpenTTD/OpenTTD/blob/master/CODINGSTYLE.md#commit-message for more details.
+-->
+
 ## Motivation / Problem
 
 <!--

.github/changelog.sh

@@ -5,8 +5,8 @@ tag=$(git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null | sed 's@\
 # If we are a tag, show the part of the changelog till (but excluding) the last stable
 if [ -n "$tag" ]; then
     grep='^[0-9]\+\.[0-9]\+[^-]'
-    next=$(cat changelog.txt | grep '^[0-9]' | awk 'BEGIN { show="false" } // { if (show=="true") print $0; if ($1=="'$tag'") show="true"} ' | grep "$grep" | head -n1 | sed 's/ .*//')
+    next=$(cat changelog.md | grep '^[0-9]' | awk 'BEGIN { show="false" } // { if (show=="true") print $0; if ($1=="'$tag'") show="true"} ' | grep "$grep" | head -n1 | sed 's/ .*//')
-    cat changelog.txt | awk 'BEGIN { show="false" } /^[0-9]+.[0-9]+/ { if ($1=="'$next'") show="false"; if ($1=="'$tag'") show="true";} // { if (show=="true") print $0 }'
+    cat changelog.md | awk 'BEGIN { show="false" } /^[0-9]+.[0-9]+/ { if ($1=="'$next'") show="false"; if ($1=="'$tag'") show="true";} // { if (show=="true") print $0 }'
     exit 0
 fi
 

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "monthly"
+  groups:
+    actions:
+      patterns:
+      - "*"

.github/unused-strings.py

@@ -39,7 +39,6 @@ def read_language_file(filename, strings_found, errors):
     skip = SkipType.NONE
     length = 0
     common_prefix = ""
-    last_tiny_string = ""
 
     with open(filename) as fp:
         for line in fp.readlines():
@@ -114,17 +113,6 @@ def read_language_file(filename, strings_found, errors):
             name = line.split(":")[0].strip()
             strings_defined.append(name)
 
-            # If a string ends on _TINY or _SMALL, it can be the {TINY} variant.
-            # Check for this by some fuzzy matching.
-            if name.endswith(("_SMALL", "_TINY")):
-                last_tiny_string = name
-            elif last_tiny_string:
-                matching_name = "_".join(last_tiny_string.split("_")[:-1])
-                if name == matching_name:
-                    strings_found.add(last_tiny_string)
-            else:
-                last_tiny_string = ""
-
             if skip == SkipType.EXTERNAL:
                 strings_found.add(name)
                 skip = SkipType.LENGTH

.github/windowdesc-ini-key.py

@@ -1,50 +0,0 @@
-"""
-Script to scan the OpenTTD source-tree for ini_key issues in WindowDesc entries.
-"""
-
-import glob
-import os
-import re
-import sys
-
-
-def scan_source_files(path, ini_keys=None):
-    if ini_keys is None:
-        ini_keys = set()
-
-    errors = []
-
-    for new_path in glob.glob(f"{path}/*.cpp"):
-        if os.path.isdir(new_path):
-            errors.append(scan_source_files(new_path, ini_keys))
-            continue
-
-        with open(new_path) as fp:
-            output = fp.read()
-
-        for (name, ini_key, widgets) in re.findall(r"^static WindowDesc ([a-zA-Z0-9_]*).*?, (?:\"(.*?)\")?.*?,(?:\s+.*?,){6}\s+[^\s]+\((.*?)\)", output, re.S|re.M):
-            if ini_key:
-                if ini_key in ini_keys:
-                    errors.append(f"{new_path}: {name} ini_key is a duplicate")
-                ini_keys.add(ini_key)
-            widget = re.findall("static const (?:struct )?NWidgetPart " + widgets + ".*?(?:WWT_(DEFSIZE|STICKY)BOX.*?)?;", output, re.S)[0]
-            if widget and not ini_key:
-                errors.append(f"{new_path}: {name} has WWT_DEFSIZEBOX/WWT_STICKYBOX without ini_key")
-            if ini_key and not widget:
-                errors.append(f"{new_path}: {name} has ini_key without WWT_DEFSIZEBOX/WWT_STICKYBOX")
-
-    return errors
-
-
-def main():
-    errors = scan_source_files("src")
-
-    if errors:
-        print("\n".join(errors))
-        sys.exit(1)
-
-    print("OK")
-
-
-if __name__ == "__main__":
-    main()

.github/workflows/ci-build.yml

@@ -1,4 +1,4 @@
-name: CI
+name: CI - Build
 
 on:
   pull_request:
@@ -17,421 +17,79 @@ jobs:
   emscripten:
     name: Emscripten
 
-    runs-on: ubuntu-20.04
+    uses: ./.github/workflows/ci-emscripten.yml
-    container:
+    secrets: inherit
-      # If you change this version, change the number in the cache step too.
-      image: emscripten/emsdk:3.1.42
-
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-
-    - name: Setup cache
-      uses: actions/cache@v3
-      with:
-        path: /emsdk/upstream/emscripten/cache
-        key: 3.1.42-${{ runner.os }}
-
-    - name: Patch Emscripten to support LZMA
-      run: |
-        cd /emsdk/upstream/emscripten
-        patch -p1 < ${GITHUB_WORKSPACE}/os/emscripten/emsdk-liblzma.patch
-
-    - name: Build (host tools)
-      run: |
-        mkdir build-host
-        cd build-host
-
-        echo "::group::CMake"
-        cmake .. -DOPTION_TOOLS_ONLY=ON
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        echo "Running on $(nproc) cores"
-        cmake --build . -j $(nproc) --target tools
-        echo "::endgroup::"
-
-    - name: Install GCC problem matcher
-      uses: ammaraskar/gcc-problem-matcher@master
-
-    - name: Build
-      run: |
-        mkdir build
-        cd build
-
-        echo "::group::CMake"
-        emcmake cmake .. -DHOST_BINARY_DIR=../build-host
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        echo "Running on $(nproc) cores"
-        cmake --build . -j $(nproc) --target openttd
-        echo "::endgroup::"
 
   linux:
     strategy:
       fail-fast: false
       matrix:
         include:
-        - name: Clang - Debug
+        - name: Clang
           compiler: clang
           cxxcompiler: clang++
           libraries: libsdl2-dev
-        - name: Clang - Release
-          compiler: clang
-          cxxcompiler: clang++
-          libraries: libsdl2-dev
-          extra-cmake-parameters: -DCMAKE_BUILD_TYPE=RelWithDebInfo -DOPTION_USE_ASSERTS=OFF
         - name: GCC - SDL2
           compiler: gcc
           cxxcompiler: g++
           libraries: libsdl2-dev
-        - name: GCC - SDL1.2
-          compiler: gcc
-          cxxcompiler: g++
-          libraries: libsdl1.2-dev
         - name: GCC - Dedicated
           compiler: gcc
           cxxcompiler: g++
+          libraries: grfcodec
           extra-cmake-parameters: -DOPTION_DEDICATED=ON -DCMAKE_CXX_FLAGS_INIT="-DRANDOM_DEBUG" -DCMAKE_DISABLE_PRECOMPILE_HEADERS=ON
           # Compile without SDL / SDL2, as that should compile fine too.
 
     name: Linux (${{ matrix.name }})
 
-    runs-on: ubuntu-20.04
+    uses: ./.github/workflows/ci-linux.yml
-    env:
+    secrets: inherit
-      CC: ${{ matrix.compiler }}
-      CXX: ${{ matrix.cxxcompiler }}
 
-    steps:
+    with:
-    - name: Checkout
+      compiler: ${{ matrix.compiler }}
-      uses: actions/checkout@v3
+      cxxcompiler: ${{ matrix.cxxcompiler }}
-
+      libraries: ${{ matrix.libraries }}
-    - name: Install dependencies
+      extra-cmake-parameters: ${{ matrix.extra-cmake-parameters }}
-      run: |
-        echo "::group::Update apt"
-        sudo apt-get update
-        echo "::endgroup::"
-
-        echo "::group::Install dependencies"
-        sudo apt-get install -y --no-install-recommends \
-          liballegro4-dev \
-          libcurl4-openssl-dev \
-          libfontconfig-dev \
-          libharfbuzz-dev \
-          libicu-dev \
-          liblzma-dev \
-          liblzo2-dev \
-          ${{ matrix.libraries }} \
-          zlib1g-dev \
-          # EOF
-
-        sudo vcpkg install \
-          breakpad \
-          # EOF
-        echo "::endgroup::"
-      env:
-        DEBIAN_FRONTEND: noninteractive
-
-    - name: Get OpenGFX
-      run: |
-        mkdir -p ~/.local/share/openttd/baseset
-        cd ~/.local/share/openttd/baseset
-
-        echo "::group::Download OpenGFX"
-        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
-        echo "::endgroup::"
-
-        echo "::group::Unpack OpenGFX"
-        unzip opengfx-all.zip
-        echo "::endgroup::"
-
-        rm -f opengfx-all.zip
-
-    - name: Install GCC problem matcher
-      uses: ammaraskar/gcc-problem-matcher@master
-
-    - name: Build
-      run: |
-        mkdir build
-        cd build
-
-        echo "::group::CMake"
-        cmake .. -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake ${{ matrix.extra-cmake-parameters }}
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        echo "Running on $(nproc) cores"
-        cmake --build . -j $(nproc)
-        echo "::endgroup::"
-
-    - name: Test
-      run: |
-        cd build
-        ctest -j $(nproc) --timeout 120
 
   macos:
     strategy:
       fail-fast: false
       matrix:
         include:
-        - arch: x64
+        - name: arm64 - Debug
-          full_arch: x86_64
+          arch: arm64
+          full_arch: arm64
+          extra-cmake-parameters: -DCMAKE_BUILD_TYPE=Debug
+        - name: arm64 - Release
+          arch: arm64
+          full_arch: arm64
+          extra-cmake-parameters: -DCMAKE_BUILD_TYPE=RelWithDebInfo -DOPTION_USE_ASSERTS=OFF
 
-    name: Mac OS (${{ matrix.arch }})
+    name: Mac OS (${{ matrix.name }})
 
-    runs-on: macos-latest
+    uses: ./.github/workflows/ci-macos.yml
-    env:
+    secrets: inherit
-      MACOSX_DEPLOYMENT_TARGET: 10.13
 
-    steps:
+    with:
-    - name: Checkout
+      arch: ${{ matrix.arch }}
-      uses: actions/checkout@v3
+      full_arch: ${{ matrix.full_arch }}
-
+      extra-cmake-parameters: ${{ matrix.extra-cmake-parameters }}
-    - name: Install dependencies
-      env:
-        HOMEBREW_NO_AUTO_UPDATE: 1
-        HOMEBREW_NO_INSTALL_CLEANUP: 1
-      run: |
-        brew install \
-          pkg-config \
-          # EOF
-
-    - name: Prepare cache key
-      id: key
-      run: |
-        echo "image=$ImageOS-$ImageVersion" >> $GITHUB_OUTPUT
-
-    - name: Enable vcpkg cache
-      uses: actions/cache@v3
-      with:
-        path: /usr/local/share/vcpkg/installed
-        key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-1 # Increase the number whenever dependencies are modified
-        restore-keys: |
-          ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}
-
-    - name: Prepare vcpkg
-      run: |
-        vcpkg install --triplet=${{ matrix.arch }}-osx \
-          breakpad \
-          curl \
-          liblzma \
-          libpng \
-          lzo \
-          zlib \
-          # EOF
-
-    - name: Install OpenGFX
-      run: |
-        mkdir -p ~/Documents/OpenTTD/baseset
-        cd ~/Documents/OpenTTD/baseset
-
-        echo "::group::Download OpenGFX"
-        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
-        echo "::endgroup::"
-
-        echo "::group::Unpack OpenGFX"
-        unzip opengfx-all.zip
-        echo "::endgroup::"
-
-        rm -f opengfx-all.zip
-
-    - name: Install GCC problem matcher
-      uses: ammaraskar/gcc-problem-matcher@master
-
-    - name: Build
-      run: |
-        mkdir build
-        cd build
-
-        echo "::group::CMake"
-        cmake .. \
-          -DCMAKE_OSX_ARCHITECTURES=${{ matrix.full_arch }} \
-          -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-osx \
-          -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        echo "Running on $(sysctl -n hw.logicalcpu) cores"
-        cmake --build . -j $(sysctl -n hw.logicalcpu)
-        echo "::endgroup::"
-
-    - name: Test
-      run: |
-        cd build
-        ctest -j $(sysctl -n hw.logicalcpu) --timeout 120
 
   windows:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [windows-latest, windows-2019]
-        arch: [x86, x64]
-
-    name: Windows (${{ matrix.os }} / ${{ matrix.arch }})
-
-    runs-on: ${{ matrix.os }}
-
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-
-    - name: Prepare cache key
-      id: key
-      shell: powershell
-      run: |
-        # Work around caching failure with GNU tar
-        New-Item -Type Junction -Path vcpkg -Target c:\vcpkg
-
-        Write-Output "image=$env:ImageOS-$env:ImageVersion" >> $env:GITHUB_OUTPUT
-
-    - name: Enable vcpkg cache
-      uses: actions/cache@v3
-      with:
-        path: vcpkg/installed
-        key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-1 # Increase the number whenever dependencies are modified
-        restore-keys: |
-          ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}
-
-    - name: Prepare vcpkg
-      shell: bash
-      run: |
-        vcpkg install --triplet=${{ matrix.arch }}-windows-static \
-          breakpad \
-          liblzma \
-          libpng \
-          lzo \
-          zlib \
-          # EOF
-
-    - name: Install OpenGFX
-      shell: bash
-      run: |
-        mkdir -p "C:/Users/Public/Documents/OpenTTD/baseset"
-        cd "C:/Users/Public/Documents/OpenTTD/baseset"
-
-        echo "::group::Download OpenGFX"
-        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
-        echo "::endgroup::"
-
-        echo "::group::Unpack OpenGFX"
-        unzip opengfx-all.zip
-        echo "::endgroup::"
-
-        rm -f opengfx-all.zip
-
-    - name: Install MSVC problem matcher
-      uses: ammaraskar/msvc-problem-matcher@master
-
-    - name: Configure developer command prompt for ${{ matrix.arch }}
-      uses: ilammy/msvc-dev-cmd@v1
-      with:
-        arch: ${{ matrix.arch }}
-
-    - name: Build
-      shell: bash
-      env:
-        NINJA_STATUS: "[%f/%t -- %e] " # [finished_edges/total_edges -- elapsed_time], default value is "[%f/%t] "
-      run: |
-        mkdir build
-        cd build
-
-        echo "::group::CMake"
-        cmake .. \
-          -GNinja \
-          -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
-          -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        cmake --build .
-        echo "::endgroup::"
-
-    - name: Test
-      shell: bash
-      run: |
-        cd build
-        ctest --timeout 120
-
-
-  msys2:
     strategy:
       fail-fast: false
       matrix:
         include:
-          - msystem: MINGW64
+        - arch: x86
-            arch: x86_64
+        - arch: x64
-          - msystem: MINGW32
-            arch: i686
 
-    name: MinGW (${{ matrix.arch }})
+    name: Windows (${{ matrix.arch }})
 
-    runs-on: windows-latest
+    uses: ./.github/workflows/ci-windows.yml
+    secrets: inherit
 
-    steps:
+    with:
-    - name: Checkout
+      arch: ${{ matrix.arch }}
-      uses: actions/checkout@v3
-
-    - name: Setup MSYS2
-      uses: msys2/setup-msys2@v2
-      with:
-        msystem: ${{ matrix.msystem }}
-        release: false
-        install: >-
-          git
-          make
-          mingw-w64-${{ matrix.arch }}-cmake
-          mingw-w64-${{ matrix.arch }}-gcc
-          mingw-w64-${{ matrix.arch }}-lzo2
-          mingw-w64-${{ matrix.arch }}-libpng
-          mingw-w64-${{ matrix.arch }}-lld
-          mingw-w64-${{ matrix.arch }}-ninja
-
-    - name: Install OpenGFX
-      shell: bash
-      run: |
-        mkdir -p "C:/Users/Public/Documents/OpenTTD/baseset"
-        cd "C:/Users/Public/Documents/OpenTTD/baseset"
-
-        echo "::group::Download OpenGFX"
-        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
-        echo "::endgroup::"
-
-        echo "::group::Unpack OpenGFX"
-        unzip opengfx-all.zip
-        echo "::endgroup::"
-
-        rm -f opengfx-all.zip
-
-    - name: Install GCC problem matcher
-      uses: ammaraskar/gcc-problem-matcher@master
-
-    - name: Build
-      shell: msys2 {0}
-      env:
-        NINJA_STATUS: "[%f/%t -- %e] " # [finished_edges/total_edges -- elapsed_time], default value is "[%f/%t] "
-      run: |
-        mkdir build
-        cd build
-
-        echo "::group::CMake"
-        cmake .. \
-          -GNinja \
-          -DCMAKE_CXX_FLAGS="-fuse-ld=lld" \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        cmake --build .
-        echo "::endgroup::"
-
-    - name: Test
-      shell: msys2 {0}
-      run: |
-        cd build
-        ctest --timeout 120
 
   check_annotations:
     name: Check Annotations
@@ -440,7 +98,6 @@ jobs:
     - linux
     - macos
     - windows
-    - msys2
 
     if: always() && github.event_name == 'pull_request'
 
@@ -448,4 +105,4 @@ jobs:
 
     steps:
     - name: Check annotations
-      uses: OpenTTD/actions/annotation-check@v3
+      uses: OpenTTD/actions/annotation-check@v5

.github/workflows/ci-emscripten.yml

@@ -0,0 +1,65 @@
+name: CI (Emscripten)
+
+on:
+  workflow_call:
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+
+jobs:
+  emscripten:
+    name: CI
+
+    runs-on: ubuntu-latest
+    container:
+      # If you change this version, change the number in the cache step too.
+      image: emscripten/emsdk:3.1.57
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Fix dubious ownership
+      run: |
+        git config --global --add safe.directory ${GITHUB_WORKSPACE}
+
+    - name: Setup cache
+      uses: actions/cache@v4
+      with:
+        path: /emsdk/upstream/emscripten/cache
+        key: 3.1.57-${{ runner.os }}
+
+    - name: Add liblzma support
+      run: |
+        cp ${GITHUB_WORKSPACE}/os/emscripten/ports/liblzma.py /emsdk/upstream/emscripten/tools/ports/contrib/
+
+    - name: Build (host tools)
+      run: |
+        mkdir build-host
+        cd build-host
+
+        echo "::group::CMake"
+        cmake .. -DOPTION_TOOLS_ONLY=ON
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(nproc) cores"
+        cmake --build . -j $(nproc) --target tools
+        echo "::endgroup::"
+
+    - name: Install GCC problem matcher
+      uses: ammaraskar/gcc-problem-matcher@master
+
+    - name: Build
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        emcmake cmake .. -DHOST_BINARY_DIR=../build-host
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(nproc) cores"
+        cmake --build . -j $(nproc) --target openttd
+        echo "::endgroup::"

.github/workflows/ci-linux.yml

@@ -0,0 +1,126 @@
+name: CI (Linux)
+
+on:
+  workflow_call:
+    inputs:
+      compiler:
+        required: true
+        type: string
+      cxxcompiler:
+        required: true
+        type: string
+      libraries:
+        required: true
+        type: string
+      extra-cmake-parameters:
+        required: true
+        type: string
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+
+jobs:
+  linux:
+    name: CI
+
+    runs-on: ubuntu-24.04
+    env:
+      CC: ${{ inputs.compiler }}
+      CXX: ${{ inputs.cxxcompiler }}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup vcpkg caching
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+          core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite')
+
+    - name: Install vcpkg
+      run: |
+        git clone https://github.com/microsoft/vcpkg ${{ runner.temp }}/vcpkg
+        ${{ runner.temp }}/vcpkg/bootstrap-vcpkg.sh -disableMetrics
+
+    - name: Install dependencies
+      run: |
+        echo "::group::Update apt"
+        sudo apt-get update
+        echo "::endgroup::"
+
+        echo "::group::Install dependencies"
+        sudo apt-get install -y --no-install-recommends \
+          liballegro4-dev \
+          libcurl4-openssl-dev \
+          libfontconfig-dev \
+          libharfbuzz-dev \
+          libicu-dev \
+          liblzma-dev \
+          liblzo2-dev \
+          libogg-dev \
+          libopus-dev \
+          libopusfile-dev \
+          ${{ inputs.libraries }} \
+          zlib1g-dev \
+          # EOF
+
+        echo "::group::Install vcpkg dependencies"
+
+        # Disable vcpkg integration, as we mostly use system libraries.
+        mv vcpkg.json vcpkg-disabled.json
+
+        # We only use breakpad from vcpkg, as its CMake files
+        # are a bit special. So the Ubuntu's variant doesn't work.
+        ${{ runner.temp }}/vcpkg/vcpkg install breakpad
+
+        echo "::endgroup::"
+      env:
+        DEBIAN_FRONTEND: noninteractive
+
+    - name: Get OpenGFX
+      run: |
+        mkdir -p ~/.local/share/openttd/baseset
+        cd ~/.local/share/openttd/baseset
+
+        echo "::group::Download OpenGFX"
+        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
+        echo "::endgroup::"
+
+        echo "::group::Unpack OpenGFX"
+        unzip opengfx-all.zip
+        echo "::endgroup::"
+
+        rm -f opengfx-all.zip
+
+    - name: Install GCC problem matcher
+      uses: ammaraskar/gcc-problem-matcher@master
+
+    - name: Build
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake .. -DCMAKE_TOOLCHAIN_FILE=${{ runner.temp }}/vcpkg/scripts/buildsystems/vcpkg.cmake ${{ inputs.extra-cmake-parameters }}
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(nproc) cores"
+        cmake --build . -j $(nproc)
+        echo "::endgroup::"
+
+    - name: Test
+      run: |
+        (
+          cd build
+          ctest -j $(nproc) --timeout 120
+        )
+
+        # Re-enable vcpkg.
+        mv vcpkg-disabled.json vcpkg.json
+
+        # Check no tracked files have been modified.
+        git diff --exit-code

.github/workflows/ci-macos.yml

@@ -0,0 +1,90 @@
+name: CI (MacOS)
+
+on:
+  workflow_call:
+    inputs:
+      arch:
+        required: true
+        type: string
+      full_arch:
+        required: true
+        type: string
+      extra-cmake-parameters:
+        required: false
+        type: string
+        default: ""
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+
+jobs:
+  macos:
+    name: CI
+
+    runs-on: macos-latest
+    env:
+      MACOSX_DEPLOYMENT_TARGET: 10.13
+
+    steps:
+    - name: Setup Xcode version
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: latest-stable
+
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup vcpkg caching
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+          core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite')
+
+    - name: Install vcpkg
+      run: |
+        git clone https://github.com/microsoft/vcpkg ${{ runner.temp }}/vcpkg
+        ${{ runner.temp }}/vcpkg/bootstrap-vcpkg.sh -disableMetrics
+
+    - name: Install OpenGFX
+      run: |
+        mkdir -p ~/Documents/OpenTTD/baseset
+        cd ~/Documents/OpenTTD/baseset
+
+        echo "::group::Download OpenGFX"
+        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
+        echo "::endgroup::"
+
+        echo "::group::Unpack OpenGFX"
+        unzip opengfx-all.zip
+        echo "::endgroup::"
+
+        rm -f opengfx-all.zip
+
+    - name: Install GCC problem matcher
+      uses: ammaraskar/gcc-problem-matcher@master
+
+    - name: Build
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake .. \
+          -DCMAKE_OSX_ARCHITECTURES=${{ inputs.full_arch }} \
+          -DVCPKG_TARGET_TRIPLET=${{ inputs.arch }}-osx \
+          -DCMAKE_TOOLCHAIN_FILE=${{ runner.temp }}/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          ${{ inputs.extra-cmake-parameters }} \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(sysctl -n hw.logicalcpu) cores"
+        cmake --build . -j $(sysctl -n hw.logicalcpu)
+        echo "::endgroup::"
+
+    - name: Test
+      run: |
+        cd build
+        ctest -j $(sysctl -n hw.logicalcpu) --timeout 120

.github/workflows/ci-mingw.yml

@@ -0,0 +1,86 @@
+name: CI (MinGW)
+
+on:
+  workflow_call:
+    inputs:
+      arch:
+        required: true
+        type: string
+      msystem:
+        required: true
+        type: string
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+
+jobs:
+  mingw:
+    name: CI
+
+    runs-on: windows-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup MSYS2
+      uses: msys2/setup-msys2@v2
+      with:
+        msystem: ${{ inputs.msystem }}
+        release: false
+        install: >-
+          git
+          make
+          mingw-w64-${{ inputs.arch }}-cmake
+          mingw-w64-${{ inputs.arch }}-gcc
+          mingw-w64-${{ inputs.arch }}-lzo2
+          mingw-w64-${{ inputs.arch }}-libpng
+          mingw-w64-${{ inputs.arch }}-lld
+          mingw-w64-${{ inputs.arch }}-ninja
+          mingw-w64-${{ inputs.arch }}-libogg
+          mingw-w64-${{ inputs.arch }}-opus
+          mingw-w64-${{ inputs.arch }}-opusfile
+
+    - name: Install OpenGFX
+      shell: bash
+      run: |
+        mkdir -p "C:/Users/Public/Documents/OpenTTD/baseset"
+        cd "C:/Users/Public/Documents/OpenTTD/baseset"
+
+        echo "::group::Download OpenGFX"
+        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
+        echo "::endgroup::"
+
+        echo "::group::Unpack OpenGFX"
+        unzip opengfx-all.zip
+        echo "::endgroup::"
+
+        rm -f opengfx-all.zip
+
+    - name: Install GCC problem matcher
+      uses: ammaraskar/gcc-problem-matcher@master
+
+    - name: Build
+      shell: msys2 {0}
+      env:
+        NINJA_STATUS: "[%f/%t -- %e] " # [finished_edges/total_edges -- elapsed_time], default value is "[%f/%t] "
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake .. \
+          -GNinja \
+          -DCMAKE_CXX_FLAGS="-fuse-ld=lld" \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        cmake --build .
+        echo "::endgroup::"
+
+    - name: Test
+      shell: msys2 {0}
+      run: |
+        cd build
+        ctest --timeout 120

.github/workflows/ci-nightly.yml

@@ -0,0 +1,82 @@
+name: CI - Nightly
+
+on:
+  schedule:
+  - cron: '0 3 * * *'
+  workflow_dispatch:
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+
+jobs:
+  linux:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - name: GCC - SDL1.2
+          compiler: gcc
+          cxxcompiler: g++
+          libraries: libsdl1.2-dev
+
+    name: Linux (${{ matrix.name }})
+
+    uses: ./.github/workflows/ci-linux.yml
+    secrets: inherit
+
+    with:
+      compiler: ${{ matrix.compiler }}
+      cxxcompiler: ${{ matrix.cxxcompiler }}
+      libraries: ${{ matrix.libraries }}
+      extra-cmake-parameters:
+
+  macos:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - arch: x64
+          full_arch: x86_64
+
+    name: Mac OS (${{ matrix.arch }})
+
+    uses: ./.github/workflows/ci-macos.yml
+    secrets: inherit
+
+    with:
+      arch: ${{ matrix.arch }}
+      full_arch: ${{ matrix.full_arch }}
+
+  mingw:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - msystem: MINGW64
+          arch: x86_64
+        - msystem: MINGW32
+          arch: i686
+
+    name: MinGW (${{ matrix.arch }})
+
+    uses: ./.github/workflows/ci-mingw.yml
+    secrets: inherit
+
+    with:
+      msystem: ${{ matrix.msystem }}
+      arch: ${{ matrix.arch }}
+
+  check_annotations:
+    name: Check Annotations
+    needs:
+    - linux
+    - macos
+    - mingw
+
+    if: always()
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check annotations
+      uses: OpenTTD/actions/annotation-check@v5

.github/workflows/ci-windows.yml

@@ -0,0 +1,84 @@
+name: CI (Windows)
+
+on:
+  workflow_call:
+    inputs:
+      arch:
+        required: true
+        type: string
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+
+jobs:
+  windows:
+    name: CI
+
+    runs-on: windows-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup vcpkg caching
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+          core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite')
+
+    - name: Install vcpkg
+      run: |
+        git clone https://github.com/microsoft/vcpkg ${{ runner.temp }}\vcpkg
+        ${{ runner.temp }}\vcpkg\bootstrap-vcpkg.bat -disableMetrics
+
+    - name: Install OpenGFX
+      shell: bash
+      run: |
+        mkdir -p "C:/Users/Public/Documents/OpenTTD/baseset"
+        cd "C:/Users/Public/Documents/OpenTTD/baseset"
+
+        echo "::group::Download OpenGFX"
+        curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip
+        echo "::endgroup::"
+
+        echo "::group::Unpack OpenGFX"
+        unzip opengfx-all.zip
+        echo "::endgroup::"
+
+        rm -f opengfx-all.zip
+
+    - name: Install MSVC problem matcher
+      uses: ammaraskar/msvc-problem-matcher@master
+
+    - name: Configure developer command prompt for ${{ inputs.arch }}
+      uses: ilammy/msvc-dev-cmd@v1
+      with:
+        arch: ${{ inputs.arch }}
+
+    - name: Build
+      shell: bash
+      env:
+        NINJA_STATUS: "[%f/%t -- %e] " # [finished_edges/total_edges -- elapsed_time], default value is "[%f/%t] "
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake .. \
+          -GNinja \
+          -DVCPKG_TARGET_TRIPLET=${{ inputs.arch }}-windows-static \
+          -DCMAKE_TOOLCHAIN_FILE="${{ runner.temp }}\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        cmake --build .
+        echo "::endgroup::"
+
+    - name: Test
+      shell: bash
+      run: |
+        cd build
+        ctest --timeout 120

.github/workflows/codeql.yml

@@ -24,7 +24,20 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
+
+    - name: Setup vcpkg caching
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+          core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite')
+
+    - name: Install vcpkg
+      run: |
+        git clone https://github.com/microsoft/vcpkg ${{ runner.temp }}/vcpkg
+        ${{ runner.temp }}/vcpkg/bootstrap-vcpkg.sh -disableMetrics
 
     - name: Install dependencies
       run: |
@@ -41,28 +54,51 @@ jobs:
           libicu-dev \
           liblzma-dev \
           liblzo2-dev \
+          libopus-dev \
+          libopusfile-dev \
           libsdl2-dev \
           zlib1g-dev \
           # EOF
+
+        echo "::group::Install vcpkg dependencies"
+
+        # Disable vcpkg integration, as we mostly use system libraries.
+        mv vcpkg.json vcpkg-disabled.json
+
+        # We only use breakpad from vcpkg, as its CMake files
+        # are a bit special. So the Ubuntu's variant doesn't work.
+        ${{ runner.temp }}/vcpkg/vcpkg install breakpad
+
         echo "::endgroup::"
       env:
         DEBIAN_FRONTEND: noninteractive
 
-    - name: Set number of make jobs
+    - name: Prepare build
       run: |
-        echo "MAKEFLAGS=-j$(nproc)" >> $GITHUB_ENV
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake .. -DCMAKE_TOOLCHAIN_FILE=${{ runner.temp }}/vcpkg/scripts/buildsystems/vcpkg.cmake
+        echo "::endgroup::"
 
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: cpp
         config-file: ./.github/codeql/codeql-config.yml
 
-    - name: Autobuild
+    - name: Build
-      uses: github/codeql-action/autobuild@v2
+      run: |
+        cd build
+
+        echo "::group::Build"
+        echo "Running on $(nproc) cores"
+        cmake --build . -j $(nproc)
+        echo "::endgroup::"
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: /language:cpp
         upload: False
@@ -80,6 +116,6 @@ jobs:
         output: sarif-results/cpp.sarif
 
     - name: Upload results
-      uses: github/codeql-action/upload-sarif@v2
+      uses: github/codeql-action/upload-sarif@v3
       with:
         sarif_file: sarif-results/cpp.sarif

.github/workflows/commit-checker.yml

@@ -14,12 +14,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 4
 
     - name: Get pull-request commits
-      uses: OpenTTD/actions/checkout-pull-request@v2
+      uses: OpenTTD/actions/checkout-pull-request@v5
 
     - name: Check commits
       uses: OpenTTD/OpenTTD-git-hooks@main

.github/workflows/preview-build.yml

@@ -21,11 +21,11 @@ jobs:
     runs-on: ubuntu-latest
     container:
       # If you change this version, change the number in the cache step too.
-      image: emscripten/emsdk:3.1.42
+      image: emscripten/emsdk:3.1.57
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.pull_request.head.sha }}
 
@@ -35,15 +35,14 @@ jobs:
         git checkout -b pr${{ github.event.pull_request.number }}
 
     - name: Setup cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: /emsdk/upstream/emscripten/cache
-        key: 3.1.42-${{ runner.os }}
+        key: 3.1.57-${{ runner.os }}
 
-    - name: Patch Emscripten to support LZMA
+    - name: Add liblzma support
       run: |
-        cd /emsdk/upstream/emscripten
+        cp ${GITHUB_WORKSPACE}/os/emscripten/ports/liblzma.py /emsdk/upstream/emscripten/tools/ports/contrib/
-        patch -p1 < ${GITHUB_WORKSPACE}/os/emscripten/emsdk-liblzma.patch
 
     - name: Build (host tools)
       run: |

.github/workflows/preview.yml

@@ -7,6 +7,7 @@ on:
     - synchronize
     branches:
     - master
+    - release/**
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number }}

.github/workflows/release-docs.yml

@@ -11,11 +11,11 @@ jobs:
   docs:
     name: Docs
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: internal-source
 
@@ -78,7 +78,7 @@ jobs:
         echo "::endgroup::"
 
     - name: Store bundles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: openttd-docs
         path: build/bundles/*.tar.xz

.github/workflows/release-linux.yml

@@ -12,15 +12,16 @@ jobs:
   linux:
     name: Linux (Generic)
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     container:
-      # manylinux2014 is based on CentOS 7, but already has a lot of things
+      # manylinux_2_28 is based on AlmaLinux 8, and already has a lot of things
       # installed and preconfigured. It makes it easier to build OpenTTD.
-      image: quay.io/pypa/manylinux2014_x86_64
+      # This distro is based on glibc 2.28, released in 2018.
+      image: quay.io/pypa/manylinux_2_28_x86_64
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: internal-source
 
@@ -28,26 +29,19 @@ jobs:
       run: |
         tar -xf source.tar.gz --strip-components=1
 
-    # dtolnay/rust-toolchain uses a curl argument (--retry-connrefused) that the curl shipped with our container doesn't support.
-    # So we need to do one part ourselves; the action takes over the rest and prepares the setup further.
-    - name: Prepare Rust toolchain
-      run: |
-        curl --proto '=https' --tlsv1.2 --retry 10 --location --silent --show-error --fail "https://sh.rustup.rs" | sh -s -- --default-toolchain none -y
-        echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
-
     - name: Install Rust toolchain
       uses: dtolnay/rust-toolchain@stable
 
     - name: Enable Rust cache
       uses: Swatinem/rust-cache@v2
 
-    - name: Enable vcpkg cache
+    - name: Setup vcpkg caching
-      uses: actions/cache@v3
+      uses: actions/github-script@v7
       with:
-        path: /vcpkg/installed
+        script: |
-        key: ubuntu-20.04-vcpkg-release-1 # Increase the number whenever dependencies are modified
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
-        restore-keys: |
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
-          ubuntu-20.04-vcpkg-release
+          core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite')
 
     - name: Install dependencies
       run: |
@@ -87,7 +81,6 @@ jobs:
           cmake --build . -j $(nproc)
           cmake --install .
         )
-        echo "::endgroup::"
 
         echo "::group::Install audio drivers"
         # These audio libs are to make sure the SDL version of vcpkg adds
@@ -95,49 +88,43 @@ jobs:
         # binary, but the headers are used to enable them in SDL.
         yum install -y \
           alsa-lib-devel \
-          jack-audio-connection-kit-devel \
           pulseaudio-libs-devel \
           # EOF
         echo "::endgroup::"
 
+        echo "::group::Install video drivers"
+        # These video libs are to make sure the SDL version of vcpkg adds
+        # video-support; these libraries are not added to the resulting
+        # binary, but the headers are used to enable them in SDL.
+        yum install -y \
+          libX11-devel \
+          libXcursor-devel \
+          libXext-devel \
+          libXfixes-devel \
+          libXi-devel \
+          libxkbcommon-devel \
+          libXrandr-devel \
+          libXScrnSaver-devel \
+          mesa-libEGL-devel \
+          mesa-libGL-devel \
+          mesa-libGLES-devel \
+          wayland-devel \
+          wayland-protocols-devel \
+          # EOF
+        echo "::endgroup::"
+
         # We use vcpkg for our dependencies, to get more up-to-date version.
         echo "::group::Install vcpkg and dependencies"
 
-        # We do a little dance to make sure we copy the cached install folder
+        git clone https://github.com/microsoft/vcpkg /vcpkg
-        # into our new clone.
-        git clone --depth=1 https://github.com/microsoft/vcpkg /vcpkg-clone
-        if [ -e /vcpkg/installed ]; then
-          mv /vcpkg/installed /vcpkg-clone/
-          rm -rf /vcpkg
-        fi
-        mv /vcpkg-clone /vcpkg
 
         (
           cd /vcpkg
           ./bootstrap-vcpkg.sh -disableMetrics
-
-          # Make Python3 available for other packages.
-          ./vcpkg install python3
-          ln -sf $(pwd)/installed/x64-linux/tools/python3/python3.[0-9][0-9] /usr/bin/python3
-
-          ./vcpkg install \
-            breakpad \
-            curl[http2] \
-            fontconfig \
-            freetype \
-            harfbuzz \
-            icu \
-            liblzma \
-            libpng \
-            lzo \
-            sdl2 \
-            zlib \
-            # EOF
         )
-        echo "::endgroup::"
 
         echo "::group::Install breakpad dependencies"
-        cargo install dump_syms
+        cargo install --locked dump_syms
         echo "::endgroup::"
 
     - name: Install GCC problem matcher
@@ -181,14 +168,14 @@ jobs:
         echo "::endgroup::"
 
     - name: Store bundles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: openttd-linux-generic
         path: build/bundles
         retention-days: 5
 
     - name: Store symbols
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: symbols-linux-generic
         path: build/symbols

.github/workflows/release-macos.yml

@@ -12,13 +12,18 @@ jobs:
   macos:
     name: MacOS
 
-    runs-on: macos-11
+    runs-on: macos-latest
     env:
       MACOSX_DEPLOYMENT_TARGET: 10.13
 
     steps:
+    - name: Setup Xcode version
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: latest-stable
+
     - name: Download source
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: internal-source
 
@@ -32,6 +37,19 @@ jobs:
     - name: Enable Rust cache
       uses: Swatinem/rust-cache@v2
 
+    - name: Setup vcpkg caching
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+          core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite')
+
+    - name: Install vcpkg
+      run: |
+        git clone https://github.com/microsoft/vcpkg ${{ runner.temp }}/vcpkg
+        ${{ runner.temp }}/vcpkg/bootstrap-vcpkg.sh -disableMetrics
+
     - name: Install dependencies
       env:
         HOMEBREW_NO_AUTO_UPDATE: 1
@@ -40,45 +58,13 @@ jobs:
         echo "::group::Install brew dependencies"
         brew install \
           pandoc \
-          pkg-config \
           # EOF
         echo "::endgroup::"
 
         echo "::group::Install breakpad dependencies"
-        cargo install dump_syms
+        cargo install --locked dump_syms
         echo "::endgroup::"
 
-    - name: Prepare cache key
-      id: key
-      run: |
-        echo "image=$ImageOS-$ImageVersion" >> $GITHUB_OUTPUT
-
-    - name: Enable vcpkg cache
-      uses: actions/cache@v3
-      with:
-        path: /usr/local/share/vcpkg/installed
-        key: ${{ steps.key.outputs.image }}-vcpkg-release-1 # Increase the number whenever dependencies are modified
-        restore-keys: |
-          ${{ steps.key.outputs.image }}-vcpkg-release
-          ${{ steps.key.outputs.image }}-vcpkg-x64
-
-    - name: Prepare vcpkg
-      run: |
-        vcpkg install \
-          breakpad:x64-osx \
-          breakpad:arm64-osx \
-          curl:x64-osx \
-          curl:arm64-osx \
-          liblzma:x64-osx \
-          liblzma:arm64-osx \
-          libpng:x64-osx \
-          libpng:arm64-osx \
-          lzo:x64-osx \
-          lzo:arm64-osx \
-          zlib:x64-osx \
-          zlib:arm64-osx \
-          # EOF
-
     - name: Install GCC problem matcher
       uses: ammaraskar/gcc-problem-matcher@master
 
@@ -100,7 +86,7 @@ jobs:
         echo "::endgroup::"
 
     - name: Import code signing certificates
-      uses: Apple-Actions/import-codesign-certs@v2
+      uses: Apple-Actions/import-codesign-certs@v3
       with:
         # The certificates in a PKCS12 file encoded as a base64 string
         p12-file-base64: ${{ secrets.APPLE_DEVELOPER_CERTIFICATE_P12_BASE64 }}
@@ -118,7 +104,7 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -DCMAKE_OSX_ARCHITECTURES=arm64 \
           -DVCPKG_TARGET_TRIPLET=arm64-osx \
-          -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          -DCMAKE_TOOLCHAIN_FILE=${{ runner.temp }}/vcpkg/scripts/buildsystems/vcpkg.cmake \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
@@ -139,7 +125,7 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -DCMAKE_OSX_ARCHITECTURES=x86_64 \
           -DVCPKG_TARGET_TRIPLET=x64-osx \
-          -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          -DCMAKE_TOOLCHAIN_FILE=${{ runner.temp }}/vcpkg/scripts/buildsystems/vcpkg.cmake \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
@@ -226,14 +212,14 @@ jobs:
         mv _CPack_Packages/*/Bundle/openttd-*.zip bundles/
 
     - name: Store bundles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: openttd-macos-universal
         path: build-x64/bundles
         retention-days: 5
 
     - name: Store symbols
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: symbols-macos-universal
         path: build-x64/symbols

.github/workflows/release-source.yml

@@ -18,7 +18,7 @@ jobs:
   source:
     name: Source
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     outputs:
       version: ${{ steps.metadata.outputs.version }}
@@ -30,14 +30,14 @@ jobs:
     steps:
     - name: Checkout (Release)
       if: github.event_name == 'release'
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         # We generate a changelog; for this we need the full git log.
         fetch-depth: 0
 
     - name: Checkout (Manual)
       if: github.event_name == 'workflow_dispatch'
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.inputs.ref }}
         # We generate a changelog; for this we need the full git log.
@@ -45,7 +45,7 @@ jobs:
 
     - name: Checkout (Trigger)
       if: github.event_name == 'repository_dispatch'
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.client_payload.ref }}
         # We generate a changelog; for this we need the full git log.
@@ -127,7 +127,7 @@ jobs:
         fi
 
         mkdir -p build/bundles
-        cp .changelog build/bundles/changelog.txt
+        cp .changelog build/bundles/changelog.md
         cp .release_date build/bundles/released.txt
         cp README.md build/bundles/README.md
         echo "::endgroup::"
@@ -193,14 +193,14 @@ jobs:
         echo "::endgroup::"
 
     - name: Store bundles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: openttd-source
         path: build/bundles/*
         retention-days: 5
 
     - name: Store source (for other jobs)
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: internal-source
         path: source.tar.gz

.github/workflows/release-windows-store.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: internal-source
 
@@ -25,17 +25,17 @@ jobs:
         tar -xf source.tar.gz --strip-components=1
 
     - name: Download x86 build
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-windows-x86
 
     - name: Download x64 build
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-windows-x64
 
     - name: Download arm64 build
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-windows-arm64
 
@@ -185,7 +185,7 @@ jobs:
         move output\OpenTTD.appxbundle bundles\internal\openttd-${{ inputs.version }}-windows-store.appxbundle
 
     - name: Store bundles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: openttd-windows-store
         path: builds/bundles

.github/workflows/release-windows.yml

@@ -30,7 +30,7 @@ jobs:
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: internal-source
 
@@ -45,6 +45,19 @@ jobs:
     - name: Enable Rust cache
       uses: Swatinem/rust-cache@v2
 
+    - name: Setup vcpkg caching
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+          core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite')
+
+    - name: Install vcpkg
+      run: |
+        git clone https://github.com/microsoft/vcpkg ${{ runner.temp }}\vcpkg
+        ${{ runner.temp }}\vcpkg\bootstrap-vcpkg.bat -disableMetrics
+
     - name: Install dependencies
       shell: bash
       run: |
@@ -53,43 +66,9 @@ jobs:
         echo "::endgroup::"
 
         echo "::group::Install breakpad dependencies"
-        cargo install dump_syms
+        cargo install --locked dump_syms
         echo "::endgroup::"
 
-    - name: Prepare cache key
-      id: key
-      shell: powershell
-      run: |
-        # Work around caching failure with GNU tar
-        New-Item -Type Junction -Path vcpkg -Target c:\vcpkg
-
-        Write-Output "image=$env:ImageOS-$env:ImageVersion" >> $env:GITHUB_OUTPUT
-
-    - name: Enable vcpkg cache
-      uses: actions/cache@v3
-      with:
-        path: vcpkg/installed
-        key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-1 # Increase the number whenever dependencies are modified
-        restore-keys: |
-          ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}
-
-    - name: Prepare vcpkg
-      shell: bash
-      run: |
-        vcpkg install --triplet=${{ matrix.arch }}-windows-static \
-          liblzma \
-          libpng \
-          lzo \
-          zlib \
-          # EOF
-
-        # arm64-windows-static is not (yet) supported for breakpad.
-        if [ "${{ matrix.arch }}" != "arm64" ]; then
-          vcpkg install --triplet=${{ matrix.arch }}-windows-static \
-            breakpad \
-            # EOF
-        fi
-
     - name: Install MSVC problem matcher
       uses: ammaraskar/msvc-problem-matcher@master
 
@@ -121,21 +100,6 @@ jobs:
       with:
         arch: ${{ matrix.host }}
 
-    - name: Import code signing certificate
-      shell: powershell
-      # If this is run on a fork, there may not be a certificate set up - continue in this case
-      continue-on-error: true
-      run: |
-        $tempFile = [System.IO.Path]::GetTempFileName()
-        $bytes = [System.Convert]::FromBase64String($env:WINDOWS_CERTIFICATE_P12)
-        [IO.File]::WriteAllBytes($tempFile, $bytes)
-        $pwd = ConvertTo-SecureString $env:WINDOWS_CERTIFICATE_PASSWORD -AsPlainText -Force
-        Import-PfxCertificate -FilePath $tempFile -CertStoreLocation Cert:\CurrentUser\My -Password $pwd
-        Remove-Item $tempFile
-      env:
-        WINDOWS_CERTIFICATE_P12: ${{ secrets.WINDOWS_CERTIFICATE_P12 }}
-        WINDOWS_CERTIFICATE_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }}
-
     - name: Build (with installer)
       if: inputs.is_tag == 'true'
       shell: bash
@@ -147,12 +111,11 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -GNinja \
           -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
-          -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          -DCMAKE_TOOLCHAIN_FILE="${{ runner.temp }}\vcpkg\scripts\buildsystems\vcpkg.cmake" \
           -DOPTION_USE_NSIS=ON \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
-          -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \
           # EOF
         echo "::endgroup::"
 
@@ -160,7 +123,12 @@ jobs:
         cmake --build . --target openttd
         echo "::endgroup::"
       env:
-        WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }}
+        AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+        AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+        AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+        AZURE_CODESIGN_ACCOUNT_NAME: ${{ secrets.AZURE_CODESIGN_ACCOUNT_NAME }}
+        AZURE_CODESIGN_ENDPOINT: ${{ secrets.AZURE_CODESIGN_ENDPOINT }}
+        AZURE_CODESIGN_PROFILE_NAME: ${{ secrets.AZURE_CODESIGN_PROFILE_NAME }}
 
     - name: Build (without installer)
       if: inputs.is_tag != 'true'
@@ -173,11 +141,10 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -GNinja \
           -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
-          -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          -DCMAKE_TOOLCHAIN_FILE="${{ runner.temp }}\vcpkg\scripts\buildsystems\vcpkg.cmake" \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
-          -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \
           # EOF
         echo "::endgroup::"
 
@@ -185,7 +152,12 @@ jobs:
         cmake --build . --target openttd
         echo "::endgroup::"
       env:
-        WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }}
+        AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+        AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+        AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+        AZURE_CODESIGN_ACCOUNT_NAME: ${{ secrets.AZURE_CODESIGN_ACCOUNT_NAME }}
+        AZURE_CODESIGN_ENDPOINT: ${{ secrets.AZURE_CODESIGN_ENDPOINT }}
+        AZURE_CODESIGN_PROFILE_NAME: ${{ secrets.AZURE_CODESIGN_PROFILE_NAME }}
 
     - name: Create breakpad symbols
       shell: bash
@@ -219,23 +191,25 @@ jobs:
     - name: Sign installer
       if: inputs.is_tag == 'true'
       shell: bash
-      # If this is run on a fork, there may not be a certificate set up - continue in this case
-      continue-on-error: true
       run: |
-        cd ${GITHUB_WORKSPACE}/build/bundles
+        ${GITHUB_WORKSPACE}/os/windows/sign.bat "${GITHUB_WORKSPACE}/build/bundles"
-        ../../os/windows/sign.bat *.exe "${WINDOWS_CERTIFICATE_COMMON_NAME}"
       env:
-        WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }}
+        AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+        AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+        AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+        AZURE_CODESIGN_ACCOUNT_NAME: ${{ secrets.AZURE_CODESIGN_ACCOUNT_NAME }}
+        AZURE_CODESIGN_ENDPOINT: ${{ secrets.AZURE_CODESIGN_ENDPOINT }}
+        AZURE_CODESIGN_PROFILE_NAME: ${{ secrets.AZURE_CODESIGN_PROFILE_NAME }}
 
     - name: Store bundles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: openttd-windows-${{ matrix.arch }}
         path: build/bundles
         retention-days: 5
 
     - name: Store symbols
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: symbols-windows-${{ matrix.arch }}
         path: build/symbols

.github/workflows/release.yml

@@ -76,8 +76,8 @@ jobs:
     with:
       version: ${{ needs.source.outputs.version }}
 
-  upload-cdn:
+  upload:
-    name: Upload (CDN)
+    name: Upload
     needs:
     - source
     - docs
@@ -90,6 +90,25 @@ jobs:
     # The always() makes sure the rest is always evaluated.
     if: always() && needs.source.result == 'success' && needs.docs.result == 'success' && needs.linux.result == 'success' && needs.macos.result == 'success' && needs.windows.result == 'success' && (needs.windows-store.result == 'success' || needs.windows-store.result == 'skipped')
 
+    runs-on: ubuntu-latest
+
+    # This job is empty, but ensures no upload job starts before all targets finished and are successful.
+    steps:
+    - name: Build completed
+      run: |
+        true
+
+  upload-cdn:
+    name: Upload (CDN)
+    needs:
+    - source
+    - upload
+
+    # As windows-store is condition, we need to check ourselves if we need to run.
+    # The always() makes sure the rest is always evaluated.
+    # Yes, you even need to do this if you yourself don't depend on the condition.
+    if: always() && needs.source.result == 'success' && needs.upload.result == 'success'
+
     uses: ./.github/workflows/upload-cdn.yml
     secrets: inherit
 
@@ -102,11 +121,13 @@ jobs:
     name: Upload (Steam)
     needs:
     - source
-    - linux
+    - upload
-    - macos
-    - windows
 
-    if: needs.source.outputs.trigger_type == 'new-master' || needs.source.outputs.trigger_type == 'new-tag'
+    # As windows-store is condition, we need to check ourselves if we need to run.
+    # The always() makes sure the rest is always evaluated.
+    # Yes, you even need to do this if you yourself don't depend on the condition.
+    # Additionally, only nightlies and releases go to Steam; not PRs.
+    if: always() && needs.source.result == 'success' && needs.upload.result == 'success' && (needs.source.outputs.trigger_type == 'new-master' || needs.source.outputs.trigger_type == 'new-tag')
 
     uses: ./.github/workflows/upload-steam.yml
     secrets: inherit
@@ -119,11 +140,13 @@ jobs:
     name: Upload (GOG)
     needs:
     - source
-    - linux
+    - upload
-    - macos
-    - windows
 
-    if: needs.source.outputs.trigger_type == 'new-tag'
+    # As windows-store is condition, we need to check ourselves if we need to run.
+    # The always() makes sure the rest is always evaluated.
+    # Yes, you even need to do this if you yourself don't depend on the condition.
+    # Additionally, only releases go to GOG; not nightlies or PRs.
+    if: always() && needs.source.result == 'success' && needs.upload.result == 'success' && needs.source.outputs.trigger_type == 'new-tag'
 
     uses: ./.github/workflows/upload-gog.yml
     secrets: inherit

.github/workflows/script-missing-mode-enforcement.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Check for finding script functions that require company/deity mode enforcement/checks
       run: |

.github/workflows/unused-strings.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Check for unused strings
       run: |

.github/workflows/upload-cdn.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
     - name: Download all bundles
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
 
     - name: Calculate checksums
       run: |
@@ -70,14 +70,14 @@ jobs:
         done
 
     - name: Store bundles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: cdn-bundles
         path: bundles/*
         retention-days: 5
 
     - name: Store breakpad symbols
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: cdn-symbols
         path: symbols/*
@@ -88,7 +88,7 @@ jobs:
     - prepare
 
     name: Publish bundles
-    uses: OpenTTD/actions/.github/workflows/rw-cdn-upload.yml@v4
+    uses: OpenTTD/actions/.github/workflows/rw-cdn-upload.yml@v5
     secrets:
       CDN_SIGNING_KEY: ${{ secrets.CDN_SIGNING_KEY }}
       DEPLOYMENT_APP_ID: ${{ secrets.DEPLOYMENT_APP_ID }}
@@ -103,7 +103,7 @@ jobs:
     - prepare
 
     name: Publish symbols
-    uses: OpenTTD/actions/.github/workflows/rw-symbols-upload.yml@v4
+    uses: OpenTTD/actions/.github/workflows/rw-symbols-upload.yml@v5
     secrets:
       SYMBOLS_SIGNING_KEY: ${{ secrets.SYMBOLS_SIGNING_KEY }}
     with:
@@ -122,14 +122,15 @@ jobs:
     steps:
     - name: Generate access token
       id: generate_token
-      uses: tibdex/github-app-token@v1
+      uses: tibdex/github-app-token@v2
       with:
         app_id: ${{ secrets.DEPLOYMENT_APP_ID }}
         private_key: ${{ secrets.DEPLOYMENT_APP_PRIVATE_KEY }}
-        repository: OpenTTD/workflows
+        installation_retrieval_mode: "repository"
+        installation_retrieval_payload: "OpenTTD/workflows"
 
     - name: Trigger 'Publish Docs'
-      uses: peter-evans/repository-dispatch@v2
+      uses: peter-evans/repository-dispatch@v3
       with:
         token: ${{ steps.generate_token.outputs.token }}
         repository: OpenTTD/workflows

.github/workflows/upload-gog.yml

@@ -11,35 +11,35 @@ jobs:
   upload:
     name: Upload (GOG)
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: internal-source
         path: internal-source
 
     - name: Download bundle (Windows x86)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-windows-x86
         path: openttd-windows-x86
 
     - name: Download bundle (Windows x64)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-windows-x64
         path: openttd-windows-x64
 
     - name: Download bundle (MacOS)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-macos-universal
         path: openttd-macos-universal
 
     - name: Download bundle (Linux)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-linux-generic
         path: openttd-linux-generic

.github/workflows/upload-steam.yml

@@ -14,35 +14,35 @@ jobs:
   upload:
     name: Upload (Steam)
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: internal-source
         path: internal-source
 
     - name: Download bundle (Windows x86)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-windows-x86
         path: openttd-windows-x86
 
     - name: Download bundle (Windows x64)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-windows-x64
         path: openttd-windows-x64
 
     - name: Download bundle (MacOS)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-macos-universal
         path: openttd-macos-universal
 
     - name: Download bundle (Linux)
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: openttd-linux-generic
         path: openttd-linux-generic

.github/workflows/windowdesc-ini-key.yml

@@ -1,24 +0,0 @@
-name: WindowDesc ini_key
-
-on:
-  pull_request:
-    branches:
-    - master
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
-
-jobs:
-  windowdesc-ini-key:
-    name: WindowDesc ini_key issues
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-
-    - name: Check for ini_key issues in WindowDesc entries
-      shell: bash
-      run: |
-        python3 .github/windowdesc-ini-key.py

.gitignore

@@ -5,3 +5,4 @@ docs/aidocs/*
 docs/gamedocs/*
 docs/source/*
 /out
+/vcpkg_installed

CMakeLists.txt

@@ -5,7 +5,7 @@ if(NOT BINARY_NAME)
 endif()
 
 project(${BINARY_NAME}
-    VERSION 14.0
+    VERSION 15.0
     LANGUAGES CXX
 )
 
@@ -42,7 +42,7 @@ set_directory_options()
 include(Static)
 set_static_if_needed()
 
-set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED YES)
 set(CMAKE_CXX_EXTENSIONS NO)
 
@@ -152,9 +152,10 @@ if(NOT OPTION_DEDICATED)
                 find_package(Fontconfig)
             endif()
             find_package(Harfbuzz)
-            find_package(ICU OPTIONAL_COMPONENTS i18n)
+            find_package(ICU OPTIONAL_COMPONENTS i18n uc)
         endif()
     endif()
+    find_package(OpusFile)
 endif()
 if(APPLE)
     enable_language(OBJCXX)
@@ -288,6 +289,10 @@ target_link_libraries(openttd
 )
 
 target_link_libraries(openttd_test PRIVATE openttd_lib)
+if(ANDROID)
+    target_link_libraries(openttd_test PRIVATE log)
+endif()
+
 include(Catch)
 catch_discover_tests(openttd_test)
 
@@ -311,6 +316,7 @@ link_package(LZO)
 
 if(NOT WIN32 AND NOT EMSCRIPTEN)
     link_package(CURL ENCOURAGED)
+    target_link_libraries(openttd_lib ${CMAKE_DL_LIBS})
 endif()
 
 if(NOT EMSCRIPTEN)
@@ -326,6 +332,8 @@ if(NOT OPTION_DEDICATED)
     link_package(Fontconfig TARGET Fontconfig::Fontconfig)
     link_package(Harfbuzz TARGET harfbuzz::harfbuzz)
     link_package(ICU_i18n)
+    link_package(ICU_uc)
+    link_package(OpusFile TARGET OpusFile::opusfile)
 
     if(SDL2_FOUND AND OPENGL_FOUND AND UNIX)
         # SDL2 dynamically loads OpenGL if needed, so do not link to OpenGL when
@@ -338,7 +346,7 @@ if(NOT OPTION_DEDICATED)
     endif()
 endif()
 
-include(CheckAtomic)
+include(3rdparty/llvm/CheckAtomic)
 
 if(APPLE)
     link_package(Iconv TARGET Iconv::Iconv)
@@ -383,8 +391,8 @@ if(EMSCRIPTEN)
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/CREDITS.md@/CREDITS.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/CONTRIBUTING.md@/CONTRIBUTING.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/COPYING.md@/COPYING.md")
-    target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/known-bugs.txt@/known-bugs.txt")
+    target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/known-bugs.md@/known-bugs.md")
-    target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/changelog.txt@/changelog.txt")
+    target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/changelog.md@/changelog.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/admin_network.md@/docs/admin_network.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/debugging_desyncs.md@/docs/debugging_desyncs.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/desync.md@/docs/desync.md")
@@ -447,6 +455,7 @@ if(WIN32)
         usp10
         psapi
         winhttp
+        bcrypt
     )
 endif()
 
@@ -454,8 +463,9 @@ if(CMAKE_SIZEOF_VOID_P EQUAL 8)
     add_definitions(-DPOINTER_IS_64BIT)
 endif()
 
-include(CreateRegression)
+enable_testing()
-create_regression()
+
+add_subdirectory(regression)
 
 if(APPLE OR WIN32)
     find_package(Pandoc)

CODINGSTYLE.md

@@ -157,7 +157,7 @@ enum SomeEnumeration {
 * Use curly braces and put the contained statements on their own lines (e.g., don't put them directly after the **if**).
 * Opening curly bracket **{** stays on the first line, closing curly bracket **}** gets a line to itself (except for the **}** preceding an **else**, which should be on the same line as the **else**).
 * When only a single statement is contained, the brackets can be omitted. In this case, put the single statement on the same line as the preceding keyword (**if**, **while**, etc.). Note that this is only allowed for if statements without an **else** clause.
-* All fall throughs must be documented, using a **FALLTHROUGH** define/macro.
+* Non-trivial fall throughs must be documented, using a `[[fallthrough]]` attribute.
 * The NOT_REACHED() macro can be used in default constructs that should never be reached.
 * Unconditional loops are written with **`for (;;) {`**
 
@@ -180,7 +180,7 @@ switch (a) {
 
 	case 1:
 		DoSomething();
-		FALLTHROUGH;
+		[[fallthrough]];
 
 	case 2:
 		DoMore();
@@ -191,7 +191,7 @@ switch (a) {
 		int r = 2;
 
 		DoEvenMore(a);
-		FALLTHROUGH;
+		[[fallthrough]];
 	}
 
 	case 4: {
@@ -248,12 +248,46 @@ Templates are a very powerful C++ tool, but they can easily confuse beginners. T
 * Templates are to be documented in a very clear and verbose manner. Never assume anything in the documentation.
 * the template keyword and the template layout get a separate line. typenames are either "T" or preceded by a "T", integers get a single capital letter or a descriptive name preceded by "T".
 ```c++
-template <typename T, typename Tsomething, int N, byte Tnumber_of_something>
+template <typename T, typename Tsomething, int N, uint8_t Tnumber_of_something>
 int Func();
 ```
 
 * If you are writing one or more template class in the dedicated header file, use file.hpp for its name instead of file.h. This will let others know that it is template library (includes also implementation), not just header with declarations.
 
+### Code Comment Vertical Alignment
+
+When adding code or comments to an existing formatted section, follow the existing style if possible without editing the preexisting lines.
+
+If your addition cannot be aligned with existing code, do not align the comments with anything and use only a single space between the code and the comment.
+
+Good:
+
+```c++
+enum Vehicle {
+	BUS,  ///< Take the bus.
++	CAR,  ///< Drive your car.
+	BIKE, ///< Ride your bike
++	TRAIN, ///< Catch the train.
+}
+```
+
+"Car" is shorter than Bike which allows you to easily align the new comment. "Train" is longer.  It is *NOT* desirable to change the vertical comment alignment of this enum.
+
+Bad:
+
+```c++
+enum Vehicle {
+-	BUS,  ///< Take the bus.
+-	BIKE, ///< Ride your bike
++	BUS,   ///< Take the bus.
++	CAR,   ///< Drive your car.
++	BIKE,  ///< Ride your bike
++	TRAIN, ///< Catch the train.
+}
+```
+
+OpenTTD used to vertically-align inline Doxygen comments as shown above. OpenTTD has since stopped strictly following this rule to keep diffs smaller and reduce pollution to the git blame history for non-functional changes.
+
 ### Other important rules
 * Put a space before and after binary operators: "a + b", "a == b", "a & b", "a <<= b", etc.. Exceptions are ".", "->" and "[]" (no spaces) and "," (just space after it).
 * Put parenthesis where it improves readability: "*(b++)" instead of "*b++", and "if ((a & b) && c == 2)" instead of "if (a & b && c == 2)".
@@ -416,36 +450,57 @@ There is a check-script on the git server (also available for clients, see below
 
 The first line of a message must match:
 ```
-<keyword>( #<issue>| <commit>(, (<keyword> #<issue>|<commit>))*)?: ([<section])? <Details>
+<keyword>( #<issue>|<commit>(, (#<issue>|<commit>))*)?: ([<component>])? <details>
 ```
-Keywords are:
-* Add, Feature: Adding new stuff. Difference between "Feature" and "Add" is somewhat subjective. "Feature" for user-point-of-view stuff, "Add" for other.
-* Change: Changing behaviour from user-point-of-view.
-* Remove: Removing something from user-point-of-view.
-* Codechange, Cleanup: Changes without intentional change of behaviour from user-point-of-view. Difference between "Codechange" and "Cleanup" is somewhat subjective.
-* Fix, Revert: Fixing stuff.
-* Doc, Update: Documentation changes, version increments, translator commits.
-* Prepare: Preparation for bigger changes. Rarely used.
 
-If you commit a fix for an [issue](https://github.com/OpenTTD/OpenTTD/issues), add the corresponding issue number in the form of #NNNN. Do it as well if you implement a feature with a matching entry.
+Keywords can either be player-facing, NewGRF / Script author-facing, or developer-facing.
 
-In the case of bugfixes, if you know what revision the bug was introduced (eg regression), please mention that revision as well just after the prefix. Finding the trouble-causing revision is highly encouraged as it makes backporting/branching/releases that much easier.
+For player-facing changes, we have these keywords:
+* Feature: Adding a significant new functionality to the game. This can be small in code-size, but is meant for the bigger things from a player perspective.
+* Add: Similar to Feature, but for small functionalities.
+* Change: Changing existing behaviour to an extent the player needs to know about it.
+* Fix: Fixing an issue with the game (as seen by the player).
+* Remove: Completely removing a functionality.
+* Revert: Reverting an earlier Feature / Add / Change / Fix / Remove.
+* Doc: Update to (player-facing) documentation, like in the `docs/` folder etc.
+* Update: Translator commits.
 
-To further structure the changelog, you can add sections. Example are:
+For NewGRF / Script author-facing changes, we use the same keywords as player-facing changes, followed by `[NewGRF]` / `[Script]` component.
-* "Network" for network specific changes
+This also means the commit is aimed (and worded) towards the NewGRF / Script authors, rather than players.
-* "NewGRF" for NewGRF additions
-* "YAPP", "NPF", for changes in these features
-* "OSX", "Debian", "win32", for OS-specific packaging changes
 
-Further explanations, general bitching, etc. don't go into the first line. Use a new line for those.
+For developer-facing changes, we have these keywords:
+* Codechange: Changes to the code the player is not going to notice. Refactors, modernization, etc.
+* Cleanup: Similar to Codechange, but when it is more about removing old code, rather than an actual change.
+* Codefix: Fixing problems in earlier commits that the player is not actually going to notice. Wrong comments, missing files, CI changes.
+
+If you commit a `Fix` for an [issue](https://github.com/OpenTTD/OpenTTD/issues), add the corresponding issue number in the form of #NNNNN.
+
+In the case of `Fix`es, if you know the hash of the commit in which the bug was introduced (eg regression), please mention that hash (the first 7 characters) as well just after the keyword (or, if present, after the issue number).
+Finding the trouble-causing commit is highly encouraged as it makes backporting / branching / releases that much easier.
+
+Do not mention two keywords; if two apply, pick one that best represents the commit (for example, "Fix #123" is mostly always better than "Revert", even if both are true).
+
+The `<details>` part starts with a capital and does not end with a dot.
+Try to be descriptive to what the player will notice, not to what is actually being changed in the code.
+See `changelog.md` for inspiration.
+
+To further structure the changelog, you can add components. Example are:
+* "Network" for network specific changes.
+* "NewGRF" for NewGRF additions.
+* "Script" for AI / GS additions.
+* "YAPF", "NPF", for changes in these features.
+* "MacOS", "Linux", "Windows", for OS-specific changes.
+* "CI", "CMake", for changes to the (build) infrastructure.
+
+Further explanations, more details, etc. don't go into the first line. Use a new line for those.
 
 Complete examples:
-* Fix: [YAPF] Infinite loop in pathfinder.
+* `Fix: [YAPF] Infinite loop in pathfinder`
-* Fix #5926: [YAPF] Infinite loop in pathfinder.
+* `Fix #5926: [YAPF] Infinite loop in pathfinder`
-* Fix 80dffae130: Warning about unsigned unary minus.
+* `Codefix 80dffae: Warning about unsigned unary minus`
-* Fix #6673, 99bb3a95b4: Store the map variety setting in the samegame.
+* `Fix #6673, 99bb3a9: Store the map variety setting in the savegame`
-* Revert d9065fbfbe, Fix #5922: ClientSizeChanged is only called via WndProcGdi which already has the mutex.
+* `Codefix #5922: ClientSizeChanged is only called via WndProcGdi which already has the mutex`
-* Fix #1264, Fix #2037, Fix #2038, Fix #2110: Rewrite the autoreplace kernel.
+* `Codechange #1264, #2037, #2038, #2110: Rewrite the autoreplace kernel`
 
 
 ## Other tips

COMPILING.md

@@ -29,7 +29,7 @@ open most older savegames or use the content downloading system.
 
 ## Windows
 
-You need Microsoft Visual Studio 2017 or more recent.
+You need Microsoft Visual Studio 2022 or more recent.
 
 You can download the free Visual Studio Community Edition from Microsoft at
 https://visualstudio.microsoft.com/vs/community/.
@@ -38,7 +38,7 @@ OpenTTD needs the Platform SDK, if it isn't installed already. This can be
 done during installing Visual Studio, by selecting
 `Visual C++ MFC for x86 and x64` (and possibly
 `Visual C++ ATL for x86 and x64` depending on your version). If not, you
-can get download it as [MS Windows Platform SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk).
+can get download it as [MS Windows Platform SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk).
 
 Install the SDK by following the instructions as given.
 
@@ -59,13 +59,13 @@ the `static` versions, and OpenTTD currently needs the following dependencies:
 To install both the x64 (64bit) and x86 (32bit) variants (though only one is necessary), you can use:
 
 ```ps
-.\vcpkg install breakpad:x64-windows-static liblzma:x64-windows-static libpng:x64-windows-static lzo:x64-windows-static zlib:x64-windows-static
+.\vcpkg install --triplet=x64-windows-static
-.\vcpkg install breakpad:x86-windows-static liblzma:x86-windows-static libpng:x86-windows-static lzo:x86-windows-static zlib:x86-windows-static
+.\vcpkg install --triplet=x86-windows-static
 ```
 
 You can open the folder (as a CMake project). CMake will be detected, and you can compile from there.
 If libraries are installed but not found, you need to set VCPKG_TARGET_TRIPLET in CMake parameters.
-For Visual Studio 2017 you also need to set CMAKE_TOOLCHAIN_FILE.
+For Visual Studio 2022 you also need to set CMAKE_TOOLCHAIN_FILE.
 (Typical values are shown in the MSVC project file command line example)
 
 Alternatively, you can create a MSVC project file via CMake. For this
@@ -75,7 +75,7 @@ that comes with vcpkg. After that, you can run something similar to this:
 ```powershell
 mkdir build
 cd build
-cmake.exe .. -G"Visual Studio 16 2019" -DCMAKE_TOOLCHAIN_FILE="<location of vcpkg>\vcpkg\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET="x64-windows-static"
+cmake.exe .. -G"Visual Studio 17 2022" -DCMAKE_TOOLCHAIN_FILE="<location of vcpkg>\vcpkg\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET="x64-windows-static"
 ```
 
 Change `<location of vcpkg>` to where you have installed vcpkg. After this
@@ -83,7 +83,7 @@ in the build folder are MSVC project files. MSVC can rebuild the project
 files himself via the `ZERO_CHECK` project.
 
 ## All other platforms
-Minimum required version of CMake is 3.9.
+Minimum required version of CMake is 3.16.
 By default this produces a Debug build with assertations enabled.
 This is a far slower build than release builds.
 
@@ -110,17 +110,14 @@ builds.
 - `-DOPTION_USE_ASSERTS=OFF`: disable asserts. Use with care, as assert
    statements capture early signs of trouble. Release builds have them
    disabled by default.
-- `-DOPTION_USE_THREADS=OFF`: disable the use of threads. This will block
-   the interface in many places, and in general gives a worse experience of
-   the game. Use with care.
 - `-DOPTION_TOOLS_ONLY=ON`: only build tools like `strgen`. Does not build
    the game itself. Useful for cross-compiling.
 
 ## Supported compilers
 
-Every compiler that is supported by CMake and supports C++17, should be
+Every compiler that is supported by CMake and supports C++20, should be
 able to compile OpenTTD. As the exact list of compilers changes constantly,
-we refer to the compiler manual to see if it supports C++17, and to CMake
+we refer to the compiler manual to see if it supports C++20, and to CMake
 to see if it supports your compiler.
 
 ## Compilation of base sets

CONTRIBUTING.md

@@ -112,7 +112,7 @@ Every pull request should have a clear scope, with no unrelated commits.
 
 Adhering to the following process is the best way to get your work included in the project:
 
-1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
+1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the project, clone your fork, and configure the remotes:
 
 ```bash
 git clone https://github.com/<your-username>/OpenTTD.git openttd
@@ -266,7 +266,7 @@ This is inevitable, because it is a main feature of git.
 If you are concerned about your privacy, we strongly recommend to use "Anonymous &lt;anonymous@openttd.org&gt;" as the git commit author. We might refuse anonymous contributions if malicious intent is suspected.
 
 Please note that the contributor identity, once given, is used for copyright verification and to provide proof should a malicious commit be made.
-As such, the [EU GDPR](https://www.eugdpr.org/key-changes.html) "right to be forgotten" does not apply, as this is an overriding legitimate interest.
+As such, the [EU GDPR](https://gdpr.eu) "right to be forgotten" does not apply, as this is an overriding legitimate interest.
 
 Please also note that your commit is public and as such will potentially be processed by many third-parties.
 Git's distributed nature makes it impossible to track where exactly your commit, and thus your personal data, will be stored and be processed.

CREDITS.md

@@ -3,14 +3,15 @@
 - Matthijs Kooijman (blathijs) - Pathfinder-guru, Debian port (since 0.3)
 - Christoph Elsenhans (frosch) - General coding (since 0.6)
 - Loïc Guilloux (glx) - General / Windows Expert (since 0.4.5)
+- Koen Bussemaker (Kuhnovic) - General / Ship pathfinder (since 14)
 - Charles Pigott (LordAro) - General / Correctness police (since 1.9)
 - Michael Lutz (michi_cc) - General / Path based signals (since 0.7)
 - Niels Martin Hansen (nielsm) - Music system, general coding (since 1.9)
 - Owen Rudge (orudge) - Forum host, OS/2 port (since 0.1)
-- Peter Nelson (peter1138) - Spiritual descendant from newGRF gods (since 0.4.5)
+- Peter Nelson (peter1138) - Spiritual descendant from NewGRF gods (since 0.4.5)
 - Remko Bijker (Rubidium) - Coder and way more (since 0.4.5)
 - Patric Stout (TrueBrain) - NoProgrammer (since 0.3), sys op
-- Tyler Trahan (2TallTyler) - General coding (since 13)
+- Tyler Trahan (2TallTyler) - General / Time Lord (since 13)
 
 ### Inactive Developers:
 
@@ -56,6 +57,7 @@
 - George - Canal/Lock graphics
 - Andrew Parkhouse (andythenorth) - River graphics
 - David Dallaston (Pikka) - Tram tracks
+- Richard Wheeler (zephyris) - OpenTTD TrueType font
 - All Translators - For their support to make OpenTTD a truly international game
 - Bug Reporters - Thanks for all bug reports
 - Chris Sawyer - For an amazing game!

Doxyfile.in

@@ -3,6 +3,8 @@
 # OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 # See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 
+# Doxyfile 1.9.4
+
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
@@ -13,6 +15,7 @@ PROJECT_BRIEF          =
 PROJECT_LOGO           =
 OUTPUT_DIRECTORY       = ${CPACK_BINARY_DIR}/docs/source/
 CREATE_SUBDIRS         = YES
+CREATE_SUBDIRS_LEVEL   = 8
 ALLOW_UNICODE_NAMES    = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
@@ -35,8 +38,10 @@ STRIP_FROM_PATH        = ./
 STRIP_FROM_INC_PATH    =
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = YES
+JAVADOC_BANNER         = NO
 QT_AUTOBRIEF           = NO
 MULTILINE_CPP_IS_BRIEF = NO
+PYTHON_DOCSTRING       = YES
 INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 2
@@ -45,6 +50,7 @@ OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = NO
 OPTIMIZE_FOR_FORTRAN   = NO
 OPTIMIZE_OUTPUT_VHDL   = NO
+OPTIMIZE_OUTPUT_SLICE  = NO
 EXTENSION_MAPPING      =
 MARKDOWN_SUPPORT       = YES
 TOC_INCLUDE_HEADINGS   = 0
@@ -60,16 +66,19 @@ INLINE_GROUPED_CLASSES = NO
 INLINE_SIMPLE_STRUCTS  = NO
 TYPEDEF_HIDES_STRUCT   = NO
 LOOKUP_CACHE_SIZE      = 0
+NUM_PROC_THREADS       = 1
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
 EXTRACT_ALL            = NO
 EXTRACT_PRIVATE        = YES
+EXTRACT_PRIV_VIRTUAL   = NO
 EXTRACT_PACKAGE        = NO
 EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
 EXTRACT_LOCAL_METHODS  = YES
 EXTRACT_ANON_NSPACES   = YES
+RESOLVE_UNNAMED_PARAMS = YES
 HIDE_UNDOC_MEMBERS     = NO
 HIDE_UNDOC_CLASSES     = NO
 HIDE_FRIEND_COMPOUNDS  = NO
@@ -78,6 +87,7 @@ INTERNAL_DOCS          = NO
 CASE_SENSE_NAMES       = YES
 HIDE_SCOPE_NAMES       = NO
 HIDE_COMPOUND_REFERENCE= NO
+SHOW_HEADERFILE        = YES
 SHOW_INCLUDE_FILES     = YES
 SHOW_GROUPED_MEMB_INC  = NO
 FORCE_LOCAL_INCLUDES   = NO
@@ -107,9 +117,11 @@ QUIET                  = NO
 WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
+WARN_IF_INCOMPLETE_DOC = YES
 WARN_NO_PARAMDOC       = NO
 WARN_AS_ERROR          = NO
 WARN_FORMAT            = "$file:$line: $text"
+WARN_LINE_FORMAT       = "at line $line of file $file"
 WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
@@ -150,6 +162,10 @@ REFERENCES_LINK_SOURCE = YES
 SOURCE_TOOLTIPS        = YES
 USE_HTAGS              = NO
 VERBATIM_HEADERS       = YES
+CLANG_ASSISTED_PARSING = NO
+CLANG_ADD_INC_PATHS    = YES
+CLANG_OPTIONS          =
+CLANG_DATABASE_PATH    =
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
@@ -175,6 +191,7 @@ HTML_DYNAMIC_SECTIONS  = NO
 HTML_INDEX_NUM_ENTRIES = 100
 GENERATE_DOCSET        = NO
 DOCSET_FEEDNAME        = "Doxygen generated docs"
+DOCSET_FEEDURL         =
 DOCSET_BUNDLE_ID       = org.doxygen.Project
 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 DOCSET_PUBLISHER_NAME  = Publisher
@@ -197,12 +214,17 @@ GENERATE_ECLIPSEHELP   = NO
 ECLIPSE_DOC_ID         = org.doxygen.Project
 DISABLE_INDEX          = NO
 GENERATE_TREEVIEW      = YES
+FULL_SIDEBAR           = NO
 ENUM_VALUES_PER_LINE   = 4
 TREEVIEW_WIDTH         = 250
 EXT_LINKS_IN_WINDOW    = NO
+OBFUSCATE_EMAILS       = YES
+HTML_FORMULA_FORMAT    = png
 FORMULA_FONTSIZE       = 10
 FORMULA_TRANSPARENT    = YES
+FORMULA_MACROFILE      =
 USE_MATHJAX            = NO
+MATHJAX_VERSION        = MathJax_2
 MATHJAX_FORMAT         = HTML-CSS
 MATHJAX_RELPATH        = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/
 MATHJAX_EXTENSIONS     =
@@ -221,6 +243,7 @@ GENERATE_LATEX         = NO
 LATEX_OUTPUT           = latex
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
+LATEX_MAKEINDEX_CMD    = makeindex
 COMPACT_LATEX          = NO
 PAPER_TYPE             = a4
 EXTRA_PACKAGES         =
@@ -232,9 +255,9 @@ PDF_HYPERLINKS         = NO
 USE_PDFLATEX           = NO
 LATEX_BATCHMODE        = NO
 LATEX_HIDE_INDICES     = NO
-LATEX_SOURCE_CODE      = NO
 LATEX_BIB_STYLE        = plain
 LATEX_TIMESTAMP        = NO
+LATEX_EMOJI_DIRECTORY  =
 #---------------------------------------------------------------------------
 # Configuration options related to the RTF output
 #---------------------------------------------------------------------------
@@ -244,7 +267,6 @@ COMPACT_RTF            = NO
 RTF_HYPERLINKS         = NO
 RTF_STYLESHEET_FILE    =
 RTF_EXTENSIONS_FILE    =
-RTF_SOURCE_CODE        = NO
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
 #---------------------------------------------------------------------------
@@ -259,12 +281,12 @@ MAN_LINKS              = NO
 GENERATE_XML           = NO
 XML_OUTPUT             = xml
 XML_PROGRAMLISTING     = YES
+XML_NS_MEMB_FILE_SCOPE = NO
 #---------------------------------------------------------------------------
 # Configuration options related to the DOCBOOK output
 #---------------------------------------------------------------------------
 GENERATE_DOCBOOK       = NO
 DOCBOOK_OUTPUT         = docbook
-DOCBOOK_PROGRAMLISTING = NO
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
@@ -311,7 +333,6 @@ EXTERNAL_PAGES         = YES
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
-CLASS_DIAGRAMS         = YES
 DIA_PATH               =
 HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = NO
@@ -324,6 +345,8 @@ COLLABORATION_GRAPH    = YES
 GROUP_GRAPHS           = YES
 UML_LOOK               = NO
 UML_LIMIT_NUM_FIELDS   = 10
+DOT_UML_DETAILS        = NO
+DOT_WRAP_THRESHOLD     = 17
 TEMPLATE_RELATIONS     = NO
 INCLUDE_GRAPH          = YES
 INCLUDED_BY_GRAPH      = YES
@@ -331,6 +354,7 @@ CALL_GRAPH             = NO
 CALLER_GRAPH           = NO
 GRAPHICAL_HIERARCHY    = YES
 DIRECTORY_GRAPH        = YES
+DIR_GRAPH_MAX_DEPTH    = 1
 DOT_IMAGE_FORMAT       = png
 INTERACTIVE_SVG        = NO
 DOT_PATH               =

README.md

@@ -118,6 +118,15 @@ Most types of add-on content can be downloaded within OpenTTD via the 'Check Onl
 Add-on content can also be installed manually, but that's more complicated; the [OpenTTD wiki](https://wiki.openttd.org/) may offer help with that, or the [OpenTTD directory structure guide](./docs/directory_structure.md).
 
 
+### 1.5.1) Social Integration
+
+OpenTTD has the ability to load plugins to integrate with Social Platforms like Steam, Discord, etc.
+
+To enable such integration, the plugin for the specific platform has to be downloaded and stored in the `social_integration` folder.
+
+See [OpenTTD's website](https://www.openttd.org), under Downloads, for what plugins are available.
+
+
 ### 1.6) OpenTTD directories
 
 OpenTTD uses its own directory structure to store game data, add-on content etc.
@@ -197,6 +206,15 @@ See `src/3rdparty/catch2/LICENSE.txt` for the complete license text.
 The icu scriptrun implementation in `src/3rdparty/icu` is licensed under the Unicode license.
 See `src/3rdparty/icu/LICENSE` for the complete license text.
 
+The monocypher implementation in `src/3rdparty/monocypher` is licensed under the 2-clause BSD and CC-0 license.
+See `src/3rdparty/monocypher/LICENSE.md` for the complete license text.
+
+The OpenTTD Social Integration API in `src/3rdparty/openttd_social_integration_api` is licensed under the MIT license.
+See `src/3rdparty/openttd_social_integration_api/LICENSE` for the complete license text.
+
+The atomic datatype support detection in `cmake/3rdparty/llvm/CheckAtomic.cmake` is licensed under the Apache 2.0 license.
+See `cmake/3rdparty/llvm/LICENSE.txt` for the complete license text.
+
 ## 4.0 Credits
 
 See [CREDITS.md](./CREDITS.md)

bin/ai/CMakeLists.txt

@@ -15,6 +15,7 @@ set(AI_COMPAT_SOURCE_FILES
 	${CMAKE_CURRENT_SOURCE_DIR}/compat_12.nut
 	${CMAKE_CURRENT_SOURCE_DIR}/compat_13.nut
 	${CMAKE_CURRENT_SOURCE_DIR}/compat_14.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_15.nut
 )
 
 foreach(AI_COMPAT_SOURCE_FILE IN LISTS AI_COMPAT_SOURCE_FILES)

bin/ai/compat_14.nut

@@ -4,3 +4,5 @@
  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
  */
+
+AILog.Info("14 API compatibility in effect.");

bin/ai/compat_15.nut

@@ -0,0 +1,6 @@
+/*
+ * This file is part of OpenTTD.
+ * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
+ * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+ */

bin/game/CMakeLists.txt

@@ -12,6 +12,7 @@ set(GS_COMPAT_SOURCE_FILES
 	${CMAKE_CURRENT_SOURCE_DIR}/compat_12.nut
 	${CMAKE_CURRENT_SOURCE_DIR}/compat_13.nut
 	${CMAKE_CURRENT_SOURCE_DIR}/compat_14.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_15.nut
 )
 
 foreach(GS_COMPAT_SOURCE_FILE IN LISTS GS_COMPAT_SOURCE_FILES)

bin/game/compat_14.nut

@@ -4,3 +4,5 @@
  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
  */
+
+GSLog.Info("14 API compatibility in effect.");

bin/game/compat_15.nut

@@ -0,0 +1,6 @@
+/*
+ * This file is part of OpenTTD.
+ * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
+ * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+ */

cmake/3rdparty/llvm/CheckAtomic.cmake

@@ -1,3 +1,11 @@
+#
+# This was originally part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+# See (https://llvm.org/)LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# Modifications have been made to suit building OpenTTD.
+#
+
 # atomic builtins are required for threading support.
 
 INCLUDE(CheckCXXSourceCompiles)
@@ -48,6 +56,8 @@ else()
   check_working_cxx_atomics(HAVE_CXX_ATOMICS_WITHOUT_LIB)
   # If not, check if the library exists, and atomics work with it.
   if(NOT HAVE_CXX_ATOMICS_WITHOUT_LIB)
+    # check_library_exists requires the C-compiler as the atomic functions are built-in declared.
+    enable_language(C)
     check_library_exists(atomic __atomic_fetch_add_4 "" HAVE_LIBATOMIC)
     if(HAVE_LIBATOMIC)
       list(APPEND CMAKE_REQUIRED_LIBRARIES "atomic")
@@ -69,6 +79,8 @@ else()
   check_working_cxx_atomics64(HAVE_CXX_ATOMICS64_WITHOUT_LIB)
   # If not, check if the library exists, and atomics work with it.
   if(NOT HAVE_CXX_ATOMICS64_WITHOUT_LIB)
+    # check_library_exists requires the C-compiler as the atomic functions are built-in declared.
+    enable_language(C)
     check_library_exists(atomic __atomic_load_8 "" HAVE_CXX_LIBATOMICS64)
     if(HAVE_CXX_LIBATOMICS64)
       list(APPEND CMAKE_REQUIRED_LIBRARIES "atomic")

cmake/3rdparty/llvm/LICENSE.txt

@@ -0,0 +1,279 @@
+==============================================================================
+The LLVM Project is under the Apache License v2.0 with LLVM Exceptions:
+==============================================================================
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+
+---- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.
+
+==============================================================================
+Software from third parties included in the LLVM Project:
+==============================================================================
+The LLVM Project contains third party software which is under different license
+terms. All such code will be identified clearly using at least one of two
+mechanisms:
+1) It will be in a separate directory tree with its own `LICENSE.txt` or
+   `LICENSE` file at the top containing the specific license and restrictions
+   which apply to that software, or
+2) It will contain specific license and restriction terms at the top of every
+   file.
+
+==============================================================================
+Legacy LLVM License (https://llvm.org/docs/DeveloperPolicy.html#legacy):
+==============================================================================
+University of Illinois/NCSA
+Open Source License
+
+Copyright (c) 2003-2019 University of Illinois at Urbana-Champaign.
+All rights reserved.
+
+Developed by:
+
+    LLVM Team
+
+    University of Illinois at Urbana-Champaign
+
+    http://llvm.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal with
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimers.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimers in the
+      documentation and/or other materials provided with the distribution.
+
+    * Neither the names of the LLVM Team, University of Illinois at
+      Urbana-Champaign, nor the names of its contributors may be used to
+      endorse or promote products derived from this Software without specific
+      prior written permission.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
+SOFTWARE.
+

cmake/CompileFlags.cmake

@@ -10,12 +10,20 @@ macro(compile_flags)
 
         if(NOT CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
             add_compile_options(
+                /Zc:preprocessor # Needed for __VA_OPT__() in macros.
                 /MP # Enable multi-threaded compilation.
                 /FC # Display the full path of source code files passed to the compiler in diagnostics.
             )
         endif()
     endif()
 
+    # Our strings are UTF-8.
+    if(MSVC)
+        add_compile_options(/utf-8)
+    else()
+        add_compile_options(-finput-charset=utf-8)
+    endif()
+
     # Add some -D flags for Debug builds. We cannot use add_definitions(), because
     # it does not appear to support the $<> tags.
     add_compile_options(
@@ -48,6 +56,11 @@ macro(compile_flags)
             # This flag disables the broken optimisation to work around the bug
             add_compile_options(/d2ssa-rse-)
         endif()
+        if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+            add_compile_options(
+                -Wno-multichar
+            )
+        endif()
     elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
         add_compile_options(
             -W
@@ -67,12 +80,6 @@ macro(compile_flags)
 
             # We use 'ABCD' multichar for SaveLoad chunks identifiers
             -Wno-multichar
-
-            # Compilers complains about that we break strict-aliasing.
-            #  On most places we don't see how to fix it, and it doesn't
-            #  break anything. So disable strict-aliasing to make the
-            #  compiler all happy.
-            -fno-strict-aliasing
         )
 
         # Ninja processes the output so the output from the compiler

cmake/CreateGrfCommand.cmake

@@ -1,16 +1,13 @@
 # Macro which contains all bits and pieces to create a single grf file based
 # on NFO and PNG files.
 #
-# create_grf_command()
+# create_grf_command(NFO_SOURCE_FILES nfo_file1 ... PNG_SOURCE_FILES png_file1 ...)
 #
 function(create_grf_command)
-    set(EXTRA_PNG_SOURCE_FILES ${ARGV})
+    cmake_parse_arguments(GRF "" "" "NFO_SOURCE_FILES;PNG_SOURCE_FILES" ${ARGN})
 
     get_filename_component(GRF_SOURCE_FOLDER_NAME "${CMAKE_CURRENT_SOURCE_DIR}" NAME)
     get_filename_component(GRF_BINARY_FILE ${CMAKE_CURRENT_SOURCE_DIR}/../${GRF_SOURCE_FOLDER_NAME}.grf ABSOLUTE)
-    file(GLOB_RECURSE GRF_PNG_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.png)
-    file(GLOB_RECURSE GRF_NFO_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.nfo)
-    set(GRF_PNG_SOURCE_FILES ${GRF_PNG_SOURCE_FILES} ${EXTRA_PNG_SOURCE_FILES})
 
     # Copy over all the PNG files to the correct folder
     foreach(GRF_PNG_SOURCE_FILE IN LISTS GRF_PNG_SOURCE_FILES)
@@ -28,12 +25,13 @@ function(create_grf_command)
         list(APPEND GRF_PNG_BINARY_FILES ${GRF_PNG_BINARY_FILE})
     endforeach()
 
-    add_custom_command(OUTPUT ${GRF_BINARY_FILE}
+    add_custom_command(OUTPUT ${GRF_BINARY_FILE} ${GRF_BINARY_FILE}.hash
             COMMAND ${CMAKE_COMMAND}
                     -DGRF_SOURCE_FOLDER=${CMAKE_CURRENT_SOURCE_DIR}
                     -DGRF_BINARY_FILE=${GRF_BINARY_FILE}
                     -DNFORENUM_EXECUTABLE=${NFORENUM_EXECUTABLE}
                     -DGRFCODEC_EXECUTABLE=${GRFCODEC_EXECUTABLE}
+                    -DGRFID_EXECUTABLE=${GRFID_EXECUTABLE}
                     -P ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateGRF.cmake
             MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateGRF.cmake
             DEPENDS ${GRF_PNG_BINARY_FILES}

cmake/CreateRegression.cmake

@@ -3,20 +3,15 @@
 # 'ctest'. The first is prefered, as it is more verbose, and takes care of
 # dependencies correctly.
 #
-# create_regression()
+# create_regression(file1 ...)
 #
 macro(create_regression)
-    # Find all the files in the regression folder; they need to be copied to the
+    set(REGRESSION_SOURCE_FILES ${ARGN})
-    # build folder before we can run the regression
+
-    file(GLOB_RECURSE REGRESSION_SOURCE_FILES ${CMAKE_SOURCE_DIR}/regression/*)
     foreach(REGRESSION_SOURCE_FILE IN LISTS REGRESSION_SOURCE_FILES)
         string(REPLACE "${CMAKE_SOURCE_DIR}/regression/" "" REGRESSION_SOURCE_FILE_NAME "${REGRESSION_SOURCE_FILE}")
         string(CONCAT REGRESSION_BINARY_FILE "${CMAKE_BINARY_DIR}/ai/" "${REGRESSION_SOURCE_FILE_NAME}")
 
-        if("${REGRESSION_SOURCE_FILE_NAME}" STREQUAL "regression.cfg")
-            continue()
-        endif()
-
         add_custom_command(OUTPUT ${REGRESSION_BINARY_FILE}
                 COMMAND ${CMAKE_COMMAND} -E copy
                         ${REGRESSION_SOURCE_FILE}
@@ -28,59 +23,36 @@ macro(create_regression)
         list(APPEND REGRESSION_BINARY_FILES ${REGRESSION_BINARY_FILE})
     endforeach()
 
-    # Copy the regression configuration in a special folder, so all autogenerated
+    get_filename_component(REGRESSION_TEST_NAME "${CMAKE_CURRENT_SOURCE_DIR}" NAME)
-    # folders end up in the same place after running regression.
-    add_custom_command(OUTPUT ${CMAKE_BINARY_DIR}/regression/regression.cfg
-            COMMAND ${CMAKE_COMMAND} -E copy
-                    ${CMAKE_SOURCE_DIR}/regression/regression.cfg
-                    ${CMAKE_BINARY_DIR}/regression/regression.cfg
-            MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/regression/regression.cfg
-            COMMENT "Copying ${REGRESSION_SOURCE_FILE_NAME} regression file"
-    )
-    list(APPEND REGRESSION_BINARY_FILES ${CMAKE_BINARY_DIR}/regression/regression.cfg)
 
-    # Create a new target which copies all regression files
+    # Create a new target which copies regression files
-    add_custom_target(regression_files
+    add_custom_target(regression_${REGRESSION_TEST_NAME}_files
-            ALL  # this is needed because 'make test' doesn't resolve dependencies, and otherwise this is never executed
             DEPENDS
             ${REGRESSION_BINARY_FILES}
     )
 
-    enable_testing()
+    add_dependencies(regression_files regression_${REGRESSION_TEST_NAME}_files)
 
-    # Find all the tests we have, and create a target for them
+    add_custom_target(regression_${REGRESSION_TEST_NAME}
-    file(GLOB REGRESSION_TESTS ${CMAKE_SOURCE_DIR}/regression/*)
+            COMMAND ${CMAKE_COMMAND}
-    foreach(REGRESSION_TEST IN LISTS REGRESSION_TESTS)
+                    -DOPENTTD_EXECUTABLE=$<TARGET_FILE:openttd>
-        get_filename_component(REGRESSION_TEST_NAME "${REGRESSION_TEST}" NAME)
+                    -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE}
+                    -DREGRESSION_TEST=${REGRESSION_TEST_NAME}
+                    -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake"
+            DEPENDS openttd regression_${REGRESSION_TEST_NAME}_files
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            COMMENT "Running regression test ${REGRESSION_TEST_NAME}"
+    )
 
-        if("${REGRESSION_TEST_NAME}" STREQUAL "regression.cfg")
+    # Also make sure that 'make test' runs the regression
-            continue()
+    add_test(NAME regression_${REGRESSION_TEST_NAME}
-        endif()
+            COMMAND ${CMAKE_COMMAND}
+                    -DOPENTTD_EXECUTABLE=$<TARGET_FILE:openttd>
+                    -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE}
+                    -DREGRESSION_TEST=${REGRESSION_TEST_NAME}
+                    -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake"
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    )
 
-        add_custom_target(regression_${REGRESSION_TEST_NAME}
+    add_dependencies(regression regression_${REGRESSION_TEST_NAME})
-                COMMAND ${CMAKE_COMMAND}
-                        -DOPENTTD_EXECUTABLE=$<TARGET_FILE:openttd>
-                        -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE}
-                        -DREGRESSION_TEST=${REGRESSION_TEST_NAME}
-                        -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake"
-                DEPENDS openttd regression_files
-                WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
-                COMMENT "Running regression test ${REGRESSION_TEST_NAME}"
-                )
-
-        # Also make sure that 'make test' runs the regression
-        add_test(NAME regression_${REGRESSION_TEST_NAME}
-                COMMAND ${CMAKE_COMMAND}
-                        -DOPENTTD_EXECUTABLE=$<TARGET_FILE:openttd>
-                        -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE}
-                        -DREGRESSION_TEST=${REGRESSION_TEST_NAME}
-                        -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake"
-                WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
-
-        list(APPEND REGRESSION_TARGETS regression_${REGRESSION_TEST_NAME})
-    endforeach()
-
-    # Create a new target which runs the regression
-    add_custom_target(regression
-            DEPENDS ${REGRESSION_TARGETS})
 endmacro()

cmake/FindGrfcodec.cmake

@@ -2,6 +2,7 @@
 #
 
 find_program(GRFCODEC_EXECUTABLE grfcodec)
+find_program(GRFID_EXECUTABLE grfid)
 find_program(NFORENUM_EXECUTABLE nforenum)
 
 include(FindPackageHandleStandardArgs)
@@ -9,5 +10,6 @@ find_package_handle_standard_args(Grfcodec
     FOUND_VAR GRFCODEC_FOUND
     REQUIRED_VARS
         GRFCODEC_EXECUTABLE
+        GRFID_EXECUTABLE
         NFORENUM_EXECUTABLE
 )

cmake/FindOgg.cmake

@@ -0,0 +1,37 @@
+include(FindPackageHandleStandardArgs)
+
+find_library(Ogg_LIBRARY
+    NAMES ogg
+)
+
+set(Ogg_COMPILE_OPTIONS "" CACHE STRING "Extra compile options of ogg")
+
+set(Ogg_LINK_LIBRARIES "" CACHE STRING "Extra link libraries of ogg")
+
+set(Ogg_LINK_FLAGS "" CACHE STRING "Extra link flags of ogg")
+
+find_path(Ogg_INCLUDE_PATH
+    NAMES ogg.h
+    PATH_SUFFIXES ogg
+)
+
+find_package_handle_standard_args(Ogg
+    REQUIRED_VARS Ogg_LIBRARY Ogg_INCLUDE_PATH
+)
+
+if (Ogg_FOUND)
+    set(Ogg_dirs ${Ogg_INCLUDE_PATH})
+    if(EXISTS "${Ogg_INCLUDE_PATH}/ogg")
+        list(APPEND Ogg_dirs "${Ogg_INCLUDE_PATH}/ogg")
+    endif()
+    if (NOT TARGET Ogg::ogg)
+        add_library(Ogg::ogg UNKNOWN IMPORTED)
+        set_target_properties(Ogg::ogg PROPERTIES
+            IMPORTED_LOCATION "${Ogg_LIBRARY}"
+            INTERFACE_INCLUDE_DIRECTORIES "${Ogg_dirs}"
+            INTERFACE_COMPILE_OPTIONS "${Ogg_COMPILE_OPTIONS}"
+            INTERFACE_LINK_LIBRARIES "${Ogg_LINK_LIBRARIES}"
+            INTERFACE_LINK_FLAGS "${Ogg_LINK_FLAGS}"
+        )
+    endif()
+endif()

cmake/FindOpus.cmake

@@ -0,0 +1,37 @@
+include(FindPackageHandleStandardArgs)
+
+find_library(Opus_LIBRARY
+    NAMES opus
+)
+
+set(Opus_COMPILE_OPTIONS "" CACHE STRING "Extra compile options of opus")
+
+set(Opus_LINK_LIBRARIES "" CACHE STRING "Extra link libraries of opus")
+
+set(Opus_LINK_FLAGS "" CACHE STRING "Extra link flags of opus")
+
+find_path(Opus_INCLUDE_PATH
+    NAMES opus.h
+    PATH_SUFFIXES opus
+)
+
+find_package_handle_standard_args(Opus
+    REQUIRED_VARS Opus_LIBRARY Opus_INCLUDE_PATH
+)
+
+if (Opus_FOUND)
+    set(Opus_dirs ${Opus_INCLUDE_PATH})
+    if(EXISTS "${Opus_INCLUDE_PATH}/opus")
+        list(APPEND Opus_dirs "${Opus_INCLUDE_PATH}/opus")
+    endif()
+    if (NOT TARGET Opus::opus)
+        add_library(Opus::opus UNKNOWN IMPORTED)
+        set_target_properties(Opus::opus PROPERTIES
+            IMPORTED_LOCATION "${Opus_LIBRARY}"
+            INTERFACE_INCLUDE_DIRECTORIES "${Opus_dirs}"
+            INTERFACE_COMPILE_OPTIONS "${Opus_COMPILE_OPTIONS}"
+            INTERFACE_LINK_LIBRARIES "${Opus_LINK_LIBRARIES}"
+            INTERFACE_LINK_FLAGS "${Opus_LINK_FLAGS}"
+        )
+    endif()
+endif()

cmake/FindOpusFile.cmake

@@ -0,0 +1,40 @@
+include(FindPackageHandleStandardArgs)
+
+find_library(OpusFile_LIBRARY
+    NAMES opusfile
+)
+
+set(OpusFile_COMPILE_OPTIONS "" CACHE STRING "Extra compile options of opusfile")
+
+set(OpusFile_LINK_LIBRARIES "" CACHE STRING "Extra link libraries of opusfile")
+
+set(OpusFile_LINK_FLAGS "" CACHE STRING "Extra link flags of opusfile")
+
+find_path(OpusFile_INCLUDE_PATH
+    NAMES opusfile.h
+    PATH_SUFFIXES opus
+)
+
+find_package_handle_standard_args(OpusFile
+    REQUIRED_VARS OpusFile_LIBRARY OpusFile_INCLUDE_PATH
+)
+
+find_package(Ogg)
+find_package(Opus)
+
+if (OpusFile_FOUND)
+    set(OpusFile_dirs ${OpusFile_INCLUDE_PATH})
+    if(EXISTS "${OpusFile_INCLUDE_PATH}/opus")
+        list(APPEND OpusFile_dirs "${OpusFile_INCLUDE_PATH}/opus")
+    endif()
+    if (NOT TARGET OpusFile::opusfile)
+        add_library(OpusFile::opusfile UNKNOWN IMPORTED)
+        set_target_properties(OpusFile::opusfile PROPERTIES
+            IMPORTED_LOCATION "${OpusFile_LIBRARY}"
+            INTERFACE_INCLUDE_DIRECTORIES "${OpusFile_dirs}"
+            INTERFACE_COMPILE_OPTIONS "${OpusFile_COMPILE_OPTIONS}"
+            INTERFACE_LINK_LIBRARIES "Ogg::ogg;Opus::opus;${OpusFile_LINK_LIBRARIES}"
+            INTERFACE_LINK_FLAGS "${OpusFile_LINK_FLAGS}"
+        )
+    endif()
+endif()

cmake/InstallAndPackage.cmake

@@ -23,24 +23,36 @@ install(TARGETS openttd
             COMPONENT Runtime
         )
 
-install(DIRECTORY
+if (NOT EMSCRIPTEN)
-                ${CMAKE_BINARY_DIR}/lang
+    # Emscripten embeds these files in openttd.data.
-                ${CMAKE_BINARY_DIR}/baseset
+    # See CMakeLists.txt in the root.
-                ${CMAKE_BINARY_DIR}/ai
+    install(DIRECTORY
-                ${CMAKE_BINARY_DIR}/game
+                    ${CMAKE_BINARY_DIR}/lang
-                ${CMAKE_SOURCE_DIR}/bin/scripts
+                    ${CMAKE_BINARY_DIR}/baseset
-        DESTINATION ${DATA_DESTINATION_DIR}
+                    ${CMAKE_BINARY_DIR}/ai
-        COMPONENT language_files
+                    ${CMAKE_BINARY_DIR}/game
-        REGEX "ai/[^\.]+$" EXCLUDE # Ignore subdirs in ai dir
+                    ${CMAKE_SOURCE_DIR}/bin/scripts
-)
+            DESTINATION ${DATA_DESTINATION_DIR}
+            COMPONENT language_files
+            REGEX "ai/[^\.]+$" EXCLUDE # Ignore subdirs in ai dir
+    )
+else()
+    install(FILES
+                ${CMAKE_BINARY_DIR}/openttd.js
+                ${CMAKE_BINARY_DIR}/openttd.wasm
+                ${CMAKE_BINARY_DIR}/openttd.data
+            DESTINATION ${BINARY_DESTINATION_DIR}
+            COMPONENT Runtime
+    )
+endif()
 
 install(FILES
                 ${CMAKE_SOURCE_DIR}/COPYING.md
                 ${CMAKE_SOURCE_DIR}/README.md
                 ${CMAKE_SOURCE_DIR}/CREDITS.md
                 ${CMAKE_SOURCE_DIR}/CONTRIBUTING.md
-                ${CMAKE_SOURCE_DIR}/changelog.txt
+                ${CMAKE_SOURCE_DIR}/changelog.md
-                ${CMAKE_SOURCE_DIR}/known-bugs.txt
+                ${CMAKE_SOURCE_DIR}/known-bugs.md
         DESTINATION ${DOCS_DESTINATION_DIR}
         COMPONENT docs)
 
@@ -79,7 +91,7 @@ if(OPTION_INSTALL_FHS)
             COMPONENT manual)
 endif()
 
-if(UNIX AND NOT APPLE)
+if(UNIX AND NOT APPLE AND NOT EMSCRIPTEN)
     install(DIRECTORY
                     ${CMAKE_BINARY_DIR}/media/icons
                     ${CMAKE_BINARY_DIR}/media/pixmaps
@@ -160,10 +172,10 @@ elseif(WIN32)
 
     set(CPACK_PACKAGE_FILE_NAME "openttd-#CPACK_PACKAGE_VERSION#-windows-${CPACK_SYSTEM_NAME}")
 
-    if(WINDOWS_CERTIFICATE_COMMON_NAME)
+    if(DEFINED ENV{AZURE_CODESIGN_PROFILE_NAME})
       add_custom_command(TARGET openttd
         POST_BUILD
-        COMMAND "${CMAKE_SOURCE_DIR}/os/windows/sign.bat" "$<TARGET_FILE:openttd>" "${WINDOWS_CERTIFICATE_COMMON_NAME}"
+        COMMAND "${CMAKE_SOURCE_DIR}/os/windows/sign.bat" "${BINARY_DESTINATION_DIR}"
       )
     endif()
 elseif(UNIX)
@@ -183,7 +195,7 @@ elseif(UNIX)
             OUTPUT_STRIP_TRAILING_WHITESPACE
         )
         if(LSB_RELEASE_ID)
-            if(LSB_RELEASE_ID STREQUAL "Ubuntu" OR LSB_RELEASE_ID STREQUAL "Debian")
+            if(LSB_RELEASE_ID STREQUAL "Ubuntu" OR LSB_RELEASE_ID STREQUAL "Debian" OR LSB_RELEASE_ID STREQUAL "Linuxmint")
                 execute_process(COMMAND ${LSB_RELEASE_EXEC} -cs
                     OUTPUT_VARIABLE LSB_RELEASE_CODENAME
                     OUTPUT_STRIP_TRAILING_WHITESPACE

cmake/Options.cmake

@@ -57,16 +57,10 @@ function(set_options)
     option(OPTION_DEDICATED "Build dedicated server only (no GUI)" OFF)
     option(OPTION_INSTALL_FHS "Install with Filesystem Hierarchy Standard folders" ${DEFAULT_OPTION_INSTALL_FHS})
     option(OPTION_USE_ASSERTS "Use assertions; leave enabled for nightlies, betas, and RCs" ON)
-    if(EMSCRIPTEN)
-        # Although pthreads is supported, it is not in a way yet that is
-        # useful for us.
-        option(OPTION_USE_THREADS "Use threads" OFF)
-    else()
-        option(OPTION_USE_THREADS "Use threads" ON)
-    endif()
     option(OPTION_USE_NSIS "Use NSIS to create windows installer; enable only for stable releases" OFF)
     option(OPTION_TOOLS_ONLY "Build only tools target" OFF)
     option(OPTION_DOCS_ONLY "Build only docs target" OFF)
+    option(OPTION_ALLOW_INVALID_SIGNATURE "Allow loading of content with invalid signatures" OFF)
 
     if (OPTION_DOCS_ONLY)
         set(OPTION_TOOLS_ONLY ON PARENT_SCOPE)
@@ -84,7 +78,6 @@ function(show_options)
     message(STATUS "Option Dedicated - ${OPTION_DEDICATED}")
     message(STATUS "Option Install FHS - ${OPTION_INSTALL_FHS}")
     message(STATUS "Option Use assert - ${OPTION_USE_ASSERTS}")
-    message(STATUS "Option Use threads - ${OPTION_USE_THREADS}")
     message(STATUS "Option Use NSIS - ${OPTION_USE_NSIS}")
 
     if(OPTION_SURVEY_KEY)
@@ -92,6 +85,11 @@ function(show_options)
     else()
         message(STATUS "Option Survey Key - NOT USED")
     endif()
+
+    if(OPTION_ALLOW_INVALID_SIGNATURE)
+        message(STATUS "Option Allow Invalid Signature - USED")
+        message(WARNING "Ignoring invalid signatures is a security risk! Use with care!")
+    endif()
 endfunction()
 
 # Add the definitions for the options that are selected.
@@ -103,10 +101,6 @@ function(add_definitions_based_on_options)
         add_definitions(-DDEDICATED)
     endif()
 
-    if(NOT OPTION_USE_THREADS)
-        add_definitions(-DNO_THREADS)
-    endif()
-
     if(OPTION_USE_ASSERTS)
         add_definitions(-DWITH_ASSERT)
     else()
@@ -116,4 +110,8 @@ function(add_definitions_based_on_options)
     if(OPTION_SURVEY_KEY)
         add_definitions(-DSURVEY_KEY="${OPTION_SURVEY_KEY}")
     endif()
+
+    if(OPTION_ALLOW_INVALID_SIGNATURE)
+        add_definitions(-DALLOW_INVALID_SIGNATURE)
+    endif()
 endfunction()

cmake/PackageBundle.cmake

@@ -4,6 +4,7 @@ set(CPACK_BUNDLE_NAME "OpenTTD")
 set(CPACK_BUNDLE_ICON "${CMAKE_SOURCE_DIR}/os/macosx/openttd.icns")
 set(CPACK_BUNDLE_PLIST "${CMAKE_CURRENT_BINARY_DIR}/Info.plist")
 set(CPACK_DMG_BACKGROUND_IMAGE "${CMAKE_SOURCE_DIR}/os/macosx/splash.png")
+set(CPACK_BUNDLE_APPLE_ENTITLEMENTS "${CMAKE_SOURCE_DIR}/os/macosx/openttd.entitlements")
 set(CPACK_DMG_FORMAT "UDBZ")
 
 # Create a temporary Info.plist.in, where we will fill in the version via

cmake/scripts/Baseset.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 #
 # Create a single baseset meta file with the correct translations.
@@ -58,6 +58,7 @@ list(SORT ${PLACE_HOLDER})
 string(REPLACE ";" "\n" ${PLACE_HOLDER} "${${PLACE_HOLDER}}")
 
 # Get the grf md5
-file(MD5 ${BASESET_EXTRAGRF_FILE} ORIG_EXTRA_GRF_MD5)
+file(READ ${BASESET_EXTRAGRF_FILE}.hash ORIG_EXTRA_GRF_MD5)
+string(STRIP ${ORIG_EXTRA_GRF_MD5} ORIG_EXTRA_GRF_MD5)
 
 configure_file(${BASESET_SOURCE_FILE} ${BASESET_BINARY_FILE})

cmake/scripts/CreateGRF.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 #
 # Create a single GRF file based on sprites/<grfname>.nfo and sprites/*.png
@@ -11,6 +11,9 @@ endif()
 if(NOT GRFCODEC_EXECUTABLE)
     message(FATAL_ERROR "Script needs GRFCODEC_EXECUTABLE defined")
 endif()
+if(NOT GRFID_EXECUTABLE)
+    message(FATAL_ERROR "Script needs GRFID_EXECUTABLE defined")
+endif()
 if(NOT GRF_SOURCE_FOLDER)
     message(FATAL_ERROR "Script needs GRF_SOURCE_FOLDER defined")
 endif()
@@ -18,6 +21,9 @@ if(NOT GRF_BINARY_FILE)
     message(FATAL_ERROR "Script needs GRF_BINARY_FILE defined")
 endif()
 
+# Remove the existing output so failures never go unnoticed
+file(REMOVE ${GRF_BINARY_FILE} ${GRF_BINARY_FILE}.hash)
+
 get_filename_component(GRF_SOURCE_FOLDER_NAME "${GRF_SOURCE_FOLDER}" NAME)
 
 file(WRITE sprites/${GRF_SOURCE_FOLDER_NAME}.nfo "")
@@ -47,7 +53,7 @@ if(RESULT)
     message(FATAL_ERROR "NFORenum failed")
 endif()
 
-execute_process(COMMAND ${GRFCODEC_EXECUTABLE} -n -s -e -p1 ${GRF_SOURCE_FOLDER_NAME}.grf RESULT_VARIABLE RESULT)
+execute_process(COMMAND ${GRFCODEC_EXECUTABLE} -n -s -e -g2 -p1 ${GRF_SOURCE_FOLDER_NAME}.grf RESULT_VARIABLE RESULT)
 if(RESULT)
     if(NOT RESULT MATCHES "^[0-9]*$")
         message(FATAL_ERROR "Failed to run GRFCodec (${RESULT}), please check GRFCODEC_EXECUTABLE variable")
@@ -55,4 +61,15 @@ if(RESULT)
     message(FATAL_ERROR "GRFCodec failed")
 endif()
 
+execute_process(COMMAND ${GRFID_EXECUTABLE} -m ${GRF_SOURCE_FOLDER_NAME}.grf OUTPUT_VARIABLE GRFID_HASH RESULT_VARIABLE RESULT)
+if(RESULT)
+    if(NOT RESULT MATCHES "^[0-9]*$")
+        message(FATAL_ERROR "Failed to run GRFID (${RESULT}), please check GRFID_EXECUTABLE variable")
+    endif()
+    message(FATAL_ERROR "GRFID failed")
+endif()
+
+file(WRITE ${GRF_BINARY_FILE}.hash ${GRFID_HASH})
+
+# Copy build files back to the source directory.
 execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${GRF_SOURCE_FOLDER_NAME}.grf ${GRF_BINARY_FILE})

cmake/scripts/Desktop.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 #
 # Create a desktop file with the correct translations.

cmake/scripts/FindVersion.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 if(NOT REV_MAJOR)
     set(REV_MAJOR 0)
@@ -49,14 +49,14 @@ if(GIT_FOUND AND EXISTS "${CMAKE_SOURCE_DIR}/.git")
     string(SUBSTRING "${FULLHASH}" 0 10 SHORTHASH)
 
     # Get the last commit date
-    execute_process(COMMAND ${GIT_EXECUTABLE} show -s --pretty=format:%ci HEAD
+    set(ENV{TZ} "UTC0")
+    execute_process(COMMAND ${GIT_EXECUTABLE} show -s --date=iso-local --pretty=format:%cd HEAD
                     OUTPUT_VARIABLE COMMITDATE
                     OUTPUT_STRIP_TRAILING_WHITESPACE
                     WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
     )
     string(REGEX REPLACE "([0-9]+)-([0-9]+)-([0-9]+).*" "\\1\\2\\3" COMMITDATE "${COMMITDATE}")
     set(REV_ISODATE "${COMMITDATE}")
-    string(SUBSTRING "${REV_ISODATE}" 0 4 REV_YEAR)
 
     # Get the branch
     execute_process(COMMAND ${GIT_EXECUTABLE} symbolic-ref -q HEAD
@@ -113,7 +113,6 @@ elseif(EXISTS "${CMAKE_SOURCE_DIR}/.ottdrev")
     list(GET OTTDREV 3 REV_HASH)
     list(GET OTTDREV 4 REV_ISTAG)
     list(GET OTTDREV 5 REV_ISSTABLETAG)
-    list(GET OTTDREV 6 REV_YEAR)
 else()
     message(WARNING "No version detected; this build will NOT be network compatible")
     set(REV_VERSION "norev0000")
@@ -122,14 +121,19 @@ else()
     set(REV_HASH "unknown")
     set(REV_ISTAG 0)
     set(REV_ISSTABLETAG 0)
-    set(REV_YEAR "1970")
 endif()
 
+# Extract REV_YEAR and REV_DATE from REV_ISODATE
+string(SUBSTRING "${REV_ISODATE}" 0 4 REV_YEAR)
+string(SUBSTRING "${REV_ISODATE}" 4 4 REV_DATE)
+# Drop leading 0 in REV_DATE if any
+string(REGEX REPLACE "^0?([0-9]+)" "\\1" REV_DATE "${REV_DATE}")
+
 message(STATUS "Version string: ${REV_VERSION}")
 
 if(GENERATE_OTTDREV)
     message(STATUS "Generating .ottdrev")
-    file(WRITE ${CMAKE_SOURCE_DIR}/.ottdrev "${REV_VERSION}\t${REV_ISODATE}\t${REV_MODIFIED}\t${REV_HASH}\t${REV_ISTAG}\t${REV_ISSTABLETAG}\t${REV_YEAR}\n")
+    file(WRITE ${CMAKE_SOURCE_DIR}/.ottdrev "${REV_VERSION}\t${REV_ISODATE}\t${REV_MODIFIED}\t${REV_HASH}\t${REV_ISTAG}\t${REV_ISSTABLETAG}\n")
 else()
     message(STATUS "Generating rev.cpp")
     configure_file("${CMAKE_SOURCE_DIR}/src/rev.cpp.in"

cmake/scripts/GenerateWidget.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 #
 # CMake script to automatically generate the enums in script_window.hpp
@@ -56,11 +56,14 @@ foreach(ENUM IN LISTS ENUM_LINES)
             endif()
 
             # Check for enum match
-            if("${LINE}" MATCHES "^	*enum *${ENUM_PATTERN} *\{")
+            if("${LINE}" MATCHES "^	*enum *${ENUM_PATTERN}( *: *[^ ]*)? *\{")
                 # REGEX REPLACE does a REGEX MATCHALL and fails if an empty string is matched
                 string(REGEX MATCH "[^	]*" RESULT "${LINE}")
                 string(REPLACE "${RESULT}" "" RM_INDENT "${LINE}")
 
+                string(REGEX MATCH " *: *[^ ]*" RESULT "${LINE}")
+                string(REPLACE "${RESULT}" "" LINE "${LINE}")
+
                 set(ACTIVE 1)
                 if(ACTIVE_COMMENT GREATER 0)
                      string(APPEND ${PLACE_HOLDER} "\n${COMMENT}")

cmake/scripts/Regression.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 #
 # Runs a single regressoion test
@@ -34,7 +34,6 @@ execute_process(COMMAND ${OPENTTD_EXECUTABLE}
                         -mnull
                         -vnull:ticks=30000
                         -d script=2
-                        -d misc=9
                         -Q
                 OUTPUT_VARIABLE REGRESSION_OUTPUT
                 ERROR_VARIABLE REGRESSION_RESULT
@@ -54,16 +53,27 @@ string(REPLACE "0x(nil)" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}")
 string(REPLACE "0x0000000000000000" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}")
 string(REPLACE "0x0x0" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}")
 
+# Convert path separators
+string(REPLACE "\\" "/" REGRESSION_RESULT "${REGRESSION_RESULT}")
+
 # Remove timestamps if any
-string(REGEX REPLACE "\[[0-9-]+ [0-9:]+\] " "" REGRESSION_RESULT "${REGRESSION_RESULT}")
+string(REGEX REPLACE "\\\[[0-9-]+ [0-9:]+\\\] " "" REGRESSION_RESULT "${REGRESSION_RESULT}")
+
+# Remove log level
+string(REGEX REPLACE "\\\[script:[0-9]\\\]" "" REGRESSION_RESULT "${REGRESSION_RESULT}")
 
 # Convert the output to a format that is expected (and more readable) by result.txt
-string(REPLACE "\ndbg: [script]" "\n" REGRESSION_RESULT "${REGRESSION_RESULT}")
+string(REPLACE "dbg:  " "ERROR: " REGRESSION_RESULT "${REGRESSION_RESULT}")
-string(REPLACE "\n " "\nERROR: " REGRESSION_RESULT "${REGRESSION_RESULT}")
+string(REPLACE "ERROR: [1] " "" REGRESSION_RESULT "${REGRESSION_RESULT}")
-string(REPLACE "\nERROR: [1] " "\n" REGRESSION_RESULT "${REGRESSION_RESULT}")
+string(REPLACE "[P] " "" REGRESSION_RESULT "${REGRESSION_RESULT}")
-string(REPLACE "\n[P] " "\n" REGRESSION_RESULT "${REGRESSION_RESULT}")
+string(REPLACE "[S] " "" REGRESSION_RESULT "${REGRESSION_RESULT}")
 string(REGEX REPLACE "dbg: ([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}")
 
+# Remove duplicate script info
+string(REGEX REPLACE "ERROR: Registering([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}")
+string(REGEX REPLACE "ERROR:   [12]([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}")
+string(REGEX REPLACE "ERROR: The first([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}")
+
 # Read the expected result
 file(READ ai/${REGRESSION_TEST}/result.txt REGRESSION_EXPECTED)
 
@@ -87,7 +97,7 @@ foreach(RESULT IN LISTS REGRESSION_RESULT)
 
     if(NOT RESULT STREQUAL EXPECTED)
         message("${ARGC}: - ${EXPECTED}")
-        message("${ARGC}: + ${RESULT}'")
+        message("${ARGC}: + ${RESULT}")
         set(ERROR YES)
     endif()
 endforeach()

cmake/scripts/SquirrelExport.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 if(NOT SCRIPT_API_SOURCE_FILE)
     message(FATAL_ERROR "Script needs SCRIPT_API_SOURCE_FILE defined")
@@ -71,13 +71,23 @@ reset_reader()
 
 file(STRINGS "${SCRIPT_API_FILE}" SOURCE_LINES)
 
+set(NUM_LINE 0)
+macro(doxygen_check)
+    if(NOT "${DOXYGEN_SKIP}" STREQUAL "")
+        message(FATAL_ERROR "${SCRIPT_API_FILE}:${NUM_LINE}: a DOXYGEN_API block was not properly closed")
+    endif()
+endmacro()
+
 foreach(LINE IN LISTS SOURCE_LINES)
+    math(EXPR NUM_LINE "${NUM_LINE} + 1")
     # Ignore special doxygen blocks
     if("${LINE}" MATCHES "^#ifndef DOXYGEN_API")
+        doxygen_check()
         set(DOXYGEN_SKIP "next")
         continue()
     endif()
     if("${LINE}" MATCHES "^#ifdef DOXYGEN_API")
+        doxygen_check()
         set(DOXYGEN_SKIP "true")
         continue()
     endif()
@@ -86,10 +96,10 @@ foreach(LINE IN LISTS SOURCE_LINES)
         continue()
     endif()
     if("${LINE}" MATCHES "^#else")
-        if("${DOXYGEN_SKIP}" STREQUAL "next")
+        if(DOXYGEN_SKIP STREQUAL "next")
             set(DOXYGEN_SKIP "true")
-        else()
+        elseif(DOXYGEN_SKIP STREQUAL "true")
-            unset(DOXYGEN_SKIP)
+            set(DOXYGEN_SKIP "false")
         endif()
         continue()
     endif()
@@ -668,4 +678,6 @@ foreach(LINE IN LISTS SOURCE_LINES)
     endif()
 endforeach()
 
+doxygen_check()
+
 configure_file(${SCRIPT_API_SOURCE_FILE} ${SCRIPT_API_BINARY_FILE})

cmake/scripts/SquirrelIncludes.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 if(NOT INCLUDES_SOURCE_FILE)
     message(FATAL_ERROR "Script needs INCLUDES_SOURCE_FILE defined")

docs/admin_network.md

@@ -1,6 +1,6 @@
 # OpenTTD's admin network
 
-Last updated:    2011-01-20
+Last updated:    2024-03-26
 
 
 ## Table of contents
@@ -49,10 +49,29 @@ Last updated:    2011-01-20
   Create a TCP connection to the server on port 3977. The application is
   expected to authenticate within 10 seconds.
 
-  To authenticate send a `ADMIN_PACKET_ADMIN_JOIN` packet.
+  To authenticate send either an `ADMIN_PACKET_ADMIN_JOIN` or an
+  `ADMIN_PACKET_ADMIN_JOIN_SECURE` packet.
 
-  The server will reply with `ADMIN_PACKET_SERVER_PROTOCOL` followed directly by
+  The `ADMIN_PACKET_ADMIN_JOIN` packet sends the password without any
-  `ADMIN_PACKET_SERVER_WELCOME`.
+  encryption or safeguards over the connection, and as such has been disabled
+  by default.
+
+  The `ADMIN_PACKET_ADMIN_JOIN_SECURE` packet initiates a key exchange
+  authentication schema which tells te server which methods the client
+  supports and the server makes a choice. The server will then send an
+  `ADMIN_PACKET_SERVER_AUTH_REQUEST` packet to which the client has to respond
+  with an `ADMIN_PACKET_ADMIN_AUTH_RESPONSE` packet.
+
+  The current choices for secure authentication are authorized keys, where
+  the client has a private key and the server a list of authorized public
+  keys, and a so-called password-authenticated key exchange which allows to
+  authenticate using a password without actually sending the password.
+  The server falls back to password authentication when the client's key is
+  not in the list of authorized keys.
+
+  When authentication has succeeded for either of the `JOIN` schemas, the
+  server will reply with `ADMIN_PACKET_SERVER_PROTOCOL` followed directly
+  by `ADMIN_PACKET_SERVER_WELCOME`.
 
   `ADMIN_PACKET_SERVER_PROTOCOL` contains details about the protocol version.
   It is the job of your application to check this number and decide whether

docs/desync.md

@@ -195,10 +195,11 @@ Last updated: 2014-02-23
      'src/network/network_func.h'.
      (DEBUG_FAILED_DUMP_COMMANDS is explained later)
    - Put the 'commands-out.log' into the root save folder, and rename
-      it to 'commands.log'.
+      it to 'commands.log'. Strip everything and including the "newgame"
-   - Run 'openttd -D -d desync=3 -g startsavegame.sav'.
+      entry from the log.
-     This replays the server log and creates new 'commands-out.log'
+   - Run 'openttd -D -d desync=0 -g startsavegame.sav'.
-     and 'dmp_cmds_*.sav' in your autosave folder.
+     This replays the server log. Use "-d desync=3" to also create a
+     new 'commands-out.log' and 'dmp_cmds_*.sav' in your autosave folder.
 
 ## 3.2) Evaluation of the replay
 
@@ -226,7 +227,7 @@ Last updated: 2014-02-23
   savegames with your own ones from the replay. You can also comment/disable
   the 'NOT_REACHED' mentioned above, to get another 'dmp_cmds_*.sav' from
   the replay after the mismatch has already been detected.
-  See Section 3.2 on how to compare savegames.
+  See Section 3.3 on how to compare savegames.
   If the saves differ you have located the Desync between the last dmp_cmds
   that match and the first one that does not. The difference of the saves
   may point you in the direction of what causes it.
@@ -252,16 +253,14 @@ Last updated: 2014-02-23
      are replayed. Their internal state will thus not change in the
      replay and will differ.
 
-  To compare savegame more semantically, there exist some ugly hackish
+  To compare savegame more semantically, easiest is to first export them
-  tools at:
+  to a JSON format with for example:
-     http://devs.openttd.org/~frosch/texts/zpipe.c
-     http://devs.openttd.org/~frosch/texts/printhunk.c
 
-  The first one decompresses OpenTTD savegames. The second one creates
+  https://github.com/TrueBrain/OpenTTD-savegame-reader
-  a textual representation of an uncompressed savegame, by parsing hunks
-  and arrays and such. With both tools you need to be a bit careful
-  since they work on stdin and stdout, which may not deal well with
-  binary data.
 
-  If you have the textual representation of the savegames, you can
+  By running:
-  compare them with regular diff tools.
+
+  python -m savegame_reader --export-json dmp_cmds_NNN.sav | jq . > NNN.json
+
+  Now you can use any (JSON) diff tool to compare the two savegames in a
+  somewhat human readable way.

docs/directory_structure.md

@@ -19,14 +19,14 @@ your operating system:
     - Windows:
         - `C:\My Documents\OpenTTD` (95, 98, ME)
         - `C:\Documents and Settings\<username>\My Documents\OpenTTD` (2000, XP)
-        - `C:\Users\<username>\Documents\OpenTTD` (Vista, 7, 8.1, 10, 11)
+        - `C:\Users\<username>\Documents\OpenTTD` (7, 8.1, 10, 11)
     - macOS: `~/Documents/OpenTTD`
     - Linux: `$XDG_DATA_HOME/openttd` which is usually `~/.local/share/openttd`
        when built with XDG base directory support, otherwise `~/.openttd`
 3. The shared directory
     - Windows:
         - `C:\Documents and Settings\All Users\Shared Documents\OpenTTD` (2000, XP)
-        - `C:\Users\Public\Documents\OpenTTD` (Vista, 7, 8.1, 10, 11)
+        - `C:\Users\Public\Documents\OpenTTD` (7, 8.1, 10, 11)
     - macOS: `/Library/Application Support/OpenTTD`
     - Linux: not available
 4. The binary directory (where the OpenTTD executable is)

docs/eints.md

@@ -25,6 +25,10 @@ The translators will decide whether, where and how to apply your suggestion.
 
 Sorry, we don't offer this option.
 
+Only when there is a consistency problem that needs addressing, this can be done via a PR.
+We are very strict about this, and in general all PRs making translation changes will be closed.
+But if it is really needed, and the change is not a revert of any older change, a PR can be created to do mass changes to a translation.
+
 ### I want to change the language definition (plural form, genders, cases) of a translation.
 
 Please [create an issue](https://github.com/OpenTTD/OpenTTD/issues/new/choose) for this.

docs/importing_town_data.md

@@ -0,0 +1,97 @@
+# Importing Town Data into OpenTTD
+
+To aid players in scenario creation, OpenTTD's Scenario Editor can import town data from external JSON files. This enables players to use an image editing program to align town coordinates with a real-world heightmap using a map underlay, instead of guessing at the correct locations in Scenario Editor itself.
+
+This town data consists of a JSON file storing an array of town data objects, each containing a name, location, target OpenTTD population, and whether it is marked as a city in the game.
+
+This document describes the standard format for this JSON file and outlines a workflow for creating this data effectively.
+
+## Table of contents
+
+- Why load external data?
+- How to use this feature
+  - Creating geodata
+    - Town data format standards
+    - Town data values
+  - Loading geodata into OpenTTD
+- Tutorial: Creating town data
+
+## Why load external data?
+
+There are three benefits to using an image editing program to create towns instead of the OpenTTD Scenario Editor.
+
+1. Placing towns accurately is much easier using a map underlay such as OpenStreetMap to match town locations with the corresponding heightmap.
+2. Storing town data in a JSON file instead of as an OpenTTD Scenario (.scn) doesn't require choosing your NewGRF house set before placing towns.
+3. Town coordinates are scaled by the map size, so you can load the data onto whatever size map you like.
+
+## How to use this feature
+
+### Creating geodata
+
+Town data is a text file in the JSON format, with a list of towns, each containing a coordinate location and properties: name, population, and whether or not it should be a city in OpenTTD.
+
+The format of this file is standardized for importing into OpenTTD and must be followed for OpenTTD to properly parse the data.
+
+For use in OpenTTD, you will also need a matching heightmap of the terrain features, as a PNG.
+
+#### Town data format standards
+
+The following code sample is complete and can be used in OpenTTD.
+- The list of towns is enclosed in an array marked with square brackets `[]`
+- Each town is enclosed in curly braces `{}`, with a comma after each town except for the last in the list.
+- The properties separated by commas except for the last.
+- Property names are enclosed in double quotes `""` with a colon `:` separating it from the property value.
+- The name property value is enclosed in double quotes `"London"`, while all other property values `44910`, `true`, etc., are not.
+
+```
+[
+    {
+        "name": "London",
+        "population": 44910,
+        "city": true,
+        "x": 0.7998046875,
+        "y": 0.708984375
+    },
+    {
+        "name": "Canterbury",
+        "population": 217.16,
+        "city": false,
+        "x": 0.83251953125,
+        "y": 0.828125
+    }
+]
+```
+
+#### Town data values
+
+- Population is scaled down for use in OpenTTD. It is possible to generate huge cities by using a large number, but there is a practical limit to town size. The larger the town, the longer it will take to import town data, since towns are placed at a relatively small size and then expanded until the population is greater than the player-defined target.
+- X and Y coordinates are a proportion of the total map dimension, between 0 and 1. Just take the pixel coordinates of the town's location in the corresponding heightmap (more detail in the tutorial below) and divide each by the maximum value.
+  - For example, London is at `726, 1638` in a 1024 px by 2048 px heightmap, so `726 / 1024 = 0.7998046875` and `1638 / 2048 = 0.708984375` gives the correct coordinates for OpenTTD.
+  - The reason for these proportional coordinates is so the data can be used for any map size.
+- 0,0 is (approximately) the very top tile in OpenTTD. You can see tile coordinates in-game with the Land Info Tool.
+- In most image editing programs, 0,0 is the top-left corner of the image. You can rotate the image however you want relative to compass north to orient the map to your liking. Make sure you crop and resize the image before recording town locations.
+- In OpenTTD, X and Y axis are swapped compared to most image editing programs and the standard Cartesian coordinate system. From the 0,0 origin at top left, X is the axis along the left side and Y is the axis along the right side. You can still measure X and Y coordinates in your image editing program, just swap them before importing into OpenTTD or towns won't line up with your heightmap.
+
+### Loading geodata into OpenTTD
+Using geodata to create a real-world location in OpenTTD is done in the Scenario Editor.
+
+1. Choose the NewGRFs you want to use in the game.
+2. Load the heightmap which you created in the geodata workflow. Either rotation will work, but the clockwise rotation is considered "correct" and the coordinates in the Land Info Tool will match your data; counter clockwise maps will align properly but the coordinates won't match your data.
+3. In the Town Generation window, click `Load from file` and choose the .json file containing town data. The default directory to search for town data is `OpenTTD\scenario\heightmap`.
+4. (Optional) Manually add industries, rivers, trees, and objects.
+5. Save the game as a Scenario and exit to the main menu.
+6. Load the game with Play Scenario and enjoy.
+
+Sometimes it's not possible to place a town, such as when the heightmap is very rough and a flat tile can't be found with a 16-tile radius of the target tile. In such cases, a sign will be placed on the target tile with the name of the town. The player can then place the town manually or change the heightmap settings and try again. This fallback also helps debug errors with data creation, such as if towns end up in the ocean.
+
+## Tutorial: Creating town data
+
+1. Load both your heightmap and a labeled map like OpenStreetMap as layers in an image editing program. You can use a free/open-source program like QGIS to acquire, align, and export these map images, if you like.
+2. Crop the image to your desired bounds, ensuring the aspect ratio is supported in OpenTTD (1:1, 1:2, 1:4, etc.).
+3. Resize the image to one of OpenTTD's supported map sizes, such as 512 px by 1024 px. Some image editors let you do this part of step 2. You can always load heightmaps and town data at a reduced size, so you may want to make this larger than your intended use in case you want it later.
+4. Use the labeled map layer to find the pixel coordinates of each town you'd like to include in your map. In GIMP this is displayed in the bottom left corner of the image window, and in Photoshop you need to enable the Info panel (F8) and switch to pixel units of measurement if not already.
+5. Some spreadsheets including Google Sheets can export data as JSON, so you may want to record it there, to export after step 8. Or you can build the JSON file manually.
+6. Adjust population numbers for OpenTTD.
+7. Change coordinates from pixels to proportion (0-1) of the total dimension: `x / maximum_x` and `y / maximum_y`, as described in "Town data values" above.
+8. Swap X and Y coordinates before importing to OpenTTD, since OpenTTD uses a reverse X and Y system than most image editors.
+9. Save the heightmap and town data files in your `OpenTTD\scenario\heightmap` folder.

docs/landscape.html

@@ -721,10 +721,9 @@
         </ul>
        </li>
       </ul>
-     <li>m3 bit 6 : bit 8 of house type (m4), allowing 512 different types.</li>
+     <li>m3 bits 6..5 : free</li>
-     <li>m3 bit 5 : free</li>
      <li>m3 bits 4..0 : triggers activated <a href="#newhouses">(newhouses)</a></li>
-     <li>m4 : <a href="landscape_externals.html">town building type</a> (with m3[6] bit)</li>
+     <li>m4 : free</li>
      <li>m5 : see m3 bit 7</li>
      <li>m6 :
       <ul>
@@ -740,6 +739,7 @@
        </li>
       </ul>
      </li>
+     <li>m6: bits 1..0: animated tile state</li>
      <li>m7 :
       <ul>
        <li>If <a href="#newhouses">newhouses</a> is activated
@@ -759,10 +759,12 @@
        </li>
       </ul>
      </li>
+     <li>m8 bits 15..12 : free</li>
+     <li>m8 bits 11..0 : <a href="landscape_externals.html">town building type</a></li>
     </ul>
     <small><a name="newhouses"></a>Newhouses is the name englobing a newGRF feature developed by TTDPatch devs (mainly Csaboka).<br>
     It allows the replacement of the properties as well as the graphics of houses in the game.<br>
-    To distinguish between the standard behaviour and the newGRF one, HouseID (m4 + m3[6]) is tested for anything above 110.<br>
+    To distinguish between the standard behaviour and the newGRF one, HouseID is tested for anything above 110.<br>
     110 is the count of standard houses. So above 110 means there is a new definition of at least one house</small>
    </td>
   </tr>
@@ -876,6 +878,25 @@
      <li>m2: index into the array of stations</li>
      <li>m3 bits 7..4: persistent random data for railway stations/waypoints and airports)</li>
      <li>m3 bits 7..4: <a href="#OwnershipInfo">owner</a> of tram tracks (road stop)</li>
+     <li>m3 bits 3..2: ground type (road waypoints)
+      <table>
+       <tr>
+        <td><tt>0</tt>&nbsp; </td>
+        <td>on bare land</td>
+       </tr>
+       <tr>
+        <td><tt>1</tt>&nbsp; </td>
+        <td>on grass</td>
+       </tr>
+       <tr>
+        <td><tt>2</tt>&nbsp; </td>
+        <td>paved</td>
+       </tr>
+      </table>
+     </li>
+     <li>m3 bit 2: rail station / waypoint may have catenary pylons</li>
+     <li>m3 bit 1: rail station / waypoint may have catenary wires</li>
+     <li>m3 bit 0: rail station / waypoint is blocked</li>
      <li>m4: custom station id; 0 means standard graphics</li>
      <li>m4: <a href="#RoadType">Roadtype</a> for road stops</li>
      <li>m5: graphics index (range from 0..255 for each station type):
@@ -956,6 +977,22 @@
         </td>
        </tr>
 
+       <tr>
+        <td nowrap valign=top><tt>04</tt>..<tt>05</tt>&nbsp; </td>
+        <td align=left>road waypoints
+         <table>
+          <tr>
+           <td><tt>04</tt>&nbsp; </td>
+           <td align=left>drive through X</td>
+          </tr>
+          <tr>
+           <td><tt>05</tt>&nbsp; </td>
+           <td align=left>drive through Y</td>
+          </tr>
+         </table>
+        </td>
+       </tr>
+
        <tr>
         <td nowrap valign=top><tt>00</tt>..<tt>05</tt>&nbsp; </td>
         <td align=left>ship dock
@@ -989,17 +1026,16 @@
        </tr>
       </table>
      </li>
-     <li>m6 bit 7: rail station / waypoint may have catenary pylons</li>
+     <li>m6 bits 6..3: the station type (rail, airport, truck, bus, oilrig, dock, buoy, waypoint, road waypoint)</li>
-     <li>m6 bit 6: rail station / waypoint may have catenary wires</li>
-     <li>m6 bits 5..3: the station type (rail, airport, truck, bus, oilrig, dock, buoy, waypoint)</li>
      <li>m6 bit 2: pbs reservation state for railway stations/waypoints</li>
-     <li>m6 bit 0: rail station / waypoint is blocked</li>
+     <li>m6 bits 1..0: animated tile state</li>
 
      <li>m7 bits 4..0: <a href="#OwnershipInfo">owner</a> of road (road stops)</li>
      <li>m7: animation frame (railway stations/waypoints, airports)</li>
+     <li>m8 bit 15: Snow or desert present (road waypoints)</li>
      <li>m8 bits 11..6: <a href="#TramType">Tramtype</a></li>
      <li>m8 bits 5..0: <a href="#TrackType">track type</a> for railway stations/waypoints</li>
-     <li>m8 bits 5..0: custom road stop id; 0 means standard graphics</li>
+     <li>m8 bits 5..0: custom road stop/waypoint id; 0 means standard graphics</li>
     </ul>
    </td>
   </tr>
@@ -1016,99 +1052,94 @@
      <li>m1 bits 6..5 : Water class (sea, canal or river)
      <li>m1 bits 4..0: <a href="#OwnershipInfo">owner</a> (for sea, rivers, and coasts normally <tt>11</tt>)</li>
      <li>m2: Depot index (for depots only)</li>
+     <li>m3 bit 0: Non-flooding state</li>
      <li>m4: Random data for canal or river tiles</li>
-     <li>m5: tile type:
+     <li>m5 bits 7..4: Water tile type:
       <table>
-       <tr>
+        <tr>
-        <td nowrap valign=top><tt>00</tt>&nbsp; </td>
+         <td><tt>0</tt>&nbsp; </td>
-        <td align=left>water, canal or river</td>
+         <td>water, canal or river</td>
-       </tr>
+        </tr>
-
+        <tr>
-       <tr>
+         <td><tt>1</tt>&nbsp; </td>
-        <td nowrap valign=top><tt>01</tt>&nbsp; </td>
+         <td>coast or riverbank</td>
-        <td align=left>coast or riverbank</td>
+        </tr>
-       </tr>
+        <tr>
-
+         <td nowrap valign=top><tt>2</tt>&nbsp; </td>
-       <tr>
+         <td>canal lock<br>
-        <td nowrap valign=top><tt>10</tt>..<tt>1B</tt>&nbsp; </td>
+          <ul>
-        <td align=left>canal locks
+           <li>m5 bits 3..2: Lock part
-         <table>
+            <table>
-          <tr>
+             <tr>
-           <td nowrap valign=top><tt>10</tt>&nbsp; </td>
+              <td><tt>0</tt>&nbsp; </td>
-           <td align=left>middle part, (SW-NE direction)</td>
+              <td>Middle part</td>
-          </tr>
+             </tr>
-          <tr>
+             <tr>
-           <td nowrap valign=top><tt>11</tt>&nbsp; </td>
+              <td><tt>1</tt>&nbsp; </td>
-           <td align=left>middle part, (NW-SE direction)</td>
+              <td>Lower part</td>
-          </tr>
+             </tr>
-          <tr>
+             <tr>
-           <td nowrap valign=top><tt>12</tt>&nbsp; </td>
+              <td><tt>2</tt>&nbsp; </td>
-           <td align=left>middle part, (NE-SW direction)</td>
+              <td>Upper part</td>
-          </tr>
+             </tr>
-          <tr>
+            </table>
-           <td nowrap valign=top><tt>13</tt>&nbsp; </td>
+           </li>
-           <td align=left>middle part, (SE-NW direction)</td>
+           <li>m5 bits 1..0: Lock direction
-          </tr>
+            <table>
-          <tr>
+             <tr>
-           <td nowrap valign=top><tt>14</tt>&nbsp; </td>
+              <td><tt>0</tt>&nbsp; </td>
-           <td align=left>lower part, (SW-NE direction)</td>
+              <td>NE raised</td>
-          </tr>
+             </tr>
-          <tr>
+             <tr>
-           <td nowrap valign=top><tt>15</tt>&nbsp; </td>
+              <td><tt>1</tt>&nbsp; </td>
-           <td align=left>lower part, (NW-SE direction)</td>
+              <td>SE raised</td>
-          </tr>
+             </tr>
-          <tr>
+             <tr>
-           <td nowrap valign=top><tt>16</tt>&nbsp; </td>
+              <td><tt>2</tt>&nbsp; </td>
-           <td align=left>lower part, (NE-SW direction)</td>
+              <td>SW raised</td>
-          </tr>
+             </tr>
-          <tr>
+             <tr>
-           <td nowrap valign=top><tt>17</tt>&nbsp; </td>
+              <td><tt>3</tt>&nbsp; </td>
-           <td align=left>lower part, (SE-NW direction)</td>
+              <td>NW raised</td>
-          </tr>
+             </tr>
-          <tr>
+            </table>
-           <td nowrap valign=top><tt>18</tt>&nbsp; </td>
+           </li>
-           <td align=left>upper part, (SW-NE direction)</td>
+          </ul>
-          </tr>
+         </td>
-          <tr>
+        </tr>
-           <td nowrap valign=top><tt>19</tt>&nbsp; </td>
+        <tr>
-           <td align=left>upper part, (NW-SE direction)</td>
+         <td nowrap valign=top><tt>3</tt>&nbsp; </td>
-          </tr>
+         <td>depot<br>
-          <tr>
+          <ul>
-           <td nowrap valign=top><tt>1A</tt>&nbsp; </td>
+           <li>m5 bit 1: Depot axis
-           <td align=left>upper part, (NE-SW direction)</td>
+            <table>
-          </tr>
+             <tr>
-          <tr>
+              <td><tt>0</tt>&nbsp; </td>
-           <td nowrap valign=top><tt>1B</tt>&nbsp; </td>
+              <td>X direction (NE-SW)</td>
-           <td align=left>upper part, (SE-NW direction)</td>
+             </tr>
-          </tr>
+             <tr>
-         </table>
+              <td><tt>1</tt>&nbsp; </td>
-        </td>
+              <td>Y direction (NW-SE)</td>
-       </tr>
+             </tr>
-
+            </table>
-       <tr>
+           </li>
-        <td nowrap valign=top><tt>80</tt>..<tt>83</tt>&nbsp; </td>
+           <li>m5 bit 0: Depot part
-        <td align=left>ship depots
+            <table>
-         <table>
+             <tr>
-          <tr>
+              <td><tt>0</tt>&nbsp; </td>
-           <td nowrap valign=top><tt>80</tt>&nbsp; </td>
+              <td>North part</td>
-           <td align=left>ship depot, NE part (X direction)</td>
+             </tr>
-          </tr>
+             <tr>
-          <tr>
+              <td><tt>1</tt>&nbsp; </td>
-           <td nowrap valign=top><tt>81</tt>&nbsp; </td>
+              <td>South part</td>
-           <td align=left>ship depot, SW part (X direction)</td>
+             </tr>
-          </tr>
+            </table>
-          <tr>
+           </li>
-           <td nowrap valign=top><tt>82</tt>&nbsp; </td>
+          </ul>
-           <td align=left>ship depot, NW part (Y direction)</td>
+         </td>
-          </tr>
+        </tr>
-          <tr>
+       </table>
-           <td nowrap valign=top><tt>83</tt>&nbsp; </td>
+      </li>
-           <td align=left>ship depot, SE part (Y direction)</td>
-          </tr>
-         </table>
-        </td>
-       </tr>
-      </table>
      </li>
     </ul>
    </td>
@@ -1451,6 +1482,7 @@
      </li>
      <li>m6 bits 5..3: random triggers (NewGRF)</li>
      <li>m6 bit 2: bit 8 of type (see m5)</li>
+     <li>m6 bits 1..0: animated tile state</li>
      <li>m7: animation frame</li>
     </ul>
    </td>
@@ -1623,6 +1655,7 @@
      <li>m2: index into the array of objects, bits 0 to 15 (upper bits in m5)</li>
      <li>m3: random bits</li>
      <li>m5: index into the array of objects, bits 16 to 23 (lower bits in m2)</li>
+     <li>m6 bits 1..0: animated tile state</li>
      <li>m7: animation counter</li>
     </ul>
    </td>

docs/landscape_grid.html

@@ -79,8 +79,8 @@ the array so you can quickly see what is used and what is not.
     <tr>
       <td rowspan="2">0</td>
       <td class="caption">ground</td>
-      <td class="bits" rowspan=27><span class="used" title="Tile type">XXXX</span> <span class="used" title="Presence and direction of bridge above">XX</span> <span class="used" title="Tropic Zone: only meaningful in tropic climate. It contains the definition of the available zones">XX</span></td>
+      <td class="bits" rowspan=29><span class="used" title="Tile type">XXXX</span> <span class="used" title="Presence and direction of bridge above">XX</span> <span class="used" title="Tropic Zone: only meaningful in tropic climate. It contains the definition of the available zones">XX</span></td>
-      <td class="bits" rowspan=27><span class="used" title="Tile height">XXXX XXXX</span></td>
+      <td class="bits" rowspan=29><span class="used" title="Tile height">XXXX XXXX</span></td>
       <td class="bits" rowspan=2><span class="free">OOO</span><span class="usable" title="Owner (always OWNER_NONE)">1 OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
       <td class="bits"><span class="used" title="Type of hedge on NE border">XXX</span> <span class="used" title="Snow presence">X</span><span class="free">OOOO</span></td>
@@ -130,7 +130,7 @@ the array so you can quickly see what is used and what is not.
       <td class="bits"><span class="used" title="Tile type: simple road (00), level crossing (01), road depot (10)">OO</span> <span class="used" title="Disallow vehicles to go a specific direction">XX</span> <span class="used" title="Road pieces">XXXX</span></td>
       <td class="bits"><span class="free">OO</span> <span class="used" title="Pavement type">XXX</span><span class="free">OOO</span></td>
       <td class="bits"><span class="free">OO</span><span class="used" title="Snow/desert present">X</span> <span class="free">O</span><span class="used" title="Roadworks counter">XXXX</span></td>
-      <td class="bits" rowspan=1><span class="free">OOOO</span> <span class="used" title="Tram type">XXXX XX<span class="free">OO OOOO</span></td>
+      <td class="bits" rowspan=1><span class="free">OOOO</span> <span class="used" title="Tram type">XXXX XX</span><span class="free">OO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">level crossing</td>
@@ -156,17 +156,17 @@ the array so you can quickly see what is used and what is not.
       <td class="caption">finished house</td>
       <td class="bits" rowspan=2><span class="used" title="House random bits">XXXX XXXX</span></td>
       <td class="bits" rowspan=2><span class="pool" title="Town index on pool">XXXX XXXX XXXX XXXX</span></td>
-      <td class="bits"><span class="used" title="House is complete/in construction (see m5)">1</span> <span class="used" title="House type (m4 + m3[6])">X</span><span class="free">O</span><span class="usable" title="Activated triggers (bits 2..4 don't have a meaning)">XXX</span><span class="used" title="Activated triggers (bits 2..4 don't have a meaning)">XX</span></td>
+      <td class="bits"><span class="used" title="House is complete/in construction (see m5)">1</span><span class="free">OO</span><span class="usable" title="Activated triggers (bits 2..4 don't have a meaning)">X XX</span><span class="used" title="Activated triggers (bits 2..4 don't have a meaning)">XX</span></td>
-      <td class="bits" rowspan=2><span class="used" title="House type (m4 + m3[6])">XXXX XXXX</span></td>
+      <td class="bits" rowspan=2><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="used" title="Age in years, clamped at 255">XXXX XXXX</span></td>
-      <td class="bits" rowspan=2><span class="abuse" title="Newhouses activated: periodic processing time remaining; if not, lift position for houses 04 and 05">XXXX XX</span><span class="free">OO</span></td>
+      <td class="bits" rowspan=2><span class="abuse" title="Newhouses activated: periodic processing time remaining; if not, lift position for houses 04 and 05">XXXX XX</span><span class="used" title="Animated tile state">XX</span></td>
       <td class="bits" rowspan=2><span class="abuse" title="If newhouses active, m7 is the current animation frame">XXXX</span> <span class="abuse" title="If newhouses active, m7 is the current animantion frame; if not, lift behaviour for houses 04 and 05">XXXX</span></td>
-      <td class="bits" rowspan=2><span class="free">OOOO OOOO OOOO OOOO</span></td>
+      <td class="bits" rowspan=2><span class="free">OOOO</span> <span class="used" title="House type">XXXX XXXX XXXX</span></td>
     </tr>
     <tr>
       <td class="caption">house under construction</td>
-      <td class="bits"><span class="used" title="House is complete/in construction (see m5)">O</span> <span class="used" title="House type (m4 + m3[6])">X</span><span class="free">O</span><span class="usable" title="Activated triggers (bits 2..4 don't have a meaning)">XXX</span><span class="used" title="Activated triggers (bits 2..4 don't have a meaning)">XX</span></td>
+      <td class="bits"><span class="used" title="House is complete/in construction (see m5)">O</span><span class="used" title="House type (m4 + m3[6])">X</span><span class="free">O</span><span class="usable" title="Activated triggers (bits 2..4 don't have a meaning)">X XX</span><span class="used" title="Activated triggers (bits 2..4 don't have a meaning)">XX</span></td>
-      <td class="bits"><span class="free">OOO</span><span class="used" title="Construction stage">XX</span> <span class="used" title="Construction counter">XXX</span></td>
+      <td class="bits"><span class="free">OOO</span><span class="used" title="Construction stage">X X</span><span class="used" title="Construction counter">XXX</span></td>
     </tr>
     <tr>
       <td>4</td>
@@ -181,14 +181,14 @@ the array so you can quickly see what is used and what is not.
       <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
     <tr>
-      <td rowspan=7>5</td>
+      <td rowspan=8>5</td>
       <td class="caption">rail station</td>
-      <td class="bits" rowspan=7><span class="free">O</span><span class="used" title="Water class">XX</span> <span class="used" title="Owner">XXXXX</span></td>
+      <td class="bits" rowspan=8><span class="free">O</span><span class="used" title="Water class">XX</span> <span class="used" title="Owner">XXXXX</span></td>
-      <td class="bits" rowspan=7><span class="pool" title="Station index on pool">XXXX XXXX XXXX XXXX</span></td>
+      <td class="bits" rowspan=8><span class="pool" title="Station index on pool">XXXX XXXX XXXX XXXX</span></td>
-      <td class="bits" rowspan=2><span class="used" title="Random bits">XXXX</span> <span class="free">OOOO</span></td>
+      <td class="bits" rowspan=2><span class="used" title="Random bits">XXXX</span> <span class="free">O</span><span class="used" title="May have pylons">X</span><span class="used" title="May have wires">X</span><span class="used" title="Tile is blocked">X</span></td>
       <td class="bits" rowspan=2><span class="used" title="Custom station specifications ID">XXXX XXXX</span></td>
       <td class="bits"><span class="used" title="Graphics index">XXXX XXXX</span></td>
-      <td class="bits" rowspan=2><span class="used" title="May have pylons">X</span><span class="used" title="May have wires">X</span><span class="used" title="Station type">XXX</span> <span class="used" title="Reserved track">X</span><span class="free">O</span><span class="used" title="Tile is blocked">X</span></td>
+      <td class="bits" rowspan=2><span class="free">O</span><span class="used" title="Station type">XXX X</span><span class="used" title="Reserved track">X</span><span class="used" title="Animated tile state">XX</span></td>
       <td class="bits" rowspan=2><span class="used" title="Animation frame">XXXX XXXX</span></td>
       <td class="bits" rowspan=2><span class="free">OOOO OOOO OO</span><span class="used" title="Railway type">XX XXXX</span></td>
     </tr>
@@ -199,12 +199,17 @@ the array so you can quickly see what is used and what is not.
     <tr>
       <td class="caption">road stop</td>
       <td class="bits"><span class="used" title="Owner of tram">XXXX</span> <span class="free">OOOO</span></td>
-      <td class="bits"><span class="free">OO</span><span class="used" title="Roadtype for road stop">XX XXXX</span></td>
+      <td class="bits" rowspan=2><span class="free">OO</span><span class="used" title="Roadtype for road stop">XX XXXX</span></td>
-      <td class="bits"><span class="usable" title="Graphics index">OOOO O</span><span class="used" title="Graphics index: 00 (exit towards NE), 01 (exit towards SE), 02 (exit towards SW), 03 (exit towards NW), 04 (drive through X), 05 (drive through Y)">XXX</span></td>
+      <td class="bits" rowspan=2><span class="usable" title="Graphics index">OOOO O</span><span class="used" title="Graphics index: 00 (exit towards NE), 01 (exit towards SE), 02 (exit towards SW), 03 (exit towards NW), 04 (drive through X), 05 (drive through Y)">XXX</span></td>
-      <td class="bits" rowspan=5><span class="free">OO</span><span class="used" title="Station type">XX X</span><span class="free">OOO</span></td>
+      <td class="bits" rowspan=6><span class="free">O</span><span class="used" title="Station type">XXX X</span><span class="free">O</span><span class="used" title="Animated tile state">XX</span></td>
-      <td class="bits"><span class="free">OOO</span><span class="used" title="Owner of road">X XXXX</span></td>
+      <td class="bits" rowspan=2><span class="free">OOO</span><span class="used" title="Owner of road">X XXXX</span></td>
       <td class="bits"><span class="free">OOOO</span> <span class="used" title="Tram type">XXXX XX</span> <span class="used" title="Custom road stops specifications ID">XXXXXX</span></td>
     </tr>
+    <tr>
+      <td class="caption">road waypoint</td>
+      <td class="bits"><span class="used" title="Owner of tram">XXXX</span> <span class="used" title="Pavement type">XX</span><span class="free">OO</span></td>
+      <td class="bits"><span class="used" title="Snow/desert present">X</span><span class="free">OOO</span> <span class="used" title="Tram type">XXXX XX</span> <span class="used" title="Custom road stops specifications ID">XXXXXX</span></td>
+    </tr>
     <tr>
       <td class="caption">airport</td>
       <td class="bits"><span class="used" title="Random bits">XXXX</span> <span class="free">OOOO</span></td>
@@ -235,32 +240,37 @@ the array so you can quickly see what is used and what is not.
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
-      <td rowspan=4>6</td>
+      <td rowspan=5>6</td>
-      <td class="caption">sea, shore</td>
+      <td class="caption">sea</td>
-      <td class="bits" rowspan=4><span class="used" title="Ship docking tile status">X</span> <span class="used" title="Water class">XX</span> <span class="used" title="Owner">XXXXX</span></td>
+      <td class="bits" rowspan=5><span class="used" title="Ship docking tile status">X</span> <span class="used" title="Water class">XX</span> <span class="used" title="Owner">XXXXX</span></td>
-      <td class="bits" rowspan=3><span class="free">OOOO OOOO OOOO OOOO</span></td>
-      <td class="bits" rowspan=4><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">O<span class="usable">OO</span>O</span> <span class="free">OOO</span><span class="used" title="Sea shore flag">X</span></td>
-      <td class="bits" rowspan=4><span class="free">OOOO OOOO</span></td>
-      <td class="bits" rowspan=4><span class="free">OOOO OOOO</td>
       <td class="bits" rowspan=4><span class="free">OOOO OOOO OOOO OOOO</span></td>
+      <td class="bits" rowspan=5><span class="free">OOOO OOO</span><span class="used" title="Non-flooding state">X</span></td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
+      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">0000</span> <span class="free">OOO0</span></td>
+      <td class="bits" rowspan=5><span class="free">OOOO OOOO</span></td>
+      <td class="bits" rowspan=5><span class="free">OOOO OOOO</span></td>
+      <td class="bits" rowspan=5><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">canal, river</td>
       <td class="bits"><span class="used" title="Canal/river random bits">XXXX XXXX</span></td>
-      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">O<span class="usable">OO</span>O</span> <span class="free">OOOO</span></td>
+      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">0000</span> <span class="free">OOOO</span></td>
+    </tr>
+    <tr>
+      <td class="caption">shore</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
+      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">0001</span> <span class="free">OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">lock</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">O<span class="usable">OO</span>1</span> <span class="used" title="Lock part">XX</span> <span class="used" title="Lock orientation m5[1..0]">XX</span></td>
+      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">0010</span> <span class="used" title="Lock part">XX</span><span class="used" title="Lock orientation m5[1..0]">XX</span></td>
     </tr>
     <tr>
       <td class="caption">shipdepot</td>
       <td class="bits"><span class="pool" title="Depot index on pool">XXXX XXXX XXXX XXXX</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">1<span class="usable">OOO</span></span> <span class="free">OO</span><span class="used" title="Depot axis">X</span> <span class="used" title="Depot part">X</span></td>
+      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">0011</span> <span class="free">OO</span><span class="used" title="Depot axis">X</span><span class="used" title="Depot part">X</span></td>
     </tr>
     <tr>
       <td rowspan=2>8</td>
@@ -270,7 +280,7 @@ the array so you can quickly see what is used and what is not.
       <td class="bits" rowspan=2><span class="used" title="Random bits">XXXX XXXX</span></td>
       <td class="bits" rowspan=2><span class="used" title="Animation loop">XXXX XXXX</span></td>
       <td class="bits" rowspan=2><span class="used" title="Industry graphics ID (m5 + m6[2])">XXXX XXXX</span></td>
-      <td class="bits" rowspan=2><span class="free">OO</span><span class="used" title="Random triggers (NewGRF)">XXX</span> <span class="used" title="Industry graphics ID (m5 + m6[2])">X</span><span class="free">OO</span></td>
+      <td class="bits" rowspan=2><span class="free">OO</span><span class="used" title="Random triggers (NewGRF)">XXX</span> <span class="used" title="Industry graphics ID (m5 + m6[2])">X</span><span class="used" title="Animated tile state">XX</span></td>
       <td class="bits" rowspan=2><span class="used" title="Animation frame">XXXX XXXX</span></td>
       <td class="bits" rowspan=2><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
@@ -303,7 +313,7 @@ the array so you can quickly see what is used and what is not.
       <td class="bits"><span class="used" title="Random bits">XXXX XXXX</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="pool" title="Object index on pool (m2 + m5)">XXXX XXXX</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
+      <td class="bits"><span class="free">OOOO OO</span><span class="used" title="Animated tile state">XX</span></td>
       <td class="bits"><span class="used" title="Animation counter">XXXX XXXX</span></td>
       <td class="bits" rowspan=1><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>

docs/openttd.6

@@ -13,15 +13,13 @@
 .Op Fl c Ar config_file
 .Op Fl d Op Ar level | Ar cat Ns = Ns Ar lvl Ns Op , Ns Ar ...
 .Op Fl D Oo Ar host Oc Ns Op : Ns Ar port
-.Op Fl g Op Ar savegame
+.Op Fl g Op Ar file
 .Op Fl G Ar seed
 .Op Fl I Ar graphicsset
-.Op Fl l Ar host Ns Op : Ns Ar port
 .Op Fl m Ar driver
 .Op Fl M Ar musicset
 .Op Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar company
 .Op Fl p Ar password
-.Op Fl P Ar password
 .Op Fl q Ar savegame
 .Op Fl r Ar width Ns x Ns Ar height
 .Op Fl s Ar driver
@@ -63,11 +61,11 @@ Start in world editor mode.
 .It Fl f
 Fork into background (dedicated server only, see
 .Fl D ) .
-.It Fl g Op Ar savegame
+.It Fl g Op Ar file
 Load
-.Ar savegame
+.Ar file
-at start or start a new game if omitted.
+(can be either a savegame, scenario, or heightmap) at start or start a new game if omitted.
-.Ar savegame
+.Ar file
 must be either an absolute path or one relative to the current path or one of
 the search paths.
 .It Fl G Ar seed
@@ -82,9 +80,6 @@ Select the graphics set
 see
 .Fl h
 for a full list.
-.It Fl l Ar host Ns Op : Ns Ar port
-Redirect debug output; see
-.Fl d .
 .It Fl m Ar driver
 Select the music driver
 .Ar driver ;
@@ -104,10 +99,6 @@ play as.
 Password used to join server.
 Only useful with
 .Fl n .
-.It Fl P Ar password
-Password used to join company.
-Only useful with
-.Fl n .
 .It Fl q Ar savegame
 Write some information about the specified savegame and exit.
 .It Fl Q

docs/releasing_openttd.md

@@ -7,18 +7,20 @@ This guide is for OpenTTD developers/maintainers, to release a new version of Op
 * If this is a beta version release, skip this step.
 
 * If this is an RC1 (first Release Candidate) build, create a new branch `release/nn` where `nn` is the major version number, then apply changes similar to [PR#9573](https://github.com/OpenTTD/OpenTTD/pull/9573). You also need to forwardport the changelog, as in [PR#10113](https://github.com/OpenTTD/OpenTTD/pull/10113).
-  * Update CMakeLists.txt
+  * Update the version in `CMakeLists.txt` in the master branch, heading for the next major release, e.g. from 14.0 to 15.0.
-  * Add a new (empty) AI compatibility script in bin/ai/
+  * Add a new (empty) AI compatibility script in `bin/ai/`
-  * Add the new version to CheckAPIVersion in src/ai/ai_info.cpp + src/game/game_info.cpp
+  * Add the new version to CheckAPIVersion in `src/ai/ai_info.cpp` and `src/game/game_info.cpp`
-  * Add the new version to src/script/api/ai_changelog.hpp + src/script/api/game_changelog.hpp
+  * Add the new version to `src/script/api/ai_changelog.hpp` and `src/script/api/game_changelog.hpp`
-  * Update the version of regression in bin/ai/regression/regression_info.nut
+  * Update the version of regression in `bin/ai/regression/regression_info.nut`
-  * Add a note to src/saveload/saveload.h about which savegame version is used in the branch.
+  * Add a note to `src/saveload/saveload.h` about which savegame version is used in the branch.
 
 * If this is a later RC or release build and the release branch already exists, you'll need to backport fixes and language from master to this branch, which were merged after the branch diverged from master. You can use these two helper scripts: https://github.com/OpenTTD/scripts/tree/main/backport
 
+* If this is a maintenance release, update the version in `CMakeLists.txt` in the release branch, e.g. from 14.0 to 14.1.
+
 ## Step 1: Prepare changelog documentation
 
-1. Update the [changelog](../changelog.txt) with new changes since the last release.
+1. Update the [changelog](../changelog.md) with new changes since the last release.
    * Changelog entries are typically PR titles, but can be edited to be more helpful without context.
    * Don't include fixes to things which haven't previously been released (like fixes to features which are in the same changelog).
    * Order the entries by importance: `Feature > Add > Change > Fix`, then numerically by PR number.
@@ -29,20 +31,26 @@ This guide is for OpenTTD developers/maintainers, to release a new version of Op
 
 1. Go to https://github.com/OpenTTD/website/new/main/_posts and write a new announcement post. See a [previous example](https://github.com/OpenTTD/website/pull/238) for a template.
 2. Create a new branch for this post and open a PR for it.
-3. Write announcement text for socials like Forum/Discord/Twitter/Reddit and include it in the PR.
+3. Write announcement text for the store pages and socials like TT-Forums / Discord / Twitter / Reddit / Fosstodon / etc., and include it in the PR.
 4. Create a Steam news image for that post and include it in the PR.
-5. Check the website post (preview link via checks page) and make corrections. We usually just use the GitHub web interface for this and squash the result later.
+5. Check the website post ("View Deployment" link) and make corrections. We usually just use the GitHub web interface for this and squash the result later.
 6. Get this PR approved, but do not merge yet.
 
 ## Step 3: Make the actual OpenTTD release
 
-1. Go to https://github.com/OpenTTD/OpenTTD/releases/new and create a new tag matching the release number. For the body of the release, see any older release. "Set as a pre-release" for a beta or RC, set as latest for a real release.
+1. Confirm that the version in `CMakeLists.txt` matches the intended release version.
-2. Merge website PR.
+2. Go to https://github.com/OpenTTD/OpenTTD/releases/new and create a new tag matching the release number. For the body of the release, copy in the changelog. "Set as a pre-release" for a beta or RC.
-3. Wait for the OpenTTD release checks to be complete.
+3. Wait for the OpenTTD release workflow to be complete.
-4. Check that website links to the new release are working and correct, using the [staging website](https://www-staging.openttd.org/).
+4. If this is a full release:
-5. If this is a full release, ask orudge to update the Microsoft Store and TrueBrain to move the release from the "testing" to "default" branch on Steam.
+   * for `Steam`: under Steamworks -> SteamPipe -> Builds, set the "testing" branch live on the "default" branch. This will request 2FA validation.
+   * for `GOG`: under Builds, "Publish" the freshly uploaded builds to `Master`, `GOG-use only` and `Testing`.
+   * for `Microsoft Store`: ask orudge to publish the new release.
+
+Access to `Steam`, `GOG` and/or `Microsoft Store` requires a developer account on that platform.
+You will need access to the shared keystore in order to create such an account.
+For help and/or access to either or both, please contact TrueBrain.
 
 ## Step 4: Tell the world
 
-1. Tag and create a website release to trigger the actions that update the website.
+1. Merge the website PR. This will publish the release post.
-2. After the website is live, make announcements on social media. You may need to coordinate with other developers who can make posts on Twitter, Reddit, Steam, and GOG.
+2. Make announcements on social media and store pages. You may need to coordinate with other developers who can make posts on TT-Forums, Twitter, Reddit, Fosstodon, Discord, Steam, GOG, Microsoft Store, etc.

docs/symbol_server.md

@@ -19,7 +19,7 @@ Now simply open up the `crash.dmp`, and start debugging.
 The best tool to use is `minidump-stackwalk` as published in the Rust's cargo index:
 
 ```bash
-cargo install minidump-stackwalk
+cargo install --locked minidump-stackwalk
 ```
 
 For how to install Rust, please see [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).

known-bugs.md

@@ -0,0 +1,426 @@
+# OpenTTD's known bugs
+
+## Table of contents
+
+- 1.0) About
+- 2.0) Known bugs
+
+## 1.0) About
+
+All bugs listed below are marked as known. Please do not submit any bugs
+that are the same as these. If you do, do not act surprised, because
+we WILL flame you!
+
+The current list of known bugs that we intend to fix can be found in our
+bug tracking system at https://github.com/OpenTTD/OpenTTD/issues
+Also check the closed bugs when searching for your bug in this system as we
+might have fixed the bug in the mean time.
+
+## 2.0) Known bugs
+
+This section lists all known bugs that we do not intend to fix and the
+reasons why we think that fixing them is infeasible. We might make some
+minor improvements that reduce the scope of these bugs, but we will not
+be able to completely fix them.
+
+### No suitable AI can be found:
+
+If you have no AIs and an AI is started the so-called 'dummy' AI will
+be loaded. This AI does nothing but writing a message on the AI debug
+window and showing a red warning. There are basically two solutions
+for this problem: Either you set the number of AI players to 0 so that
+no AI is started. You find that setting at the top of the window in the
+"AI / Game Scripts Settings" window.
+
+The other solution is acquiring (downloading) some AI. The easiest way
+to do this is via the "Check Online Content" button in the main (intro)
+menu or directly in the "AI / Game Scripts Settings" dialogue via the
+"Check Online Content" button.
+
+### After a while of playing, colours get corrupted:
+
+In Windows 7 the background slideshow corrupts the colour mapping
+of OpenTTD's 8bpp screen modes. Workarounds for this are:
+
+* Switching to windowed mode, instead of fullscreen
+* Switching off background slideshow
+* Setting up the `32bpp-anim` or `32bpp-optimized` blitter
+
+### Custom vehicle type name is incorrectly aligned:
+
+Some NewGRFs use sprites that are bigger than normal in the "buy
+vehicle" window. Due to this they have to encode an offset for
+the vehicle type name. Upon renaming the vehicle type this encoded
+offset is stripped from the name because the "edit box" cannot show
+this encoding. As a result the custom vehicle type names will get
+the default alignment. The only way to (partially) fix this is by
+adding spaces to the custom name.
+
+### Clipping problems [#119]:
+
+In some cases sprites are not drawn as one would expect. Examples of
+this are aircraft that might be hidden below the runway or trees that
+in some cases are rendered over vehicles.
+
+The primary cause of this problem is that OpenTTD does not have enough
+data (like a 3D model) to properly determine what needs to be drawn in
+front of what. OpenTTD has bounding boxes but in lots of cases they
+are either too big or too small and then cause problems with what
+needs to be drawn in front of what. Also some visual tricks are used.
+
+For example trains at 8 pixels high, the catenary needs to be drawn
+above that. When you want to draw bridges on top of that, which are
+only one height level (= 8 pixels) higher, you are getting into some
+big problems.
+
+We can not change the height levels; it would require us to either
+redraw all vehicle or all landscape graphics. Doing so would mean we
+leave the Transport Tycoon graphics, which in effect means OpenTTD
+will not be a Transport Tycoon clone anymore.
+
+### Mouse scrolling not possible at the edges of the screen [#383] [#3966]:
+
+Scrolling the viewport with the mouse cursor at the edges of the screen
+in the same direction of the edge will fail. If the cursor is near the
+edge the scrolling will be very slow.
+
+OpenTTD only receives cursor position updates when the cursor is inside
+OpenTTD's window. It is not told how far you have moved the cursor
+outside of OpenTTD's window.
+
+### Lost trains ignore (block) exit signals [#1473]:
+
+If trains are lost they ignore block exit signals, blocking junctions
+with presignals. This is caused because the path finders cannot tell
+where the train needs to go. As such a random direction is chosen at
+each junction. This causes the trains to occasionally to make choices
+that are unwanted from a player's point of view.
+
+This will not be fixed because lost trains are in almost all cases a
+network problem, e.g. a train can never reach a specific place. This
+makes the impact of fixing the bug enormously small against the amount
+of work needed to write a system that prevents the lost trains from
+taking the wrong direction.
+
+### Vehicle owner of last transfer leg gets paid for all [#2427]:
+
+When you make a transfer system that switches vehicle owners. This
+is only possible with 'industry stations', e.g. the oil rig station
+the owner of the vehicle that does the final delivery gets paid for
+the whole trip. It is not shared amongst the different vehicle
+owners that have participated in transporting the cargo.
+
+This sharing is not done because it would enormously increase the
+memory and CPU usage in big games for something that is happening
+in only one corner case. We think it is not worth the effort until
+sharing of stations is an official feature.
+
+### Forbid 90 degree turns does not work for crossing PBS paths [#2737]:
+
+When you run a train through itself on a X junction with PBS turned on
+the train will not obey the 'forbid 90 degree turns' setting. This is
+due to the fact that we can not be sure that the setting was turned
+off when the track was reserved, which means that we assume it was
+turned on and that the setting does not hold at the time. We made it
+this way to allow one to change the setting in-game, but it breaks
+slightly when you are running your train through itself. Running a
+train through means that your network is broken and is thus a user
+error which OpenTTD tries to graciously handle.
+
+Fixing this bug means that we need to record whether this particular
+setting was turned on or off at the time the reservation was made. This
+means adding quite a bit of data to the savegame for solving an issue
+that is basically an user error. We think it is not worth the effort.
+
+### Duplicate (station) names after renaming [#3204]:
+
+After renaming stations one can create duplicate station names. This
+is done giving a station the same custom name as another station with
+an automatically generated name.
+
+The major part of this problem is that station names are translatable.
+Meaning that a station is called e.g. '<TOWN> Central' in English and
+'<TOWN> Centraal' in Dutch. This means that in network games the
+renaming of a town could cause the rename to succeed on some clients
+and fail at others. This creates an inconsistent game state that will
+be seen as a 'desync'. Secondly the custom names are intended to fall
+completely outside of the '<TOWN> <name>' naming of stations, so when
+you rename a town all station names are updated accordingly.
+
+As a result the decision has been made that all custom names are only
+compared to the other custom names in the same class and not compared
+to the automatically generated names.
+
+### Extreme CPU usage/hangs when using SDL and PulseAudio [#3294], OpenTTD hangs/freezes when closing, OpenTTD is slow, OpenTTD uses a lot of CPU:
+
+OpenTTD can be extremely slow/use a lot of CPU when the sound is
+played via SDL and then through PulseAudio's ALSA wrapper. Under the
+same configuration OpenTTD, or rather SDL, might hang when exiting
+the game. This problem is seen most in Ubuntu 9.04 and higher.
+
+This is because recent versions of the PulseAudio sound server
+are configured to use timer-based audio scheduling rather than
+interrupt-based audio scheduling. Configuring PulseAudio to force
+use of interrupt-based scheduling may resolve sound problems for
+some users. Under recent versions of Ubuntu Linux (9.04 and higher)
+this can be accomplished by changing the following line in the
+`/etc/pulse/default.pa` file:
+        `load-module module-udev-detect`
+to
+        `load-module module-udev-detect tsched=0`
+
+Note that PulseAudio must be restarted for changes to take effect. Older
+versions of PulseAudio may use the module-hal-detect module instead.
+Adding tsched=0 to the end of that line will have a similar effect.
+
+Another possible solution is selecting the "pulse" backend of SDL
+by either using `SDL_AUDIODRIVER=pulse openttd` at the command
+prompt or installing the `libsdl1.2debian-pulseaudio` package from
+Ubuntu's Universe repository. For other distributions a similar
+package needs to be installed.
+
+### OpenTTD not properly resizing with SDL on X [#3305]:
+
+Under some X window managers OpenTTD's window does not properly
+resize. You will either end up with a black bar at the right/bottom
+side of the window or you cannot see the right/bottom of the window,
+e.g. you cannot see the status bar. The problem is that OpenTTD does
+not always receive a resize event from SDL making it impossible for
+OpenTTD to know that the window was resized; sometimes moving the
+window will solve the problem.
+
+Window managers that are known to exhibit this behaviour are GNOME's
+and KDE's. With the XFCE's and LXDE's window managers the resize
+event is sent when the user releases the mouse.
+
+### Incorrect colours, crashes upon exit, debug warnings and smears upon window resizing with SDL on macOS [#3447]:
+
+Video handling with (lib)SDL under macOS is known to fail on some
+versions of macOS with some hardware configurations. Some of
+the problems happen only under some circumstances whereas others
+are always present.
+
+We suggest that the SDL video/sound backend is not used for OpenTTD
+in combinations with macOS.
+
+### Train crashes entering same junction from block and path signals [#3928]:
+
+When a train has reserved a path from a path signal to a two way
+block signal and the reservation passes a path signal through the
+back another train can enter the reserved path (only) via that
+same two way block signal.
+
+The reason for this has to do with optimisation; to fix this issue
+the signal update has to pass all path signals until it finds either
+a train or a backwards facing signal. This is a very expensive task.
+
+The (signal) setups that allow these crashes can furthermore be
+considered incorrectly signalled; one extra safe waiting point for
+the train entering from path signal just after the backwards facing
+signal (from the path signal train) resolves the issue.
+
+### Crashes when run in a VM using Parallels Desktop [#4003]:
+
+When the Windows version of OpenTTD is executed in a VM under
+Parallels Desktop a privileged instruction exception may be thrown.
+
+As OpenTTD works natively on macOS as well as natively on Windows and
+these native builds both don't exhibit this behaviour this crash is
+most likely due to a bug in the virtual machine, something out of
+the scope of OpenTTD. Most likely this is due to Parallels Desktop
+lacking support for RDTSC calls. The problem can be avoided by using
+other VM-software, Wine, or running natively on macOS.
+
+### Entry- and exit signals are not dragged [#4378]:
+
+Unlike all other signal types, the entry- and exit signals are not
+dragged but instead normal signals are placed on subsequent track
+sections. This is done on purpose as this is the usually more
+convenient solution. There are little to no occasions where more
+than one entry or exit signal in a row are useful. This is different
+for all other signal types where several in a row can serve one
+purpose or another.
+
+### (Temporary) wrong colours when switching to full screen [#4511]:
+
+On Windows it can happen that you temporarily see wrong colours
+when switching to full screen OpenTTD, either by starting
+OpenTTD in full screen mode, changing to full screen mode or by
+ALT-TAB-ing into a full screen OpenTTD. This is caused by the
+fact that OpenTTD, by default, uses 8bpp paletted output. The
+wrong colours you are seeing is a temporary effect of the video
+driver switching to 8bpp palette mode.
+
+This issue can be worked around in two ways:
+* Setting fullscreen_bpp to 32
+* Setting up the 32bpp-anim or 32bpp-optimized blitter
+
+### Can't run OpenTTD with the -d option from a MSYS console [#4587]:
+
+The MSYS console does not allow OpenTTD to open an extra console for
+debugging output. Compiling OpenTTD with the --enable-console
+configure option prevents this issue and allows the -d option to use
+the MSYS console for its output.
+
+### Unreadable characters for non-latin locales [#4607]:
+
+OpenTTD does not ship a non-latin font in its graphics files. As a
+result OpenTTD needs to acquire the font from somewhere else. What
+OpenTTD does is ask the operating system, or a system library, for
+the best font for a given language if the currently loaded font
+does not provide all characters of the chosen translation. This
+means that OpenTTD has no influence over the quality of the chosen
+font; it just does the best it can do.
+
+If the text is unreadable there are several steps that you can take
+to improve this. The first step is finding a good font and configure
+this in the configuration file. See section 9.0 of README.md for
+more information. You can also increase the font size to make the
+characters bigger and possible better readable.
+
+If the problem is with the clarity of the font you might want to
+enable anti-aliasing by setting the small_aa/medium_aa/large_aa
+settings to "true". However, anti-aliasing only works when a 32-bit
+blitter has been selected, e.g. `blitter = "32bpp-anim"`, as with the
+8 bits blitter there are not enough colours to properly perform the
+anti-aliasing.
+
+### Train does not crash with itself [#4635]:
+
+When a train drives in a circle the front engine passes through
+wagons of the same train without crashing. This is intentional.
+Signals are only aware of tracks, they do not consider the train
+length and whether there would be enough room for a train in some
+circle it might drive on. Also the path a train might take is not
+necessarily known when passing a signal.
+
+Checking all circumstances would take a lot of additional
+computational power for signals, which is not considered worth
+the effort, as it does not add anything to gameplay.
+
+Nevertheless trains shall not crash in normal operation, so making
+a train not crash with itself is the best solution for everyone.
+
+### Aircraft coming through wall in rotated airports [#4705]:
+
+With rotated airports, specifically hangars, you will see that the
+aircraft will show a part through the back wall of the hangar.
+
+This can be solved by only drawing a part of the plane when being
+at the back of the hangar, however then with transparency turned on
+the aircraft would be shown partially which would be even weirder.
+
+As such the current behaviour is deemed the least bad.
+The same applies to overly long ships and their depots.
+
+### Vehicles not keeping their "maximum" speed [#4815]:
+
+Vehicles that have not enough power to reach and maintain their
+advertised maximum speed might be constantly jumping between two
+speeds. This is due to the fact that speed and its calculations
+are done with integral numbers instead of floating point numbers.
+
+As a result of this a vehicle will never reach its equilibrium
+between the drag/friction and propulsion. So in effect it will be
+in a vicious circle of speeding up and slowing down due to being
+just at the other side of the equilibrium.
+
+Not speeding up when near the equilibrium will cause the vehicle to
+never come in the neighbourhood of the equilibrium and not slowing
+down when near the equilibrium will cause the vehicle to never slow
+down towards the equilibrium once it has come down a hill.
+
+It is possible to calculate whether the equilibrium will be passed,
+but then all acceleration calculations need to be done twice.
+
+### Settings not saved when OpenTTD crashes [#4846]:
+
+The settings are not saved when OpenTTD crashes for several reasons.
+The most important is that the game state is broken and as such the
+settings might contain invalid values, or the settings have not even
+been loaded yet. This would cause invalid or totally wrong settings
+to be written to the configuration file.
+
+A solution to that would be saving the settings whenever one changes,
+however due to the way the configuration file is saved this requires
+a flush of the file to the disk and OpenTTD needs to wait till that
+is finished. On some file system implementations this causes the
+flush of all 'write-dirty' caches, which can be a significant amount
+of data to be written. This can further be aggravated by spinning
+down disks to conserve power, in which case this disk needs to be
+spun up first. This means that many seconds may pass before the
+configuration file is actually written, and all that time OpenTTD
+will not be able to show any progress. Changing the way the
+configuration file is saved is not an option as that leaves us more
+vulnerable to corrupt configuration files.
+
+Finally, crashes should not be happening. If they happen they should
+be reported and fixed, so essentially fixing this is fixing the wrong
+thing. If you really need the configuration changes to be saved,
+and you need to run a version that crashes regularly, then you can
+use the `saveconfig` command in the console to save the settings.
+
+### Not all NewGRFs, AIs, game scripts are found [#4887]:
+
+Under certain situations, where the path for the content within a
+tar file is the same as other content on the file system or in another
+tar file, it is possible that content is not found. A more thorough
+explanation and solutions are described in section 4.4 of README.md.
+
+### Mouse cursor going missing with SDL [#4997]:
+
+Under certain circumstances SDL does not notify OpenTTD of changes with
+respect to the mouse pointer, specifically whether the mouse pointer
+is within the bounds of OpenTTD or not. For example, if you "Alt-Tab"
+to another application the mouse cursor will still be shown in OpenTTD,
+and when you move the mouse outside of the OpenTTD window so the cursor
+gets hidden, open/move another application on top of the OpenTTD window
+and then Alt-tab back into OpenTTD the cursor will not be shown.
+
+We cannot fix this problem as SDL simply does not provide the required
+information in these corner cases. This is a bug in SDL and as such
+there is little that we can do about it.
+
+### Trains might not stop at platforms that are currently being changed [#5553]:
+
+If you add tiles to or remove tiles from a platform while a train is
+approaching to stop at the same platform, that train can miss the place
+where it's supposed to stop and pass the station without stopping.
+
+This is caused by the fact that the train is considered to already
+have stopped if it's beyond its assigned stopping location. We can't
+let the train stop just anywhere in the station because then it would
+never leave the station if you have the same station in the order
+list multiple times in a row or if there is only one station
+in theorder list (see #5684).
+
+### Some houses and industries are not affected by transparency [#5817]:
+
+Some of the default houses and industries (f.e. the iron ore mine) are
+not affected by the transparency options. This is because the graphics
+do not (completely) separate the ground from the building.
+
+This is a bug of the original graphics, and unfortunately cannot be
+fixed with OpenGFX for the sake of maintaining compatibility with
+the original graphics.
+
+### Involuntary cargo exchange with cargodist via neutral station [#6114]:
+
+When two players serve a neutral station at an industry, a cross-company
+chain for cargo flow can and will be established which can only be
+interrupted if one of the players stops competing for the resources of
+that industry. There is an easy fix for this: If you are loading at the
+shared station make the order "no unload" and if you're unloading make
+it "no load". Cargodist will then figure out that it should not create
+such a route.
+
+### Incorrect ending year displayed in end of game newspaper [#8625]
+
+The ending year of the game is configurable, but the date displayed in
+the newspaper at the end of the game is part of the graphics, not text.
+
+So to fix this would involve fixing the graphics in every baseset,
+including the original. Additionally, basesets are free to put this
+text in different positions (which they do), making a proper solution
+to this infinitely more complex for a part of the game that fewer than
+1% of players ever see.

known-bugs.txt

@@ -1,389 +0,0 @@
-OpenTTD's known bugs
-------------------------------------------------------------------------
-
-
-Table of contents
------------------
-1.0) About
-2.0) Known bugs
-
-
-1.0) About
----- -----
-All bugs listed below are marked as known. Please do not submit any bugs
-that are the same as these. If you do, do not act surprised, because
-we WILL flame you!
-
-The current list of known bugs that we intend to fix can be found in our
-bug tracking system at https://github.com/OpenTTD/OpenTTD/issues
-Also check the closed bugs when searching for your bug in this system as we
-might have fixed the bug in the mean time.
-
-
-2.0) Known bugs
----- ----------------------------------
-This section lists all known bugs that we do not intend to fix and the
-reasons why we think that fixing them is infeasible. We might make some
-minor improvements that reduce the scope of these bugs, but we will not
-be able to completely fix them.
-
-No suitable AI can be found:
-        If you have no AIs and an AI is started the so-called 'dummy' AI will
-        be loaded. This AI does nothing but writing a message on the AI debug
-        window and showing a red warning. There are basically two solutions
-        for this problem: Either you set the number of AI players to 0 so that
-        no AI is started. You find that setting at the top of the window in the
-        "AI / Game Scripts Settings" window.
-        The other solution is acquiring (downloading) some AI. The easiest way
-        to do this is via the "Check Online Content" button in the main (intro)
-        menu or directly in the "AI / Game Scripts Settings" dialogue via the
-        "Check Online Content" button.
-
-After a while of playing, colours get corrupted:
-        In Windows 7 the background slideshow corrupts the colour mapping
-        of OpenTTD's 8bpp screen modes. Workarounds for this are:
-                a) Switching to windowed mode, instead of fullscreen
-                b) Switching off background slideshow
-                c) Setting up the 32bpp-anim or 32bpp-optimized blitter
-
-Custom vehicle type name is incorrectly aligned:
-        Some NewGRFs use sprites that are bigger than normal in the "buy
-        vehicle" window. Due to this they have to encode an offset for
-        the vehicle type name. Upon renaming the vehicle type this encoded
-        offset is stripped from the name because the "edit box" cannot show
-        this encoding. As a result the custom vehicle type names will get
-        the default alignment. The only way to (partially) fix this is by
-        adding spaces to the custom name.
-
-Clipping problems [#119]:
-        In some cases sprites are not drawn as one would expect. Examples of
-        this are aircraft that might be hidden below the runway or trees that
-        in some cases are rendered over vehicles.
-        The primary cause of this problem is that OpenTTD does not have enough
-        data (like a 3D model) to properly determine what needs to be drawn in
-        front of what. OpenTTD has bounding boxes but in lots of cases they
-        are either too big or too small and then cause problems with what
-        needs to be drawn in front of what. Also some visual tricks are used.
-        For example trains at 8 pixels high, the catenary needs to be drawn
-        above that. When you want to draw bridges on top of that, which are
-        only one height level (= 8 pixels) higher, you are getting into some
-        big problems.
-        We can not change the height levels; it would require us to either
-        redraw all vehicle or all landscape graphics. Doing so would mean we
-        leave the Transport Tycoon graphics, which in effect means OpenTTD
-        will not be a Transport Tycoon clone anymore.
-
-Mouse scrolling not possible at the edges of the screen [#383] [#3966]:
-        Scrolling the viewport with the mouse cursor at the edges of the screen
-        in the same direction of the edge will fail. If the cursor is near the
-        edge the scrolling will be very slow.
-        OpenTTD only receives cursor position updates when the cursor is inside
-        OpenTTD's window. It is not told how far you have moved the cursor
-        outside of OpenTTD's window.
-
-Lost trains ignore (block) exit signals [#1473]:
-        If trains are lost they ignore block exit signals, blocking junctions
-        with presignals. This is caused because the path finders cannot tell
-        where the train needs to go. As such a random direction is chosen at
-        each junction. This causes the trains to occasionally to make choices
-        that are unwanted from a player's point of view.
-        This will not be fixed because lost trains are in almost all cases a
-        network problem, e.g. a train can never reach a specific place. This
-        makes the impact of fixing the bug enormously small against the amount
-        of work needed to write a system that prevents the lost trains from
-        taking the wrong direction.
-
-Vehicle owner of last transfer leg gets paid for all [#2427]:
-        When you make a transfer system that switches vehicle owners. This
-        is only possible with 'industry stations', e.g. the oil rig station
-        the owner of the vehicle that does the final delivery gets paid for
-        the whole trip. It is not shared amongst the different vehicle
-        owners that have participated in transporting the cargo.
-        This sharing is not done because it would enormously increase the
-        memory and CPU usage in big games for something that is happening
-        in only one corner case. We think it is not worth the effort until
-        sharing of stations is an official feature.
-
-Forbid 90 degree turns does not work for crossing PBS paths [#2737]:
-        When you run a train through itself on a X junction with PBS turned on
-        the train will not obey the 'forbid 90 degree turns' setting. This is
-        due to the fact that we can not be sure that the setting was turned
-        off when the track was reserved, which means that we assume it was
-        turned on and that the setting does not hold at the time. We made it
-        this way to allow one to change the setting in-game, but it breaks
-        slightly when you are running your train through itself. Running a
-        train through means that your network is broken and is thus a user
-        error which OpenTTD tries to graciously handle.
-        Fixing this bug means that we need to record whether this particular
-        setting was turned on or off at the time the reservation was made. This
-        means adding quite a bit of data to the savegame for solving an issue
-        that is basically an user error. We think it is not worth the effort.
-
-Duplicate (station) names after renaming [#3204]:
-        After renaming stations one can create duplicate station names. This
-        is done giving a station the same custom name as another station with
-        an automatically generated name.
-        The major part of this problem is that station names are translatable.
-        Meaning that a station is called e.g. '<TOWN> Central' in English and
-        '<TOWN> Centraal' in Dutch. This means that in network games the
-        renaming of a town could cause the rename to succeed on some clients
-        and fail at others. This creates an inconsistent game state that will
-        be seen as a 'desync'. Secondly the custom names are intended to fall
-        completely outside of the '<TOWN> <name>' naming of stations, so when
-        you rename a town all station names are updated accordingly.
-        As a result the decision has been made that all custom names are only
-        compared to the other custom names in the same class and not compared
-        to the automatically generated names.
-
-Extreme CPU usage/hangs when using SDL and PulseAudio [#3294],
-OpenTTD hangs/freezes when closing, OpenTTD is slow, OpenTTD uses a lot of CPU:
-        OpenTTD can be extremely slow/use a lot of CPU when the sound is
-        played via SDL and then through PulseAudio's ALSA wrapper. Under the
-        same configuration OpenTTD, or rather SDL, might hang when exiting
-        the game. This problem is seen most in Ubuntu 9.04 and higher.
-
-        This is because recent versions of the PulseAudio sound server
-        are configured to use timer-based audio scheduling rather than
-        interrupt-based audio scheduling. Configuring PulseAudio to force
-        use of interrupt-based scheduling may resolve sound problems for
-        some users. Under recent versions of Ubuntu Linux (9.04 and higher)
-        this can be accomplished by changing the following line in the
-        /etc/pulse/default.pa file:
-                load-module module-udev-detect
-        to
-                load-module module-udev-detect tsched=0
-        Note that PulseAudio must be restarted for changes to take effect. Older
-        versions of PulseAudio may use the module-hal-detect module instead.
-        Adding tsched=0 to the end of that line will have a similar effect.
-
-        Another possible solution is selecting the "pulse" backend of SDL
-        by either using "SDL_AUDIODRIVER=pulse openttd" at the command
-        prompt or installing the 'libsdl1.2debian-pulseaudio' package from
-        Ubuntu's Universe repository. For other distributions a similar
-        package needs to be installed.
-
-OpenTTD not properly resizing with SDL on X [#3305]:
-        Under some X window managers OpenTTD's window does not properly
-        resize. You will either end up with a black bar at the right/bottom
-        side of the window or you cannot see the right/bottom of the window,
-        e.g. you cannot see the status bar. The problem is that OpenTTD does
-        not always receive a resize event from SDL making it impossible for
-        OpenTTD to know that the window was resized; sometimes moving the
-        window will solve the problem.
-        Window managers that are known to exhibit this behaviour are GNOME's
-        and KDE's. With the XFCE's and LXDE's window managers the resize
-        event is sent when the user releases the mouse.
-
-Incorrect colours, crashes upon exit, debug warnings and smears upon
-window resizing with SDL on macOS [#3447]:
-        Video handling with (lib)SDL under macOS is known to fail on some
-        versions of macOS with some hardware configurations. Some of
-        the problems happen only under some circumstances whereas others
-        are always present.
-        We suggest that the SDL video/sound backend is not used for OpenTTD
-        in combinations with macOS.
-
-Train crashes entering same junction from block and path signals [#3928]:
-        When a train has reserved a path from a path signal to a two way
-        block signal and the reservation passes a path signal through the
-        back another train can enter the reserved path (only) via that
-        same two way block signal.
-        The reason for this has to do with optimisation; to fix this issue
-        the signal update has to pass all path signals until it finds either
-        a train or a backwards facing signal. This is a very expensive task.
-        The (signal) setups that allow these crashes can furthermore be
-        considered incorrectly signalled; one extra safe waiting point for
-        the train entering from path signal just after the backwards facing
-        signal (from the path signal train) resolves the issue.
-
-Crashes when run in a VM using Parallels Desktop [#4003]:
-        When the Windows version of OpenTTD is executed in a VM under
-        Parallels Desktop a privileged instruction exception may be thrown.
-        As OpenTTD works natively on macOS as well as natively on Windows and
-        these native builds both don't exhibit this behaviour this crash is
-        most likely due to a bug in the virtual machine, something out of
-        the scope of OpenTTD. Most likely this is due to Parallels Desktop
-        lacking support for RDTSC calls. The problem can be avoided by using
-        other VM-software, Wine, or running natively on macOS.
-
-Entry- and exit signals are not dragged [#4378]:
-        Unlike all other signal types, the entry- and exit signals are not
-        dragged but instead normal signals are placed on subsequent track
-        sections. This is done on purpose as this is the usually more
-        convenient solution. There are little to no occasions where more
-        than one entry or exit signal in a row are useful. This is different
-        for all other signal types where several in a row can serve one
-        purpose or another.
-
-Station build date is incorrect [#4415]:
-        The tile query tool will show the date of the last (re)construction
-        at the station and not the date of the first construction. This is
-        due to compatibility reasons with NewGRFs and the fact that it is
-        wrong to say that the station is built in a particular year when it
-        was completely destroyed/rebuilt later on.
-        The tile query tool can be fixed by changing the "Build date" text
-        to "Date at which the last (re)construction took place" but this is
-        deemed too specific and long for that window.
-
-(Temporary) wrong colours when switching to full screen [#4511]:
-        On Windows it can happen that you temporarily see wrong colours
-        when switching to full screen OpenTTD, either by starting
-        OpenTTD in full screen mode, changing to full screen mode or by
-        ALT-TAB-ing into a full screen OpenTTD. This is caused by the
-        fact that OpenTTD, by default, uses 8bpp paletted output. The
-        wrong colours you are seeing is a temporary effect of the video
-        driver switching to 8bpp palette mode.
-
-        This issue can be worked around in two ways:
-                a) Setting fullscreen_bpp to 32
-                b) Setting up the 32bpp-anim or 32bpp-optimized blitter
-
-Can't run OpenTTD with the -d option from a MSYS console [#4587]:
-        The MSYS console does not allow OpenTTD to open an extra console for
-        debugging output. Compiling OpenTTD with the --enable-console
-        configure option prevents this issue and allows the -d option to use
-        the MSYS console for its output.
-
-Unreadable characters for non-latin locales [#4607]:
-        OpenTTD does not ship a non-latin font in its graphics files. As a
-        result OpenTTD needs to acquire the font from somewhere else. What
-        OpenTTD does is ask the operating system, or a system library, for
-        the best font for a given language if the currently loaded font
-        does not provide all characters of the chosen translation. This
-        means that OpenTTD has no influence over the quality of the chosen
-        font; it just does the best it can do.
-
-        If the text is unreadable there are several steps that you can take
-        to improve this. The first step is finding a good font and configure
-        this in the configuration file. See section 9.0 of README.md for
-        more information. You can also increase the font size to make the
-        characters bigger and possible better readable.
-
-        If the problem is with the clarity of the font you might want to
-        enable anti-aliasing by setting the small_aa/medium_aa/large_aa
-        settings to "true". However, anti-aliasing only works when a 32-bit
-        blitter has been selected, e.g. blitter = "32bpp-anim", as with the
-        8 bits blitter there are not enough colours to properly perform the
-        anti-aliasing.
-
-Train does not crash with itself [#4635]:
-        When a train drives in a circle the front engine passes through
-        wagons of the same train without crashing. This is intentional.
-        Signals are only aware of tracks, they do not consider the train
-        length and whether there would be enough room for a train in some
-        circle it might drive on. Also the path a train might take is not
-        necessarily known when passing a signal.
-        Checking all circumstances would take a lot of additional
-        computational power for signals, which is not considered worth
-        the effort, as it does not add anything to gameplay.
-        Nevertheless trains shall not crash in normal operation, so making
-        a train not crash with itself is the best solution for everyone.
-
-Aircraft coming through wall in rotated airports [#4705]:
-        With rotated airports, specifically hangars, you will see that the
-        aircraft will show a part through the back wall of the hangar.
-        This can be solved by only drawing a part of the plane when being
-        at the back of the hangar, however then with transparency turned on
-        the aircraft would be shown partially which would be even weirder.
-        As such the current behaviour is deemed the least bad.
-        The same applies to overly long ships and their depots.
-
-Vehicles not keeping their "maximum" speed [#4815]:
-        Vehicles that have not enough power to reach and maintain their
-        advertised maximum speed might be constantly jumping between two
-        speeds. This is due to the fact that speed and its calculations
-        are done with integral numbers instead of floating point numbers.
-        As a result of this a vehicle will never reach its equilibrium
-        between the drag/friction and propulsion. So in effect it will be
-        in a vicious circle of speeding up and slowing down due to being
-        just at the other side of the equilibrium.
-
-        Not speeding up when near the equilibrium will cause the vehicle to
-        never come in the neighbourhood of the equilibrium and not slowing
-        down when near the equilibrium will cause the vehicle to never slow
-        down towards the equilibrium once it has come down a hill.
-
-        It is possible to calculate whether the equilibrium will be passed,
-        but then all acceleration calculations need to be done twice.
-
-Settings not saved when OpenTTD crashes [#4846]:
-        The settings are not saved when OpenTTD crashes for several reasons.
-        The most important is that the game state is broken and as such the
-        settings might contain invalid values, or the settings have not even
-        been loaded yet. This would cause invalid or totally wrong settings
-        to be written to the configuration file.
-
-        A solution to that would be saving the settings whenever one changes,
-        however due to the way the configuration file is saved this requires
-        a flush of the file to the disk and OpenTTD needs to wait till that
-        is finished. On some file system implementations this causes the
-        flush of all 'write-dirty' caches, which can be a significant amount
-        of data to be written. This can further be aggravated by spinning
-        down disks to conserve power, in which case this disk needs to be
-        spun up first. This means that many seconds may pass before the
-        configuration file is actually written, and all that time OpenTTD
-        will not be able to show any progress. Changing the way the
-        configuration file is saved is not an option as that leaves us more
-        vulnerable to corrupt configuration files.
-
-        Finally, crashes should not be happening. If they happen they should
-        be reported and fixed, so essentially fixing this is fixing the wrong
-        thing. If you really need the configuration changes to be saved,
-        and you need to run a version that crashes regularly, then you can
-        use the 'saveconfig' command in the console to save the settings.
-
-Not all NewGRFs, AIs, game scripts are found [#4887]:
-        Under certain situations, where the path for the content within a
-        tar file is the same as other content on the file system or in another
-        tar file, it is possible that content is not found. A more thorough
-        explanation and solutions are described in section 4.4 of README.md.
-
-Mouse cursor going missing with SDL [#4997]:
-        Under certain circumstances SDL does not notify OpenTTD of changes with
-        respect to the mouse pointer, specifically whether the mouse pointer
-        is within the bounds of OpenTTD or not. For example, if you "Alt-Tab"
-        to another application the mouse cursor will still be shown in OpenTTD,
-        and when you move the mouse outside of the OpenTTD window so the cursor
-        gets hidden, open/move another application on top of the OpenTTD window
-        and then Alt-tab back into OpenTTD the cursor will not be shown.
-
-        We cannot fix this problem as SDL simply does not provide the required
-        information in these corner cases. This is a bug in SDL and as such
-        there is little that we can do about it.
-
-Trains might not stop at platforms that are currently being changed [#5553]:
-        If you add tiles to or remove tiles from a platform while a train is
-        approaching to stop at the same platform, that train can miss the place
-        where it's supposed to stop and pass the station without stopping.
-        This is caused by the fact that the train is considered to already
-        have stopped if it's beyond its assigned stopping location. We can't
-        let the train stop just anywhere in the station because then it would
-        never leave the station if you have the same station in the order
-        list multiple times in a row or if there is only one station
-        in theorder list (see #5684).
-
-Some houses and industries are not affected by transparency [#5817]:
-        Some of the default houses and industries (f.e. the iron ore mine) are
-        not affected by the transparency options. This is because the graphics
-        do not (completely) separate the ground from the building.
-        This is a bug of the original graphics, and unfortunately cannot be
-        fixed with OpenGFX for the sake of maintaining compatibility with
-        the original graphics.
-
-Involuntary cargo exchange with cargodist via neutral station [#6114]:
-        When two players serve a neutral station at an industry, a cross-company
-        chain for cargo flow can and will be established which can only be
-        interrupted if one of the players stops competing for the resources of
-        that industry. There is an easy fix for this: If you are loading at the
-        shared station make the order "no unload" and if you're unloading make
-        it "no load". Cargodist will then figure out that it should not create
-        such a route.
-
-Incorrect ending year displayed in end of game newspaper [#8625]
-        The ending year of the game is configurable, but the date displayed in
-        the newspaper at the end of the game is part of the graphics, not text.
-        So to fix this would involve fixing the graphics in every baseset,
-        including the original. Additionally, basesets are free to put this
-        text in different positions (which they do), making a proper solution
-        to this infinitely more complex for a part of the game that fewer than
-        1% of players ever see.

media/baseset/CMakeLists.txt

@@ -18,6 +18,10 @@ set(BASESET_OTHER_SOURCE_FILES
         ${CMAKE_CURRENT_SOURCE_DIR}/opntitle.dat
         ${CMAKE_CURRENT_SOURCE_DIR}/orig_extra.grf
         ${CMAKE_CURRENT_SOURCE_DIR}/../openttd.32.bmp
+        ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Sans.ttf
+        ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Serif.ttf
+        ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Small.ttf
+        ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Mono.ttf
 )
 
 # Done by the subdirectories, if nforenum / grfcodec is installed
@@ -49,6 +53,7 @@ foreach(BASESET_SOURCE_FILE IN LISTS BASESET_SOURCE_FILES)
             MAIN_DEPENDENCY ${BASESET_SOURCE_FILE}
             DEPENDS ${LANG_SOURCE_FILES}
                     ${BASESET_EXTRAGRF_FILE}
+                    ${BASESET_EXTRAGRF_FILE}.hash
                     ${CMAKE_SOURCE_DIR}/cmake/scripts/Baseset.cmake
             WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
             COMMENT "Generating ${BASESET_SOURCE_FILE_NAME} baseset metadata file"
@@ -62,7 +67,7 @@ foreach(BASESET_OTHER_SOURCE_FILE IN LISTS BASESET_OTHER_SOURCE_FILES)
     get_filename_component(BASESET_OTHER_SOURCE_FILE_NAME "${BASESET_OTHER_SOURCE_FILE}" NAME)
     set(BASESET_OTHER_BINARY_FILE "${CMAKE_BINARY_DIR}/baseset/${BASESET_OTHER_SOURCE_FILE_NAME}")
 
-    add_custom_command(OUTPUT ${BASESET_OTHER_BINARY_FILE}
+    add_custom_command_timestamp(OUTPUT ${BASESET_OTHER_BINARY_FILE}
             COMMAND ${CMAKE_COMMAND} -E copy
                     ${BASESET_OTHER_SOURCE_FILE}
                     ${BASESET_OTHER_BINARY_FILE}

media/baseset/OpenTTD-font.md

@@ -0,0 +1,6 @@
+# OpenTTD TrueType font
+
+The OpenTTD TrueType font was created by Zephyris and is maintained on [Github](https://github.com/zephyris/openttd-ttf).
+It is licensed under GPL-2.0.
+
+The currently included files correspond to release v0.6.

media/baseset/openttd.grf.hash

@@ -0,0 +1 @@
+8bc3926cb50e19747de498357417d973

media/baseset/openttd/CMakeLists.txt

@@ -5,5 +5,49 @@
 # working on it / have the tools installed.
 if(GRFCODEC_FOUND)
     include(CreateGrfCommand)
-    create_grf_command()
+    create_grf_command(
+        NFO_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/airports.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/airport_preview.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/aqueduct.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/autorail.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/canals.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/chars.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/elrails.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/foundations.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/mono.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/oneway.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/openttd.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/palette.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/roadstops.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/road_waypoints.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/signals.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/sloped_tracks.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/tramtracks.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/tunnel_portals.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/2ccmap.nfo
+        PNG_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/airports.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/airport_preview.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/aqueduct.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/autorail.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/canals.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/canal_locks.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/chars.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/elrails.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/foundations.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/mono.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/oneway.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_build_tram.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_convert_road.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_convert_tram.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_group_livery.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/roadstops.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/road_waypoints.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/signals.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/sloped_tracks.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/tramtracks.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/tramtracks_bare_depot.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/tunnel_portals.png
+    )
 endif()

media/baseset/openttd/openttd.nfo

@@ -98,3 +98,4 @@
 #include "mono.nfo"
 #include "tunnel_portals.nfo"
 #include "palette.nfo"
+#include "road_waypoints.nfo"

media/baseset/openttd/road_waypoints.nfo

@@ -0,0 +1,14 @@
+// This file is part of OpenTTD.
+// OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
+// OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+// See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+//
+
+   -1 * 0	 0C "Road waypoints"
+//@@LINT OFF
+   -1 * 3 05 19 04
+//@@LINT ON
+   -1 sprites/road_waypoints.png       8bpp   10   10   64   40   -5  -22 normal
+   -1 sprites/road_waypoints.png       8bpp   90   10   64   40  -31   -9 normal
+   -1 sprites/road_waypoints.png       8bpp  170   10   64   35  -31   -4 normal
+   -1 sprites/road_waypoints.png       8bpp  240   10   64   35  -57  -17 normal

media/baseset/orig_extra.grf.hash

@@ -0,0 +1 @@
+5fdc049a7a0ada4c280239f15bc38174

media/baseset/orig_extra/CMakeLists.txt

@@ -6,9 +6,35 @@
 if(GRFCODEC_FOUND)
     include(CreateGrfCommand)
     create_grf_command(
-        # We share some files with 'openttd' grf
+        NFO_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/rivers/arctic.nfo
-        ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/airports.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/rapids.nfo
-        ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/canals.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/temperate.nfo
-        ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/chars.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland_rapids.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/tropic.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/airports_orig_extra.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/canals_extra.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/chars_orig_extra.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/fix_graphics.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/fix_gui_icons.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/orig_extra.nfo
+                         ${CMAKE_CURRENT_SOURCE_DIR}/shore.nfo
+        PNG_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/rivers/arctic_brown.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/arctic_snowy.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/rapids.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/rapids_shading.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/temperate.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland_rapids.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland_rapids_shading.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/tropic_desert.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/rivers/tropic_forest.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/fix_graphics.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/fix_gui_icons.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/shore.png
+                         # We share some files with 'openttd' grf
+                         ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/airports.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/canals.png
+                         ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/chars.png
     )
 endif()

media/baseset/orig_extra/orig_extra.nfo

@@ -79,6 +79,7 @@
 #include "airports_orig_extra.nfo"
 #include "canals_extra.nfo"
 #include "rivers/rapids.nfo"
+#include "rivers/toyland_rapids.nfo"
 #include "rivers/temperate.nfo"
 #include "rivers/arctic.nfo"
 #include "rivers/tropic.nfo"

media/baseset/orig_extra/rivers/rapids.nfo

@@ -5,115 +5,243 @@
 //
    -1 * 0	 0C "Rapid graphics"
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10   10  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10   10  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90   10  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10   10  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170   10  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10   10
-   -1 sprites/rapids.png 8bpp 250   10  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90   10  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90   10  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90   10
+   -1 sprites/rapids.png          8bpp 170   10  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170   10  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170   10
+   -1 sprites/rapids.png          8bpp 250   10  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250   10  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250   10
    -1 * 7	 02 05 00 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10   60  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10   60  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90   60  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10   60  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170   60  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10   60
-   -1 sprites/rapids.png 8bpp 250   60  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90   60  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90   60  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90   60
+   -1 sprites/rapids.png          8bpp 170   60  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170   60  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170   60
+   -1 sprites/rapids.png          8bpp 250   60  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250   60  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250   60
    -1 * 7	 02 05 01 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  110  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  110  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  110  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  110  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  110  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  110
-   -1 sprites/rapids.png 8bpp 250  110  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  110  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  110  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  110
+   -1 sprites/rapids.png          8bpp 170  110  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  110  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  110
+   -1 sprites/rapids.png          8bpp 250  110  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  110  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  110
    -1 * 7	 02 05 02 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  160  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  160  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  160  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  160  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  160  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  160
-   -1 sprites/rapids.png 8bpp 250  160  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  160  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  160  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  160
+   -1 sprites/rapids.png          8bpp 170  160  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  160  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  160
+   -1 sprites/rapids.png          8bpp 250  160  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  160  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  160
    -1 * 7	 02 05 03 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  210  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  210  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  210  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  210  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  210  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  210
-   -1 sprites/rapids.png 8bpp 250  210  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  210  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  210  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  210
+   -1 sprites/rapids.png          8bpp 170  210  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  210  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  210
+   -1 sprites/rapids.png          8bpp 250  210  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  210  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  210
    -1 * 7	 02 05 04 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  260  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  260  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  260  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  260  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  260  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  260
-   -1 sprites/rapids.png 8bpp 250  260  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  260  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  260  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  260
+   -1 sprites/rapids.png          8bpp 170  260  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  260  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  260
+   -1 sprites/rapids.png          8bpp 250  260  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  260  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  260
    -1 * 7	 02 05 05 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  310  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  310  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  310  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  310  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  310  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  310
-   -1 sprites/rapids.png 8bpp 250  310  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  310  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  310  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  310
+   -1 sprites/rapids.png          8bpp 170  310  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  310  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  310
+   -1 sprites/rapids.png          8bpp 250  310  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  310  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  310
    -1 * 7	 02 05 06 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  360  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  360  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  360  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  360  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  360  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  360
-   -1 sprites/rapids.png 8bpp 250  360  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  360  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  360  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  360
+   -1 sprites/rapids.png          8bpp 170  360  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  360  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  360
+   -1 sprites/rapids.png          8bpp 250  360  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  360  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  360
    -1 * 7	 02 05 07 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  410  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  410  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  410  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  410  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  410  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  410
-   -1 sprites/rapids.png 8bpp 250  410  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  410  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  410  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  410
+   -1 sprites/rapids.png          8bpp 170  410  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  410  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  410
+   -1 sprites/rapids.png          8bpp 250  410  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  410  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  410
    -1 * 7	 02 05 08 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  460  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  460  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  460  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  460  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  460  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  460
-   -1 sprites/rapids.png 8bpp 250  460  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  460  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  460  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  460
+   -1 sprites/rapids.png          8bpp 170  460  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  460  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  460
+   -1 sprites/rapids.png          8bpp 250  460  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  460  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  460
    -1 * 7	 02 05 09 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  510  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  510  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  510  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  510  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  510  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  510
-   -1 sprites/rapids.png 8bpp 250  510  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  510  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  510  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  510
+   -1 sprites/rapids.png          8bpp 170  510  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  510  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  510
+   -1 sprites/rapids.png          8bpp 250  510  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  510  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  510
    -1 * 7	 02 05 0A 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  560  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  560  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  560  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  560  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  560  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  560
-   -1 sprites/rapids.png 8bpp 250  560  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  560  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  560  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  560
+   -1 sprites/rapids.png          8bpp 170  560  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  560  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  560
+   -1 sprites/rapids.png          8bpp 250  560  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  560  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  560
    -1 * 7	 02 05 0B 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  610  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  610  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  610  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  610  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  610  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  610
-   -1 sprites/rapids.png 8bpp 250  610  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  610  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  610  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  610
+   -1 sprites/rapids.png          8bpp 170  610  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  610  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  610
+   -1 sprites/rapids.png          8bpp 250  610  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  610  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  610
    -1 * 7	 02 05 0C 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  660  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  660  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  660  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  660  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  660  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  660
-   -1 sprites/rapids.png 8bpp 250  660  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  660  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  660  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  660
+   -1 sprites/rapids.png          8bpp 170  660  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  660  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  660
+   -1 sprites/rapids.png          8bpp 250  660  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  660  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  660
    -1 * 7	 02 05 0D 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  710  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  710  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  710  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  710  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  710  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  710
-   -1 sprites/rapids.png 8bpp 250  710  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  710  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  710  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  710
+   -1 sprites/rapids.png          8bpp 170  710  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  710  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  710
+   -1 sprites/rapids.png          8bpp 250  710  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  710  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  710
    -1 * 7	 02 05 0E 01 00 00 00
 
    -1 * 4	 01 05 01 04
-   -1 sprites/rapids.png 8bpp  10  760  64  23 -31   0 normal
+   -1 sprites/rapids.png          8bpp  10  760  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp  90  760  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  10  760  64  23 -31   0 normal
-   -1 sprites/rapids.png 8bpp 170  760  64  23 -31   0 normal
+    | sprites/rapids.png          mask  10  760
-   -1 sprites/rapids.png 8bpp 250  760  64  39 -31  -8 normal
+   -1 sprites/rapids.png          8bpp  90  760  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp  90  760  64  39 -31  -8 normal
+    | sprites/rapids.png          mask  90  760
+   -1 sprites/rapids.png          8bpp 170  760  64  23 -31   0 normal
+    | sprites/rapids_shading.png 32bpp 170  760  64  23 -31   0 normal
+    | sprites/rapids.png          mask 170  760
+   -1 sprites/rapids.png          8bpp 250  760  64  39 -31  -8 normal
+    | sprites/rapids_shading.png 32bpp 250  760  64  39 -31  -8 normal
+    | sprites/rapids.png          mask 250  760
    -1 * 7	 02 05 0F 01 00 00 00
 
    -1 * 39	 02 05 10 80 00 01 10

media/baseset/orig_extra/rivers/toyland.nfo

@@ -3,7 +3,7 @@
 // OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 // See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 //
-   -1 * 0	 0C "Toyland river graphics by andythenorth (Andrew Parkhouse)"
+   -1 * 0	 0C "Toyland river graphics by zephyris (Richard Wheeler)"
    -1 * 4	 01 05 01 3C
    -1 sprites/toyland.png 8bpp  10   10  38  19  -5   0 normal
    -1 sprites/toyland.png 8bpp  58   10  38  18  -5  13 normal

media/baseset/orig_extra/rivers/toyland_rapids.nfo

@@ -0,0 +1,73 @@
+// This file is part of OpenTTD.
+// OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
+// OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+// See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+//
+   -1 * 0	 0C "Toyland rapid graphics by zephyris (Richard Wheeler)"
+   -1 * 4	 01 05 01 04
+   -1 sprites/toyland_rapids.png          8bpp  10   10  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp  10   10  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask  10   10
+   -1 sprites/toyland_rapids.png          8bpp  90   10  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp  90   10  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask  90   10
+   -1 sprites/toyland_rapids.png          8bpp 170   10  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp 170   10  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask 170   10
+   -1 sprites/toyland_rapids.png          8bpp 250   10  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp 250   10  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask 250   10
+   -1 * 7	 02 05 00 01 00 00 00
+
+   -1 * 4	 01 05 01 04
+   -1 sprites/toyland_rapids.png          8bpp  10   60  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp  10   60  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask  10   60
+   -1 sprites/toyland_rapids.png          8bpp  90   60  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp  90   60  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask  90   60
+   -1 sprites/toyland_rapids.png          8bpp 170   60  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp 170   60  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask 170   60
+   -1 sprites/toyland_rapids.png          8bpp 250   60  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp 250   60  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask 250   60
+   -1 * 7	 02 05 01 01 00 00 00
+
+   -1 * 4	 01 05 01 04
+   -1 sprites/toyland_rapids.png          8bpp  10  110  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp  10  110  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask  10  110
+   -1 sprites/toyland_rapids.png          8bpp  90  110  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp  90  110  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask  90  110
+   -1 sprites/toyland_rapids.png          8bpp 170  110  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp 170  110  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask 170  110
+   -1 sprites/toyland_rapids.png          8bpp 250  110  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp 250  110  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask 250  110
+   -1 * 7	 02 05 02 01 00 00 00
+
+   -1 * 4	 01 05 01 04
+   -1 sprites/toyland_rapids.png          8bpp  10  160  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp  10  160  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask  10  160
+   -1 sprites/toyland_rapids.png          8bpp  90  160  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp  90  160  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask  90  160
+   -1 sprites/toyland_rapids.png          8bpp 170  160  64  23 -31   0 normal
+    | sprites/toyland_rapids_shading.png 32bpp 170  160  64  23 -31   0 normal
+    | sprites/toyland_rapids.png          mask 170  160
+   -1 sprites/toyland_rapids.png          8bpp 250  160  64  39 -31  -8 normal
+    | sprites/toyland_rapids_shading.png 32bpp 250  160  64  39 -31  -8 normal
+    | sprites/toyland_rapids.png          mask 250  160
+   -1 * 7	 02 05 03 01 00 00 00
+
+   -1 * 39	 02 05 10 80 00 01 04
+            00 00
+            01 00
+            02 00
+            03 00
+    -1 * 6	 07 83 01 \7! 03 01
+    -1 * 7	 03 05 01 05 00 10 00