Update: Changelog for 15.1 (#15164)

Invalidate vehicle view window when the vehicle chain is changed.

Co-authored-by: Abigail <abigailthomsonhicks@gmail.com>

.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

@@ -50,7 +50,6 @@ Describe here
 Some things are not automated, and forgotten often. This list is a reminder for the reviewers.
 * The bug fix is important enough to be backported? (label: 'backport requested')
 * This PR touches english.txt or translations? Check the [guidelines](https://github.com/OpenTTD/OpenTTD/blob/master/docs/eints.md)
-* This PR affects the save game format? (label 'savegame upgrade')
 * This PR affects the GS/AI API? (label 'needs review: Script API')
     * ai_changelog.hpp, game_changelog.hpp need updating.
     * The compatibility wrappers (compat_*.nut) need updating.

.github/changelog.py

@@ -0,0 +1,36 @@
+import sys
+
+"""
+This script assumes changelogs use the following format:
+    ## <major>.x (eg. "## 15.x") to indicate a major version series
+    ### <major>.<minor>[-<suffix>] <date etc> (eg. "## 15.0 (2025-04-01)", "### 15.1-beta1 (2024-12-25)") to indicate an individual version
+"""
+
+def main():
+    current_version = sys.argv[1]
+    stable_version = current_version.split("-")[0]
+    major_version = current_version.split(".")[0]
+    # set when current version is found
+    current_found = False
+
+    with open("changelog.md", "r") as file:
+        for line in file:
+            if line.startswith("### "):
+                if not line.startswith(f"### {current_version} ") and not current_found:
+                    # First version in changelog should be the current one
+                    sys.stderr.write(f"Changelog doesn't start with current version ({current_version})\n")
+                    sys.exit(1)
+                if not line.startswith(f"### {stable_version}"):
+                    # Reached a previous stable version
+                    break
+                if line.startswith(f"### {current_version} "):
+                    current_found = True
+            elif line.startswith("## "):
+                if not line.startswith(f"## {major_version}.x"):
+                    # Reached a previous major version
+                    break
+
+            print(line.rstrip())
+
+if __name__ == '__main__':
+    main()

.github/changelog.sh

@@ -1,16 +0,0 @@
-#!/bin/sh
-
-tag=$(git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null | sed 's@\^0$@@')
-
-# 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/ .*//')
-    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 }'
-    exit 0
-fi
-
-# In all other cases, show the git log of the last 7 days
-revdate=$(git log -1 --pretty=format:"%ci")
-last_week=$(date -d "$revdate -7days" +"%Y-%m-%d %H:%M")
-git log --after="${last_week}" --pretty=fuller

.github/codeql/codeql-config.yml

@@ -10,3 +10,5 @@ query-filters:
     - cpp/irregular-enum-init
     # Our GUI code tends to use switches for OnClick handlers, DrawWidget, and UpdateWidgetSize. Sometimes GUIs just don't have many elements, but we want to keep consistency.
     - cpp/trivial-switch
+    # Our (GUI) code tends to use long switches.
+    - cpp/long-switch

.github/dependabot.yml

@@ -8,3 +8,5 @@ updates:
     actions:
       patterns:
       - "*"
+  commit-message:
+    prefix: "Upgrade: "

.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
@@ -170,7 +158,7 @@ def scan_source_files(path, strings_found):
         # Most files we can just open, but some use magic, that requires the
         # G++ preprocessor before we can make sense out of it.
         if new_path == "src/table/cargo_const.h":
-            p = subprocess.run(["g++", "-E", new_path], stdout=subprocess.PIPE)
+            p = subprocess.run(["g++", "-E", "-DCHECK_UNUSED_STRINGS", new_path], stdout=subprocess.PIPE)
             output = p.stdout.decode()
         else:
             with open(new_path) as fp:

.github/workflows/ci-build.yml

@@ -1,4 +1,4 @@
-name: CI
+name: CI - Build
 
 on:
   pull_request:
@@ -17,79 +17,22 @@ jobs:
   emscripten:
     name: Emscripten
 
-    runs-on: ubuntu-20.04
-    container:
-      # 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@v4
-
-    - name: Setup cache
-      uses: actions/cache@v4
-      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::"
+    uses: ./.github/workflows/ci-emscripten.yml
+    secrets: inherit
 
   linux:
     strategy:
       fail-fast: false
       matrix:
         include:
-        - name: Clang - Debug
-          compiler: clang-15
-          cxxcompiler: clang++-15
+        - name: Clang
+          compiler: clang
+          cxxcompiler: clang++
           libraries: libsdl2-dev
-        - name: Clang - Release
-          compiler: clang-15
-          cxxcompiler: clang++-15
-          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++
@@ -99,332 +42,54 @@ jobs:
 
     name: Linux (${{ matrix.name }})
 
-    runs-on: ubuntu-latest
-    env:
-      CC: ${{ matrix.compiler }}
-      CXX: ${{ matrix.cxxcompiler }}
+    uses: ./.github/workflows/ci-linux.yml
+    secrets: inherit
 
-    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
-        ./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 \
-          ${{ matrix.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.
-        ./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=${GITHUB_WORKSPACE}/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
-        )
-
-        # Re-enable vcpkg.
-        mv vcpkg-disabled.json vcpkg.json
-
-        # Check no tracked files have been modified.
-        git diff --exit-code
+    with:
+      compiler: ${{ matrix.compiler }}
+      cxxcompiler: ${{ matrix.cxxcompiler }}
+      libraries: ${{ matrix.libraries }}
+      extra-cmake-parameters: ${{ matrix.extra-cmake-parameters }}
 
   macos:
     strategy:
       fail-fast: false
       matrix:
         include:
-        - arch: arm64
+        - name: arm64 - Debug
+          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-14
-    env:
-      MACOSX_DEPLOYMENT_TARGET: 10.13
+    uses: ./.github/workflows/ci-macos.yml
+    secrets: inherit
 
-    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
-        ./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=${{ matrix.full_arch }} \
-          -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-osx \
-          -DCMAKE_TOOLCHAIN_FILE=${GITHUB_WORKSPACE}/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
+    with:
+      arch: ${{ matrix.arch }}
+      full_arch: ${{ matrix.full_arch }}
+      extra-cmake-parameters: ${{ matrix.extra-cmake-parameters }}
 
   windows:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [windows-latest]
-        arch: [x86, x64]
-
-    name: Windows (${{ matrix.os }} / ${{ matrix.arch }})
-
-    runs-on: ${{ matrix.os }}
-
-    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
-        .\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 ${{ 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="${GITHUB_WORKSPACE}\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_64
-          - msystem: MINGW32
-            arch: i686
+        - arch: x86
+        - arch: x64
 
-    name: MinGW (${{ matrix.arch }})
+    name: Windows (${{ matrix.arch }})
 
-    runs-on: windows-latest
+    uses: ./.github/workflows/ci-windows.yml
+    secrets: inherit
 
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - 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
+    with:
+      arch: ${{ matrix.arch }}
 
   check_annotations:
     name: Check Annotations
@@ -433,7 +98,6 @@ jobs:
     - linux
     - macos
     - windows
-    - msys2
 
     if: always() && github.event_name == 'pull_request'
 
@@ -441,4 +105,4 @@ jobs:
 
     steps:
     - name: Check annotations
-      uses: OpenTTD/actions/annotation-check@v5
+      uses: OpenTTD/actions/annotation-check@v6

.github/workflows/ci-emscripten.yml

@@ -0,0 +1,75 @@
+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 numbers in the cache step,
+      # .github/workflows/preview-build.yml (2x) and os/emscripten/Dockerfile too.
+      image: emscripten/emsdk:3.1.57
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+
+    - name: Fix dubious ownership
+      run: |
+        git config --global --add safe.directory ${GITHUB_WORKSPACE}
+
+    - name: Update to modern GCC
+      run: |
+        apt-get update
+        apt-get install -y gcc-12 g++-12
+        update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 100
+        update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-12 100
+
+    - name: Setup cache
+      uses: actions/cache@v4
+      with:
+        # If you change this version, change the numbers in the image configuration step,
+        # .github/workflows/preview-build.yml (2x) and os/emscripten/Dockerfile too.
+        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,117 @@
+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@v6
+
+    - name: Setup vcpkg
+      id: vcpkg
+      uses: OpenTTD/actions/setup-vcpkg@v6
+
+    - 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.
+        ${{ steps.vcpkg.outputs.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,81 @@
+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@v6
+
+    - name: Setup vcpkg
+      id: vcpkg
+      uses: OpenTTD/actions/setup-vcpkg@v6
+
+    - 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=${{ steps.vcpkg.outputs.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@v6
+
+    - 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,60 @@
+name: CI - Nightly
+
+on:
+  schedule:
+  - cron: '0 3 * * *'
+  workflow_dispatch:
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+
+jobs:
+  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:
+    - macos
+    - mingw
+
+    if: always()
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check annotations
+      uses: OpenTTD/actions/annotation-check@v6

.github/workflows/ci-windows.yml

@@ -0,0 +1,75 @@
+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@v6
+
+    - name: Setup vcpkg
+      id: vcpkg
+      uses: OpenTTD/actions/setup-vcpkg@v6
+
+    - 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="${{ steps.vcpkg.outputs.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

@@ -21,10 +21,15 @@ jobs:
       actions: read
       contents: read
       security-events: write
+      packages: read
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
+
+    - name: Setup vcpkg
+      id: vcpkg
+      uses: OpenTTD/actions/setup-vcpkg@v6
 
     - name: Install dependencies
       run: |
@@ -41,28 +46,52 @@ 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.
+        ${{ steps.vcpkg.outputs.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@v3
+      uses: github/codeql-action/init@v4
       with:
         languages: cpp
         config-file: ./.github/codeql/codeql-config.yml
+        trap-caching: false
 
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+    - name: Build
+      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@v3
+      uses: github/codeql-action/analyze@v4
       with:
         category: /language:cpp
         upload: False
@@ -80,6 +109,6 @@ jobs:
         output: sarif-results/cpp.sarif
 
     - name: Upload results
-      uses: github/codeql-action/upload-sarif@v3
+      uses: github/codeql-action/upload-sarif@v4
       with:
         sarif_file: sarif-results/cpp.sarif

.github/workflows/commit-checker.yml

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

.github/workflows/preview-build.yml

@@ -20,12 +20,13 @@ 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
+      # If you change this version, change the numbers in the cache step,
+      # .github/workflows/ci-emscripten.yml (2x) and os/emscripten/Dockerfile too.
+      image: emscripten/emsdk:3.1.57
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
       with:
         ref: ${{ github.event.pull_request.head.sha }}
 
@@ -34,16 +35,24 @@ jobs:
         git config --global --add safe.directory ${GITHUB_WORKSPACE}
         git checkout -b pr${{ github.event.pull_request.number }}
 
+    - name: Update to modern GCC
+      run: |
+        apt-get update
+        apt-get install -y gcc-12 g++-12
+        update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 100
+        update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-12 100
+
     - name: Setup cache
       uses: actions/cache@v4
       with:
         path: /emsdk/upstream/emscripten/cache
-        key: 3.1.42-${{ runner.os }}
+        # If you change this version, change the numbers in the image configuration step,
+        # .github/workflows/ci-emscripten.yml (2x) and os/emscripten/Dockerfile too.
+        key: 3.1.57-${{ runner.os }}
 
-    - name: Patch Emscripten to support LZMA
+    - name: Add liblzma support
       run: |
-        cd /emsdk/upstream/emscripten
-        patch -p1 < ${GITHUB_WORKSPACE}/os/emscripten/emsdk-liblzma.patch
+        cp ${GITHUB_WORKSPACE}/os/emscripten/ports/liblzma.py /emsdk/upstream/emscripten/tools/ports/contrib/
 
     - name: Build (host tools)
       run: |

.github/workflows/rebase-checker.yml

@@ -0,0 +1,19 @@
+name: "Update 'work: needs rebase' label status"
+on:
+  # So that PRs touching the same files as the push are updated
+  push:
+  # So that the `dirtyLabel` is removed if conflicts are resolve
+  # We recommend `pull_request_target` so that github secrets are available.
+  # In `pull_request` we wouldn't be able to change labels of fork PRs
+  pull_request_target:
+    types: [synchronize]
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: check if prs are in need of a rebase
+        uses: eps1lon/actions-label-merge-conflict@v3
+        with:
+          dirtyLabel: "work: needs rebase"
+          repoToken: "${{ secrets.GITHUB_TOKEN }}"

.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@v4
+      uses: actions/download-artifact@v6
       with:
         name: internal-source
 
@@ -78,7 +78,7 @@ jobs:
         echo "::endgroup::"
 
     - name: Store bundles
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: openttd-docs
         path: build/bundles/*.tar.xz

.github/workflows/release-linux.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: internal-source
 
@@ -35,14 +35,6 @@ 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 dependencies
       run: |
         echo "::group::Install system dependencies"
@@ -71,10 +63,10 @@ jobs:
         # dependencies as possible. We do it before anything else is installed,
         # to make sure it doesn't pick up on any of the drivers.
         echo "::group::Install fluidsynth"
-        wget https://github.com/FluidSynth/fluidsynth/archive/v2.3.3.tar.gz
-        tar xf v2.3.3.tar.gz
+        wget https://github.com/FluidSynth/fluidsynth/archive/v2.4.4.tar.gz
+        tar xf v2.4.4.tar.gz
         (
-          cd fluidsynth-2.3.3
+          cd fluidsynth-2.4.4
           mkdir build
           cd build
           cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_INSTALL_PREFIX=/usr
@@ -113,20 +105,17 @@ jobs:
           # EOF
         echo "::endgroup::"
 
-        # We use vcpkg for our dependencies, to get more up-to-date version.
-        echo "::group::Install vcpkg and dependencies"
-
-        git clone https://github.com/microsoft/vcpkg /vcpkg
-
-        (
-          cd /vcpkg
-          ./bootstrap-vcpkg.sh -disableMetrics
-        )
-
         echo "::group::Install breakpad dependencies"
         cargo install --locked dump_syms
         echo "::endgroup::"
 
+    - name: Setup vcpkg
+      id: vcpkg
+      uses: OpenTTD/actions/setup-vcpkg@v6
+      with:
+        vcpkg-location: /vcpkg
+        mono-install-command: 'yum install -y mono-complete'
+
     - name: Install GCC problem matcher
       uses: ammaraskar/gcc-problem-matcher@master
 
@@ -137,7 +126,7 @@ jobs:
 
         echo "::group::CMake"
         cmake ${GITHUB_WORKSPACE} \
-          -DCMAKE_TOOLCHAIN_FILE=/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          -DCMAKE_TOOLCHAIN_FILE=${{ steps.vcpkg.outputs.vcpkg-cmake }} \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
           -DOPTION_PACKAGE_DEPENDENCIES=ON \
@@ -168,14 +157,14 @@ jobs:
         echo "::endgroup::"
 
     - name: Store bundles
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: openttd-linux-generic
         path: build/bundles
         retention-days: 5
 
     - name: Store symbols
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: symbols-linux-generic
         path: build/symbols

.github/workflows/release-macos.yml

@@ -12,7 +12,7 @@ jobs:
   macos:
     name: MacOS
 
-    runs-on: macos-14
+    runs-on: macos-latest
     env:
       MACOSX_DEPLOYMENT_TARGET: 10.13
 
@@ -23,7 +23,7 @@ jobs:
         xcode-version: latest-stable
 
     - name: Download source
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: internal-source
 
@@ -37,18 +37,9 @@ 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: Setup vcpkg
+      id: vcpkg
+      uses: OpenTTD/actions/setup-vcpkg@v6
 
     - name: Install dependencies
       env:
@@ -86,7 +77,7 @@ jobs:
         echo "::endgroup::"
 
     - name: Import code signing certificates
-      uses: Apple-Actions/import-codesign-certs@v2
+      uses: Apple-Actions/import-codesign-certs@v5
       with:
         # The certificates in a PKCS12 file encoded as a base64 string
         p12-file-base64: ${{ secrets.APPLE_DEVELOPER_CERTIFICATE_P12_BASE64 }}
@@ -104,7 +95,7 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -DCMAKE_OSX_ARCHITECTURES=arm64 \
           -DVCPKG_TARGET_TRIPLET=arm64-osx \
-          -DCMAKE_TOOLCHAIN_FILE=${{ runner.temp }}/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          -DCMAKE_TOOLCHAIN_FILE=${{ steps.vcpkg.outputs.vcpkg-cmake }} \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
@@ -125,7 +116,7 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -DCMAKE_OSX_ARCHITECTURES=x86_64 \
           -DVCPKG_TARGET_TRIPLET=x64-osx \
-          -DCMAKE_TOOLCHAIN_FILE=${{ runner.temp }}/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          -DCMAKE_TOOLCHAIN_FILE=${{ steps.vcpkg.outputs.vcpkg-cmake }} \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
@@ -212,14 +203,14 @@ jobs:
         mv _CPack_Packages/*/Bundle/openttd-*.zip bundles/
 
     - name: Store bundles
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: openttd-macos-universal
         path: build-x64/bundles
         retention-days: 5
 
     - name: Store symbols
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       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@v4
+      uses: actions/checkout@v6
       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@v4
+      uses: actions/checkout@v6
       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@v4
+      uses: actions/checkout@v6
       with:
         ref: ${{ github.event.client_payload.ref }}
         # We generate a changelog; for this we need the full git log.
@@ -90,10 +90,10 @@ jobs:
 
     - name: Generate metadata
       id: metadata
+      shell: bash
       run: |
         echo "::group::Prepare metadata files"
         cmake -DGENERATE_OTTDREV=1 -P cmake/scripts/FindVersion.cmake
-        ./.github/changelog.sh > .changelog
         TZ='UTC' date +"%Y-%m-%d %H:%M UTC" > .release_date
         cat .ottdrev | cut -f 1 -d$'\t' > .version
 
@@ -103,6 +103,8 @@ jobs:
 
           FOLDER="${{ env.FOLDER_RELEASES }}"
           TRIGGER_TYPE="new-tag"
+
+          python3 ./.github/changelog.py "$(cat .version)" > .changelog
         else
           IS_TAG="false"
 
@@ -124,10 +126,17 @@ jobs:
             FOLDER="${{ env.FOLDER_BRANCHES }}/${BRANCH}"
             TRIGGER_TYPE="new-branch"
           fi
+
+          # For nightlies / branches, use the git log of the last 7 days as changelog.
+          revdate=$(git log -1 --pretty=format:"%ci")
+          last_week=$(date -d "$revdate -7days" +"%Y-%m-%d %H:%M")
+          echo "## Version $(cat .version) - changes since ${last_week}" > .changelog
+          echo "" >> .changelog
+          git log --oneline --after="${last_week}" >> .changelog
         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 +202,14 @@ jobs:
         echo "::endgroup::"
 
     - name: Store bundles
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: openttd-source
         path: build/bundles/*
         retention-days: 5
 
     - name: Store source (for other jobs)
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       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@v4
+      uses: actions/download-artifact@v6
       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@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-windows-x86
 
     - name: Download x64 build
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-windows-x64
 
     - name: Download arm64 build
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-windows-arm64
 
@@ -74,16 +74,16 @@ jobs:
         mkdir -p builds/common-binaries/baseset
         cd builds/common-binaries/baseset
 
-        echo "::group::Download OpenGFX"
-        curl -L https://cdn.openttd.org/opengfx-releases/7.1/opengfx-7.1-all.zip -o opengfx-all.zip
+        echo "::group::Download OpenGFX2"
+        curl -L https://cdn.openttd.org/opengfx2_classic-releases/0.8/opengfx2_classic-0.8-all.zip -o opengfx2_classic.zip
         echo "::endgroup::"
 
-        echo "::group::Unpack OpenGFX"
-        unzip opengfx-all.zip
-        tar xf opengfx-*.tar
+        echo "::group::Unpack OpenGFX2"
+        unzip opengfx2_classic.zip
+        tar xf OpenGFX2_Classic-0.8.tar
         echo "::endgroup::"
 
-        rm -f opengfx-all.zip opengfx-*.tar
+        rm -f opengfx2_classic.zip OpenGFX2_Classic-0.8.tar
 
     - name: Install OpenMSX
       shell: bash
@@ -185,7 +185,7 @@ jobs:
         move output\OpenTTD.appxbundle bundles\internal\openttd-${{ inputs.version }}-windows-store.appxbundle
 
     - name: Store bundles
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       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@v4
+      uses: actions/download-artifact@v6
       with:
         name: internal-source
 
@@ -45,24 +45,15 @@ 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: Setup vcpkg
+      id: vcpkg
+      uses: OpenTTD/actions/setup-vcpkg@v6
 
     - name: Install dependencies
       shell: bash
       run: |
         echo "::group::Install choco dependencies"
-        choco install pandoc
+        choco install pandoc nsis
         echo "::endgroup::"
 
         echo "::group::Install breakpad dependencies"
@@ -111,7 +102,7 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -GNinja \
           -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
-          -DCMAKE_TOOLCHAIN_FILE="${{ runner.temp }}\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          -DCMAKE_TOOLCHAIN_FILE="${{ steps.vcpkg.outputs.vcpkg-cmake }}" \
           -DOPTION_USE_NSIS=ON \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
@@ -141,7 +132,7 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -GNinja \
           -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
-          -DCMAKE_TOOLCHAIN_FILE="${{ runner.temp }}\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          -DCMAKE_TOOLCHAIN_FILE="${{ steps.vcpkg.outputs.vcpkg-cmake }}" \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
           -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
@@ -202,14 +193,14 @@ jobs:
         AZURE_CODESIGN_PROFILE_NAME: ${{ secrets.AZURE_CODESIGN_PROFILE_NAME }}
 
     - name: Store bundles
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: openttd-windows-${{ matrix.arch }}
         path: build/bundles
         retention-days: 5
 
     - name: Store symbols
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: symbols-windows-${{ matrix.arch }}
         path: build/symbols

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

@@ -14,7 +14,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - 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@v4
+      uses: actions/checkout@v6
 
     - 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@v4
+      uses: actions/download-artifact@v6
 
     - name: Calculate checksums
       run: |
@@ -70,14 +70,14 @@ jobs:
         done
 
     - name: Store bundles
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: cdn-bundles
         path: bundles/*
         retention-days: 5
 
     - name: Store breakpad symbols
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: cdn-symbols
         path: symbols/*
@@ -88,7 +88,7 @@ jobs:
     - prepare
 
     name: Publish bundles
-    uses: OpenTTD/actions/.github/workflows/rw-cdn-upload.yml@v5
+    uses: OpenTTD/actions/.github/workflows/rw-cdn-upload.yml@v6
     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@v5
+    uses: OpenTTD/actions/.github/workflows/rw-symbols-upload.yml@v6
     secrets:
       SYMBOLS_SIGNING_KEY: ${{ secrets.SYMBOLS_SIGNING_KEY }}
     with:
@@ -130,7 +130,7 @@ jobs:
         installation_retrieval_payload: "OpenTTD/workflows"
 
     - name: Trigger 'Publish Docs'
-      uses: peter-evans/repository-dispatch@v3
+      uses: peter-evans/repository-dispatch@v4
       with:
         token: ${{ steps.generate_token.outputs.token }}
         repository: OpenTTD/workflows

.github/workflows/upload-gog.yml

@@ -11,44 +11,43 @@ jobs:
   upload:
     name: Upload (GOG)
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - name: Download source
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: internal-source
         path: internal-source
 
     - name: Download bundle (Windows x86)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-windows-x86
         path: openttd-windows-x86
 
     - name: Download bundle (Windows x64)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-windows-x64
         path: openttd-windows-x64
 
     - name: Download bundle (MacOS)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-macos-universal
         path: openttd-macos-universal
 
     - name: Download bundle (Linux)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-linux-generic
         path: openttd-linux-generic
 
     - name: Install GOG Galaxy Build Creator
       run: |
-        wget https://cdn.gog.com/open/galaxy/pipeline/build_creator/gnu-linux/GOGGalaxyBuildCreator-1.4.0.AppImage
-        7z x GOGGalaxyBuildCreator-1.4.0.AppImage
-        chmod +x ./app/GOGGalaxyPipelineBuilder
+        wget https://cdn.gog.com/open/galaxy/pipeline/10.6.7.17/gnu-linux/GOGGalaxyPipelineBuilder
+        chmod +x ./GOGGalaxyPipelineBuilder
 
     - name: Install OpenGFX
       shell: bash
@@ -56,15 +55,16 @@ jobs:
         mkdir -p gog/opengfx/baseset
         cd gog/opengfx/baseset
 
-        echo "::group::Download OpenGFX"
-        curl -L https://cdn.openttd.org/opengfx-releases/7.1/opengfx-7.1-all.zip -o opengfx-all.zip
+        echo "::group::Download OpenGFX2"
+        curl -L https://cdn.openttd.org/opengfx2_classic-releases/0.8/opengfx2_classic-0.8-all.zip -o opengfx2_classic.zip
         echo "::endgroup::"
 
-        echo "::group::Unpack OpenGFX"
-        unzip opengfx-all.zip
+        echo "::group::Unpack OpenGFX2"
+        unzip opengfx2_classic.zip
+        tar xf OpenGFX2_Classic-0.8.tar
         echo "::endgroup::"
 
-        rm -f opengfx-all.zip
+        rm -f opengfx2_classic.zip OpenGFX2_Classic-0.8.tar
 
     - name: Install OpenMSX
       shell: bash
@@ -76,7 +76,7 @@ jobs:
         curl -L https://cdn.openttd.org/openmsx-releases/0.4.2/openmsx-0.4.2-all.zip -o openmsx-all.zip
         echo "::endgroup::"
 
-        echo "::group::Unpack OpenGFX"
+        echo "::group::Unpack OpenMSX"
         unzip openmsx-all.zip
         tar xf openmsx-*.tar
         echo "::endgroup::"
@@ -144,8 +144,8 @@ jobs:
           echo "::endgroup::"
 
           echo "::group::Upload to GOG"
-          ../app/GOGGalaxyPipelineBuilder build-game --username "${{ secrets.GOG_USERNAME }}" --password "${{ secrets.GOG_PASSWORD }}" --branch Testing windows.json
-          ../app/GOGGalaxyPipelineBuilder build-game --username "${{ secrets.GOG_USERNAME }}" --password "${{ secrets.GOG_PASSWORD }}" --branch Testing macos.json
-          ../app/GOGGalaxyPipelineBuilder build-game --username "${{ secrets.GOG_USERNAME }}" --password "${{ secrets.GOG_PASSWORD }}" --branch Testing linux.json
+          ../GOGGalaxyPipelineBuilder build-game --username "${{ secrets.GOG_USERNAME }}" --password "${{ secrets.GOG_PASSWORD }}" --branch Testing windows.json
+          ../GOGGalaxyPipelineBuilder build-game --username "${{ secrets.GOG_USERNAME }}" --password "${{ secrets.GOG_PASSWORD }}" --branch Testing macos.json
+          ../GOGGalaxyPipelineBuilder build-game --username "${{ secrets.GOG_USERNAME }}" --password "${{ secrets.GOG_PASSWORD }}" --branch Testing linux.json
           echo "::endgroup::"
         )

.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@v4
+      uses: actions/download-artifact@v6
       with:
         name: internal-source
         path: internal-source
 
     - name: Download bundle (Windows x86)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-windows-x86
         path: openttd-windows-x86
 
     - name: Download bundle (Windows x64)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-windows-x64
         path: openttd-windows-x64
 
     - name: Download bundle (MacOS)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-macos-universal
         path: openttd-macos-universal
 
     - name: Download bundle (Linux)
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: openttd-linux-generic
         path: openttd-linux-generic

CMakeLists.txt

@@ -1,11 +1,11 @@
-cmake_minimum_required(VERSION 3.16)
+cmake_minimum_required(VERSION 3.17)
 
 if(NOT BINARY_NAME)
     set(BINARY_NAME openttd)
 endif()
 
 project(${BINARY_NAME}
-    VERSION 14.0
+    VERSION 15.0
     LANGUAGES CXX
 )
 
@@ -51,9 +51,6 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS YES)
 # An empty target for the tools
 add_custom_target(tools)
 
-include(Endian)
-add_endian_definition()
-
 include(CompileFlags)
 compile_flags()
 
@@ -135,26 +132,26 @@ endif()
 
 # Breakpad doesn't support emscripten.
 if(NOT EMSCRIPTEN)
-    find_package(unofficial-breakpad)
+    find_package(unofficial-breakpad NO_MODULE)
 endif()
 
 if(NOT OPTION_DEDICATED)
-    if(NOT WIN32)
+    if(WIN32)
+        find_package(Xaudio2)
+    else()
         find_package(Allegro)
         if(NOT APPLE)
             find_package(Freetype)
             find_package(SDL2)
-            if(NOT SDL2_FOUND)
-                find_package(SDL)
-            endif()
             find_package(Fluidsynth)
             if(Freetype_FOUND)
                 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)
@@ -176,7 +173,6 @@ if(MSVC)
 endif()
 
 find_package(SSE)
-find_package(Xaudio2)
 
 find_package(Grfcodec)
 
@@ -186,8 +182,8 @@ check_ipo_supported(RESULT IPO_FOUND)
 show_options()
 
 if(UNIX AND NOT APPLE AND NOT OPTION_DEDICATED)
-    if(NOT SDL_FOUND AND NOT SDL2_FOUND AND NOT ALLEGRO_FOUND)
-        message(FATAL_ERROR "SDL, SDL2 or Allegro is required for this platform")
+    if(NOT SDL2_FOUND AND NOT ALLEGRO_FOUND)
+        message(FATAL_ERROR "SDL2 or Allegro is required for this platform")
     endif()
     if(HARFBUZZ_FOUND AND NOT ICU_i18n_FOUND)
         message(WARNING "HarfBuzz depends on ICU i18n to function; HarfBuzz will be disabled")
@@ -235,8 +231,6 @@ endif()
 include(CTest)
 include(SourceList)
 
-# Needed by rev.cpp
-include_directories(${CMAKE_SOURCE_DIR}/src)
 # Needed by everything that uses Squirrel
 include_directories(${CMAKE_SOURCE_DIR}/src/3rdparty/squirrel/include)
 
@@ -266,6 +260,7 @@ target_precompile_headers(openttd_lib
     src/stdafx.h
     src/core/format.hpp
 )
+set_source_files_properties(src/3rdparty/fmt/format.cc PROPERTIES SKIP_PRECOMPILE_HEADERS ON)
 
 add_subdirectory(${CMAKE_SOURCE_DIR}/bin)
 add_subdirectory(${CMAKE_SOURCE_DIR}/src)
@@ -305,7 +300,6 @@ if(IPO_FOUND)
     set_target_properties(openttd PROPERTIES INTERPROCEDURAL_OPTIMIZATION_RELWITHDEBINFO True)
 endif()
 set_target_properties(openttd PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_BINARY_DIR}")
-process_compile_flags()
 
 include(LinkPackage)
 link_package(PNG TARGET PNG::PNG ENCOURAGED)
@@ -319,18 +313,19 @@ if(NOT WIN32 AND NOT EMSCRIPTEN)
 endif()
 
 if(NOT EMSCRIPTEN)
-    link_package(unofficial-breakpad TARGET unofficial::breakpad::libbreakpad_client ENCOURAGED)
+    link_package(unofficial-breakpad TARGET unofficial::breakpad::libbreakpad_client)
 endif()
 
 if(NOT OPTION_DEDICATED)
     link_package(Fluidsynth)
-    link_package(SDL)
     link_package(SDL2 TARGET SDL2::SDL2)
     link_package(Allegro)
     link_package(FREETYPE TARGET Freetype::Freetype)
     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
@@ -343,7 +338,7 @@ if(NOT OPTION_DEDICATED)
     endif()
 endif()
 
-include(CheckAtomic)
+include(3rdparty/llvm/CheckAtomic)
 
 if(APPLE)
     link_package(Iconv TARGET Iconv::Iconv)
@@ -388,13 +383,14 @@ 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}/changelog.txt@/changelog.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.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")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/directory_structure.md@/docs/directory_structure.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/eints.md@/docs/eints.md")
+    target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/fonts.md@/docs/fonts.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/linkgraph.md@/docs/linkgraph.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/logging_and_performance_metrics.md@/docs/logging_and_performance_metrics.md")
     target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/multiplayer.md@/docs/multiplayer.md")

CODINGSTYLE.md

@@ -10,6 +10,8 @@ What is simple to some might appear very complicated to others. Documentation he
 * Function names use [CamelCase](http://www.wikipedia.org/wiki/Camelcase) without underscores.
 * Opening curly bracket **{** for a function starts on the next line.
 * Use Foo() instead of Foo(void).
+* Prefer using "const" for reference and compound parameters when appropriate.
+* If a member function can be a const function, make it so.
 ```c++
 void ThisIsAFunction()
 {
@@ -157,7 +159,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 +182,7 @@ switch (a) {
 
 	case 1:
 		DoSomething();
-		FALLTHROUGH;
+		[[fallthrough]];
 
 	case 2:
 		DoMore();
@@ -191,7 +193,7 @@ switch (a) {
 		int r = 2;
 
 		DoEvenMore(a);
-		FALLTHROUGH;
+		[[fallthrough]];
 	}
 
 	case 4: {
@@ -248,17 +250,50 @@ 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)".
 * Do not put external declarations in implementation (i.e. cpp) files.
-* Use const where possible.
 * Do not typedef enums and structs.
 * Don't treat non-flags as flags: use "if (char_pointer != nullptr && *char_pointer != '\0')", not "if (char_pointer && *char_pointer)".
 * Use "free(p)" instead of "if (p != nullptr) free(p)". "free(nullptr)" doesn't hurt anyone.
@@ -448,7 +483,7 @@ Do not mention two keywords; if two apply, pick one that best represents the com
 
 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.txt` for inspiration.
+See `changelog.md` for inspiration.
 
 To further structure the changelog, you can add components. Example are:
 * "Network" for network specific changes.

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/.
@@ -65,7 +65,7 @@ To install both the x64 (64bit) and x86 (32bit) variants (though only one is nec
 
 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.
 
@@ -115,9 +115,9 @@ builds.
 
 ## 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

@@ -196,6 +196,29 @@ These include:
 You may also want the guide to [compiling OpenTTD](./COMPILING.md).
 
 
+## Use of AI
+
+OpenTTD is a labour of love, created by people.
+
+Please refrain from submitting issues or pull requests that have been generated by an LLM or other fully-automated tools.
+Any submission that is in violation of this policy will be closed, and the submitter may be blocked from this repository without warning.
+
+If you submit an issue, you need to understand what your issue description is saying.
+You need to be able to answer questions about your bug report or feature request.
+Using an AI tool to _proofread_ your issue/comment text is acceptable. Using an AI tool to _write_ your issue/comment text is not.
+
+If you submit a pull request, you need to understand what every line of code you've changed does.
+If you can't explain why your PR is doing something, then do not submit it.
+Using an AI tool to generate entire lines of code is unacceptable.
+
+The rationale behind this policy is that automated contributions are a waste of the maintainers' time.
+Humans spend their time and brainpower reviewing every submission.
+Issues or pull requests generated by automation tools create an imbalance of effort between the submitter and the reviewer.
+Nobody learns anything when a maintainer reviews code written by an LLM.
+
+Additionally, AI-generated code conflicts with this project's license (GPL v2), since you cannot truly release code for use if you didn't author it yourself.
+
+
 ## Project goals
 
 ### What are the goals of the official branch?

COPYING.md

@@ -6,7 +6,7 @@ GNU General Public License
 
 _Version 2, June 1991_
 _Copyright © 1989, 1991 Free Software Foundation, Inc.,_
-_51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA_
+_[https://fsf.org/](https://fsf.org/)_
 
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
@@ -304,8 +304,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License along
-    with this program; if not, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+    with this program. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 
 Also add information on how to contact you by electronic and paper mail.
 

CREDITS.md

@@ -12,6 +12,7 @@
 - Remko Bijker (Rubidium) - Coder and way more (since 0.4.5)
 - Patric Stout (TrueBrain) - NoProgrammer (since 0.3), sys op
 - Tyler Trahan (2TallTyler) - General / Time Lord (since 13)
+- Richard Wheeler (zephyris) - Precision pixel production (since 15)
 
 ### Inactive Developers:
 

Doxyfile.in

@@ -1,7 +1,9 @@
 # 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/>.
+# 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
+
+# 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
 #---------------------------------------------------------------------------
@@ -288,7 +310,7 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = WITH_ZLIB \
                          WITH_LZO \
                          WITH_LIBLZMA \
-                         WITH_SDL \
+                         WITH_SDL2 \
                          WITH_PNG \
                          WITH_FONTCONFIG \
                          WITH_FREETYPE \
@@ -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

@@ -37,12 +37,10 @@ Both 'stable' and 'nightly' versions are available for download:
 
 OpenTTD is also available for free on [Steam](https://store.steampowered.com/app/1536610/OpenTTD/), [GOG.com](https://www.gog.com/game/openttd), and the [Microsoft Store](https://www.microsoft.com/p/openttd-official/9ncjg5rvrr1c). On some platforms OpenTTD will be available via your OS package manager or a similar service.
 
-
 ## 1.2) OpenTTD gameplay manual
 
 OpenTTD has a [community-maintained wiki](https://wiki.openttd.org/), including a gameplay manual and tips.
 
-
 ## 1.3) Supported platforms
 
 OpenTTD has been ported to several platforms and operating systems.
@@ -56,6 +54,7 @@ The currently supported platforms are:
 Other platforms may also work (in particular various BSD systems), but we don't actively test or maintain these.
 
 ### 1.3.1) Legacy support
+
 Platforms, languages and compilers change.
 We'll keep support going on old platforms as long as someone is interested in supporting them, except where it means the project can't move forward to keep up with language and compiler features.
 
@@ -72,7 +71,6 @@ For some platforms these will be downloaded during the installation process if r
 
 For some platforms, you will need to refer to [the installation guide](https://wiki.openttd.org/en/Manual/Installation).
 
-
 ### 1.4.1) Free graphics and sound files
 
 The free data files, split into OpenGFX for graphics, OpenSFX for sounds and
@@ -85,7 +83,6 @@ OpenMSX for music can be found at:
 Please follow the readme of these packages about the installation procedure.
 The Windows installer can optionally download and install these packages.
 
-
 ### 1.4.2) Original Transport Tycoon Deluxe graphics and sound files
 
 If you want to play with the original Transport Tycoon Deluxe data files you have to copy the data files from the CD-ROM into the baseset/ directory.
@@ -100,7 +97,6 @@ You need to copy the following files:
 - trgir.grf or TRGI.GRF
 - trgtr.grf or TRGT.GRF
 
-
 ### 1.4.3) Original Transport Tycoon Deluxe music
 
 If you want the Transport Tycoon Deluxe music, copy the appropriate files from the original game into the baseset folder.
@@ -108,7 +104,6 @@ If you want the Transport Tycoon Deluxe music, copy the appropriate files from t
 - TTD for DOS: The GM.CAT file
 - Transport Tycoon Original: The GM.CAT file, but rename it to GM-TTO.CAT
 
-
 ## 1.5) Add-on content / mods
 
 OpenTTD features multiple types of add-on content, which modify gameplay in different ways.
@@ -117,7 +112,6 @@ 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.
@@ -126,7 +120,6 @@ To enable such integration, the plugin for the specific platform has to be downl
 
 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.
@@ -137,7 +130,6 @@ For more information, see the [directory structure guide](./docs/directory_struc
 
 If you want to compile OpenTTD from source, instructions can be found in [COMPILING.md](./COMPILING.md).
 
-
 ## 2.0) Contact and Community
 
 'Official' channels
@@ -160,12 +152,10 @@ You can play OpenTTD with others, either cooperatively or competitively.
 
 See the [multiplayer documentation](./docs/multiplayer.md) for more details.
 
-
 ### 2.2) Contributing to OpenTTD
 
 We welcome contributors to OpenTTD.  More information for contributors can be found in [CONTRIBUTING.md](./CONTRIBUTING.md)
 
-
 ### 2.3) Reporting bugs
 
 Good bug reports are very helpful.  We have a [guide to reporting bugs](./CONTRIBUTING.md#bug-reports) to help with this.
@@ -173,12 +163,10 @@ Good bug reports are very helpful.  We have a [guide to reporting bugs](./CONTRI
 Desyncs in multiplayer are complex to debug and report (some software development skils are required).
 Instructions can be found in [debugging and reporting desyncs](./docs/debugging_desyncs.md).
 
-
 ### 2.4) Translating
 
 OpenTTD is translated into many languages.  Translations are added and updated via the [online translation tool](https://translator.openttd.org).
 
-
 ## 3.0) Licensing
 
 OpenTTD is licensed under the GNU General Public License version 2.0.
@@ -212,6 +200,9 @@ 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.
 
-## 4.0 Credits
+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/compat_0.7.nut

@@ -2,10 +2,11 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("0.7 API compatibility in effect:");
+/* This file contains code to downgrade the API from 1.0 to 0.7. */
+
 AILog.Info(" - AITown::GetLastMonthProduction's behaviour has slightly changed.");
 AILog.Info(" - AISubsidy::GetDestination returns STATION_INVALID for awarded subsidies.");
 AILog.Info(" - AISubsidy::GetSource returns STATION_INVALID for awarded subsidies.");
@@ -95,158 +96,158 @@ AIEngine.IsValidEngine <- function(engine_id)
 	return AIEngine.IsBuildable(engine_id);
 }
 
-AIEngine._GetName <- AIEngine.GetName;
+AIEngine.GetNameCompat0_7 <- AIEngine.GetName;
 AIEngine.GetName <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return null;
-	return AIEngine._GetName(engine_id);
+	return AIEngine.GetNameCompat0_7(engine_id);
 }
 
-AIEngine._GetCargoType <- AIEngine.GetCargoType;
+AIEngine.GetCargoTypeCompat0_7 <- AIEngine.GetCargoType;
 AIEngine.GetCargoType <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return 255;
-	return AIEngine._GetCargoType(engine_id);
+	return AIEngine.GetCargoTypeCompat0_7(engine_id);
 }
 
-AIEngine._CanRefitCargo <- AIEngine.CanRefitCargo;
+AIEngine.CanRefitCargoCompat0_7 <- AIEngine.CanRefitCargo;
 AIEngine.CanRefitCargo <- function(engine_id, cargo_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return false;
-	return AIEngine._CanRefitCargo(engine_id, cargo_id);
+	return AIEngine.CanRefitCargoCompat0_7(engine_id, cargo_id);
 }
 
-AIEngine._CanPullCargo <- AIEngine.CanPullCargo;
+AIEngine.CanPullCargoCompat0_7 <- AIEngine.CanPullCargo;
 AIEngine.CanPullCargo <- function(engine_id, cargo_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return false;
-	return AIEngine._CanPullCargo(engine_id, cargo_id);
+	return AIEngine.CanPullCargoCompat0_7(engine_id, cargo_id);
 }
 
-AIEngine._GetCapacity <- AIEngine.GetCapacity;
+AIEngine.GetCapacityCompat0_7 <- AIEngine.GetCapacity;
 AIEngine.GetCapacity <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetCapacity(engine_id);
+	return AIEngine.GetCapacityCompat0_7(engine_id);
 }
 
-AIEngine._GetReliability <- AIEngine.GetReliability;
+AIEngine.GetReliabilityCompat0_7 <- AIEngine.GetReliability;
 AIEngine.GetReliability <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetReliability(engine_id);
+	return AIEngine.GetReliabilityCompat0_7(engine_id);
 }
 
-AIEngine._GetMaxSpeed <- AIEngine.GetMaxSpeed;
+AIEngine.GetMaxSpeedCompat0_7 <- AIEngine.GetMaxSpeed;
 AIEngine.GetMaxSpeed <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetMaxSpeed(engine_id);
+	return AIEngine.GetMaxSpeedCompat0_7(engine_id);
 }
 
-AIEngine._GetPrice <- AIEngine.GetPrice;
+AIEngine.GetPriceCompat0_7 <- AIEngine.GetPrice;
 AIEngine.GetPrice <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetPrice(engine_id);
+	return AIEngine.GetPriceCompat0_7(engine_id);
 }
 
-AIEngine._GetMaxAge <- AIEngine.GetMaxAge;
+AIEngine.GetMaxAgeCompat0_7 <- AIEngine.GetMaxAge;
 AIEngine.GetMaxAge <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetMaxAge(engine_id);
+	return AIEngine.GetMaxAgeCompat0_7(engine_id);
 }
 
-AIEngine._GetRunningCost <- AIEngine.GetRunningCost;
+AIEngine.GetRunningCostCompat0_7 <- AIEngine.GetRunningCost;
 AIEngine.GetRunningCost <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetRunningCost(engine_id);
+	return AIEngine.GetRunningCostCompat0_7(engine_id);
 }
 
-AIEngine._GetPower <- AIEngine.GetPower;
+AIEngine.GetPowerCompat0_7 <- AIEngine.GetPower;
 AIEngine.GetPower <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetPower(engine_id);
+	return AIEngine.GetPowerCompat0_7(engine_id);
 }
 
-AIEngine._GetWeight <- AIEngine.GetWeight;
+AIEngine.GetWeightCompat0_7 <- AIEngine.GetWeight;
 AIEngine.GetWeight <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetWeight(engine_id);
+	return AIEngine.GetWeightCompat0_7(engine_id);
 }
 
-AIEngine._GetMaxTractiveEffort <- AIEngine.GetMaxTractiveEffort;
+AIEngine.GetMaxTractiveEffortCompat0_7 <- AIEngine.GetMaxTractiveEffort;
 AIEngine.GetMaxTractiveEffort <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetMaxTractiveEffort(engine_id);
+	return AIEngine.GetMaxTractiveEffortCompat0_7(engine_id);
 }
 
-AIEngine._GetDesignDate <- AIEngine.GetDesignDate;
+AIEngine.GetDesignDateCompat0_7 <- AIEngine.GetDesignDate;
 AIEngine.GetDesignDate <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetDesignDate(engine_id);
+	return AIEngine.GetDesignDateCompat0_7(engine_id);
 }
 
-AIEngine._GetVehicleType <- AIEngine.GetVehicleType;
+AIEngine.GetVehicleTypeCompat0_7 <- AIEngine.GetVehicleType;
 AIEngine.GetVehicleType <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return AIVehicle.VT_INVALID;
-	return AIEngine._GetVehicleType(engine_id);
+	return AIEngine.GetVehicleTypeCompat0_7(engine_id);
 }
 
-AIEngine._IsWagon <- AIEngine.IsWagon;
+AIEngine.IsWagonCompat0_7 <- AIEngine.IsWagon;
 AIEngine.IsWagon <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return false;
-	return AIEngine._IsWagon(engine_id);
+	return AIEngine.IsWagonCompat0_7(engine_id);
 }
 
-AIEngine._CanRunOnRail <- AIEngine.CanRunOnRail;
+AIEngine.CanRunOnRailCompat0_7 <- AIEngine.CanRunOnRail;
 AIEngine.CanRunOnRail <- function(engine_id, track_rail_type)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return false;
-	return AIEngine._CanRunOnRail(engine_id, track_rail_type);
+	return AIEngine.CanRunOnRailCompat0_7(engine_id, track_rail_type);
 }
 
-AIEngine._HasPowerOnRail <- AIEngine.HasPowerOnRail;
+AIEngine.HasPowerOnRailCompat0_7 <- AIEngine.HasPowerOnRail;
 AIEngine.HasPowerOnRail <- function(engine_id, track_rail_type)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return false;
-	return AIEngine._HasPowerOnRail(engine_id, track_rail_type);
+	return AIEngine.HasPowerOnRailCompat0_7(engine_id, track_rail_type);
 }
 
-AIEngine._GetRoadType <- AIEngine.GetRoadType;
+AIEngine.GetRoadTypeCompat0_7 <- AIEngine.GetRoadType;
 AIEngine.GetRoadType <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return AIRoad.ROADTYPE_INVALID;
-	return AIEngine._GetRoadType(engine_id);
+	return AIEngine.GetRoadTypeCompat0_7(engine_id);
 }
 
-AIEngine._GetRailType <- AIEngine.GetRailType;
+AIEngine.GetRailTypeCompat0_7 <- AIEngine.GetRailType;
 AIEngine.GetRailType <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return AIRail.RAILTYPE_INVALID;
-	return AIEngine._GetRailType(engine_id);
+	return AIEngine.GetRailTypeCompat0_7(engine_id);
 }
 
-AIEngine._IsArticulated <- AIEngine.IsArticulated;
+AIEngine.IsArticulatedCompat0_7 <- AIEngine.IsArticulated;
 AIEngine.IsArticulated <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return false;
-	return AIEngine._IsArticulated(engine_id);
+	return AIEngine.IsArticulatedCompat0_7(engine_id);
 }
 
-AIEngine._GetPlaneType <- AIEngine.GetPlaneType;
+AIEngine.GetPlaneTypeCompat0_7 <- AIEngine.GetPlaneType;
 AIEngine.GetPlaneType <- function(engine_id)
 {
 	if (!AIEngine.IsBuildable(engine_id)) return -1;
-	return AIEngine._GetPlaneType(engine_id);
+	return AIEngine.GetPlaneTypeCompat0_7(engine_id);
 }
 
 _AIWaypointList <- AIWaypointList;
@@ -256,139 +257,3 @@ class AIWaypointList extends _AIWaypointList {
 		::_AIWaypointList.constructor(AIWaypoint.WAYPOINT_RAIL);
 	}
 }
-
-AIRoad._BuildRoadStation <- AIRoad.BuildRoadStation;
-AIRoad.BuildRoadStation <- function(tile, front, road_veh_type, station_id)
-{
-	if (AIRoad.IsRoadStationTile(tile) && AICompany.IsMine(AITile.GetOwner(tile))) return false;
-
-	return AIRoad._BuildRoadStation(tile, front, road_veh_type, station_id);
-}
-
-AIRoad._BuildDriveThroughRoadStation <- AIRoad.BuildDriveThroughRoadStation;
-AIRoad.BuildDriveThroughRoadStation <- function(tile, front, road_veh_type, station_id)
-{
-	if (AIRoad.IsRoadStationTile(tile) && AICompany.IsMine(AITile.GetOwner(tile))) return false;
-
-	return AIRoad._BuildDriveThroughRoadStation(tile, front, road_veh_type, station_id);
-}
-
-AIBridgeList.HasNext <-
-AIBridgeList_Length.HasNext <-
-AICargoList.HasNext <-
-AICargoList_IndustryAccepting.HasNext <-
-AICargoList_IndustryProducing.HasNext <-
-AIDepotList.HasNext <-
-AIEngineList.HasNext <-
-AIGroupList.HasNext <-
-AIIndustryList.HasNext <-
-AIIndustryList_CargoAccepting.HasNext <-
-AIIndustryList_CargoProducing.HasNext <-
-AIIndustryTypeList.HasNext <-
-AIList.HasNext <-
-AIRailTypeList.HasNext <-
-AISignList.HasNext <-
-AIStationList.HasNext <-
-AIStationList_Vehicle.HasNext <-
-AISubsidyList.HasNext <-
-AITileList.HasNext <-
-AITileList_IndustryAccepting.HasNext <-
-AITileList_IndustryProducing.HasNext <-
-AITileList_StationType.HasNext <-
-AITownList.HasNext <-
-AIVehicleList.HasNext <-
-AIVehicleList_DefaultGroup.HasNext <-
-AIVehicleList_Group.HasNext <-
-AIVehicleList_SharedOrders.HasNext <-
-AIVehicleList_Station.HasNext <-
-AIWaypointList.HasNext <-
-AIWaypointList_Vehicle.HasNext <-
-function()
-{
-	return !this.IsEnd();
-}
-
-AIIndustry._IsCargoAccepted <- AIIndustry.IsCargoAccepted;
-AIIndustry.IsCargoAccepted <- function(industry_id, cargo_id)
-{
-	return AIIndustry._IsCargoAccepted(industry_id, cargo_id) != AIIndustry.CAS_NOT_ACCEPTED;
-}
-
-AIAbstractList <- AIList;
-
-AIList.ChangeItem <- AIList.SetValue;
-
-AIRail.ERR_NONUNIFORM_STATIONS_DISABLED <- 0xFFFF;
-
-AICompany.GetCompanyValue <- function(company)
-{
-	return AICompany.GetQuarterlyCompanyValue(company, AICompany.CURRENT_QUARTER);
-}
-
-AITown.GetLastMonthTransported <- AITown.GetLastMonthSupplied;
-
-AIEvent.AI_ET_INVALID <- AIEvent.ET_INVALID;
-AIEvent.AI_ET_TEST <- AIEvent.ET_TEST;
-AIEvent.AI_ET_SUBSIDY_OFFER <- AIEvent.ET_SUBSIDY_OFFER;
-AIEvent.AI_ET_SUBSIDY_OFFER_EXPIRED <- AIEvent.ET_SUBSIDY_OFFER_EXPIRED;
-AIEvent.AI_ET_SUBSIDY_AWARDED <- AIEvent.ET_SUBSIDY_AWARDED;
-AIEvent.AI_ET_SUBSIDY_EXPIRED <- AIEvent.ET_SUBSIDY_EXPIRED;
-AIEvent.AI_ET_ENGINE_PREVIEW <- AIEvent.ET_ENGINE_PREVIEW;
-AIEvent.AI_ET_COMPANY_NEW <- AIEvent.ET_COMPANY_NEW;
-AIEvent.AI_ET_COMPANY_IN_TROUBLE <- AIEvent.ET_COMPANY_IN_TROUBLE;
-AIEvent.AI_ET_COMPANY_MERGER <- AIEvent.ET_COMPANY_MERGER;
-AIEvent.AI_ET_COMPANY_BANKRUPT <- AIEvent.ET_COMPANY_BANKRUPT;
-AIEvent.AI_ET_VEHICLE_CRASHED <- AIEvent.ET_VEHICLE_CRASHED;
-AIEvent.AI_ET_VEHICLE_LOST <- AIEvent.ET_VEHICLE_LOST;
-AIEvent.AI_ET_VEHICLE_WAITING_IN_DEPOT <- AIEvent.ET_VEHICLE_WAITING_IN_DEPOT;
-AIEvent.AI_ET_VEHICLE_UNPROFITABLE <- AIEvent.ET_VEHICLE_UNPROFITABLE;
-AIEvent.AI_ET_INDUSTRY_OPEN <- AIEvent.ET_INDUSTRY_OPEN;
-AIEvent.AI_ET_INDUSTRY_CLOSE <- AIEvent.ET_INDUSTRY_CLOSE;
-AIEvent.AI_ET_ENGINE_AVAILABLE <- AIEvent.ET_ENGINE_AVAILABLE;
-AIEvent.AI_ET_STATION_FIRST_VEHICLE <- AIEvent.ET_STATION_FIRST_VEHICLE;
-AIEvent.AI_ET_DISASTER_ZEPPELINER_CRASHED <- AIEvent.ET_DISASTER_ZEPPELINER_CRASHED;
-AIEvent.AI_ET_DISASTER_ZEPPELINER_CLEARED <- AIEvent.ET_DISASTER_ZEPPELINER_CLEARED;
-AIOrder.AIOF_NONE <- AIOrder.OF_NONE
-AIOrder.AIOF_NON_STOP_INTERMEDIATE <- AIOrder.OF_NON_STOP_INTERMEDIATE
-AIOrder.AIOF_NON_STOP_DESTINATION <- AIOrder.OF_NON_STOP_DESTINATION
-AIOrder.AIOF_UNLOAD <- AIOrder.OF_UNLOAD
-AIOrder.AIOF_TRANSFER <- AIOrder.OF_TRANSFER
-AIOrder.AIOF_NO_UNLOAD <- AIOrder.OF_NO_UNLOAD
-AIOrder.AIOF_FULL_LOAD <- AIOrder.OF_FULL_LOAD
-AIOrder.AIOF_FULL_LOAD_ANY <- AIOrder.OF_FULL_LOAD_ANY
-AIOrder.AIOF_NO_LOAD <- AIOrder.OF_NO_LOAD
-AIOrder.AIOF_SERVICE_IF_NEEDED <- AIOrder.OF_SERVICE_IF_NEEDED
-AIOrder.AIOF_STOP_IN_DEPOT <- AIOrder.OF_STOP_IN_DEPOT
-AIOrder.AIOF_GOTO_NEAREST_DEPOT <- AIOrder.OF_GOTO_NEAREST_DEPOT
-AIOrder.AIOF_NON_STOP_FLAGS <- AIOrder.OF_NON_STOP_FLAGS
-AIOrder.AIOF_UNLOAD_FLAGS <- AIOrder.OF_UNLOAD_FLAGS
-AIOrder.AIOF_LOAD_FLAGS <- AIOrder.OF_LOAD_FLAGS
-AIOrder.AIOF_DEPOT_FLAGS <- AIOrder.OF_DEPOT_FLAGS
-AIOrder.AIOF_INVALID <- AIOrder.OF_INVALID
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}

bin/ai/compat_1.0.nut

@@ -2,25 +2,25 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.0 API compatibility in effect.");
+/* This file contains code to downgrade the API from 1.1 to 1.0. */
 
-AIRoad._BuildRoadStation <- AIRoad.BuildRoadStation;
+AIRoad.BuildRoadStationCompat1_0 <- AIRoad.BuildRoadStation;
 AIRoad.BuildRoadStation <- function(tile, front, road_veh_type, station_id)
 {
 	if (AIRoad.IsRoadStationTile(tile) && AICompany.IsMine(AITile.GetOwner(tile))) return false;
 
-	return AIRoad._BuildRoadStation(tile, front, road_veh_type, station_id);
+	return AIRoad.BuildRoadStationCompat1_0(tile, front, road_veh_type, station_id);
 }
 
-AIRoad._BuildDriveThroughRoadStation <- AIRoad.BuildDriveThroughRoadStation;
+AIRoad.BuildDriveThroughRoadStationCompat1_0 <- AIRoad.BuildDriveThroughRoadStation;
 AIRoad.BuildDriveThroughRoadStation <- function(tile, front, road_veh_type, station_id)
 {
 	if (AIRoad.IsRoadStationTile(tile) && AICompany.IsMine(AITile.GetOwner(tile))) return false;
 
-	return AIRoad._BuildDriveThroughRoadStation(tile, front, road_veh_type, station_id);
+	return AIRoad.BuildDriveThroughRoadStationCompat1_0(tile, front, road_veh_type, station_id);
 }
 
 AIBridgeList.HasNext <-
@@ -59,10 +59,10 @@ function()
 	return !this.IsEnd();
 }
 
-AIIndustry._IsCargoAccepted <- AIIndustry.IsCargoAccepted;
+AIIndustry.IsCargoAcceptedCompat1_0 <- AIIndustry.IsCargoAccepted;
 AIIndustry.IsCargoAccepted <- function(industry_id, cargo_id)
 {
-	return AIIndustry._IsCargoAccepted(industry_id, cargo_id) != AIIndustry.CAS_NOT_ACCEPTED;
+	return AIIndustry.IsCargoAcceptedCompat1_0(industry_id, cargo_id) != AIIndustry.CAS_NOT_ACCEPTED;
 }
 
 AIAbstractList <- AIList;
@@ -70,77 +70,3 @@ AIAbstractList <- AIList;
 AIList.ChangeItem <- AIList.SetValue;
 
 AIRail.ERR_NONUNIFORM_STATIONS_DISABLED <- 0xFFFF;
-
-AICompany.GetCompanyValue <- function(company)
-{
-	return AICompany.GetQuarterlyCompanyValue(company, AICompany.CURRENT_QUARTER);
-}
-
-AITown.GetLastMonthTransported <- AITown.GetLastMonthSupplied;
-
-AIEvent.AI_ET_INVALID <- AIEvent.ET_INVALID;
-AIEvent.AI_ET_TEST <- AIEvent.ET_TEST;
-AIEvent.AI_ET_SUBSIDY_OFFER <- AIEvent.ET_SUBSIDY_OFFER;
-AIEvent.AI_ET_SUBSIDY_OFFER_EXPIRED <- AIEvent.ET_SUBSIDY_OFFER_EXPIRED;
-AIEvent.AI_ET_SUBSIDY_AWARDED <- AIEvent.ET_SUBSIDY_AWARDED;
-AIEvent.AI_ET_SUBSIDY_EXPIRED <- AIEvent.ET_SUBSIDY_EXPIRED;
-AIEvent.AI_ET_ENGINE_PREVIEW <- AIEvent.ET_ENGINE_PREVIEW;
-AIEvent.AI_ET_COMPANY_NEW <- AIEvent.ET_COMPANY_NEW;
-AIEvent.AI_ET_COMPANY_IN_TROUBLE <- AIEvent.ET_COMPANY_IN_TROUBLE;
-AIEvent.AI_ET_COMPANY_ASK_MERGER <- AIEvent.ET_COMPANY_ASK_MERGER;
-AIEvent.AI_ET_COMPANY_MERGER <- AIEvent.ET_COMPANY_MERGER;
-AIEvent.AI_ET_COMPANY_BANKRUPT <- AIEvent.ET_COMPANY_BANKRUPT;
-AIEvent.AI_ET_VEHICLE_CRASHED <- AIEvent.ET_VEHICLE_CRASHED;
-AIEvent.AI_ET_VEHICLE_LOST <- AIEvent.ET_VEHICLE_LOST;
-AIEvent.AI_ET_VEHICLE_WAITING_IN_DEPOT <- AIEvent.ET_VEHICLE_WAITING_IN_DEPOT;
-AIEvent.AI_ET_VEHICLE_UNPROFITABLE <- AIEvent.ET_VEHICLE_UNPROFITABLE;
-AIEvent.AI_ET_INDUSTRY_OPEN <- AIEvent.ET_INDUSTRY_OPEN;
-AIEvent.AI_ET_INDUSTRY_CLOSE <- AIEvent.ET_INDUSTRY_CLOSE;
-AIEvent.AI_ET_ENGINE_AVAILABLE <- AIEvent.ET_ENGINE_AVAILABLE;
-AIEvent.AI_ET_STATION_FIRST_VEHICLE <- AIEvent.ET_STATION_FIRST_VEHICLE;
-AIEvent.AI_ET_DISASTER_ZEPPELINER_CRASHED <- AIEvent.ET_DISASTER_ZEPPELINER_CRASHED;
-AIEvent.AI_ET_DISASTER_ZEPPELINER_CLEARED <- AIEvent.ET_DISASTER_ZEPPELINER_CLEARED;
-AIOrder.AIOF_NONE <- AIOrder.OF_NONE
-AIOrder.AIOF_NON_STOP_INTERMEDIATE <- AIOrder.OF_NON_STOP_INTERMEDIATE
-AIOrder.AIOF_NON_STOP_DESTINATION <- AIOrder.OF_NON_STOP_DESTINATION
-AIOrder.AIOF_UNLOAD <- AIOrder.OF_UNLOAD
-AIOrder.AIOF_TRANSFER <- AIOrder.OF_TRANSFER
-AIOrder.AIOF_NO_UNLOAD <- AIOrder.OF_NO_UNLOAD
-AIOrder.AIOF_FULL_LOAD <- AIOrder.OF_FULL_LOAD
-AIOrder.AIOF_FULL_LOAD_ANY <- AIOrder.OF_FULL_LOAD_ANY
-AIOrder.AIOF_NO_LOAD <- AIOrder.OF_NO_LOAD
-AIOrder.AIOF_SERVICE_IF_NEEDED <- AIOrder.OF_SERVICE_IF_NEEDED
-AIOrder.AIOF_STOP_IN_DEPOT <- AIOrder.OF_STOP_IN_DEPOT
-AIOrder.AIOF_GOTO_NEAREST_DEPOT <- AIOrder.OF_GOTO_NEAREST_DEPOT
-AIOrder.AIOF_NON_STOP_FLAGS <- AIOrder.OF_NON_STOP_FLAGS
-AIOrder.AIOF_UNLOAD_FLAGS <- AIOrder.OF_UNLOAD_FLAGS
-AIOrder.AIOF_LOAD_FLAGS <- AIOrder.OF_LOAD_FLAGS
-AIOrder.AIOF_DEPOT_FLAGS <- AIOrder.OF_DEPOT_FLAGS
-AIOrder.AIOF_INVALID <- AIOrder.OF_INVALID
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}

bin/ai/compat_1.1.nut

@@ -2,10 +2,10 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.1 API compatibility in effect.");
+/* This file contains code to downgrade the API from 1.2 to 1.1. */
 
 AICompany.GetCompanyValue <- function(company)
 {
@@ -54,30 +54,3 @@ AIOrder.AIOF_UNLOAD_FLAGS <- AIOrder.OF_UNLOAD_FLAGS
 AIOrder.AIOF_LOAD_FLAGS <- AIOrder.OF_LOAD_FLAGS
 AIOrder.AIOF_DEPOT_FLAGS <- AIOrder.OF_DEPOT_FLAGS
 AIOrder.AIOF_INVALID <- AIOrder.OF_INVALID
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}

bin/ai/compat_1.10.nut

@@ -2,20 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.10 API compatibility in effect.");
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.11 to 1.10. */

bin/ai/compat_1.11.nut

@@ -2,20 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.11 API compatibility in effect.");
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 12 to 1.11. */

bin/ai/compat_1.2.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.2 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.3 to 1.2. */

bin/ai/compat_1.3.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.3 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.4 to 1.3. */

bin/ai/compat_1.4.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.4 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.5 to 1.4. */

bin/ai/compat_1.5.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.5 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.6 to 1.5. */

bin/ai/compat_1.6.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.6 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.7 to 1.6. */

bin/ai/compat_1.7.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.7 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
-AIBridge.GetName <- function(bridge_id)
-{
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
-}
-
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
-AIGroup.CreateGroup <- function(vehicle_type)
-{
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.8 to 1.7. */

bin/ai/compat_1.8.nut

@@ -2,34 +2,19 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.8 API compatibility in effect.");
+/* This file contains code to downgrade the API from 1.9 to 1.8. */
 
-/* 1.9 adds a vehicle type parameter. */
-AIBridge._GetName <- AIBridge.GetName;
+AIBridge.GetNameCompat1_8 <- AIBridge.GetName;
 AIBridge.GetName <- function(bridge_id)
 {
-	return AIBridge._GetName(bridge_id, AIVehicle.VT_RAIL);
+	return AIBridge.GetNameCompat1_8(bridge_id, AIVehicle.VT_RAIL);
 }
 
-/* 1.9 adds parent_group_id to CreateGroup function */
-AIGroup._CreateGroup <- AIGroup.CreateGroup;
+AIGroup.CreateGroupCompat1_8 <- AIGroup.CreateGroup;
 AIGroup.CreateGroup <- function(vehicle_type)
 {
-	return AIGroup._CreateGroup(vehicle_type, AIGroup.GROUP_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
+	return AIGroup.CreateGroupCompat1_8(vehicle_type, AIGroup.GROUP_INVALID);
 }

bin/ai/compat_1.9.nut

@@ -2,20 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("1.9 API compatibility in effect.");
-
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
-AIRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.10 to 1.9. */

bin/ai/compat_12.nut

@@ -2,18 +2,17 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("12 API compatibility in effect.");
+/* This file contains code to downgrade the API from 13 to 12. */
 
-/* 13 really checks RoadType against RoadType */
-AIRoad._HasRoadType <- AIRoad.HasRoadType;
+AIRoad.HasRoadTypeCompat12 <- AIRoad.HasRoadType;
 AIRoad.HasRoadType <- function(tile, road_type)
 {
 	local list = AIRoadTypeList(AIRoad.GetRoadTramType(road_type));
 	foreach (rt, _ in list) {
-		if (AIRoad._HasRoadType(tile, rt)) {
+		if (AIRoad.HasRoadTypeCompat12(tile, rt)) {
 			return true;
 		}
 	}

bin/ai/compat_13.nut

@@ -2,7 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-AILog.Info("13 API compatibility in effect.");
+/* This file contains code to downgrade the API from 14 to 13. */

bin/ai/compat_14.nut

@@ -2,5 +2,45 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
+
+/* This file contains code to downgrade the API from 15 to 14. */
+
+AIBridge.GetBridgeID <- AIBridge.GetBridgeType;
+
+class AICompat14 {
+	function Text(text)
+	{
+		if (typeof text == "string") return text;
+		return null;
+	}
+}
+
+AIBaseStation.SetNameCompat14 <- AIBaseStation.SetName;
+AIBaseStation.SetName <- function(id, name) { return AIBaseStation.SetNameCompat14(id, AICompat14.Text(name)); }
+
+AICompany.SetNameCompat14 <- AICompany.SetName;
+AICompany.SetName <- function(name) { return AICompany.SetNameCompat14(AICompat14.Text(name)); }
+AICompany.SetPresidentNameCompat14 <- AICompany.SetPresidentName;
+AICompany.SetPresidentName <- function(name) { return AICompany.SetPresidentNameCompat14(AICompat14.Text(name)); }
+
+AIGroup.SetNameCompat14 <- AIGroup.SetName;
+AIGroup.SetName <- function(id, name) { return AIGroup.SetNameCompat14(id, AICompat14.Text(name)); }
+
+AISign.BuildSignCompat14 <- AISign.BuildSign;
+AISign.BuildSign <- function(id, name) { return AISign.BuildSignCompat14(id, AICompat14.Text(name)); }
+
+AITown.FoundTownCompat14 <- AITown.FoundTown;
+AITown.FoundTown <- function(tile, size, city, layout, name) { return AITown.FoundTownCompat14(tile, size, city, layout, AICompat14.Text(name)); }
+
+AIVehicle.SetNameCompat14 <- AIVehicle.SetName;
+AIVehicle.SetName <- function(id, name) { return AIVehicle.SetNameCompat14(id, AICompat14.Text(name)); }
+
+AIObject.constructorCompat14 <- AIObject.constructor;
+foreach(name, object in CompatScriptRootTable) {
+	if (type(object) != "class") continue;
+	if (!object.rawin("constructor")) continue;
+	if (object.constructor != AIObject.constructorCompat14) continue;
+	object.constructor <- function() : (name) { AILog.Error("'" + name + "' is not instantiable"); }
+}

bin/game/compat_1.10.nut

@@ -2,27 +2,13 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.10 API compatibility in effect.");
+/* This file contains code to downgrade the API from 1.11 to 1.10. */
 
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
+GSCompany.ChangeBankBalanceCompat1_10 <- GSCompany.ChangeBankBalance;
 GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
 {
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
+	return GSCompany.ChangeBankBalanceCompat1_10(company, delta, expenses_type, GSMap.TILE_INVALID);
 }

bin/game/compat_1.11.nut

@@ -2,20 +2,8 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.11 API compatibility in effect.");
+/* This file contains code to downgrade the API from 12 to 1.11. */
 
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}

bin/game/compat_1.2.nut

@@ -2,49 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.2 API compatibility in effect.");
-
-GSTown._SetGrowthRate <- GSTown.SetGrowthRate;
-GSTown.SetGrowthRate <- function(town_id, days_between_town_growth)
-{
-	/* Growth rate 0 caused resetting the custom growth rate. While this was undocumented, it was used nevertheless (ofc). */
-	if (days_between_town_growth == 0) days_between_town_growth = GSTown.TOWN_GROWTH_NORMAL;
-	return GSTown._SetGrowthRate(town_id, days_between_town_growth);
-}
-
-/* 1.5 adds a game element reference to the news. */
-GSNews._Create <- GSNews.Create;
-GSNews.Create <- function(type, text, company)
-{
-    return GSNews._Create(type, text, company, GSNews.NR_NONE, 0);
-}
-
-/* 1.9 adds a vehicle type parameter. */
-GSBridge._GetName <- GSBridge.GetName;
-GSBridge.GetName <- function(bridge_id)
-{
-	return GSBridge._GetName(bridge_id, GSVehicle.VT_RAIL);
-}
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.3 to 1.2. */

bin/game/compat_1.3.nut

@@ -2,49 +2,15 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.3 API compatibility in effect.");
+/* This file contains code to downgrade the API from 1.4 to 1.3. */
 
-GSTown._SetGrowthRate <- GSTown.SetGrowthRate;
+GSTown.SetGrowthRateCompat1_3 <- GSTown.SetGrowthRate;
 GSTown.SetGrowthRate <- function(town_id, days_between_town_growth)
 {
 	/* Growth rate 0 caused resetting the custom growth rate. While this was undocumented, it was used nevertheless (ofc). */
 	if (days_between_town_growth == 0) days_between_town_growth = GSTown.TOWN_GROWTH_NORMAL;
-	return GSTown._SetGrowthRate(town_id, days_between_town_growth);
-}
-
-/* 1.5 adds a game element reference to the news. */
-GSNews._Create <- GSNews.Create;
-GSNews.Create <- function(type, text, company)
-{
-    return GSNews._Create(type, text, company, GSNews.NR_NONE, 0);
-}
-
-/* 1.9 adds a vehicle type parameter. */
-GSBridge._GetName <- GSBridge.GetName;
-GSBridge.GetName <- function(bridge_id)
-{
-	return GSBridge._GetName(bridge_id, GSVehicle.VT_RAIL);
-}
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
+	return GSTown.SetGrowthRateCompat1_3(town_id, days_between_town_growth);
 }

bin/game/compat_1.4.nut

@@ -2,41 +2,13 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.4 API compatibility in effect.");
+/* This file contains code to downgrade the API from 1.5 to 1.4 */
 
-/* 1.5 adds a game element reference to the news. */
-GSNews._Create <- GSNews.Create;
+GSNews.CreateCompat1_4 <- GSNews.Create;
 GSNews.Create <- function(type, text, company)
 {
-    return GSNews._Create(type, text, company, GSNews.NR_NONE, 0);
-}
-
-/* 1.9 adds a vehicle type parameter. */
-GSBridge._GetName <- GSBridge.GetName;
-GSBridge.GetName <- function(bridge_id)
-{
-	return GSBridge._GetName(bridge_id, GSVehicle.VT_RAIL);
-}
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
+    return GSNews.CreateCompat1_4(type, text, company, GSNews.NR_NONE, 0);
 }

bin/game/compat_1.5.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.5 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-GSBridge._GetName <- GSBridge.GetName;
-GSBridge.GetName <- function(bridge_id)
-{
-	return GSBridge._GetName(bridge_id, GSVehicle.VT_RAIL);
-}
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.6 to 1.5. */

bin/game/compat_1.6.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.6 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-GSBridge._GetName <- GSBridge.GetName;
-GSBridge.GetName <- function(bridge_id)
-{
-	return GSBridge._GetName(bridge_id, GSVehicle.VT_RAIL);
-}
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.7 to 1.6. */

bin/game/compat_1.7.nut

@@ -2,34 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.7 API compatibility in effect.");
-
-/* 1.9 adds a vehicle type parameter. */
-GSBridge._GetName <- GSBridge.GetName;
-GSBridge.GetName <- function(bridge_id)
-{
-	return GSBridge._GetName(bridge_id, GSVehicle.VT_RAIL);
-}
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.8 to 1.7. */

bin/game/compat_1.8.nut

@@ -2,34 +2,13 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.8 API compatibility in effect.");
+/* This file contains code to downgrade the API from 1.9 to 1.8. */
 
-/* 1.9 adds a vehicle type parameter. */
-GSBridge._GetName <- GSBridge.GetName;
+GSBridge.GetNameCompat1_8 <- GSBridge.GetName;
 GSBridge.GetName <- function(bridge_id)
 {
-	return GSBridge._GetName(bridge_id, GSVehicle.VT_RAIL);
-}
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
+	return GSBridge.GetNameCompat1_8(bridge_id, GSVehicle.VT_RAIL);
 }

bin/game/compat_1.9.nut

@@ -2,27 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("1.9 API compatibility in effect.");
-
-/* 1.11 adds a tile parameter. */
-GSCompany._ChangeBankBalance <- GSCompany.ChangeBankBalance;
-GSCompany.ChangeBankBalance <- function(company, delta, expenses_type)
-{
-	return GSCompany._ChangeBankBalance(company, delta, expenses_type, GSMap.TILE_INVALID);
-}
-
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
-GSRoad.HasRoadType <- function(tile, road_type)
-{
-	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
-	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
-			return true;
-		}
-	}
-	return false;
-}
+/* This file contains code to downgrade the API from 1.10 to 1.9. */

bin/game/compat_12.nut

@@ -2,18 +2,17 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("12 API compatibility in effect.");
+/* This file contains code to downgrade the API from 13 to 12. */
 
-/* 13 really checks RoadType against RoadType */
-GSRoad._HasRoadType <- GSRoad.HasRoadType;
+GSRoad.HasRoadTypeCompat12 <- GSRoad.HasRoadType;
 GSRoad.HasRoadType <- function(tile, road_type)
 {
 	local list = GSRoadTypeList(GSRoad.GetRoadTramType(road_type));
 	foreach (rt, _ in list) {
-		if (GSRoad._HasRoadType(tile, rt)) {
+		if (GSRoad.HasRoadTypeCompat12(tile, rt)) {
 			return true;
 		}
 	}

bin/game/compat_13.nut

@@ -2,7 +2,7 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
 
-GSLog.Info("13 API compatibility in effect.");
+/* This file contains code to downgrade the API from 14 to 13. */

bin/game/compat_14.nut

@@ -2,5 +2,90 @@
  * 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/>.
+ * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
  */
+
+/* This file contains code to downgrade the API from 15 to 14. */
+
+GSBridge.GetBridgeID <- GSBridge.GetBridgeType;
+
+/* Emulate old GSText parameter padding behaviour */
+GSText.SCRIPT_TEXT_MAX_PARAMETERS <- 20;
+
+class GSCompat14 {
+	function Text(text)
+	{
+		if (typeof text == "string") return text;
+		if (typeof text == "instance" && text instanceof GSText) return text;
+		return null;
+	}
+}
+
+GSBaseStation.SetNameCompat14 <- GSBaseStation.SetName;
+GSBaseStation.SetName <- function(id, name) { return GSBaseStation.SetNameCompat14(id, GSCompat14.Text(name)); }
+
+GSCompany.SetNameCompat14 <- GSCompany.SetName;
+GSCompany.SetName <- function(name) { return GSCompany.SetNameCompat14(GSCompat14.Text(name)); }
+GSCompany.SetPresidentNameCompat14 <- GSCompany.SetPresidentName;
+GSCompany.SetPresidentName <- function(name) { return GSCompany.SetPresidentNameCompat14(GSCompat14.Text(name)); }
+
+GSGoal.NewCompat14 <- GSGoal.New;
+GSGoal.New <- function(company, goal, type, dest) { return GSGoal.NewCompat14(company, GSCompat14.Text(goal), type, dest); }
+GSGoal.SetTextCompat14 <- GSGoal.SetText;
+GSGoal.SetText <- function(id, goal) { return GSGoal.SetTextCompat14(id, GSCompat14.Text(goal)); }
+GSGoal.SetProgressCompat14 <- GSGoal.SetProgress;
+GSGoal.SetProgress <- function(id, progress) { return GSGoal.SetProgressCompat14(id, GSCompat14.Text(progress)); }
+GSGoal.QuestionCompat14 <- GSGoal.Question;
+GSGoal.Question <- function(id, company, question, type, buttons) { return GSGoal.QuestionCompat14(id, company, GSCompat14.Text(question), type, buttons); }
+GSGoal.QuestionClientCompat14 <- GSGoal.QuestionClient;
+GSGoal.QuestionClient <- function(id, target, is_client, question, type, buttons) { return GSGoal.QuestionClientCompat14(id, target, is_client, GSCompat14.Text(question), type, buttons); }
+
+GSGroup.SetNameCompat14 <- GSGroup.SetName;
+GSGroup.SetName <- function(id, name) { return GSGroup.SetNameCompat14(id, GSCompat14.Text(name)); }
+
+GSIndustry.SetTextCompat14 <- GSIndustry.SetText;
+GSIndustry.SetText <- function(id, text) { return GSIndustry.SetTextCompat14(id, GSCompat14.Text(text)); }
+GSIndustry.SetProductionLevelCompat14 <- GSIndustry.SetProductionLevel;
+GSIndustry.SetProductionLevel <- function(id, level, news, text) { return GSIndustry.SetProductionLevelCompat14(id, level, news, GSCompat14.Text(text)); }
+
+GSLeagueTable.NewCompat14 <- GSLeagueTable.New;
+GSLeagueTable.New <- function(title, header, footer) { return GSLeagueTable.NewCompat14(GSCompat14.Text(title), GSCompat14.Text(header), GSCompat14.Text(footer)); }
+GSLeagueTable.NewElementCompat14 <- GSLeagueTable.NewElement;
+GSLeagueTable.NewElement <- function(table, rating, company, text, score, type, target) { return GSLeagueTable.NewElementCompat14(table, rating, company, GSCompat14.Text(text), GSCompat14.Text(score), type, target); }
+GSLeagueTable.UpdateElementDataCompat14 <- GSLeagueTable.UpdateElementData;
+GSLeagueTable.UpdateElementData <- function(element, company, text, type, target) { return GSLeagueTable.UpdateElementDataCompat14(element, company, GSCompat14.Text(text), type, target); }
+GSLeagueTable.UpdateElementScoreCompat14 <- GSLeagueTable.UpdateElementScore;
+GSLeagueTable.UpdateElementScore <- function(element, rating, score) { return GSLeagueTable.UpdateElementScoreCompat14(element, rating, GSCompat14.Text(score)); }
+
+GSNews.CreateCompat14 <- GSNews.Create;
+GSNews.Create <- function(type, text, company, ref_type, ref) { return GSNews.CreateCompat14(type, GSCompat14.Text(text), company, ref_type, ref); }
+
+GSSign.BuildSignCompat14 <- GSSign.BuildSign;
+GSSign.BuildSign <- function(id, name) { return GSSign.BuildSignCompat14(id, GSCompat14.Text(name)); }
+
+GSStoryPage.NewCompat14 <- GSStoryPage.New;
+GSStoryPage.New <- function(company, title) { return GSStoryPage.NewCompat14(company, GSCompat14.Text(title)); }
+GSStoryPage.NewElementCompat14 <- GSStoryPage.NewElement;
+GSStoryPage.NewElement <- function(page, type, ref, text) { return GSStoryPage.NewElementCompat14(page, type, ref, GSCompat14.Text(text)); }
+GSStoryPage.UpdateElementCompat14 <- GSStoryPage.UpdateElement;
+GSStoryPage.UpdateElement <- function(id, ref, text) { return GSStoryPage.UpdateElementCompat14(id, ref, GSCompat14.Text(text)); }
+GSStoryPage.SetTitleCompat14 <- GSStoryPage.SetTitle;
+GSStoryPage.SetTitle <- function(page, tile) { return GSStoryPage.SetTitleCompat14(page, GSCompat14.Text(title)); }
+
+GSTown.SetNameCompat14 <- GSTown.SetName;
+GSTown.SetName <- function(id, name) { return GSTown.SetNameCompat14(id, GSCompat14.Text(name)); }
+GSTown.SetTextCompat14 <- GSTown.SetText;
+GSTown.SetText <- function(id, text) { return GSTown.SetTextCompat14(id, GSCompat14.Text(text)); }
+GSTown.FoundTownCompat14 <- GSTown.FoundTown;
+GSTown.FoundTown <- function(tile, size, city, layout, name) { return GSTown.FoundTownCompat14(tile, size, city, layout, GSCompat14.Text(name)); }
+
+GSVehicle.SetNameCompat14 <- GSVehicle.SetName;
+GSVehicle.SetName <- function(id, name) { return GSVehicle.SetNameCompat14(id, GSCompat14.Text(name)); }
+
+GSObject.constructorCompat14 <- GSObject.constructor;
+foreach(name, object in CompatScriptRootTable) {
+	if (type(object) != "class") continue;
+	if (!object.rawin("constructor")) continue;
+	if (object.constructor != GSObject.constructorCompat14) continue;
+	object.constructor <- function() : (name) { GSLog.Error("'" + name + "' is not instantiable"); }
+}

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,6 +10,7 @@ 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.
             )
@@ -55,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
@@ -75,11 +81,9 @@ 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
+            # Prevent optimisation supposing enums are in a range specified by the standard
+            # For details, see http://gcc.gnu.org/PR43680 and PR#5246.
+            -fno-strict-enums
         )
 
         # Ninja processes the output so the output from the compiler
@@ -106,10 +110,6 @@ macro(compile_flags)
                 # about its own optimized code in some places.
                 "-fno-strict-overflow"
 
-                # Prevent optimisation supposing enums are in a range specified by the standard
-                # For details, see http://gcc.gnu.org/PR43680
-                "-fno-tree-vrp"
-
                 # -flifetime-dse=2 (default since GCC 6) doesn't play
                 # well with our custom pool item allocator
                 "$<$<BOOL:${LIFETIME_DSE_FOUND}>:-flifetime-dse=1>"

cmake/Endian.cmake

@@ -1,14 +0,0 @@
-# Add the definitions to indicate which endian we are building for.
-#
-# add_endian_definition()
-#
-function(add_endian_definition)
-    include(TestBigEndian)
-    TEST_BIG_ENDIAN(IS_BIG_ENDIAN)
-
-    if(IS_BIG_ENDIAN)
-        add_definitions(-DTTD_ENDIAN=TTD_BIG_ENDIAN)
-    else()
-        add_definitions(-DTTD_ENDIAN=TTD_LITTLE_ENDIAN)
-    endif()
-endfunction()

cmake/FindLZO.cmake

@@ -43,29 +43,8 @@ find_library(LZO_LIBRARY
     PATHS ${PC_LZO_LIBRARY_DIRS}
 )
 
-# With vcpkg, the library path should contain both 'debug' and 'optimized'
-# entries (see target_link_libraries() documentation for more information)
-#
-# NOTE: we only patch up when using vcpkg; the same issue might happen
-# when not using vcpkg, but this is non-trivial to fix, as we have no idea
-# what the paths are. With vcpkg we do. And we only official support vcpkg
-# with Windows.
-#
-# NOTE: this is based on the assumption that the debug file has the same
-# name as the optimized file. This is not always the case, but so far
-# experiences has shown that in those case vcpkg CMake files do the right
-# thing.
-if(VCPKG_TOOLCHAIN AND LZO_LIBRARY AND LZO_LIBRARY MATCHES "${VCPKG_INSTALLED_DIR}")
-    if(LZO_LIBRARY MATCHES "/debug/")
-        set(LZO_LIBRARY_DEBUG ${LZO_LIBRARY})
-        string(REPLACE "/debug/lib/" "/lib/" LZO_LIBRARY_RELEASE ${LZO_LIBRARY})
-    else()
-        set(LZO_LIBRARY_RELEASE ${LZO_LIBRARY})
-        string(REPLACE "/lib/" "/debug/lib/" LZO_LIBRARY_DEBUG ${LZO_LIBRARY})
-    endif()
-    include(SelectLibraryConfigurations)
-    select_library_configurations(LZO)
-endif()
+include(FixVcpkgLibrary)
+FixVcpkgLibrary(LZO)
 
 set(LZO_VERSION ${PC_LZO_VERSION})
 

cmake/FindOgg.cmake

@@ -0,0 +1,41 @@
+include(FindPackageHandleStandardArgs)
+
+find_library(Ogg_LIBRARY
+    NAMES ogg
+)
+
+include(FixVcpkgLibrary)
+FixVcpkgLibrary(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}"
+        )
+        FixVcpkgTarget(Ogg Ogg::ogg)
+    endif()
+endif()

cmake/FindOpus.cmake

@@ -0,0 +1,41 @@
+include(FindPackageHandleStandardArgs)
+
+find_library(Opus_LIBRARY
+    NAMES opus
+)
+
+include(FixVcpkgLibrary)
+FixVcpkgLibrary(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}"
+        )
+        FixVcpkgTarget(Opus Opus::opus)
+    endif()
+endif()

cmake/FindOpusFile.cmake

@@ -0,0 +1,44 @@
+include(FindPackageHandleStandardArgs)
+
+find_library(OpusFile_LIBRARY
+    NAMES opusfile
+)
+
+include(FixVcpkgLibrary)
+FixVcpkgLibrary(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}"
+        )
+        FixVcpkgTarget(OpusFile OpusFile::opusfile)
+    endif()
+endif()

cmake/FindSSE.cmake

@@ -2,6 +2,7 @@
 # SSE version (SSE 2.0, SSSE 3.0).
 
 include(CheckCXXSourceCompiles)
+set(OLD_CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS})
 set(CMAKE_REQUIRED_FLAGS "")
 
 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
@@ -15,3 +16,5 @@ check_cxx_source_compiles("
     int main() { return 0; }"
     SSE_FOUND
 )
+
+set(CMAKE_REQUIRED_FLAGS ${OLD_CMAKE_REQUIRED_FLAGS})

cmake/FindXaudio2.cmake

@@ -1,6 +1,7 @@
 # Autodetect if xaudio2 can be used.
 
 include(CheckCXXSourceCompiles)
+set(OLD_CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS})
 set(CMAKE_REQUIRED_FLAGS "")
 
 check_cxx_source_compiles("
@@ -17,3 +18,5 @@ check_cxx_source_compiles("
     int main() { printf(\"%s\\\\n\", XAUDIO2_DLL_A); return 0; }"
     XAUDIO2_FOUND
 )
+
+set(CMAKE_REQUIRED_FLAGS ${OLD_CMAKE_REQUIRED_FLAGS})

cmake/FixVcpkgLibrary.cmake

@@ -0,0 +1,40 @@
+macro(FixVcpkgLibrary NAME)
+    # With vcpkg, the library path should contain both 'debug' and 'optimized'
+    # entries (see target_link_libraries() documentation for more information)
+    #
+    # NOTE: we only patch up when using vcpkg; the same issue might happen
+    # when not using vcpkg, but this is non-trivial to fix, as we have no idea
+    # what the paths are. With vcpkg we do. And we only official support vcpkg
+    # with Windows.
+    #
+    # NOTE: this is based on the assumption that the debug file has the same
+    # name as the optimized file. This is not always the case, but so far
+    # experiences has shown that in those case vcpkg CMake files do the right
+    # thing.
+    if(VCPKG_TOOLCHAIN AND ${NAME}_LIBRARY AND ${NAME}_LIBRARY MATCHES "${VCPKG_INSTALLED_DIR}")
+        if(${NAME}_LIBRARY MATCHES "/debug/")
+            set(${NAME}_LIBRARY_DEBUG ${${NAME}_LIBRARY})
+            string(REPLACE "/debug/lib/" "/lib/" ${NAME}_LIBRARY_RELEASE ${${NAME}_LIBRARY})
+        else()
+            set(${NAME}_LIBRARY_RELEASE ${${NAME}_LIBRARY})
+            string(REPLACE "/lib/" "/debug/lib/" ${NAME}_LIBRARY_DEBUG ${${NAME}_LIBRARY})
+        endif()
+        include(SelectLibraryConfigurations)
+        select_library_configurations(${NAME})
+    endif()
+endmacro()
+
+function(FixVcpkgTarget NAME TARGET)
+    if(EXISTS "${${NAME}_LIBRARY_RELEASE}")
+        set_property(TARGET ${TARGET} APPEND PROPERTY
+        IMPORTED_CONFIGURATIONS RELEASE)
+        set_target_properties(${TARGET} PROPERTIES
+        IMPORTED_LOCATION_RELEASE "${${NAME}_LIBRARY_RELEASE}")
+    endif()
+    if(EXISTS "${${NAME}_LIBRARY_DEBUG}")
+        set_property(TARGET ${TARGET} APPEND PROPERTY
+        IMPORTED_CONFIGURATIONS DEBUG)
+        set_target_properties(${TARGET} PROPERTIES
+        IMPORTED_LOCATION_DEBUG "${${NAME}_LIBRARY_DEBUG}")
+    endif()
+endfunction()

cmake/InstallAndPackage.cmake

@@ -51,8 +51,8 @@ install(FILES
                 ${CMAKE_SOURCE_DIR}/README.md
                 ${CMAKE_SOURCE_DIR}/CREDITS.md
                 ${CMAKE_SOURCE_DIR}/CONTRIBUTING.md
-                ${CMAKE_SOURCE_DIR}/changelog.txt
-                ${CMAKE_SOURCE_DIR}/known-bugs.txt
+                ${CMAKE_SOURCE_DIR}/changelog.md
+                ${CMAKE_SOURCE_DIR}/known-bugs.md
         DESTINATION ${DOCS_DESTINATION_DIR}
         COMPONENT docs)
 
@@ -62,6 +62,7 @@ install(FILES
                 ${CMAKE_SOURCE_DIR}/docs/desync.md
                 ${CMAKE_SOURCE_DIR}/docs/directory_structure.md
                 ${CMAKE_SOURCE_DIR}/docs/eints.md
+                ${CMAKE_SOURCE_DIR}/docs/fonts.md
                 ${CMAKE_SOURCE_DIR}/docs/game_coordinator.md
                 ${CMAKE_SOURCE_DIR}/docs/linkgraph.md
                 ${CMAKE_SOURCE_DIR}/docs/logging_and_performance_metrics.md

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/SourceList.cmake

@@ -46,44 +46,3 @@ endfunction()
 function(add_test_files)
     _add_files_tgt(openttd_test ${ARGV})
 endfunction()
-
-# This function works around an 'issue' with CMake, where
-# set_source_files_properties() only works in the scope of the file. We want
-# to set properties for the source file on a more global level. To solve this,
-# this function records the flags you want, and a macro adds them in the root
-# CMakeLists.txt.
-# See this URL for more information on the issue:
-# http://cmake.3232098.n2.nabble.com/scope-of-set-source-files-properties-td4766111.html
-#
-# set_compile_flags([file1 ...] COMPILE_FLAGS cflag [cflag ...])
-#
-function(set_compile_flags)
-    cmake_parse_arguments(PARAM "" "" "COMPILE_FLAGS" ${ARGN})
-    set(PARAM_FILES "${PARAM_UNPARSED_ARGUMENTS}")
-
-    get_property(SOURCE_PROPERTIES GLOBAL PROPERTY source_properties)
-
-    foreach(FILE IN LISTS PARAM_FILES)
-        list(APPEND SOURCE_PROPERTIES "${CMAKE_CURRENT_SOURCE_DIR}/${FILE}::${PARAM_COMPILE_FLAGS}")
-    endforeach()
-
-    set_property(GLOBAL PROPERTY source_properties "${SOURCE_PROPERTIES}")
-endfunction()
-
-# Call this macro in the same CMakeLists.txt and after add_executable().
-# This makes sure all the COMPILE_FLAGS of set_compile_flags() are set
-# correctly.
-#
-# process_compile_flags()
-#
-function(process_compile_flags)
-    get_property(SOURCE_PROPERTIES GLOBAL PROPERTY source_properties)
-
-    foreach(ENTRY ${SOURCE_PROPERTIES})
-        string(REPLACE "::" ";" ENTRY "${ENTRY}")
-        list(GET ENTRY 0 FILE)
-        list(GET ENTRY 1 PROPERTIES)
-
-        set_source_files_properties(${FILE} PROPERTIES COMPILE_FLAGS ${PROPERTIES})
-    endforeach()
-endfunction()

cmake/scripts/Baseset.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.17)
 
 #
 # Create a single baseset meta file with the correct translations.

cmake/scripts/CreateGRF.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.17)
 
 #
 # Create a single GRF file based on sprites/<grfname>.nfo and sprites/*.png

cmake/scripts/Desktop.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.17)
 
 #
 # 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.17)
 
 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.17)
 
 #
 # CMake script to automatically generate the enums in script_window.hpp

cmake/scripts/Regression.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.17)
 
 #
 # Runs a single regressoion test
@@ -25,6 +25,12 @@ if(EDITBIN_EXECUTABLE)
     execute_process(COMMAND ${EDITBIN_EXECUTABLE} /nologo /subsystem:console ${OPENTTD_EXECUTABLE})
 endif()
 
+# Remove previous crash files
+file(GLOB CRASH_FILES "regression/crash*")
+if(CRASH_FILES)
+    file(REMOVE ${CRASH_FILES})
+endif()
+
 # Run the regression test
 execute_process(COMMAND ${OPENTTD_EXECUTABLE}
                         -x
@@ -40,6 +46,13 @@ execute_process(COMMAND ${OPENTTD_EXECUTABLE}
                 OUTPUT_STRIP_TRAILING_WHITESPACE
 )
 
+# Detect any crash
+file(GLOB CRASH_FILES "regression/crash*.log")
+if (CRASH_FILES)
+    file(READ ${CRASH_FILES} CRASH_LOG)
+    message(FATAL_ERROR "OpenTTD crashed: ${CRASH_LOG}")
+endif()
+
 if(REGRESSION_OUTPUT)
     message(FATAL_ERROR "Unexpected output: ${REGRESSION_OUTPUT}")
 endif()
@@ -87,12 +100,7 @@ set(ERROR NO)
 list(LENGTH REGRESSION_EXPECTED REGRESSION_EXPECTED_LENGTH)
 
 # Compare the output
-foreach(RESULT IN LISTS REGRESSION_RESULT)
-    unset(EXPECTED)
-    if(ARGC LESS REGRESSION_EXPECTED_LENGTH)
-        list(GET REGRESSION_EXPECTED ${ARGC} EXPECTED)
-    endif()
-
+foreach(RESULT EXPECTED IN ZIP_LISTS REGRESSION_RESULT REGRESSION_EXPECTED)
     math(EXPR ARGC "${ARGC} + 1")
 
     if(NOT RESULT STREQUAL EXPECTED)

cmake/scripts/SquirrelExport.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.17)
 
 if(NOT SCRIPT_API_SOURCE_FILE)
     message(FATAL_ERROR "Script needs SCRIPT_API_SOURCE_FILE defined")
@@ -17,38 +17,48 @@ if(NOT APILC)
 endif()
 
 macro(dump_fileheader)
-    get_filename_component(SCRIPT_API_FILE_NAME "${SCRIPT_API_FILE}" NAME)
-    string(APPEND SQUIRREL_EXPORT "\n#include \"../${SCRIPT_API_FILE_NAME}\"")
+    get_filename_component(SCRIPT_API_FILE_NAME "${SCRIPT_API_FILE}" NAME_WE)
+    string(APPEND SQUIRREL_EXPORT "\n#include \"../${SCRIPT_API_FILE_NAME}.hpp\"")
     if(NOT "${APIUC}" STREQUAL "Template")
         string(REPLACE "script_" "template_" SCRIPT_API_FILE_NAME "${SCRIPT_API_FILE_NAME}")
-        string(APPEND SQUIRREL_EXPORT "\n#include \"../template/${SCRIPT_API_FILE_NAME}.sq\"")
+        string(APPEND SQUIRREL_EXPORT "\n#include \"../template/${SCRIPT_API_FILE_NAME}.sq.hpp\"")
+    endif()
+endmacro()
+
+macro(open_namespace)
+    if(NOT NAMESPACE_OPENED)
+        string(APPEND SQUIRREL_EXPORT "\nnamespace SQConvert {")
+        set(NAMESPACE_OPENED TRUE)
     endif()
 endmacro()
 
 macro(dump_class_templates NAME)
     string(REGEX REPLACE "^Script" "" REALNAME ${NAME})
 
-    string(APPEND SQUIRREL_EXPORT "\n	template <> struct Param<${NAME} *> { static inline ${NAME} *Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return  (${NAME} *)instance; } };")
-    string(APPEND SQUIRREL_EXPORT "\n	template <> struct Param<${NAME} &> { static inline ${NAME} &Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; } };")
-    string(APPEND SQUIRREL_EXPORT "\n	template <> struct Param<const ${NAME} *> { static inline const ${NAME} *Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return  (${NAME} *)instance; } };")
-    string(APPEND SQUIRREL_EXPORT "\n	template <> struct Param<const ${NAME} &> { static inline const ${NAME} &Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; } };")
+    string(APPEND SQUIRREL_EXPORT "\n\ttemplate <> struct Param<${NAME} *> { static inline ${NAME} *Get(HSQUIRRELVM vm, int index) { return  static_cast<${NAME} *>(Squirrel::GetRealInstance(vm, index, \"${REALNAME}\")); } };")
+    string(APPEND SQUIRREL_EXPORT "\n\ttemplate <> struct Param<${NAME} &> { static inline ${NAME} &Get(HSQUIRRELVM vm, int index) { return *static_cast<${NAME} *>(Squirrel::GetRealInstance(vm, index, \"${REALNAME}\")); } };")
+    string(APPEND SQUIRREL_EXPORT "\n\ttemplate <> struct Param<const ${NAME} *> { static inline const ${NAME} *Get(HSQUIRRELVM vm, int index) { return  static_cast<${NAME} *>(Squirrel::GetRealInstance(vm, index, \"${REALNAME}\")); } };")
+    string(APPEND SQUIRREL_EXPORT "\n\ttemplate <> struct Param<const ${NAME} &> { static inline const ${NAME} &Get(HSQUIRRELVM vm, int index) { return *static_cast<${NAME} *>(Squirrel::GetRealInstance(vm, index, \"${REALNAME}\")); } };")
     if("${NAME}" STREQUAL "ScriptEvent")
-        string(APPEND SQUIRREL_EXPORT "\n	template <> struct Return<${NAME} *> { static inline int Set(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; } };")
+        string(APPEND SQUIRREL_EXPORT "\n\ttemplate <> struct Return<${NAME} *> { static inline int Set(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; } };")
     elseif("${NAME}" STREQUAL "ScriptText")
         string(APPEND SQUIRREL_EXPORT "\n")
-        string(APPEND SQUIRREL_EXPORT "\n	template <> struct Param<Text *> {")
-        string(APPEND SQUIRREL_EXPORT "\n		static inline Text *Get(HSQUIRRELVM vm, int index) {")
-        string(APPEND SQUIRREL_EXPORT "\n			if (sq_gettype(vm, index) == OT_INSTANCE) {")
-        string(APPEND SQUIRREL_EXPORT "\n				return Param<ScriptText *>::Get(vm, index);")
-        string(APPEND SQUIRREL_EXPORT "\n			}")
-        string(APPEND SQUIRREL_EXPORT "\n			if (sq_gettype(vm, index) == OT_STRING) {")
-        string(APPEND SQUIRREL_EXPORT "\n				return new RawText(Param<const std::string &>::Get(vm, index));")
-        string(APPEND SQUIRREL_EXPORT "\n			}")
-        string(APPEND SQUIRREL_EXPORT "\n			return nullptr;")
-        string(APPEND SQUIRREL_EXPORT "\n		}")
-        string(APPEND SQUIRREL_EXPORT "\n	};")
+        string(APPEND SQUIRREL_EXPORT "\n\ttemplate <> struct Param<Text *> {")
+        string(APPEND SQUIRREL_EXPORT "\n\t\tstatic inline Text *Get(HSQUIRRELVM vm, int index) {")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\tif (sq_gettype(vm, index) == OT_INSTANCE) {")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\t\treturn Param<ScriptText *>::Get(vm, index);")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\t}")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\tif (sq_gettype(vm, index) == OT_STRING) {")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\t\treturn new RawText(Param<const std::string &>::Get(vm, index));")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\t}")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\tif (sq_gettype(vm, index) == OT_NULL) {")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\t\treturn nullptr;")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\t}")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t\tthrow sq_throwerror(vm, fmt::format(\"parameter {} has an invalid type ; expected: 'Text'\", index - 1));")
+        string(APPEND SQUIRREL_EXPORT "\n\t\t}")
+        string(APPEND SQUIRREL_EXPORT "\n\t};")
     else()
-        string(APPEND SQUIRREL_EXPORT "\n	template <> struct Return<${NAME} *> { static inline int Set(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; } };")
+        string(APPEND SQUIRREL_EXPORT "\n\ttemplate <> struct Return<${NAME} *> { static inline int Set(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; } };")
     endif()
 endmacro()
 
@@ -63,7 +73,6 @@ macro(reset_reader)
     unset(STATIC_METHODS)
     unset(CLS)
     unset(START_SQUIRREL_DEFINE_ON_NEXT_LINE)
-    set(CLS_LEVEL 0)
     unset(CLS_IN_API)
 endmacro()
 
@@ -72,6 +81,9 @@ reset_reader()
 file(STRINGS "${SCRIPT_API_FILE}" SOURCE_LINES)
 
 set(NUM_LINE 0)
+set(CLS_LEVEL 0)
+set(BRACE_LEVEL 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")
@@ -107,7 +119,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
         continue()
     endif()
 
-    if("${LINE}" MATCHES "^([	 ]*)\\* @api (.*)$")
+    if("${LINE}" MATCHES "^([\t ]*)\\* @api (.*)$")
         set(LINE ${CMAKE_MATCH_2})
         # By default, classes are not selected
         if(NOT CLS_LEVEL)
@@ -145,22 +157,28 @@ foreach(LINE IN LISTS SOURCE_LINES)
         continue()
     endif()
 
+    # Count braces to skip function bodies
+    string(REGEX REPLACE "[^{]" "" OPENING_BRACES "${LINE}")
+    string(LENGTH "${OPENING_BRACES}" OPENING_BRACES)
+    string(REGEX REPLACE "[^}]" "" CLOSING_BRACES "${LINE}")
+    string(LENGTH "${CLOSING_BRACES}" CLOSING_BRACES)
+    math(EXPR BRACE_LEVEL "${BRACE_LEVEL} + ${OPENING_BRACES} - ${CLOSING_BRACES}")
+
     # Ignore forward declarations of classes
-    if("${LINE}" MATCHES "^(	*)class(.*);")
+    if("${LINE}" MATCHES "^(\t*)class(.*);")
         continue()
     endif()
 
     # We only want to have public functions exported for now
-    if("${LINE}" MATCHES "^(	*)class (.*) (: public|: protected|: private|:) ([^ ]*)")
+    if("${LINE}" MATCHES "^(\t*)class (.*) (: public|: protected|: private|:) ([^ ]*)")
         if(NOT CLS_LEVEL)
             if(NOT DEFINED API_SELECTED)
-                message(WARNING "Class '${CMAKE_MATCH_2}' has no @api. It won't be published to any API.")
+                message(WARNING "${SCRIPT_API_FILE}:${NUM_LINE}: Class '${CMAKE_MATCH_2}' has no @api. It won't be published to any API.")
                 set(API_SELECTED FALSE)
             endif()
             unset(IS_PUBLIC)
-            unset(CLS_PARAM_0)
-            set(CLS_PARAM_1 1)
-            set(CLS_PARAM_2 "x")
+            unset(CLS_PARAMS)
+            set(CLS_TYPES "x")
             set(CLS_IN_API ${API_SELECTED})
             unset(API_SELECTED)
             set(CLS "${CMAKE_MATCH_2}")
@@ -178,19 +196,19 @@ foreach(LINE IN LISTS SOURCE_LINES)
         math(EXPR CLS_LEVEL "${CLS_LEVEL} + 1")
         continue()
     endif()
-    if("${LINE}" MATCHES "^(	*)public")
+    if("${LINE}" MATCHES "^(\t*)public")
         if(CLS_LEVEL EQUAL 1)
             set(IS_PUBLIC TRUE)
         endif()
         continue()
     endif()
-    if("${LINE}" MATCHES "^(	*)protected")
+    if("${LINE}" MATCHES "^(\t*)protected")
         if(CLS_LEVEL EQUAL 1)
             unset(IS_PUBLIC)
         endif()
         continue()
     endif()
-    if("${LINE}" MATCHES "^(	*)private")
+    if("${LINE}" MATCHES "^(\t*)private")
         if(CLS_LEVEL EQUAL 1)
             unset(IS_PUBLIC)
         endif()
@@ -218,7 +236,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
     endif()
 
     # We need to make specialized conversions for structs
-    if("${LINE}" MATCHES "^(	*)struct ([^ ]*)")
+    if("${LINE}" MATCHES "^(\t*)struct ([^ ]*)")
         math(EXPR CLS_LEVEL "${CLS_LEVEL} + 1")
 
         # Check if we want to publish this struct
@@ -240,7 +258,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
     endif()
 
     # We need to make specialized conversions for enums
-    if("${LINE}" MATCHES "^(	*)enum ([^ ]*)")
+    if("${LINE}" MATCHES "^(\t*)enum ([^ ]*)")
         math(EXPR CLS_LEVEL "${CLS_LEVEL} + 1")
 
         # Check if we want to publish this enum
@@ -263,7 +281,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
     endif()
 
     # Maybe the end of the class, if so we can start with the Squirrel export pretty soon
-    if("${LINE}" MATCHES "};")
+    if(BRACE_LEVEL LESS CLS_LEVEL)
         math(EXPR CLS_LEVEL "${CLS_LEVEL} - 1")
         if(CLS_LEVEL)
             unset(IN_ENUM)
@@ -277,7 +295,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
     endif()
 
     # Empty/white lines. When we may do the Squirrel export, do that export.
-    if("${LINE}" MATCHES "^([ 	]*)$")
+    if("${LINE}" MATCHES "^([ \t]*)$")
         if(NOT START_SQUIRREL_DEFINE_ON_NEXT_LINE)
             continue()
         endif()
@@ -301,38 +319,17 @@ foreach(LINE IN LISTS SOURCE_LINES)
         string(APPEND SQUIRREL_EXPORT "\n")
 
         if("${APIUC}" STREQUAL "Template")
-            # First check whether we have enums to print
-            if(DEFINED ENUMS)
-                if(NOT NAMESPACE_OPENED)
-                    string(APPEND SQUIRREL_EXPORT "\nnamespace SQConvert {")
-                    set(NAMESPACE_OPENED TRUE)
-                endif()
-                string(APPEND SQUIRREL_EXPORT "\n	/* Allow enums to be used as Squirrel parameters */")
-                foreach(ENUM IN LISTS ENUMS)
-                    string(APPEND SQUIRREL_EXPORT "\n	template <> struct Param<${ENUM}> { static inline ${ENUM} Get(HSQUIRRELVM vm, int index) { SQInteger tmp; sq_getinteger(vm, index, &tmp); return (${ENUM})tmp; } };")
-                    string(APPEND SQUIRREL_EXPORT "\n	template <> struct Return<${ENUM}> { static inline int Set(HSQUIRRELVM vm, ${ENUM} res) { sq_pushinteger(vm, res); return 1; } };")
-                endforeach()
-            endif()
-
             # Then check whether we have structs/classes to print
             if(DEFINED STRUCTS)
-                if(NOT NAMESPACE_OPENED)
-                    string(APPEND SQUIRREL_EXPORT "\nnamespace SQConvert {")
-                    set(NAMESPACE_OPENED TRUE)
-                endif()
-                string(APPEND SQUIRREL_EXPORT "\n	/* Allow inner classes/structs to be used as Squirrel parameters */")
+                open_namespace()
+                string(APPEND SQUIRREL_EXPORT "\n\t/* Allow inner classes/structs to be used as Squirrel parameters */")
                 foreach(STRUCT IN LISTS STRUCTS)
                     dump_class_templates(${STRUCT})
                 endforeach()
             endif()
 
-            if(NOT NAMESPACE_OPENED)
-                string(APPEND SQUIRREL_EXPORT "\nnamespace SQConvert {")
-                set(NAMESPACE_OPENED TRUE)
-            else()
-                string(APPEND SQUIRREL_EXPORT "\n")
-            endif()
-            string(APPEND SQUIRREL_EXPORT "\n	/* Allow ${CLS} to be used as Squirrel parameter */")
+            open_namespace()
+            string(APPEND SQUIRREL_EXPORT "\n\t/* Allow ${CLS} to be used as Squirrel parameter */")
             dump_class_templates(${CLS})
 
             string(APPEND SQUIRREL_EXPORT "\n} // namespace SQConvert")
@@ -342,23 +339,23 @@ foreach(LINE IN LISTS SOURCE_LINES)
         endif()
 
         string(APPEND SQUIRREL_EXPORT "\n")
-        string(APPEND SQUIRREL_EXPORT "\ntemplate <> const char *GetClassName<${CLS}, ScriptType::${APIUC}>() { return \"${API_CLS}\"; }")
+        string(APPEND SQUIRREL_EXPORT "\ntemplate <> SQInteger PushClassName<${CLS}, ScriptType::${APIUC}>(HSQUIRRELVM vm) { sq_pushstring(vm, \"${API_CLS}\"); return 1; }")
         string(APPEND SQUIRREL_EXPORT "\n")
 
         # Then do the registration functions of the class.
-        string(APPEND SQUIRREL_EXPORT "\nvoid SQ${API_CLS}_Register(Squirrel *engine)")
+        string(APPEND SQUIRREL_EXPORT "\nvoid SQ${API_CLS}_Register(Squirrel &engine)")
         string(APPEND SQUIRREL_EXPORT "\n{")
-        string(APPEND SQUIRREL_EXPORT "\n	DefSQClass<${CLS}, ScriptType::${APIUC}> SQ${API_CLS}(\"${API_CLS}\");")
-        if("${SUPER_CLS}" STREQUAL "Text" OR "${SUPER_CLS}" STREQUAL "ScriptObject" OR "${SUPER_CLS}" STREQUAL "AIAbstractiveList::Valuator")
-            string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.PreRegister(engine);")
+        string(APPEND SQUIRREL_EXPORT "\n\tDefSQClass<${CLS}, ScriptType::${APIUC}> SQ${API_CLS}(\"${API_CLS}\");")
+        if("${SUPER_CLS}" STREQUAL "Text")
+            string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.PreRegister(engine);")
         else()
-            string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.PreRegister(engine, \"${API_SUPER_CLS}\");")
+            string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.PreRegister(engine, \"${API_SUPER_CLS}\");")
         endif()
-        if(NOT "${SUPER_CLS}" MATCHES "^ScriptEvent")
-            if("${CLS_PARAM_2}" STREQUAL "v")
-                string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.AddSQAdvancedConstructor(engine);")
+        if((DEFINED CLS_PARAMS OR DEFINED METHODS) AND NOT "${SUPER_CLS}" MATCHES "^ScriptEvent" AND NOT "${CLS}" STREQUAL "ScriptEvent")
+            if("${CLS_TYPES}" STREQUAL "v")
+                string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.AddSQAdvancedConstructor(engine);")
             else()
-                string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.AddConstructor<void (${CLS}::*)(${CLS_PARAM_0}), ${CLS_PARAM_1}>(engine, \"${CLS_PARAM_2}\");")
+                string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.AddConstructor<void (${CLS}::*)(${CLS_PARAMS})>(engine, \"${CLS_TYPES}\");")
             endif()
         endif()
         string(APPEND SQUIRREL_EXPORT "\n")
@@ -378,7 +375,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
             foreach(i RANGE ${LEN})
                 string(APPEND SPACES " ")
             endforeach()
-            string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.DefSQConst(engine, ${CLS}::${ENUM_VALUE},${SPACES}\"${ENUM_VALUE}\");")
+            string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.DefSQConst(engine, ${CLS}::${ENUM_VALUE},${SPACES}\"${ENUM_VALUE}\");")
         endforeach()
         if(MLEN)
             string(APPEND SQUIRREL_EXPORT "\n")
@@ -399,7 +396,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
             foreach(i RANGE ${LEN})
                 string(APPEND SPACES " ")
             endforeach()
-            string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.DefSQConst(engine, ${CLS}::${CONST_VALUE},${SPACES}\"${CONST_VALUE}\");")
+            string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.DefSQConst(engine, ${CLS}::${CONST_VALUE},${SPACES}\"${CONST_VALUE}\");")
         endforeach()
         if(MLEN)
             string(APPEND SQUIRREL_EXPORT "\n")
@@ -425,7 +422,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
             foreach(i RANGE ${LEN})
                 string(APPEND SPACES " ")
             endforeach()
-            string(APPEND SQUIRREL_EXPORT "\n	ScriptError::RegisterErrorMap(${ENUM_STRING},${SPACES}${CLS}::${ENUM_ERROR});")
+            string(APPEND SQUIRREL_EXPORT "\n\tScriptError::RegisterErrorMap(${ENUM_STRING},${SPACES}${CLS}::${ENUM_ERROR});")
         endforeach()
         if(MLEN)
             string(APPEND SQUIRREL_EXPORT "\n")
@@ -446,7 +443,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
             foreach(i RANGE ${LEN})
                 string(APPEND SPACES " ")
             endforeach()
-            string(APPEND SQUIRREL_EXPORT "\n	ScriptError::RegisterErrorMapString(${CLS}::${ENUM_ERROR_TO_STRING},${SPACES}\"${ENUM_ERROR_TO_STRING}\");")
+            string(APPEND SQUIRREL_EXPORT "\n\tScriptError::RegisterErrorMapString(${CLS}::${ENUM_ERROR_TO_STRING},${SPACES}\"${ENUM_ERROR_TO_STRING}\");")
         endforeach()
         if(MLEN)
             string(APPEND SQUIRREL_EXPORT "\n")
@@ -465,8 +462,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
         foreach(STATIC_METHOD IN LISTS STATIC_METHODS)
             string(REPLACE ":" ";" STATIC_METHOD "${STATIC_METHOD}")
             list(GET STATIC_METHOD 0 FUNCNAME)
-            list(GET STATIC_METHOD 1 ARGC)
-            list(GET STATIC_METHOD 2 TYPES)
+            list(GET STATIC_METHOD 1 TYPES)
             string(LENGTH "${FUNCNAME}" LEN)
             math(EXPR LEN "${MLEN} - ${LEN}")
             if("${TYPES}" STREQUAL "v")
@@ -481,9 +477,9 @@ foreach(LINE IN LISTS SOURCE_LINES)
                 string(APPEND SPACES " ")
             endforeach()
             if("${TYPES}" STREQUAL "v")
-                string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.DefSQAdvancedStaticMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\");")
+                string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.DefSQAdvancedStaticMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\");")
             else()
-                string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.DefSQStaticMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\",${SPACES}${ARGC}, \"${TYPES}\");")
+                string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.DefSQStaticMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\",${SPACES}\"${TYPES}\");")
             endif()
         endforeach()
         if(MLEN)
@@ -503,8 +499,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
         foreach(METHOD IN LISTS METHODS)
             string(REPLACE ":" ";" METHOD "${METHOD}")
             list(GET METHOD 0 FUNCNAME)
-            list(GET METHOD 1 ARGC)
-            list(GET METHOD 2 TYPES)
+            list(GET METHOD 1 TYPES)
             string(LENGTH "${FUNCNAME}" LEN)
             math(EXPR LEN "${MLEN} - ${LEN}")
             if("${TYPES}" STREQUAL "v")
@@ -519,16 +514,16 @@ foreach(LINE IN LISTS SOURCE_LINES)
                 string(APPEND SPACES " ")
             endforeach()
             if("${TYPES}" STREQUAL "v")
-                string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.DefSQAdvancedMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\");")
+                string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.DefSQAdvancedMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\");")
             else()
-                string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.DefSQMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\",${SPACES}${ARGC}, \"${TYPES}\");")
+                string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.DefSQMethod(engine, &${CLS}::${FUNCNAME},${SPACES}\"${FUNCNAME}\",${SPACES}\"${TYPES}\");")
             endif()
         endforeach()
         if(MLEN)
             string(APPEND SQUIRREL_EXPORT "\n")
         endif()
 
-        string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.PostRegister(engine);")
+        string(APPEND SQUIRREL_EXPORT "\n\tSQ${API_CLS}.PostRegister(engine);")
         string(APPEND SQUIRREL_EXPORT "\n}")
 
         reset_reader()
@@ -541,9 +536,13 @@ foreach(LINE IN LISTS SOURCE_LINES)
         continue()
     endif()
 
+    if(NOT BRACE_LEVEL EQUAL CLS_LEVEL)
+        continue()
+    endif()
+
     # Add enums
     if(IN_ENUM)
-        string(REGEX MATCH "([^,	 ]+)" ENUM_VALUE "${LINE}")
+        string(REGEX MATCH "([^,\t ]+)" ENUM_VALUE "${LINE}")
         list(APPEND ENUM_VALUES "${ENUM_VALUE}")
 
         # Check if this a special error enum
@@ -551,12 +550,12 @@ foreach(LINE IN LISTS SOURCE_LINES)
         if("${ENUM}" MATCHES ".*::ErrorMessages")
             # syntax:
             # enum ErrorMessages {
-            #	ERR_SOME_ERROR,	// [STR_ITEM1, STR_ITEM2, ...]
+            #\tERR_SOME_ERROR,\t// [STR_ITEM1, STR_ITEM2, ...]
             # }
 
             # Set the mappings
             if("${LINE}" MATCHES "\\[(.*)\\]")
-                string(REGEX REPLACE "[ 	]" "" MAPPINGS "${CMAKE_MATCH_1}")
+                string(REGEX REPLACE "[ \t]" "" MAPPINGS "${CMAKE_MATCH_1}")
                 string(REPLACE "," ";" MAPPINGS "${MAPPINGS}")
 
                 foreach(MAPPING IN LISTS MAPPINGS)
@@ -570,7 +569,11 @@ foreach(LINE IN LISTS SOURCE_LINES)
     endif()
 
     # Add a const (non-enum) value
-    if("${LINE}" MATCHES "^[ 	]*static const [^ ]+ ([^ ]+) = -?\\(?[^ ]*\\)?[^ ]+;")
+    if("${LINE}" MATCHES "^[ \t]*static const [^ ]+ ([^ ]+) = -?\\(?[^ ]*\\)?[^ ]+;")
+        list(APPEND CONST_VALUES "${CMAKE_MATCH_1}")
+        continue()
+    endif()
+    if("${LINE}" MATCHES "^[ \t]*static constexpr [^ ]+ ([^ ]+) = -?\\(?[^ ]*\\)?[^ ]+;")
         list(APPEND CONST_VALUES "${CMAKE_MATCH_1}")
         continue()
     endif()
@@ -582,41 +585,43 @@ foreach(LINE IN LISTS SOURCE_LINES)
         endif()
         if("${LINE}" MATCHES "~")
             if(DEFINED API_SELECTED)
-                message(WARNING "Destructor for '${CLS}' has @api. Tag ignored.")
+                message(WARNING "${SCRIPT_API_FILE}:${NUM_LINE}: Destructor for '${CLS}' has @api. Tag ignored.")
                 unset(API_SELECTED)
             endif()
             continue()
         endif()
 
         unset(IS_STATIC)
-        if("${LINE}" MATCHES "static")
+        if("${LINE}" MATCHES "static ")
             set(IS_STATIC TRUE)
         endif()
 
-        string(REGEX REPLACE "(virtual|static|const)[ 	]+" "" LINE "${LINE}")
+        string(REGEX REPLACE "(virtual|static|const)[ \t]+" "" LINE "${LINE}")
         string(REGEX REPLACE "{.*" "" LINE "${LINE}")
         set(PARAM_S "${LINE}")
         string(REGEX REPLACE "\\*" "" LINE "${LINE}")
         string(REGEX REPLACE "\\(.*" "" LINE "${LINE}")
 
-        string(REGEX REPLACE ".*\\(" "" PARAM_S "${PARAM_S}")
+        # Parameters start at first "(". Further "(" will appear in ctor lists.
+        string(REGEX MATCH "\\(.*" PARAM_S "${PARAM_S}")
         string(REGEX REPLACE "\\).*" "" PARAM_S "${PARAM_S}")
+        string(REGEX REPLACE "^\\(" "" PARAM_S "${PARAM_S}")
 
-        string(REGEX MATCH "([^ 	]+)( ([^ ]+))?" RESULT "${LINE}")
+        string(REGEX MATCH "([^ \t]+)( ([^ ]+))?" RESULT "${LINE}")
         set(FUNCTYPE "${CMAKE_MATCH_1}")
         set(FUNCNAME "${CMAKE_MATCH_3}")
         if("${FUNCTYPE}" STREQUAL "${CLS}" AND NOT FUNCNAME)
             if(DEFINED API_SELECTED)
-                message(WARNING "Constructor for '${CLS}' has @api. Tag ignored.")
+                message(WARNING "${SCRIPT_API_FILE}:${NUM_LINE}: Constructor for '${CLS}' has @api. Tag ignored.")
                 unset(API_SELECTED)
             endif()
-            set(CLS_PARAM_0 "${PARAM_S}")
+            set(CLS_PARAMS "${PARAM_S}")
             if(NOT PARAM_S)
                 continue()
             endif()
         elseif(NOT FUNCNAME)
             continue()
-		endif()
+        endif()
 
         string(REPLACE "," ";" PARAMS "${PARAM_S}")
         if(IS_STATIC)
@@ -625,9 +630,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
             set(TYPES "x")
         endif()
 
-        set(LEN 1)
         foreach(PARAM IN LISTS PARAMS)
-            math(EXPR LEN "${LEN} + 1")
             string(STRIP "${PARAM}" PARAM)
             if("${PARAM}" MATCHES "\\*|&")
                 if("${PARAM}" MATCHES "^char")
@@ -666,13 +669,12 @@ foreach(LINE IN LISTS SOURCE_LINES)
         unset(API_SELECTED)
 
         if("${FUNCTYPE}" STREQUAL "${CLS}" AND NOT FUNCNAME)
-            set(CLS_PARAM_1 ${LEN})
-            set(CLS_PARAM_2 "${TYPES}")
+            set(CLS_TYPES "${TYPES}")
         elseif("${FUNCNAME}" MATCHES "^_" AND NOT "${TYPES}" STREQUAL "v")
         elseif(IS_STATIC)
-            list(APPEND STATIC_METHODS "${FUNCNAME}:${LEN}:${TYPES}")
+            list(APPEND STATIC_METHODS "${FUNCNAME}:${TYPES}")
         else()
-            list(APPEND METHODS "${FUNCNAME}:${LEN}:${TYPES}")
+            list(APPEND METHODS "${FUNCNAME}:${TYPES}")
         endif()
         continue()
     endif()

cmake/scripts/SquirrelIncludes.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.17)
 
 if(NOT INCLUDES_SOURCE_FILE)
     message(FATAL_ERROR "Script needs INCLUDES_SOURCE_FILE defined")
@@ -19,7 +19,7 @@ endif()
 file(READ "${API_FILES}" SCRIPT_API_BINARY_FILES)
 
 foreach(FILE IN LISTS SCRIPT_API_BINARY_FILES)
-    file(STRINGS "${FILE}" LINES REGEX "^void SQ${APIUC}.*_Register\\(Squirrel \\*engine\\)$")
+    file(STRINGS "${FILE}" LINES REGEX "^void SQ${APIUC}.*_Register\\(Squirrel &engine\\)$")
     if(LINES)
         string(REGEX REPLACE ".*api/${APILC}/(.*)" "#include \"\\1\"" FILE "${FILE}")
         list(APPEND SQUIRREL_INCLUDES "${FILE}")
@@ -28,7 +28,7 @@ foreach(FILE IN LISTS SCRIPT_API_BINARY_FILES)
                 continue()
             endif()
             string(REGEX REPLACE "^.*void " "	" LINE "${LINE}")
-            string(REGEX REPLACE "Squirrel \\*" "" LINE "${LINE}")
+            string(REGEX REPLACE "Squirrel &" "" LINE "${LINE}")
             list(APPEND SQUIRREL_REGISTER "${LINE}")
         endforeach()
     endif()

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
-  `ADMIN_PACKET_SERVER_WELCOME`.
+  The `ADMIN_PACKET_ADMIN_JOIN` packet sends the password without any
+  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
@@ -204,7 +223,7 @@ Last updated:    2011-01-20
 
 ## 5.1) Receiving chat
 
-  Register `ADMIN_UPDATE_CHAT` at `ADMIN_FREQUENCY_AUTOMATIC` to receive chat.
+  Register `ADMIN_UPDATE_CHAT` at `AdminUpdateFrequency::Automatic` to receive chat.
   The application will be able to receive all chat the server can see.
 
   The configuration option `network.server_admin_chat` specifies 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'.
-   - Run 'openttd -D -d desync=3 -g startsavegame.sav'.
-     This replays the server log and creates new 'commands-out.log'
-     and 'dmp_cmds_*.sav' in your autosave folder.
+      it to 'commands.log'. Strip everything and including the "newgame"
+      entry from the log.
+   - Run 'openttd -D -d desync=0 -g startsavegame.sav'.
+     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
-  tools at:
-     http://devs.openttd.org/~frosch/texts/zpipe.c
-     http://devs.openttd.org/~frosch/texts/printhunk.c
+  To compare savegame more semantically, easiest is to first export them
+  to a JSON format with for example:
 
-  The first one decompresses OpenTTD savegames. The second one creates
-  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.
+  https://github.com/TrueBrain/OpenTTD-savegame-reader
 
-  If you have the textual representation of the savegames, you can
-  compare them with regular diff tools.
+  By running:
+
+  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/fonts.md

@@ -0,0 +1,62 @@
+# Fonts for OpenTTD
+
+OpenTTD uses four different fonts:
+- a medium font (used for most texts in the game)
+- a small font (used for the smallmap legend etc)
+- a large font (used for news headlines etc)
+- a monospace font (used for text files such as NewGRF readmes).
+
+You can use the following types of fonts with OpenTTD:
+
+## OpenTTD's default fonts
+
+These fonts are OpenTTD Sans (small and medium), OpenTTD Serif (large) and OpenTTD Mono (monospace). They are distributed as part of OpenTTD since version 14. The font files are included in the baseset directory of OpenTTD.
+
+These fonts are active by default and support the Latin, Greek and Cyrillic scripts at present.
+
+## Traditional sprite fonts
+
+These are the classic bitmap fonts included as part of the base graphics. They support only the Latin script.
+
+These fonts can be activated in the Graphics section of the Game options window, by enabling the option "Use traditional sprite fonts".
+
+## System fonts
+
+These are fonts installed on your computer. OpenTTD tries to automatically detect and activate a suitable system font in case you have selected a language not supported by the default fonts. However, if this fails, you may have to set a font manually.
+
+There are two ways to manually set system fonts, using the `font` console command or editing the openttd.cfg file.
+
+### Using the console
+
+Open the console. On most keyboards, this is done by pressing the key to the left of 1 (\` on most English keyboards).
+
+The command to change a font is `font [medium|small|large|mono] [<font name>] [<size>]`.
+For example, `font large "Times New Roman" 16`.
+
+The font name should be enclosed in double quotes if it contains spaces. Note that the size provided is multiplied by the interface scaling factor.
+
+You can reset the font and size to the defaults by providing the font name "" (a blank font name). This will result in the OpenTTD default font or sprite font (depending on the setting) if you are using a supported language, or a default font determined by your OS otherwise.
+
+You can view the current font configuration by running the command `font` without any arguments.
+
+For more information, run the command `help font`.
+
+### Using openttd.cfg
+
+In openttd.cfg, the following settings under the `[misc]` section determine the font (this is just an example):
+```
+small_font =
+medium_font = Arial Bold
+large_font = Times New Roman
+mono_font =
+small_size = 6
+medium_size = 10
+large_size = 18
+mono_size = 10
+```
+
+If these settings are not present, you can add them under the `[misc]` section.
+
+If any font names are left blank, the default font and size are used.
+
+If you cannot find the openttd.cfg file, see [the directory structure guide](./directory_structure.md).

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

@@ -64,7 +64,7 @@
       <tr bgcolor="#CCCCCC"><td colspan="2">Only meaningful in tropic climate. It contains the definition of the available zones</td></tr>
       <tr><td style="width: 5em;"><tt>00</tt></td><td>normal</td></tr>
       <tr><td><tt>01</tt></td><td>desert</td></tr>
-      <tr><td><tt>02</tt></td><td>rain forest</td></tr>
+      <tr><td><tt>02</tt></td><td>rainforest</td></tr>
      </table>
      In any other climate these 2 bits are theoretically free of use, however using them does not seem useful.
     </li>
@@ -721,10 +721,10 @@
         </ul>
        </li>
       </ul>
-     <li>m3 bit 6 : bit 8 of house type (m4), allowing 512 different types.</li>
-     <li>m3 bit 5 : free</li>
+     <li>m3 bit 6 : free</li>
+     <li>m3 bit 5 : The house is protected from the town upgrading it</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 +740,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 +760,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 +879,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 +978,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 +1027,16 @@
        </tr>
       </table>
      </li>
-     <li>m6 bit 7: rail station / waypoint may have catenary pylons</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 bits 6..3: the station type (rail, airport, truck, bus, oilrig, dock, buoy, waypoint, road 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 +1053,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>
-        <td nowrap valign=top><tt>00</tt>&nbsp; </td>
-        <td align=left>water, canal or river</td>
-       </tr>
-
-       <tr>
-        <td nowrap valign=top><tt>01</tt>&nbsp; </td>
-        <td align=left>coast or riverbank</td>
-       </tr>
-
-       <tr>
-        <td nowrap valign=top><tt>10</tt>..<tt>1B</tt>&nbsp; </td>
-        <td align=left>canal locks
-         <table>
-          <tr>
-           <td nowrap valign=top><tt>10</tt>&nbsp; </td>
-           <td align=left>middle part, (SW-NE direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>11</tt>&nbsp; </td>
-           <td align=left>middle part, (NW-SE direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>12</tt>&nbsp; </td>
-           <td align=left>middle part, (NE-SW direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>13</tt>&nbsp; </td>
-           <td align=left>middle part, (SE-NW direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>14</tt>&nbsp; </td>
-           <td align=left>lower part, (SW-NE direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>15</tt>&nbsp; </td>
-           <td align=left>lower part, (NW-SE direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>16</tt>&nbsp; </td>
-           <td align=left>lower part, (NE-SW direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>17</tt>&nbsp; </td>
-           <td align=left>lower part, (SE-NW direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>18</tt>&nbsp; </td>
-           <td align=left>upper part, (SW-NE direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>19</tt>&nbsp; </td>
-           <td align=left>upper part, (NW-SE direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>1A</tt>&nbsp; </td>
-           <td align=left>upper part, (NE-SW direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>1B</tt>&nbsp; </td>
-           <td align=left>upper part, (SE-NW direction)</td>
-          </tr>
-         </table>
-        </td>
-       </tr>
-
-       <tr>
-        <td nowrap valign=top><tt>80</tt>..<tt>83</tt>&nbsp; </td>
-        <td align=left>ship depots
-         <table>
-          <tr>
-           <td nowrap valign=top><tt>80</tt>&nbsp; </td>
-           <td align=left>ship depot, NE part (X direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>81</tt>&nbsp; </td>
-           <td align=left>ship depot, SW part (X direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>82</tt>&nbsp; </td>
-           <td align=left>ship depot, NW part (Y direction)</td>
-          </tr>
-          <tr>
-           <td nowrap valign=top><tt>83</tt>&nbsp; </td>
-           <td align=left>ship depot, SE part (Y direction)</td>
-          </tr>
-         </table>
-        </td>
-       </tr>
-      </table>
+        <tr>
+         <td><tt>0</tt>&nbsp; </td>
+         <td>water, canal or river</td>
+        </tr>
+        <tr>
+         <td><tt>1</tt>&nbsp; </td>
+         <td>coast or riverbank</td>
+        </tr>
+        <tr>
+         <td nowrap valign=top><tt>2</tt>&nbsp; </td>
+         <td>canal lock<br>
+          <ul>
+           <li>m5 bits 3..2: Lock part
+            <table>
+             <tr>
+              <td><tt>0</tt>&nbsp; </td>
+              <td>Middle part</td>
+             </tr>
+             <tr>
+              <td><tt>1</tt>&nbsp; </td>
+              <td>Lower part</td>
+             </tr>
+             <tr>
+              <td><tt>2</tt>&nbsp; </td>
+              <td>Upper part</td>
+             </tr>
+            </table>
+           </li>
+           <li>m5 bits 1..0: Lock direction
+            <table>
+             <tr>
+              <td><tt>0</tt>&nbsp; </td>
+              <td>NE raised</td>
+             </tr>
+             <tr>
+              <td><tt>1</tt>&nbsp; </td>
+              <td>SE raised</td>
+             </tr>
+             <tr>
+              <td><tt>2</tt>&nbsp; </td>
+              <td>SW raised</td>
+             </tr>
+             <tr>
+              <td><tt>3</tt>&nbsp; </td>
+              <td>NW raised</td>
+             </tr>
+            </table>
+           </li>
+          </ul>
+         </td>
+        </tr>
+        <tr>
+         <td nowrap valign=top><tt>3</tt>&nbsp; </td>
+         <td>depot<br>
+          <ul>
+           <li>m5 bit 1: Depot axis
+            <table>
+             <tr>
+              <td><tt>0</tt>&nbsp; </td>
+              <td>X direction (NE-SW)</td>
+             </tr>
+             <tr>
+              <td><tt>1</tt>&nbsp; </td>
+              <td>Y direction (NW-SE)</td>
+             </tr>
+            </table>
+           </li>
+           <li>m5 bit 0: Depot part
+            <table>
+             <tr>
+              <td><tt>0</tt>&nbsp; </td>
+              <td>North part</td>
+             </tr>
+             <tr>
+              <td><tt>1</tt>&nbsp; </td>
+              <td>South part</td>
+             </tr>
+            </table>
+           </li>
+          </ul>
+         </td>
+        </tr>
+       </table>
+      </li>
      </li>
     </ul>
    </td>
@@ -1451,6 +1483,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 +1656,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=27><span class="used" title="Tile height">XXXX XXXX</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=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" rowspan=2><span class="used" title="House type (m4 + m3[6])">XXXX XXXX</span></td>
+      <td class="bits"><span class="used" title="House is complete/in construction (see m5)">1</span><span class="free">O</span><span class="used" title="The house is protected from the town upgrading it.">X</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="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="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="used" title="House is complete/in construction (see m5)">O</span><span class="used" title="House type (m4 + m3[6])">X</span><span class="used" title="The house is protected from the town upgrading it.">X</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">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=7><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=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=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">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"><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"><span class="free">OOO</span><span class="used" title="Owner of road">X 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" 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=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" 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 class="caption">sea, shore</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=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 rowspan=5>6</td>
+      <td class="caption">sea</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=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">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</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/obg_format.txt

@@ -16,8 +16,11 @@
 ; - `openttd -I <name>` starts OpenTTD with the given set (case sensitive)
 ; - adding `graphicsset = <name>` to the misc section of openttd.cfg makes
 ;   OpenTTD start with that graphics set by default
-; - there is a command line tool for all platforms called md5sum that can
-;   create the MD5 checksum you need.
+; - `grfid -m` can give the GRF file MD5 checksums that you need
+; - The `--md5` output option for `nmlc` can also give the MD5 if you are
+;   encoding from an nml source
+; - Simple file MD5 checksums, eg. using `md5sum` are not correct for grf
+;   container versions other than 1
 ; - all files specified in this file are search relatively to the path where
 ;   this file is found, i.e. if the graphics files are in a subdir you have
 ;   to add that subdir to the names in this file to! It will NOT search for
@@ -44,6 +47,8 @@ description.en_US = howdie
 palette      = DOS
 ; preferred blitter, optional; either 8bpp (default) or 32bpp.
 blitter      = 8bpp
+; url, optional
+url          = https://github.com/my/baseset
 
 ; The files section lists the files that replace sprites.
 ; The file names are case sensitive.

docs/openttd.6

@@ -20,7 +20,6 @@
 .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
@@ -100,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
-  * 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 src/script/api/ai_changelog.hpp + src/script/api/game_changelog.hpp
-  * 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.
+  * 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 the new version to `ApiVersions` in `src/ai/ai_info.hpp` and `src/game/game_info.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`.
+  * Add a new (empty) AI compatibility script in `bin/ai/` and `bin/game/` for the version of 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.
-2. Merge website PR.
-3. Wait for the OpenTTD release checks 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/).
-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.
+1. Confirm that the version in `CMakeLists.txt` matches the intended release version.
+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 workflow to be complete.
+4. If this is a full release:
+   * 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.
-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.
+1. Merge the website PR. This will publish the release post.
+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.

known-bugs.md

@@ -0,0 +1,426 @@
+# OpenTTD's known bugs
+
+## Table of contents
+
+- 1.0) [About](#10-about)
+- 2.0) [Known bugs](#20-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](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.