Doc: Changelog for 13.2.1 (#10988)

On Windows in fullscreen you cannot reach the top with
the cursor for the halve of the height of your toolbar.

Additionally, on Win10 in fullscreen you can see the actual toolbar.

.dorpsgek.yml

@@ -10,6 +10,7 @@ notifications:
     only-by:
     - DorpsGek
   commit-comment:
+  discussion:
   pull-request:
   issue:
   tag-created:

.github/ISSUE_TEMPLATE.md

@@ -1,7 +0,0 @@
-## Version of OpenTTD
-
-## Expected result
-
-## Actual result
-
-## Steps to reproduce

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,41 @@
+name: Bug Report
+description: Found a bug in OpenTTD?
+title: "[Bug]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: version
+    attributes:
+      label: Version of OpenTTD
+      description: Fill in below what version of OpenTTD you are using, including your OS.
+      placeholder: ex. 1.11.2, Windows 10
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected result
+      description: Describe in a few words what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual result
+      description: Describe in a few words what actually happens.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: As detailed as possible, please tell us how we can reproduce this. Feel free to attach a savegame (zip it first) to make it more clear.
+      placeholder: |
+        1. Loaded the attached savegame.
+        2. Click on the button left of that other icon.
+        3. The window doesn't open.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+- name: Suggestions and ideas?
+  url: https://www.tt-forums.net/viewforum.php?f=32
+  about: Have a suggestion or an idea for a cool new feature? Post them on our forum!

.github/ISSUE_TEMPLATE/crash.yaml

@@ -0,0 +1,37 @@
+name: Crash
+description: Did OpenTTD crash?
+title: "[Crash]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this crash report!
+  - type: input
+    id: version
+    attributes:
+      label: Version of OpenTTD
+      description: Fill in below what version of OpenTTD you are using, including your OS.
+      placeholder: ex. 1.11.2, Windows 10
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Please spend a few words if you can reproduce this problem.
+      placeholder: |
+        1. Bought a new train.
+        2. The game crashed.
+    validations:
+      required: true
+  - type: textarea
+    id: crashlogs
+    attributes:
+      label: Upload crash files
+      description: With the `crash.log`, `crash.dmp`, and `crash.sav` we can analyze the crash in detail; this way you allow us to easier triage and fix the problem.
+      placeholder: |
+        1. Zip the `crash.log`, `crash.dmp` and `crash.sav`.
+        2. Click on this field.
+        3. Drag and drop the zip file in here.
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -39,6 +39,7 @@ 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, gs_changelog.hpp need updating.

.github/changelog.sh

@@ -4,9 +4,9 @@ tag=$(git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null | sed 's@\
 
 # If we are a tag, show the part of the changelog till (but excluding) the last stable
 if [ -n "$tag" ]; then
-    grep='^[0-9]\+\.[0-9]\+\.[0-9]\+[^-]'
+    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]+.[0-9]+/ { if ($1=="'$next'") show="false"; if ($1=="'$tag'") show="true";} // { if (show=="true") print $0 }'
+    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
 

.github/stale.yml

@@ -1,34 +0,0 @@
-daysUntilClose: 7
-staleLabel: stale
-closeComment: false
-exemptMilestones: true
-exemptAssignees: true
-
-issues:
-  daysUntilStale: 60
-  exemptLabels:
-  - pinned
-  - security
-  - "good first issue"
-  - regression
-  markComment: >
-    This issue has been automatically marked as stale because it has not had any activity in the last two months.
-
-    If you believe the issue is still relevant, please test on the latest nightly and report back.
-
-    It will be closed if no further activity occurs within 7 days.
-
-    Thank you for your contributions.
-
-pulls:
-  daysUntilStale: 30
-  exemptLabels:
-  - pinned
-  markComment: >
-    This pull request has been automatically marked as stale because it has not had any activity in the last month.
-
-    Please feel free to give a status update now, ping for review, or re-open when it's ready.
-
-    It will be closed if no further activity occurs within 7 days.
-
-    Thank you for your contributions.

.github/unused-strings.py

@@ -0,0 +1,221 @@
+"""
+Script to scan the OpenTTD source-tree for STR_ entries that are defined but
+no longer used.
+
+This is not completely trivial, as OpenTTD references a lot of strings in
+relation to another string. The most obvious example of this is a list. OpenTTD
+only references the first entry in the list, and does "+ <var>" to get to the
+correct string.
+
+There are other ways OpenTTD does use relative values. This script tries to
+account for all of them, to give the best approximation we have for "this
+string is unused".
+"""
+
+import glob
+import os
+import re
+import subprocess
+import sys
+
+from enum import Enum
+
+LENGTH_NAME_LOOKUP = {
+    "VEHICLE_TYPES": 4,
+}
+
+
+class SkipType(Enum):
+    NONE = 1
+    LENGTH = 2
+    EXTERNAL = 3
+    ZERO_IS_SPECIAL = 4
+    EXPECT_NEWLINE = 5
+
+
+def read_language_file(filename, strings_found, errors):
+    strings_defined = []
+
+    skip = SkipType.NONE
+    length = 0
+    common_prefix = ""
+    last_tiny_string = ""
+
+    with open(filename) as fp:
+        for line in fp.readlines():
+            if not line.strip():
+                if skip == SkipType.EXPECT_NEWLINE:
+                    skip = SkipType.NONE
+                continue
+
+            line = line.strip()
+
+            if skip == SkipType.EXPECT_NEWLINE:
+                # The only thing allowed after a list, is this next marker, or a newline.
+                if line == "###next-name-looks-similar":
+                    # "###next-name-looks-similar"
+                    # Indicates the common prefix of the last list has a very
+                    # similar name to the next entry, but isn't part of the
+                    # list. So do not emit a warning about them looking very
+                    # similar.
+
+                    if length != 0:
+                        errors.append(f"ERROR: list around {name} is shorted than indicated by ###length")
+
+                    common_prefix = ""
+                else:
+                    errors.append(f"ERROR: expected a newline after a list, but didn't find any around {name}. Did you add an entry to the list without increasing the length?")
+
+                skip = SkipType.NONE
+
+            if line[0] == "#":
+                if line.startswith("###length "):
+                    # "###length <count>"
+                    # Indicates the next few entries are part of a list. Only
+                    # the first entry is possibly referenced, and the rest are
+                    # indirectly.
+
+                    if length != 0:
+                        errors.append(f"ERROR: list around {name} is shorted than indicated by ###length")
+
+                    length = line.split(" ")[1].strip()
+
+                    if length.isnumeric():
+                        length = int(length)
+                    else:
+                        length = LENGTH_NAME_LOOKUP[length]
+
+                    skip = SkipType.LENGTH
+                elif line.startswith("###external "):
+                    # "###external <count>"
+                    # Indicates the next few entries are used outside the
+                    # source and will not be referenced.
+
+                    if length != 0:
+                        errors.append(f"ERROR: list around {name} is shorted than indicated by ###length")
+
+                    length = line.split(" ")[1].strip()
+                    length = int(length)
+
+                    skip = SkipType.EXTERNAL
+                elif line.startswith("###setting-zero-is-special"):
+                    # "###setting-zero-is-special"
+                    # Indicates the next entry is part of the "zero is special"
+                    # flag of settings. These entries are not referenced
+                    # directly in the code.
+
+                    if length != 0:
+                        errors.append(f"ERROR: list around {name} is shorted than indicated by ###length")
+
+                    skip = SkipType.ZERO_IS_SPECIAL
+
+                continue
+
+            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
+
+            if skip == SkipType.LENGTH:
+                skip = SkipType.NONE
+                length -= 1
+                common_prefix = name
+            elif skip == SkipType.ZERO_IS_SPECIAL:
+                strings_found.add(name)
+            elif length > 0:
+                strings_found.add(name)
+                length -= 1
+
+                # Find the common prefix of these strings
+                for i in range(len(common_prefix)):
+                    if common_prefix[0 : i + 1] != name[0 : i + 1]:
+                        common_prefix = common_prefix[0:i]
+                        break
+
+                if length == 0:
+                    skip = SkipType.EXPECT_NEWLINE
+
+                    if len(common_prefix) < 6:
+                        errors.append(f"ERROR: common prefix of block including {name} was reduced to {common_prefix}. This means the names in the list are not consistent.")
+            elif common_prefix:
+                if name.startswith(common_prefix):
+                    errors.append(f"ERROR: {name} looks a lot like block above with prefix {common_prefix}. This mostly means that the list length was too short. Use '###next-name-looks-similar' if it is not.")
+                common_prefix = ""
+
+    return strings_defined
+
+
+def scan_source_files(path, strings_found):
+    for new_path in glob.glob(f"{path}/*"):
+        if os.path.isdir(new_path):
+            scan_source_files(new_path, strings_found)
+            continue
+
+        if not new_path.endswith((".c", ".h", ".cpp", ".hpp", ".ini")):
+            continue
+
+        # 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)
+            output = p.stdout.decode()
+        else:
+            with open(new_path) as fp:
+                output = fp.read()
+
+        # Find all the string references.
+        matches = re.findall(r"[^A-Z_](STR_[A-Z0-9_]*)", output)
+        strings_found.update(matches)
+
+
+def main():
+    strings_found = set()
+    errors = []
+
+    scan_source_files("src", strings_found)
+    strings_defined = read_language_file("src/lang/english.txt", strings_found, errors)
+
+    # STR_LAST_STRINGID is special, and not really a string.
+    strings_found.remove("STR_LAST_STRINGID")
+    # These are mentioned in comments, not really a string.
+    strings_found.remove("STR_XXX")
+    strings_found.remove("STR_NEWS")
+    strings_found.remove("STR_CONTENT_TYPE_")
+
+    # This string is added for completion, but never used.
+    strings_defined.remove("STR_JUST_DATE_SHORT")
+
+    strings_defined = sorted(strings_defined)
+    strings_found = sorted(list(strings_found))
+
+    for string in strings_found:
+        if string not in strings_defined:
+            errors.append(f"ERROR: {string} found but never defined.")
+
+    for string in strings_defined:
+        if string not in strings_found:
+            errors.append(f"ERROR: {string} is (possibly) no longer needed.")
+
+    if errors:
+        for error in errors:
+            print(error)
+        sys.exit(1)
+    else:
+        print("OK")
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/ci-build.yml

@@ -16,17 +16,22 @@ jobs:
     runs-on: ubuntu-20.04
     container:
       # If you change this version, change the number in the cache step too.
-      image: emscripten/emsdk:2.0.10
+      image: emscripten/emsdk:3.1.28
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: /emsdk/upstream/emscripten/cache
-        key: 2.0.10-${{ runner.os }}
+        key: 3.1.28-${{ 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: |
@@ -39,7 +44,7 @@ jobs:
 
         echo "::group::Build"
         echo "Running on $(nproc) cores"
-        make -j$(nproc) tools
+        cmake --build . -j $(nproc) --target tools
         echo "::endgroup::"
 
     - name: Install GCC problem matcher
@@ -56,7 +61,7 @@ jobs:
 
         echo "::group::Build"
         echo "Running on $(nproc) cores"
-        emmake make -j$(nproc)
+        cmake --build . -j $(nproc)
         echo "::endgroup::"
 
   linux:
@@ -66,10 +71,18 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - compiler: clang
-            cxxcompiler: clang++
-          - compiler: gcc
-            cxxcompiler: g++
+        - compiler: clang
+          cxxcompiler: clang++
+          libsdl: libsdl2-dev
+        - compiler: gcc
+          cxxcompiler: g++
+          libsdl: libsdl2-dev
+        - compiler: gcc
+          cxxcompiler: g++
+          libsdl: libsdl1.2-dev
+        - compiler: gcc
+          cxxcompiler: g++
+          extra-cmake-parameters: -DOPTION_DEDICATED=ON -DCMAKE_CXX_FLAGS_INIT="-DRANDOM_DEBUG"
 
     runs-on: ubuntu-20.04
     env:
@@ -78,7 +91,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Install dependencies
       run: |
@@ -88,12 +101,12 @@ jobs:
 
         echo "::group::Install dependencies"
         sudo apt-get install -y --no-install-recommends \
+          liballegro4-dev \
           libfontconfig-dev \
           libicu-dev \
           liblzma-dev \
           liblzo2-dev \
-          libsdl1.2-dev \
-          libsdl2-dev \
+          ${{ matrix.libsdl }} \
           zlib1g-dev \
           # EOF
         echo "::endgroup::"
@@ -124,18 +137,18 @@ jobs:
         cd build
 
         echo "::group::CMake"
-        cmake ..
+        cmake .. ${{ matrix.extra-cmake-parameters }}
         echo "::endgroup::"
 
         echo "::group::Build"
         echo "Running on $(nproc) cores"
-        make -j$(nproc)
+        cmake --build . -j $(nproc)
         echo "::endgroup::"
 
     - name: Test
       run: |
         cd build
-        make -j$(nproc) test
+        ctest -j $(nproc) --timeout 120
 
   macos:
     name: Mac OS
@@ -149,19 +162,42 @@ jobs:
 
     runs-on: macos-latest
     env:
-      MACOSX_DEPLOYMENT_TARGET: 10.9
+      MACOSX_DEPLOYMENT_TARGET: 10.13
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
-    - name: Prepare vcpkg (with cache)
-      uses: lukka/run-vcpkg@v6
+    - name: Install dependencies
+      env:
+        HOMEBREW_NO_AUTO_UPDATE: 1
+        HOMEBREW_NO_INSTALL_CLEANUP: 1
+      run: |
+        brew install \
+          pkg-config \
+          # EOF
+
+    - name: Prepare cache key
+      id: key
+      run: |
+        echo "image=$ImageOS-$ImageVersion" >> $GITHUB_OUTPUT
+
+    - name: Enable vcpkg cache
+      uses: actions/cache@v3
       with:
-        vcpkgDirectory: '/usr/local/share/vcpkg'
-        doNotUpdateVcpkg: true
-        vcpkgArguments: 'freetype liblzma lzo'
-        vcpkgTriplet: '${{ matrix.arch }}-osx'
+        path: /usr/local/share/vcpkg/installed
+        key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-0 # Increase the number whenever dependencies are modified
+        restore-keys: |
+          ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}
+
+    - name: Prepare vcpkg
+      run: |
+        vcpkg install --triplet=${{ matrix.arch }}-osx \
+          liblzma \
+          libpng \
+          lzo \
+          zlib \
+          # EOF
 
     - name: Install OpenGFX
       run: |
@@ -196,13 +232,13 @@ jobs:
 
         echo "::group::Build"
         echo "Running on $(sysctl -n hw.logicalcpu) cores"
-        make -j$(sysctl -n hw.logicalcpu)
+        cmake --build . -j $(sysctl -n hw.logicalcpu)
         echo "::endgroup::"
 
     - name: Test
       run: |
         cd build
-        make -j$(sysctl -n hw.logicalcpu) test
+        ctest -j $(sysctl -n hw.logicalcpu) --timeout 120
 
   windows:
     name: Windows
@@ -210,35 +246,41 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        include:
-        - arch: x86
-        - arch: x64
+        os: [windows-latest, windows-2019]
+        arch: [x86, x64]
 
-    runs-on: windows-latest
+    runs-on: ${{ matrix.os }}
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
-    # "restore-cache" which is done by "run-vcpkg" uses Windows tar.
-    # A git clone on windows marks a few files as read-only; when Windows tar
-    # tries to extract the cache over this folder, it fails, despite the files
-    # being identical. This failure shows up as an warning in the logs. We
-    # avoid this by simply removing the read-only mark from the git folder.
-    # In other words: this is a hack!
-    # See: https://github.com/lukka/run-vcpkg/issues/61
-    - name: Remove read-only flag from vcpkg git folder
+    - name: Prepare cache key
+      id: key
       shell: powershell
       run: |
-        attrib -r "c:\vcpkg\.git\*.*" /s
+        # Work around caching failure with GNU tar
+        New-Item -Type Junction -Path vcpkg -Target c:\vcpkg
 
-    - name: Prepare vcpkg (with cache)
-      uses: lukka/run-vcpkg@v6
+        Write-Output "image=$env:ImageOS-$env:ImageVersion" >> $env:GITHUB_OUTPUT
+
+    - name: Enable vcpkg cache
+      uses: actions/cache@v3
       with:
-        vcpkgDirectory: 'c:/vcpkg'
-        doNotUpdateVcpkg: true
-        vcpkgArguments: 'liblzma libpng lzo zlib'
-        vcpkgTriplet: '${{ matrix.arch }}-windows-static'
+        path: vcpkg/installed
+        key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-0 # Increase the number whenever dependencies are modified
+        restore-keys: |
+          ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}
+
+    - name: Prepare vcpkg
+      shell: bash
+      run: |
+        vcpkg install --triplet=${{ matrix.arch }}-windows-static \
+          liblzma \
+          libpng \
+          lzo \
+          zlib \
+          # EOF
 
     - name: Install OpenGFX
       shell: bash
@@ -259,16 +301,120 @@ jobs:
     - name: Install MSVC problem matcher
       uses: ammaraskar/msvc-problem-matcher@master
 
-    - name: Build
-      uses: lukka/run-cmake@v3
+    - name: Configure developer command prompt for ${{ matrix.arch }}
+      uses: ilammy/msvc-dev-cmd@v1
       with:
-        cmakeListsOrSettingsJson: CMakeListsTxtAdvanced
-        useVcpkgToolchainFile: true
-        buildDirectory: '${{ github.workspace }}/build'
-        cmakeAppendedArgs: ' -GNinja'
+        arch: ${{ matrix.arch }}
+
+    - name: Build
+      shell: bash
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake .. \
+          -GNinja \
+          -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
+          -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        cmake --build .
+        echo "::endgroup::"
 
     - name: Test
       shell: bash
       run: |
         cd ${GITHUB_WORKSPACE}/build
-        ctest -C Debug
+        ctest --timeout 120
+
+
+  msys2:
+    name: msys2
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - msystem: MINGW64
+            arch: x86_64
+          - msystem: MINGW32
+            arch: i686
+
+    runs-on: windows-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Setup MSYS2
+      uses: msys2/setup-msys2@v2
+      with:
+        msystem: ${{ matrix.msystem }}
+        release: false
+        install: >-
+          git
+          make
+          mingw-w64-${{ matrix.arch }}-cmake
+          mingw-w64-${{ matrix.arch }}-gcc
+          mingw-w64-${{ matrix.arch }}-lzo2
+          mingw-w64-${{ matrix.arch }}-libpng
+
+    - 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}
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake .. -G"MSYS Makefiles"
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(nproc) cores"
+        cmake --build . -j $(nproc)
+        echo "::endgroup::"
+
+    - name: Test
+      shell: msys2 {0}
+      run: |
+        cd build
+        ctest -j $(nproc) --timeout 120
+
+  check_annotations:
+    name: Check Annotations
+    needs:
+    - emscripten
+    - linux
+    - macos
+    - windows
+    - msys2
+
+    if: always() && github.event_name == 'pull_request'
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check annotations
+      uses: OpenTTD/actions/annotation-check@v3

.github/workflows/commit-checker.yml

@@ -10,42 +10,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         fetch-depth: 4
 
     - name: Get pull-request commits
-      run: |
-        set -x
-        # actions/checkout did a merge checkout of the pull-request. As such, the first
-        # commit is the merge commit. This means that on HEAD^ is the base branch, and
-        # on HEAD^2 are the commits from the pull-request. We now check if those trees
-        # have a common parent. If not, we fetch a few more commits till we do. In result,
-        # the log between HEAD^ and HEAD^2 will be the commits in the pull-request.
-        DEPTH=4
-        while [ -z "$(git merge-base HEAD^ HEAD^2)" ]; do
-            # Prevent infinite recursion
-            if [ ${DEPTH} -gt 256 ]; then
-                echo "No common parent between '${GITHUB_HEAD_REF}' and '${GITHUB_BASE_REF}'." >&2
-                exit 1
-            fi
-
-            git -c protocol.version=2 fetch --no-tags --prune --progress --no-recurse-submodules --deepen=${DEPTH} origin HEAD
-            DEPTH=$(( ${DEPTH} * 4 ))
-        done
-
-        # Just to show which commits we are going to evaluate.
-        git log --oneline HEAD^..HEAD^2
-
-    - name: Checkout commit-checker
-      uses: actions/checkout@v2
-      with:
-        repository: OpenTTD/OpenTTD-git-hooks
-        path: git-hooks
-        ref: master
+      uses: OpenTTD/actions/checkout-pull-request@v2
 
     - name: Check commits
-      run: |
-        set -x
-        HOOKS_DIR=./git-hooks/hooks GIT_DIR=.git ./git-hooks/hooks/check-commits.sh HEAD^..HEAD^2
-        echo "Commit checks passed"
+      uses: OpenTTD/OpenTTD-git-hooks@main

.github/workflows/preview_build.yml

@@ -12,9 +12,7 @@ jobs:
     runs-on: ubuntu-20.04
     container:
       # If you change this version, change the number in the cache step too.
-      image: emscripten/emsdk:2.0.10
-      # uid=1001(runner) gid=121(docker)
-      options: -u 1001:121
+      image: emscripten/emsdk:3.1.28
 
     steps:
     - name: Update deployment status to in progress
@@ -33,7 +31,7 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.PREVIEW_GITHUB_TOKEN }}
 
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         ref: ${{ github.event.client_payload.sha }}
 
@@ -43,10 +41,15 @@ jobs:
         git checkout -b ${name}
 
     - name: Setup cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: /emsdk/upstream/emscripten/cache
-        key: 2.0.10-${{ runner.os }}
+        key: 3.1.28-${{ 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: |
@@ -73,7 +76,7 @@ jobs:
         echo "::group::CMake"
         emcmake cmake .. \
           -DHOST_BINARY_DIR=../build-host \
-          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DCMAKE_BUILD_TYPE=Release \
           # EOF
         echo "::endgroup::"
 
@@ -84,18 +87,15 @@ jobs:
 
     - name: Publish preview
       run: |
-        # setuptools is missing in this Docker image, which breaks installing
-        # awscli. So we need to do this in two steps to recover sanity.
-        pip3 install setuptools
         pip3 install awscli
 
-        ~/.local/bin/aws s3 cp --only-show-errors build/openttd.data s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
-        ~/.local/bin/aws s3 cp --only-show-errors build/openttd.html s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
-        ~/.local/bin/aws s3 cp --only-show-errors build/openttd.js s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
-        ~/.local/bin/aws s3 cp --only-show-errors build/openttd.wasm s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
+        aws s3 cp --only-show-errors build/openttd.data s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
+        aws s3 cp --only-show-errors build/openttd.html s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
+        aws s3 cp --only-show-errors build/openttd.js s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
+        aws s3 cp --only-show-errors build/openttd.wasm s3://${{ secrets.PREVIEW_S3_BUCKET }}/${{ github.event.client_payload.folder }}/
 
         # Invalidate the cache of the CloudFront distribution
-        ~/.local/bin/aws cloudfront create-invalidation --distribution-id ${{ secrets.PREVIEW_CF_DISTRIBUTION_ID }} --paths "/${{ github.event.client_payload.folder }}/*"
+        aws cloudfront create-invalidation --distribution-id ${{ secrets.PREVIEW_CF_DISTRIBUTION_ID }} --paths "/${{ github.event.client_payload.folder }}/*"
       env:
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

.github/workflows/preview_label.yml

@@ -59,7 +59,7 @@ jobs:
 
     - if: steps.core_developer.outcome == 'success'
       name: Trigger 'preview build'
-      uses: peter-evans/repository-dispatch@v1
+      uses: peter-evans/repository-dispatch@v2
       with:
         token: ${{ secrets.PREVIEW_GITHUB_TOKEN }}
         event-type: "Preview build #${{ github.event.number }}"

.github/workflows/preview_push.yml

@@ -59,7 +59,7 @@ jobs:
 
     - if: toJson(fromJson(steps.earlier_preview.outputs.data)) != '[]' && contains(fromJson(steps.preview_label.outputs.data).*.name, 'preview')
       name: Trigger 'preview build'
-      uses: peter-evans/repository-dispatch@v1
+      uses: peter-evans/repository-dispatch@v2
       with:
         token: ${{ secrets.PREVIEW_GITHUB_TOKEN }}
         event-type: "Preview build #${{ github.event.number }}"

.github/workflows/release-docs.yml

@@ -0,0 +1,85 @@
+name: Release (Docs)
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+
+jobs:
+  docs:
+    name: Docs
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - name: Download source
+      uses: actions/download-artifact@v3
+      with:
+        name: internal-source
+
+    - name: Unpack source
+      run: |
+        tar -xf source.tar.gz --strip-components=1
+
+    - 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 \
+          doxygen \
+          # EOF
+        echo "::endgroup::"
+      env:
+        DEBIAN_FRONTEND: noninteractive
+
+    - name: Build
+      run: |
+        mkdir -p ${GITHUB_WORKSPACE}/build
+        cd ${GITHUB_WORKSPACE}/build
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_DOCS_ONLY=ON \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        cmake --build . --target docs
+        echo "::endgroup::"
+
+    - name: Create bundles
+      run: |
+        BASENAME=openttd-${{ inputs.version }}
+
+        cd ${GITHUB_WORKSPACE}/build
+
+        mv docs/source ${BASENAME}-docs
+        mv docs/ai-api ${BASENAME}-docs-ai
+        mv docs/gs-api ${BASENAME}-docs-gs
+
+        mkdir -p bundles
+
+        echo "::group::Create docs bundle"
+        tar --xz -cf bundles/${BASENAME}-docs.tar.xz ${BASENAME}-docs
+        echo "::endgroup::"
+
+        echo "::group::Create AI API docs bundle"
+        tar --xz -cf bundles/${BASENAME}-docs-ai.tar.xz ${BASENAME}-docs-ai
+        echo "::endgroup::"
+
+        echo "::group::Create GameScript API docs bundle"
+        tar --xz -cf bundles/${BASENAME}-docs-gs.tar.xz ${BASENAME}-docs-gs
+        echo "::endgroup::"
+
+    - name: Store bundles
+      uses: actions/upload-artifact@v3
+      with:
+        name: openttd-docs
+        path: build/bundles/*.tar.xz
+        retention-days: 5

.github/workflows/release-linux.yml

@@ -0,0 +1,100 @@
+name: Release (Linux)
+
+on:
+  workflow_call:
+
+jobs:
+  linux:
+    name: Linux (Generic)
+
+    runs-on: ubuntu-20.04
+    container:
+      # manylinux2014 is based on CentOS 7, but already has a lot of things
+      # installed and preconfigured. It makes it easier to build OpenTTD.
+      image: quay.io/pypa/manylinux2014_x86_64
+
+    steps:
+    - name: Download source
+      uses: actions/download-artifact@v3
+      with:
+        name: internal-source
+
+    - name: Unpack source
+      run: |
+        tar -xf source.tar.gz --strip-components=1
+
+    - name: Install dependencies
+      run: |
+        echo "::group::Install dependencies"
+        yum install -y \
+          fontconfig-devel \
+          freetype-devel \
+          libicu-devel \
+          libpng-devel \
+          lzo-devel \
+          SDL2-devel \
+          wget \
+          xz-devel \
+          zlib-devel \
+          # EOF
+        echo "::endgroup::"
+
+        # The yum variant of fluidsynth depends on all possible audio drivers,
+        # like jack, ALSA, pulseaudio, etc. This is not really useful for us,
+        # as we route the output of fluidsynth back via our sound driver, and
+        # as such do not use these audio driver outputs at all. So instead,
+        # we compile fluidsynth ourselves, with as little dependencies as
+        # possible. This currently means it picks up SDL2, but this is fine,
+        # as we need SDL2 anyway.
+        echo "::group::Install fluidsynth"
+        wget https://github.com/FluidSynth/fluidsynth/archive/v2.1.6.tar.gz
+        tar xf v2.1.6.tar.gz
+        (
+          cd fluidsynth-2.1.6
+          mkdir build
+          cd build
+          cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_INSTALL_PREFIX=/usr
+          cmake --build . -j $(nproc)
+          cmake --install .
+        )
+        echo "::endgroup::"
+
+    - name: Install GCC problem matcher
+      uses: ammaraskar/gcc-problem-matcher@master
+
+    - name: Build
+      run: |
+        mkdir -p build
+        cd build
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_PACKAGE_DEPENDENCIES=ON \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(nproc) cores"
+        cmake --build . -j $(nproc)
+        echo "::endgroup::"
+
+    - name: Create bundles
+      run: |
+        cd ${GITHUB_WORKSPACE}/build
+        echo "::group::Run CPack"
+        cpack
+        echo "::endgroup::"
+
+        echo "::group::Cleanup"
+        # Remove the sha256 files CPack generates; we will do this ourself at
+        # the end of this workflow.
+        rm -f bundles/*.sha256
+        echo "::endgroup::"
+
+    - name: Store bundles
+      uses: actions/upload-artifact@v3
+      with:
+        name: openttd-linux-generic
+        path: build/bundles
+        retention-days: 5

.github/workflows/release-macos.yml

@@ -0,0 +1,198 @@
+name: Release (MacOS)
+
+on:
+  workflow_call:
+
+jobs:
+  macos:
+    name: MacOS
+
+    runs-on: macos-11
+    env:
+      MACOSX_DEPLOYMENT_TARGET: 10.13
+
+    steps:
+    - name: Download source
+      uses: actions/download-artifact@v3
+      with:
+        name: internal-source
+
+    - name: Unpack source
+      run: |
+        tar -xf source.tar.gz --strip-components=1
+
+    - name: Install dependencies
+      env:
+        HOMEBREW_NO_AUTO_UPDATE: 1
+        HOMEBREW_NO_INSTALL_CLEANUP: 1
+      run: |
+        brew install \
+          pandoc \
+          pkg-config \
+          # EOF
+
+    - name: Prepare cache key
+      id: key
+      run: |
+        echo "image=$ImageOS-$ImageVersion" >> $GITHUB_OUTPUT
+
+    - name: Enable vcpkg cache
+      uses: actions/cache@v3
+      with:
+        path: /usr/local/share/vcpkg/installed
+        key: ${{ steps.key.outputs.image }}-vcpkg-release-0 # Increase the number whenever dependencies are modified
+        restore-keys: |
+          ${{ steps.key.outputs.image }}-vcpkg-release
+          ${{ steps.key.outputs.image }}-vcpkg-x64
+
+    - name: Prepare vcpkg
+      run: |
+        vcpkg install \
+          liblzma:x64-osx \
+          liblzma:arm64-osx \
+          libpng:x64-osx \
+          libpng:arm64-osx \
+          lzo:x64-osx \
+          lzo:arm64-osx \
+          zlib:x64-osx \
+          zlib:arm64-osx \
+          # EOF
+
+    - name: Install GCC problem matcher
+      uses: ammaraskar/gcc-problem-matcher@master
+
+    - name: Build tools
+      run: |
+        mkdir build-host
+        cd build-host
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_TOOLS_ONLY=ON \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build tools"
+        echo "Running on $(sysctl -n hw.logicalcpu) cores"
+        cmake --build . -j $(sysctl -n hw.logicalcpu) --target tools
+        echo "::endgroup::"
+
+    - name: Import code signing certificates
+      uses: Apple-Actions/import-codesign-certs@v1
+      with:
+        # The certificates in a PKCS12 file encoded as a base64 string
+        p12-file-base64: ${{ secrets.APPLE_DEVELOPER_CERTIFICATE_P12_BASE64 }}
+        # The password used to import the PKCS12 file.
+        p12-password: ${{ secrets.APPLE_DEVELOPER_CERTIFICATE_PASSWORD }}
+      # If this is run on a fork, there may not be a certificate set up - continue in this case
+      continue-on-error: true
+
+    - name: Build arm64
+      run: |
+        mkdir build-arm64
+        cd build-arm64
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -DCMAKE_OSX_ARCHITECTURES=arm64 \
+          -DVCPKG_TARGET_TRIPLET=arm64-osx \
+          -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(sysctl -n hw.logicalcpu) cores"
+        cmake --build . -j $(sysctl -n hw.logicalcpu)
+        echo "::endgroup::"
+
+    - name: Build x64
+      run: |
+        mkdir build-x64
+        cd build-x64
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -DCMAKE_OSX_ARCHITECTURES=x86_64 \
+          -DVCPKG_TARGET_TRIPLET=x64-osx \
+          -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
+          -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DCPACK_BUNDLE_APPLE_CERT_APP=${{ secrets.APPLE_DEVELOPER_CERTIFICATE_ID }} \
+          "-DCPACK_BUNDLE_APPLE_CODESIGN_PARAMETER=--deep -f --options runtime" \
+          -DAPPLE_UNIVERSAL_PACKAGE=1 \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        echo "Running on $(sysctl -n hw.logicalcpu) cores"
+        cmake --build . -j $(sysctl -n hw.logicalcpu)
+        echo "::endgroup::"
+
+    - name: Create bundles
+      run: |
+        cd build-x64
+
+        echo "::group::Create universal binary"
+        # Combine the `openttd` binaries from each build into a single file
+        lipo -create -output openttd-universal ../build-*/openttd
+        mv openttd-universal openttd
+        echo "::endgroup::"
+
+        echo "::group::Run CPack"
+        cpack
+        echo "::endgroup::"
+
+        echo "::group::Cleanup"
+        # Remove the sha256 files CPack generates; we will do this ourself at
+        # the end of this workflow.
+        rm -f bundles/*.sha256
+        echo "::endgroup::"
+
+    - name: Install gon
+      env:
+        HOMEBREW_NO_AUTO_UPDATE: 1
+        HOMEBREW_NO_INSTALL_CLEANUP: 1
+      run: |
+        brew tap mitchellh/gon
+        brew install mitchellh/gon/gon
+
+    - name: Notarize
+      env:
+        AC_USERNAME: ${{ secrets.APPLE_DEVELOPER_APP_USERNAME }}
+        AC_PASSWORD: ${{ secrets.APPLE_DEVELOPER_APP_PASSWORD }}
+      run: |
+        cd build-x64
+        ../os/macosx/notarize.sh
+
+    - name: Build zip
+      run: |
+        cd build-x64
+
+        pushd _CPack_Packages/*/Bundle/openttd-*/
+
+        # Remove the Applications symlink from the staging folder
+        rm -f Applications
+
+        # Remove the original dmg built by CPack to avoid a conflict when resolving
+        # the zip_filename variable below
+        rm -f ../*.dmg
+
+        zip_filename=(../openttd-*)
+
+        # Package up the existing, notarised .app into a zip file
+        zip -r -9 ${zip_filename}.zip OpenTTD.app
+
+        popd
+
+        # Now move it into place to be uploaded
+        mv _CPack_Packages/*/Bundle/openttd-*.zip bundles/
+
+    - name: Store bundles
+      uses: actions/upload-artifact@v3
+      with:
+        name: openttd-macos-universal
+        path: build-x64/bundles
+        retention-days: 5

.github/workflows/release-source.yml

@@ -0,0 +1,186 @@
+name: Release (Source)
+
+on:
+  workflow_call:
+    outputs:
+      version:
+        value: ${{ jobs.source.outputs.version }}
+      is_tag:
+        value: ${{ jobs.source.outputs.is_tag }}
+      trigger_type:
+        value: ${{ jobs.source.outputs.trigger_type }}
+      folder:
+        value: ${{ jobs.source.outputs.folder }}
+
+jobs:
+  source:
+    name: Source
+
+    runs-on: ubuntu-20.04
+
+    outputs:
+      version: ${{ steps.metadata.outputs.version }}
+      is_tag: ${{ steps.metadata.outputs.is_tag }}
+      trigger_type: ${{ steps.metadata.outputs.trigger_type }}
+      folder: ${{ steps.metadata.outputs.folder }}
+
+    steps:
+    - name: Checkout (Release)
+      if: github.event_name == 'release'
+      uses: actions/checkout@v3
+      with:
+        # We generate a changelog; for this we need the full git log.
+        fetch-depth: 0
+
+    - name: Checkout (Manual)
+      if: github.event_name == 'workflow_dispatch'
+      uses: actions/checkout@v3
+      with:
+        ref: ${{ github.event.inputs.ref }}
+        # We generate a changelog; for this we need the full git log.
+        fetch-depth: 0
+
+    - name: Checkout (Trigger)
+      if: github.event_name == 'repository_dispatch'
+      uses: actions/checkout@v3
+      with:
+        ref: ${{ github.event.client_payload.ref }}
+        # We generate a changelog; for this we need the full git log.
+        fetch-depth: 0
+
+    - name: Check valid branch name
+      run: |
+        if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+          REF="${{ github.event.inputs.ref }}"
+        elif [ "${{ github.event_name }}" = "repository_dispatch" ]; then
+          REF="${{ github.event.client_payload.ref }}"
+        else
+          REF="${{ github.ref }}"
+        fi
+
+        # Check if we are a tag.
+        if [ -n "$(git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || false)" ]; then
+          exit 0
+        fi
+
+        # Check if the checkout caused the branch to be named.
+        if [ "$(git rev-parse --abbrev-ref HEAD)" != "HEAD" ]; then
+          exit 0
+        fi
+
+        # Check if this was a pull request.
+        if [ -n "$(echo ${REF} | grep '^refs/pull/[0-9]*')" ]; then
+          PULL=$(echo ${REF} | cut -d/ -f3)
+          git checkout -b pr${PULL}
+        fi
+
+        # Are we still in a detached state? Error out.
+        if [ "$(git rev-parse --abbrev-ref HEAD)" == "HEAD" ]; then
+          echo "The 'ref' given resulted in a checkout of a detached HEAD."
+          echo "We cannot detect the version for these checkout accurate."
+          echo ""
+          echo "If you want to build a Pull Request, make sure you use 'refs/pull/NNN/head'."
+          echo ""
+          echo "Cancelling build, as without a version we cannot store the artifacts."
+          exit 1
+        fi
+
+    - name: Generate metadata
+      id: metadata
+      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
+
+        if [ $(cat .ottdrev | cut -f 5 -d$'\t') = '1' ]; then
+          # Assume that all tags are always releases. Why else make a tag?
+          IS_TAG="true"
+
+          FOLDER="${{ env.FOLDER_RELEASES }}"
+          TRIGGER_TYPE="new-tag"
+        else
+          IS_TAG="false"
+
+          BRANCH=$(git symbolic-ref -q HEAD | sed 's@.*/@@')
+          if [ -z "${BRANCH}" ]; then
+            echo "Internal error: branch name is empty."
+            echo "An earlier step should have prevented this from happening."
+            echo "Cancelling build, as without a branch name we cannot store the artifacts"
+            exit 1
+          fi
+
+          if [ "${BRANCH}" = "${{ env.NIGHTLIES_BRANCH }}" ]; then
+            # The "master" branch is special, and we call a nightly.
+            FOLDER="${{ env.FOLDER_NIGHTLIES }}/$(date +%Y)"
+            TRIGGER_TYPE="new-master"
+          else
+            # All other branches, which can be builds of Pull Requests, are
+            # put in their own folder.
+            FOLDER="${{ env.FOLDER_BRANCHES }}/${BRANCH}"
+            TRIGGER_TYPE="new-branch"
+          fi
+        fi
+
+        mkdir -p build/bundles
+        cp .changelog build/bundles/changelog.txt
+        cp .release_date build/bundles/released.txt
+        cp README.md build/bundles/README.md
+        echo "::endgroup::"
+
+        echo "Release Date: $(cat .release_date)"
+        echo "Revision: $(cat .ottdrev)"
+        echo "Version: $(cat .version)"
+        echo "Is tag: ${IS_TAG}"
+        echo "Folder on CDN: ${FOLDER}"
+        echo "Workflow trigger: ${TRIGGER_TYPE}"
+
+        echo "version=$(cat .version)" >> $GITHUB_OUTPUT
+        echo "is_tag=${IS_TAG}" >> $GITHUB_OUTPUT
+        echo "folder=${FOLDER}" >> $GITHUB_OUTPUT
+        echo "trigger_type=${TRIGGER_TYPE}" >> $GITHUB_OUTPUT
+      env:
+        NIGHTLIES_BRANCH: master
+        FOLDER_RELEASES: openttd-releases
+        FOLDER_NIGHTLIES: openttd-nightlies
+        FOLDER_BRANCHES: openttd-branches
+
+    - name: Remove VCS information
+      run: |
+        rm -rf .git
+
+    - name: Create bundles
+      run: |
+        FOLDER_NAME=openttd-${{ steps.metadata.outputs.version }}
+
+        # Rename the folder to openttd-NNN
+        mkdir ${FOLDER_NAME}
+        find . -maxdepth 1 -not -name . -not -name build -not -name ${FOLDER_NAME} -exec mv {} ${FOLDER_NAME}/ \;
+
+        echo "::group::Create tarball (xz) bundle"
+        tar --xz -cvf build/bundles/${FOLDER_NAME}-source.tar.xz ${FOLDER_NAME}
+        echo "::endgroup::"
+
+        # This tarball is only to be used within this workflow.
+        echo "::group::Create tarball (gz) bundle"
+        tar --gzip -cvf source.tar.gz ${FOLDER_NAME}
+        echo "::endgroup::"
+
+        echo "::group::Create zip bundle"
+        zip -9 -r build/bundles/${FOLDER_NAME}-source.zip ${FOLDER_NAME}
+        echo "::endgroup::"
+
+    - name: Store bundles
+      uses: actions/upload-artifact@v3
+      with:
+        name: openttd-source
+        path: build/bundles/*
+        retention-days: 5
+
+    - name: Store source (for other jobs)
+      uses: actions/upload-artifact@v3
+      with:
+        name: internal-source
+        path: source.tar.gz
+        retention-days: 1

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

@@ -0,0 +1,192 @@
+name: Release (Windows Store)
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+
+jobs:
+  windows-store:
+    name: Windows Store
+
+    runs-on: windows-latest
+
+    steps:
+    - name: Download source
+      uses: actions/download-artifact@v3
+      with:
+        name: internal-source
+
+    - name: Unpack source
+      shell: bash
+      run: |
+        tar -xf source.tar.gz --strip-components=1
+
+    - name: Download x86 build
+      uses: actions/download-artifact@v3
+      with:
+        name: openttd-windows-x86
+
+    - name: Download x64 build
+      uses: actions/download-artifact@v3
+      with:
+        name: openttd-windows-x64
+
+    - name: Download arm64 build
+      uses: actions/download-artifact@v3
+      with:
+        name: openttd-windows-arm64
+
+    - name: Unpack builds
+      shell: bash
+      run: |
+        mkdir builds
+        cd builds
+
+        function extract {
+            mkdir $1
+
+            # Extract the zip version of the release
+            unzip ../openttd-*-windows-$2.zip -d $1
+
+            # Remove the extraneous directory
+            mv $1/openttd-*-windows-$2/* $1/
+            rmdir $1/openttd-*-windows-$2
+
+            # Move the openttd.exe to the '{arch}-binaries' folder
+            mkdir $1-binaries
+            mv $1/openttd.exe $1-binaries/
+        }
+
+        extract x86 win32
+        extract x64 win64
+        extract arm64 arm64
+
+        # Use the "x86" folder as the source of the common binaries (lang files, etc) and remove the others
+        mv x86 common-binaries
+        rm -rf x64 arm64
+
+    - name: Install OpenGFX
+      shell: bash
+      run: |
+        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 "::endgroup::"
+
+        echo "::group::Unpack OpenGFX"
+        unzip opengfx-all.zip
+        tar xf opengfx-*.tar
+        echo "::endgroup::"
+
+        rm -f opengfx-all.zip opengfx-*.tar
+
+    - name: Install OpenMSX
+      shell: bash
+      run: |
+        mkdir -p builds/common-binaries/baseset
+        cd builds/common-binaries/baseset
+
+        echo "::group::Download OpenMSX"
+        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"
+        unzip openmsx-all.zip
+        tar xf openmsx-*.tar
+        echo "::endgroup::"
+
+        rm -f openmsx-all.zip openmsx-*.tar
+
+    - name: Install OpenSFX
+      shell: bash
+      run: |
+        mkdir -p builds/common-binaries/baseset/opensfx
+        cd builds/common-binaries/baseset/opensfx
+
+        echo "::group::Download OpenSFX"
+        curl -L https://cdn.openttd.org/opensfx-releases/1.0.3/opensfx-1.0.3-all.zip -o opensfx-all.zip
+        echo "::endgroup::"
+
+        echo "::group::Unpack OpenSFX"
+        unzip opensfx-all.zip
+        tar xf opensfx-*.tar
+        echo "::endgroup::"
+
+        rm -f opensfx-all.zip opensfx-*.tar
+
+    - name: Generate signing certificate
+      shell: cmd
+      run: |
+        cd builds
+
+        REM We need to provide a signed .appx to the Windows Store, so generate a certificate with password 'password'
+        call ..\os\windows\winstore\generate-key.bat "CN=78024DA8-4BE4-4C77-B12E-547BBF7359D2" password cert.pfx
+
+    - name: Generate assets
+      shell: cmd
+      run: |
+        cd os\windows\winstore
+        call generate-assets.bat
+
+    - name: Prepare manifests
+      shell: cmd
+      run: |
+        cd builds
+        mkdir manifests
+
+        REM Set the version environment variable
+        call ..\os\windows\winstore\set-version.bat x86-binaries\openttd.exe
+
+        call ..\os\windows\winstore\prepare-manifests.bat manifests "CN=78024DA8-4BE4-4C77-B12E-547BBF7359D2" "57420OpenTTDDevelopers.OpenTTDofficial"
+
+    - name: Prepare binaries
+      shell: bash
+      run: |
+        cd builds
+
+        # Copy the Windows Store assets
+        mkdir common-binaries/Assets
+        cp -R ../os/windows/winstore/assets-common/* common-binaries/Assets/
+
+        mkdir Assets
+        cp -R ../os/windows/winstore/assets/* Assets/
+
+        cp manifests/*.xml .
+
+    - name: Build
+      shell: cmd
+      run: |
+        REM Add the Windows SDK tools to the PATH
+
+        echo|set /p="SET VS_INSTALLDIR=" > _vspath.bat
+        vswhere -products * -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -property installationPath >> _vspath.bat
+        call _vspath.bat
+        call "%VS_INSTALLDIR%\Common7\Tools\VsDevCmd.bat"
+
+        REM Set the version environment variable
+        call os\windows\winstore\set-version.bat builds\x86-binaries\openttd.exe
+
+        cd builds
+        mkdir output
+
+        REM Build and sign the package
+        makeappx build /v /f PackagingLayout.xml /op output\ /bv %OTTD_VERSION% /pv %OTTD_VERSION% /ca
+        SignTool sign /fd sha256 /a /f cert.pfx /p password "output\OpenTTD.appxbundle"
+
+        REM Move resulting files to bundles folder
+        mkdir bundles
+        mkdir bundles\internal
+        move cert.pfx bundles\internal\openttd-${{ inputs.version }}-windows-store.pfx
+        move output\OpenTTD.appxbundle bundles\internal\openttd-${{ inputs.version }}-windows-store.appxbundle
+
+    - name: Store bundles
+      uses: actions/upload-artifact@v3
+      with:
+        name: openttd-windows-store
+        path: builds/bundles
+        retention-days: 5

.github/workflows/release-windows.yml

@@ -0,0 +1,201 @@
+name: Release (Windows)
+
+on:
+  workflow_call:
+    inputs:
+      is_tag:
+        required: true
+        type: string
+
+jobs:
+  windows:
+    name: Windows
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - arch: x86
+          host: x86
+        - arch: x64
+          host: x64
+        - arch: arm64
+          host: x64_arm64
+
+    runs-on: windows-latest
+
+    steps:
+    - name: Download source
+      uses: actions/download-artifact@v3
+      with:
+        name: internal-source
+
+    - name: Unpack source
+      shell: bash
+      run: |
+        tar -xf source.tar.gz --strip-components=1
+
+    - name: Install dependencies
+      shell: bash
+      run: |
+        choco install pandoc
+
+    - name: Prepare cache key
+      id: key
+      shell: powershell
+      run: |
+        # Work around caching failure with GNU tar
+        New-Item -Type Junction -Path vcpkg -Target c:\vcpkg
+
+        Write-Output "image=$env:ImageOS-$env:ImageVersion" >> $env:GITHUB_OUTPUT
+
+    - name: Enable vcpkg cache
+      uses: actions/cache@v3
+      with:
+        path: vcpkg/installed
+        key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-0 # Increase the number whenever dependencies are modified
+        restore-keys: |
+          ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}
+
+    - name: Prepare vcpkg
+      shell: bash
+      run: |
+        vcpkg install --triplet=${{ matrix.arch }}-windows-static \
+          liblzma \
+          libpng \
+          lzo \
+          zlib \
+          # EOF
+
+    - name: Install MSVC problem matcher
+      uses: ammaraskar/msvc-problem-matcher@master
+
+    - name: Configure developer command prompt for tools
+      uses: ilammy/msvc-dev-cmd@v1
+      with:
+        arch: x64
+
+    - name: Build tools
+      shell: bash
+      run: |
+        mkdir build-host
+        cd build-host
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -GNinja \
+          -DOPTION_TOOLS_ONLY=ON \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        cmake --build . --target tools
+        echo "::endgroup::"
+
+    - name: Configure developer command prompt for ${{ matrix.arch }}
+      uses: ilammy/msvc-dev-cmd@v1
+      with:
+        arch: ${{ matrix.host }}
+
+    - name: Import code signing certificate
+      shell: powershell
+      # If this is run on a fork, there may not be a certificate set up - continue in this case
+      continue-on-error: true
+      run: |
+        $tempFile = [System.IO.Path]::GetTempFileName()
+        $bytes = [System.Convert]::FromBase64String($env:WINDOWS_CERTIFICATE_P12)
+        [IO.File]::WriteAllBytes($tempFile, $bytes)
+        $pwd = ConvertTo-SecureString $env:WINDOWS_CERTIFICATE_PASSWORD -AsPlainText -Force
+        Import-PfxCertificate -FilePath $tempFile -CertStoreLocation Cert:\CurrentUser\My -Password $pwd
+        Remove-Item $tempFile
+      env:
+        WINDOWS_CERTIFICATE_P12: ${{ secrets.WINDOWS_CERTIFICATE_P12 }}
+        WINDOWS_CERTIFICATE_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }}
+
+    - name: Build (with installer)
+      if: inputs.is_tag == 'true'
+      shell: bash
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -GNinja \
+          -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
+          -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          -DOPTION_USE_NSIS=ON \
+          -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        cmake --build .
+        echo "::endgroup::"
+      env:
+        WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }}
+
+    - name: Build (without installer)
+      if: inputs.is_tag != 'true'
+      shell: bash
+      run: |
+        mkdir build
+        cd build
+
+        echo "::group::CMake"
+        cmake ${GITHUB_WORKSPACE} \
+          -GNinja \
+          -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-windows-static \
+          -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \
+          -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
+          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \
+          # EOF
+        echo "::endgroup::"
+
+        echo "::group::Build"
+        cmake --build .
+        echo "::endgroup::"
+      env:
+        WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }}
+
+    - name: Create bundles
+      shell: bash
+      run: |
+        cd ${GITHUB_WORKSPACE}/build
+        echo "::group::Run CPack"
+        cpack
+        echo "::endgroup::"
+
+        echo "::group::Prepare PDB to be bundled"
+        PDB=$(ls bundles/*.zip | cut -d/ -f2 | sed 's/.zip$/.pdb/')
+        cp openttd.pdb bundles/${PDB}
+        xz -9 bundles/${PDB}
+        echo "::endgroup::"
+
+        echo "::group::Cleanup"
+        # Remove the sha256 files CPack generates; we will do this ourself at
+        # the end of this workflow.
+        rm -f bundles/*.sha256
+        echo "::endgroup::"
+
+    - name: Sign installer
+      if: inputs.is_tag == 'true'
+      shell: bash
+      # If this is run on a fork, there may not be a certificate set up - continue in this case
+      continue-on-error: true
+      run: |
+        cd ${GITHUB_WORKSPACE}/build/bundles
+        ../../os/windows/sign.bat *.exe "${WINDOWS_CERTIFICATE_COMMON_NAME}"
+      env:
+        WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }}
+
+    - name: Store bundles
+      uses: actions/upload-artifact@v3
+      with:
+        name: openttd-windows-${{ matrix.arch }}
+        path: build/bundles
+        retention-days: 5

.github/workflows/release.yml

@@ -18,648 +18,108 @@ jobs:
   source:
     name: Source
 
-    runs-on: ubuntu-20.04
-
-    outputs:
-      version: ${{ steps.metadata.outputs.version }}
-      is_tag: ${{ steps.metadata.outputs.is_tag }}
-      trigger_type: ${{ steps.metadata.outputs.trigger_type }}
-      folder: ${{ steps.metadata.outputs.folder }}
-
-    steps:
-    - name: Checkout (Release)
-      if: github.event_name == 'release'
-      uses: actions/checkout@v2
-      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@v2
-      with:
-        ref: ${{ github.event.inputs.ref }}
-        # We generate a changelog; for this we need the full git log.
-        fetch-depth: 0
-
-    - name: Checkout (Trigger)
-      if: github.event_name == 'repository_dispatch'
-      uses: actions/checkout@v2
-      with:
-        ref: ${{ github.event.client_payload.ref }}
-        # We generate a changelog; for this we need the full git log.
-        fetch-depth: 0
-
-    - name: Check valid branch name
-      run: |
-        if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
-          REF="${{ github.event.inputs.ref }}"
-        elif [ "${{ github.event_name }}" = "repository_dispatch" ]; then
-          REF="${{ github.event.client_payload.ref }}"
-        else
-          REF="${{ github.ref }}"
-        fi
-
-        # Check if we are a tag.
-        if [ -n "$(git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || false)" ]; then
-          exit 0
-        fi
-
-        # Check if the checkout caused the branch to be named.
-        if [ "$(git rev-parse --abbrev-ref HEAD)" != "HEAD" ]; then
-          exit 0
-        fi
-
-        # Check if this was a pull request.
-        if [ -n "$(echo ${REF} | grep '^refs/pull/[0-9]*')" ]; then
-          PULL=$(echo ${REF} | cut -d/ -f3)
-          git checkout -b pr${PULL}
-        fi
-
-        # Are we still in a detached state? Error out.
-        if [ "$(git rev-parse --abbrev-ref HEAD)" == "HEAD" ]; then
-          echo "The 'ref' given resulted in a checkout of a detached HEAD."
-          echo "We cannot detect the version for these checkout accurate."
-          echo ""
-          echo "If you want to build a Pull Request, make sure you use 'refs/pull/NNN/head'."
-          echo ""
-          echo "Cancelling build, as without a version we cannot store the artifacts."
-          exit 1
-        fi
-
-    - name: Generate metadata
-      id: metadata
-      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
-
-        if [ $(cat .ottdrev | cut -f 6 -d$'\t') = '1' ]; then
-          # Assume that all tags are always releases. Why else make a tag?
-          IS_TAG="true"
-
-          FOLDER="${{ env.FOLDER_RELEASES }}"
-          TRIGGER_TYPE="new-tag"
-        else
-          IS_TAG="false"
-
-          BRANCH=$(git symbolic-ref -q HEAD | sed 's@.*/@@')
-          if [ -z "${BRANCH}" ]; then
-            echo "Internal error: branch name is empty."
-            echo "An earlier step should have prevented this from happening."
-            echo "Cancelling build, as without a branch name we cannot store the artifacts"
-            exit 1
-          fi
-
-          if [ "${BRANCH}" = "${{ env.NIGHTLIES_BRANCH }}" ]; then
-            # The "master" branch is special, and we call a nightly.
-            FOLDER="${{ env.FOLDER_NIGHTLIES }}/$(date +%Y)"
-            TRIGGER_TYPE="new-master"
-          else
-            # All other branches, which can be builds of Pull Requests, are
-            # put in their own folder.
-            FOLDER="${{ env.FOLDER_BRANCHES }}/${BRANCH}"
-            TRIGGER_TYPE="new-branch"
-          fi
-        fi
-
-        mkdir -p build/bundles
-        cp .changelog build/bundles/changelog.txt
-        cp .release_date build/bundles/released.txt
-        cp README.md build/bundles/README.md
-        echo "::endgroup::"
-
-        echo "Release Date: $(cat .release_date)"
-        echo "Revision: $(cat .ottdrev)"
-        echo "Version: $(cat .version)"
-        echo "Is tag: ${IS_TAG}"
-        echo "Folder on CDN: ${FOLDER}"
-        echo "Workflow trigger: ${TRIGGER_TYPE}"
-
-        echo "::set-output name=version::$(cat .version)"
-        echo "::set-output name=is_tag::${IS_TAG}"
-        echo "::set-output name=folder::${FOLDER}"
-        echo "::set-output name=trigger_type::${TRIGGER_TYPE}"
-      env:
-        NIGHTLIES_BRANCH: master
-        FOLDER_RELEASES: openttd-releases
-        FOLDER_NIGHTLIES: openttd-nightlies
-        FOLDER_BRANCHES: openttd-branches
-
-    - name: Remove VCS information
-      run: |
-        rm -rf .git
-
-    - name: Create bundles
-      run: |
-        FOLDER_NAME=openttd-${{ steps.metadata.outputs.version }}
-
-        # Rename the folder to openttd-NNN
-        mkdir ${FOLDER_NAME}
-        find . -maxdepth 1 -not -name . -not -name build -not -name ${FOLDER_NAME} -exec mv {} ${FOLDER_NAME}/ \;
-
-        echo "::group::Create tarball (xz) bundle"
-        tar --xz -cvf build/bundles/${FOLDER_NAME}-source.tar.xz ${FOLDER_NAME}
-        echo "::endgroup::"
-
-        # This tarball is only to be used within this workflow.
-        echo "::group::Create tarball (gz) bundle"
-        tar --gzip -cvf source.tar.gz ${FOLDER_NAME}
-        echo "::endgroup::"
-
-        echo "::group::Create zip bundle"
-        zip -9 -r build/bundles/${FOLDER_NAME}-source.zip ${FOLDER_NAME}
-        echo "::endgroup::"
-
-    - name: Store bundles
-      uses: actions/upload-artifact@v2
-      with:
-        name: openttd-source
-        path: build/bundles/*
-        retention-days: 5
-
-    - name: Store source (for other jobs)
-      uses: actions/upload-artifact@v2
-      with:
-        name: internal-source
-        path: source.tar.gz
-        retention-days: 1
+    uses: ./.github/workflows/release-source.yml
+    secrets: inherit
 
   docs:
     name: Docs
     needs: source
 
-    runs-on: ubuntu-20.04
+    uses: ./.github/workflows/release-docs.yml
+    secrets: inherit
 
-    steps:
-    - name: Download source
-      uses: actions/download-artifact@v2
-      with:
-        name: internal-source
-
-    - name: Unpack source
-      run: |
-        tar -xf source.tar.gz --strip-components=1
-
-    - 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 \
-          doxygen \
-          # EOF
-        echo "::endgroup::"
-      env:
-        DEBIAN_FRONTEND: noninteractive
-
-    - name: Build
-      run: |
-        mkdir -p ${GITHUB_WORKSPACE}/build
-        cd ${GITHUB_WORKSPACE}/build
-
-        echo "::group::CMake"
-        cmake ${GITHUB_WORKSPACE} \
-          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
-          -DOPTION_DOCS_ONLY=ON \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        make docs
-        echo "::endgroup::"
-
-    - name: Create bundles
-      run: |
-        BASENAME=openttd-${{ needs.source.outputs.version }}
-
-        cd ${GITHUB_WORKSPACE}/build
-
-        mv docs/source ${BASENAME}-docs
-        mv docs/ai-api ${BASENAME}-docs-ai
-        mv docs/gs-api ${BASENAME}-docs-gs
-
-        mkdir -p bundles
-
-        echo "::group::Create docs bundle"
-        tar --xz -cf bundles/${BASENAME}-docs.tar.xz ${BASENAME}-docs
-        echo "::endgroup::"
-
-        echo "::group::Create AI API docs bundle"
-        tar --xz -cf bundles/${BASENAME}-docs-ai.tar.xz ${BASENAME}-docs-ai
-        echo "::endgroup::"
-
-        echo "::group::Create GameScript API docs bundle"
-        tar --xz -cf bundles/${BASENAME}-docs-gs.tar.xz ${BASENAME}-docs-gs
-        echo "::endgroup::"
-
-    - name: Store bundles
-      uses: actions/upload-artifact@v2
-      with:
-        name: openttd-docs
-        path: build/bundles/*.tar.xz
-        retention-days: 5
+    with:
+      version: ${{ needs.source.outputs.version }}
 
   linux:
-    name: Linux
+    name: Linux (Generic)
     needs: source
 
-    if: needs.source.outputs.is_tag == 'true'
-
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-        - container_image: "ubuntu:18.04"
-          bundle_name: "bionic"
-        - container_image: "ubuntu:20.04"
-          bundle_name: "focal"
-        - container_image: "ubuntu:20.10"
-          bundle_name: "groovy"
-        - container_image: "debian:buster"
-          bundle_name: "buster"
-
-    runs-on: ubuntu-20.04
-    container:
-      image: ${{ matrix.container_image }}
-
-    steps:
-    - name: Download source
-      uses: actions/download-artifact@v2
-      with:
-        name: internal-source
-
-    - name: Unpack source
-      run: |
-        tar -xf source.tar.gz --strip-components=1
-
-    - name: Install dependencies
-      run: |
-        echo "::group::Update apt"
-        apt-get update
-        echo "::endgroup::"
-
-        echo "::group::Install dependencies"
-        apt-get install -y --no-install-recommends \
-          cmake \
-          debhelper \
-          g++ \
-          git \
-          make \
-          openssl \
-          libfontconfig-dev \
-          libfluidsynth-dev \
-          libicu-dev \
-          liblzma-dev \
-          liblzo2-dev \
-          libsdl2-dev \
-          libxdg-basedir-dev \
-          lsb-release \
-          zlib1g-dev \
-          # EOF
-        echo "::endgroup::"
-      env:
-        DEBIAN_FRONTEND: noninteractive
-
-    - name: Install GCC problem matcher
-      uses: ammaraskar/gcc-problem-matcher@master
-
-    - name: Build
-      run: |
-        mkdir -p build
-        cd build
-
-        echo "::group::CMake"
-        cmake ${GITHUB_WORKSPACE} \
-          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
-          -DCMAKE_INSTALL_PREFIX=/usr \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        echo "Running on $(nproc) cores"
-        make -j$(nproc) package
-        echo "::endgroup::"
-
-        # Remove the sha256 files CPack generates; we will do this ourself at
-        # the end of this workflow.
-        rm -f bundles/*.sha256
-
-    - name: Store bundles
-      uses: actions/upload-artifact@v2
-      with:
-        name: openttd-linux-${{ matrix.bundle_name }}
-        path: build/bundles
-        retention-days: 5
+    uses: ./.github/workflows/release-linux.yml
+    secrets: inherit
 
   macos:
     name: MacOS
     needs: source
 
-    runs-on: macos-10.15
-    env:
-      MACOSX_DEPLOYMENT_TARGET: 10.9
-
-    steps:
-    - name: Download source
-      uses: actions/download-artifact@v2
-      with:
-        name: internal-source
-
-    - name: Unpack source
-      run: |
-        tar -xf source.tar.gz --strip-components=1
-
-    # The following step can be removed when the build VM is updated with a revision of
-    # vcpkg dating from roughly 01/01/2021 or later. At that point, `doNotUpdateVcpkg`
-    # can be set to `true` and the `vcpkgGitCommitId` can be removed.
-    - name: Update vcpkg
-      run: |
-        cd /usr/local/share/vcpkg
-        git fetch --unshallow
-
-    - name: Prepare vcpkg (with cache)
-      uses: lukka/run-vcpkg@v6
-      with:
-        vcpkgDirectory: '/usr/local/share/vcpkg'
-        doNotUpdateVcpkg: false
-        vcpkgGitCommitId: 2a42024b53ebb512fb5dd63c523338bf26c8489c
-        vcpkgArguments: 'freetype:x64-osx liblzma:x64-osx lzo:x64-osx freetype:arm64-osx liblzma:arm64-osx lzo:arm64-osx'
-
-    - name: Build tools
-      run: |
-        mkdir build-host
-        cd build-host
-
-        echo "::group::CMake"
-        cmake ${GITHUB_WORKSPACE} \
-          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
-          -DOPTION_TOOLS_ONLY=ON \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build tools"
-        echo "Running on $(sysctl -n hw.logicalcpu) cores"
-        make -j$(sysctl -n hw.logicalcpu) tools
-        echo "::endgroup::"
-
-    - name: Install GCC problem matcher
-      uses: ammaraskar/gcc-problem-matcher@master
-
-    - name: Import code signing certificates
-      uses: Apple-Actions/import-codesign-certs@v1
-      with:
-        # The certificates in a PKCS12 file encoded as a base64 string
-        p12-file-base64: ${{ secrets.APPLE_DEVELOPER_CERTIFICATE_P12_BASE64 }}
-        # The password used to import the PKCS12 file.
-        p12-password: ${{ secrets.APPLE_DEVELOPER_CERTIFICATE_PASSWORD }}
-      # If this is run on a fork, there may not be a certificate set up - continue in this case
-      continue-on-error: true
-
-    - name: Build arm64
-      run: |
-        mkdir build-arm64
-        cd build-arm64
-
-        echo "::group::CMake"
-        cmake ${GITHUB_WORKSPACE} \
-          -DCMAKE_OSX_ARCHITECTURES=arm64 \
-          -DVCPKG_TARGET_TRIPLET=arm64-osx \
-          -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
-          -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
-          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        echo "Running on $(sysctl -n hw.logicalcpu) cores"
-        make -j$(sysctl -n hw.logicalcpu)
-        echo "::endgroup::"
-
-    - name: Build x64
-      run: |
-        mkdir build-x64
-        cd build-x64
-
-        echo "::group::CMake"
-        cmake ${GITHUB_WORKSPACE} \
-          -DCMAKE_OSX_ARCHITECTURES=x86_64 \
-          -DVCPKG_TARGET_TRIPLET=x64-osx \
-          -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
-          -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
-          -DCMAKE_BUILD_TYPE=RelWithDebInfo \
-          -DCPACK_BUNDLE_APPLE_CERT_APP=${{ secrets.APPLE_DEVELOPER_CERTIFICATE_ID }} \
-          "-DCPACK_BUNDLE_APPLE_CODESIGN_PARAMETER=--deep -f --options runtime" \
-          -DAPPLE_UNIVERSAL_PACKAGE=1 \
-          # EOF
-        echo "::endgroup::"
-
-        echo "::group::Build"
-        echo "Running on $(sysctl -n hw.logicalcpu) cores"
-        make -j$(sysctl -n hw.logicalcpu)
-        echo "::endgroup::"
-
-    - name: Build package
-      run: |
-        cd build-x64
-
-        # Combine the `openttd` binaries from each build into a single file
-        lipo -create -output openttd-universal ../build-*/openttd
-        mv openttd-universal openttd
-
-        echo "::group::Build"
-        echo "Running on $(sysctl -n hw.logicalcpu) cores"
-        make -j$(sysctl -n hw.logicalcpu) package
-        echo "::endgroup::"
-
-        # Remove the sha256 files CPack generates; we will do this ourself at
-        # the end of this workflow.
-        rm -f bundles/*.sha256
-
-    - name: Install gon
-      env:
-        HOMEBREW_NO_AUTO_UPDATE: 1
-        HOMEBREW_NO_INSTALL_CLEANUP: 1
-      run: |
-        brew tap mitchellh/gon
-        brew install mitchellh/gon/gon
-
-    - name: Notarize
-      env:
-        AC_USERNAME: ${{ secrets.APPLE_DEVELOPER_APP_USERNAME }}
-        AC_PASSWORD: ${{ secrets.APPLE_DEVELOPER_APP_PASSWORD }}
-      run: |
-        cd build-x64
-        ../os/macosx/notarize.sh
-
-    - name: Store bundles
-      uses: actions/upload-artifact@v2
-      with:
-        name: openttd-macos-universal
-        path: build-x64/bundles
-        retention-days: 5
+    uses: ./.github/workflows/release-macos.yml
+    secrets: inherit
 
   windows:
     name: Windows
     needs: source
 
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-        - arch: x86
-        - arch: x64
-        - arch: arm64
+    uses: ./.github/workflows/release-windows.yml
+    secrets: inherit
 
-    runs-on: windows-latest
+    with:
+      is_tag: ${{ needs.source.outputs.is_tag }}
 
-    steps:
-    - name: Download source
-      uses: actions/download-artifact@v2
-      with:
-        name: internal-source
+  windows-store:
+    name: Windows Store
+    needs:
+    - source
+    - windows
 
-    - name: Unpack source
-      shell: bash
-      run: |
-        tar -xf source.tar.gz --strip-components=1
+    if: needs.source.outputs.is_tag == 'true'
 
-    # "restore-cache" which is done by "run-vcpkg" uses Windows tar.
-    # A git clone on windows marks a few files as read-only; when Windows tar
-    # tries to extract the cache over this folder, it fails, despite the files
-    # being identical. This failure shows up as an warning in the logs. We
-    # avoid this by simply removing the read-only mark from the git folder.
-    # In other words: this is a hack!
-    # See: https://github.com/lukka/run-vcpkg/issues/61
-    - name: Remove read-only flag from vcpkg git folder
-      shell: powershell
-      run: |
-        attrib -r "c:\vcpkg\.git\*.*" /s
+    uses: ./.github/workflows/release-windows-store.yml
+    secrets: inherit
 
-    - name: Prepare vcpkg (with cache)
-      uses: lukka/run-vcpkg@v6
-      with:
-        vcpkgDirectory: 'c:/vcpkg'
-        doNotUpdateVcpkg: true
-        vcpkgArguments: 'liblzma libpng lzo zlib'
-        vcpkgTriplet: '${{ matrix.arch }}-windows-static'
+    with:
+      version: ${{ needs.source.outputs.version }}
 
-    - name: Build tools
-      uses: lukka/run-cmake@v3
-      with:
-        cmakeListsOrSettingsJson: CMakeListsTxtAdvanced
-        useVcpkgToolchainFile: false
-        buildDirectory: '${{ github.workspace }}/build-host'
-        buildWithCMakeArgs: '--target tools'
-        cmakeAppendedArgs: ' -GNinja -DOPTION_TOOLS_ONLY=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo'
-
-    - name: Install MSVC problem matcher
-      uses: ammaraskar/msvc-problem-matcher@master
-
-    - name: Build (with installer)
-      if: needs.source.outputs.is_tag == 'true'
-      uses: lukka/run-cmake@v3
-      with:
-        cmakeListsOrSettingsJson: CMakeListsTxtAdvanced
-        useVcpkgToolchainFile: true
-        buildDirectory: '${{ github.workspace }}/build'
-        cmakeAppendedArgs: ' -GNinja -DOPTION_USE_NSIS=ON -DHOST_BINARY_DIR=${{ github.workspace }}/build-host -DCMAKE_BUILD_TYPE=RelWithDebInfo'
-
-    - name: Build (without installer)
-      if: needs.source.outputs.is_tag != 'true'
-      uses: lukka/run-cmake@v3
-      with:
-        cmakeListsOrSettingsJson: CMakeListsTxtAdvanced
-        useVcpkgToolchainFile: true
-        buildDirectory: '${{ github.workspace }}/build'
-        cmakeAppendedArgs: ' -GNinja -DHOST_BINARY_DIR=${{ github.workspace }}/build-host -DCMAKE_BUILD_TYPE=RelWithDebInfo'
-
-    - name: Create bundles
-      shell: bash
-      run: |
-        cd ${GITHUB_WORKSPACE}/build
-        echo "::group::Run CPack"
-        cpack
-        echo "::endgroup::"
-
-        echo "::group::Prepare PDB to be bundled"
-        PDB=$(ls bundles/*.zip | cut -d/ -f2 | sed 's/.zip$/.pdb/')
-        cp openttd.pdb bundles/${PDB}
-        xz -9 bundles/${PDB}
-        echo "::endgroup::"
-
-        echo "::group::Cleanup"
-        # Remove the sha256 files CPack generates; we will do this ourself at
-        # the end of this workflow.
-        rm -f bundles/*.sha256
-        echo "::endgroup::"
-
-    - name: Store bundles
-      uses: actions/upload-artifact@v2
-      with:
-        name: openttd-windows-${{ matrix.arch }}
-        path: build/bundles
-        retention-days: 5
-
-  upload:
-    name: Upload
+  upload-aws:
+    name: Upload (AWS)
     needs:
     - source
     - docs
     - linux
     - macos
     - windows
+    - windows-store
 
-    # The 'linux' job can be skipped if it is a nightly. That normally causes
-    # this job to be skipped too, unless we have this length boy :)
-    # "always()" is important here, it is the keyword to use to stop skipping
-    # this job if any dependency is skipped. It looks a bit silly, but it is
-    # how GitHub Actions work ;)
-    if: always() && needs.source.result == 'success' && needs.docs.result == 'success' && (needs.linux.result == 'success' || needs.linux.result == 'skipped') && needs.macos.result == 'success' && needs.windows.result == 'success'
+    # As windows-store is condition, we need to check ourselves if we need to run.
+    # The always() makes sure the rest is always evaluated.
+    if: always() && needs.source.result == 'success' && needs.docs.result == 'success' && needs.linux.result == 'success' && needs.macos.result == 'success' && needs.windows.result == 'success' && (needs.windows-store.result == 'success' || needs.windows-store.result == 'skipped')
 
-    runs-on: ubuntu-20.04
+    uses: ./.github/workflows/upload-aws.yml
+    secrets: inherit
 
-    steps:
-    - name: Download all bundles
-      uses: actions/download-artifact@v2
+    with:
+      version: ${{ needs.source.outputs.version }}
+      folder: ${{ needs.source.outputs.folder }}
+      trigger_type: ${{ needs.source.outputs.trigger_type }}
 
-    - name: Calculate checksums
-      run: |
-        echo "::group::Move bundles to a single folder"
-        mkdir bundles
-        mv openttd-*/* bundles/
-        cd bundles
-        echo "::group::Build"
+  upload-steam:
+    name: Upload (Steam)
+    needs:
+    - source
+    - linux
+    - macos
+    - windows
 
-        for i in $(ls openttd-*); do
-          echo "::group::Calculating checksums for ${i}"
-          openssl dgst -r -md5 -hex $i > $i.md5sum
-          openssl dgst -r -sha1 -hex $i > $i.sha1sum
-          openssl dgst -r -sha256 -hex $i > $i.sha256sum
-          echo "::endgroup::"
-        done
+    if: needs.source.outputs.trigger_type == 'new-master' || needs.source.outputs.trigger_type == 'new-tag'
 
-    - name: Upload bundles to AWS
-      run: |
-        aws s3 cp --recursive --only-show-errors bundles/ s3://${{ secrets.CDN_S3_BUCKET }}/${{ needs.source.outputs.folder }}/${{ needs.source.outputs.version }}/
+    uses: ./.github/workflows/upload-steam.yml
+    secrets: inherit
 
-        # We do not invalidate the CloudFront distribution here. The trigger
-        # for "New OpenTTD release" first updated the manifest files and
-        # creates an index.html. We invalidate after that, so everything
-        # becomes visible at once.
-      env:
-        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-        AWS_REGION: ${{ secrets.AWS_REGION }}
+    with:
+      version: ${{ needs.source.outputs.version }}
+      trigger_type: ${{ needs.source.outputs.trigger_type }}
 
-    - name: Trigger 'New OpenTTD release'
-      uses: peter-evans/repository-dispatch@v1
-      with:
-        token: ${{ secrets.DEPLOYMENT_TOKEN }}
-        repository: OpenTTD/workflows
-        event-type: ${{ needs.source.outputs.trigger_type }}
-        client-payload: '{"version": "${{ needs.source.outputs.version }}", "folder": "${{ needs.source.outputs.folder }}"}'
+  upload-gog:
+    name: Upload (GOG)
+    needs:
+    - source
+    - linux
+    - macos
+    - windows
+
+    if: needs.source.outputs.trigger_type == 'new-tag'
+
+    uses: ./.github/workflows/upload-gog.yml
+    secrets: inherit
+
+    with:
+      version: ${{ needs.source.outputs.version }}

.github/workflows/unused-strings.yml

@@ -0,0 +1,18 @@
+name: Unused strings
+
+on:
+  pull_request:
+
+jobs:
+  unused-strings:
+    name: Unused strings
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Check for unused strings
+      run: |
+        set -ex
+        python3 .github/unused-strings.py

.github/workflows/upload-aws.yml

@@ -0,0 +1,76 @@
+name: Upload (AWS)
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+      folder:
+        required: true
+        type: string
+      trigger_type:
+        required: true
+        type: string
+
+jobs:
+  upload:
+    name: Upload (AWS)
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - name: Download all bundles
+      uses: actions/download-artifact@v3
+
+    - name: Calculate checksums
+      run: |
+        echo "::group::Move bundles to a single folder"
+        mkdir bundles
+        mv openttd-*/* bundles/
+        echo "::endgroup::"
+
+        cd bundles
+        for i in $(ls openttd-*); do
+          echo "::group::Calculating checksums for ${i}"
+          openssl dgst -r -md5 -hex $i > $i.md5sum
+          openssl dgst -r -sha1 -hex $i > $i.sha1sum
+          openssl dgst -r -sha256 -hex $i > $i.sha256sum
+          echo "::endgroup::"
+        done
+
+        # Some targets generate files that are meant for our-eyes-only.
+        # They are stored in the "internal" folder, and contains bundles
+        # for targets like Windows Store. No user has a benefit of knowing
+        # they exist, hence: internal.
+        if [ -e internal ]; then
+          cd internal
+          for i in $(ls openttd-*); do
+            echo "::group::Calculating checksums for ${i}"
+            openssl dgst -r -md5 -hex $i > $i.md5sum
+            openssl dgst -r -sha1 -hex $i > $i.sha1sum
+            openssl dgst -r -sha256 -hex $i > $i.sha256sum
+            echo "::endgroup::"
+          done
+        fi
+
+    - name: Upload bundles to AWS
+      run: |
+        aws s3 cp --recursive --only-show-errors bundles/ s3://${{ secrets.CDN_S3_BUCKET }}/${{ inputs.folder }}/${{ inputs.version }}/
+
+        # We do not invalidate the CloudFront distribution here. The trigger
+        # for "New OpenTTD release" first updated the manifest files and
+        # creates an index.html. We invalidate after that, so everything
+        # becomes visible at once.
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
+
+    - name: Trigger 'New OpenTTD release'
+      uses: peter-evans/repository-dispatch@v2
+      with:
+        token: ${{ secrets.DEPLOYMENT_TOKEN }}
+        repository: OpenTTD/workflows
+        event-type: ${{ inputs.trigger_type }}
+        client-payload: '{"version": "${{ inputs.version }}", "folder": "${{ inputs.folder }}"}'

.github/workflows/upload-gog.yml

@@ -0,0 +1,124 @@
+name: Upload (GOG)
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+
+jobs:
+  upload:
+    name: Upload (GOG)
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - name: Download all bundles
+      uses: actions/download-artifact@v3
+
+    - 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
+
+    - name: Install OpenGFX
+      shell: bash
+      run: |
+        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 "::endgroup::"
+
+        echo "::group::Unpack OpenGFX"
+        unzip opengfx-all.zip
+        echo "::endgroup::"
+
+        rm -f opengfx-all.zip
+
+    - name: Install OpenMSX
+      shell: bash
+      run: |
+        mkdir -p gog/openmsx/baseset
+        cd gog/openmsx/baseset
+
+        echo "::group::Download OpenMSX"
+        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"
+        unzip openmsx-all.zip
+        tar xf openmsx-*.tar
+        echo "::endgroup::"
+
+        rm -f openmsx-all.zip openmsx-*.tar
+
+    - name: Install OpenSFX
+      shell: bash
+      run: |
+        mkdir -p gog/opensfx/baseset
+        cd gog/opensfx/baseset
+
+        echo "::group::Download OpenSFX"
+        curl -L https://cdn.openttd.org/opensfx-releases/1.0.3/opensfx-1.0.3-all.zip -o opensfx-all.zip
+        echo "::endgroup::"
+
+        echo "::group::Unpack OpenSFX"
+        unzip opensfx-all.zip
+        tar xf opensfx-*.tar
+        echo "::endgroup::"
+
+        rm -f opensfx-all.zip opensfx-*.tar
+
+    - name: Upload to GOG
+      run: |
+        echo "::group::Extracting source"
+        mkdir source
+        (
+          cd source
+          tar -xf ../internal-source/source.tar.gz --strip-components=1
+        )
+        echo "::endgroup::"
+
+        (
+          cd gog
+
+          echo "::group::Prepare Win32"
+          unzip ../openttd-windows-x86/openttd-*-windows-win32.zip
+          mv openttd-*-windows-win32 win32
+          echo "::endgroup::"
+
+          echo "::group::Prepare Win64"
+          unzip ../openttd-windows-x64/openttd-*-windows-win64.zip
+          mv openttd-*-windows-win64 win64
+          echo "::endgroup::"
+
+          echo "::group::Prepare macOS"
+          mkdir macos
+          (
+            cd macos
+            unzip ../../openttd-macos-universal/openttd-*-macos-universal.zip
+          )
+          echo "::endgroup::"
+
+          echo "::group::Prepare Linux"
+          tar xvf ../openttd-linux-generic/openttd-*-linux-generic-amd64.tar.xz
+          mv openttd-*-linux-generic-amd64 linux
+          echo "::endgroup::"
+
+          echo "::group::Preparing build files"
+          cp ../source/os/gog/*.json .
+          for json in $(ls *.json); do
+            sed -i 's/VERSION/${{ inputs.version }}/g;s/CLIENT_ID/${{ secrets.GOG_CLIENT_ID }}/g;s/CLIENT_SECRET/${{ secrets.GOG_CLIENT_SECRET }}/g' ${json}
+          done
+          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
+          echo "::endgroup::"
+        )

.github/workflows/upload-steam.yml

@@ -0,0 +1,82 @@
+name: Upload (Steam)
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+      trigger_type:
+        required: true
+        type: string
+
+jobs:
+  upload:
+    name: Upload (Steam)
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - name: Download all bundles
+      uses: actions/download-artifact@v3
+
+    - name: Setup steamcmd
+      uses: CyberAndrii/setup-steamcmd@v1
+
+    - name: Generate Steam auth code
+      id: steam-totp
+      uses: CyberAndrii/steam-totp@v1
+      with:
+        shared_secret: ${{ secrets.STEAM_SHARED_SECRET }}
+
+    - name: Upload to Steam
+      run: |
+        echo "::group::Extracting source"
+        mkdir source
+        (
+          cd source
+          tar -xf ../internal-source/source.tar.gz --strip-components=1
+        )
+        echo "::endgroup::"
+
+        mkdir steam
+        (
+          cd steam
+
+          echo "::group::Prepare Win32"
+          unzip ../openttd-windows-x86/openttd-*-windows-win32.zip
+          mv openttd-*-windows-win32 steam-win32
+          echo "::endgroup::"
+
+          echo "::group::Prepare Win64"
+          unzip ../openttd-windows-x64/openttd-*-windows-win64.zip
+          mv openttd-*-windows-win64 steam-win64
+          echo "::endgroup::"
+
+          echo "::group::Prepare macOS"
+          mkdir steam-macos
+          (
+            cd steam-macos
+            unzip ../../openttd-macos-universal/openttd-*-macos-universal.zip
+          )
+          echo "::endgroup::"
+
+          echo "::group::Prepare Linux"
+          tar xvf ../openttd-linux-generic/openttd-*-linux-generic-amd64.tar.xz
+          mv openttd-*-linux-generic-amd64 steam-linux
+          echo "::endgroup::"
+
+          echo "::group::Preparing build file"
+          if [ "${{ inputs.trigger_type }}" = "new-tag" ]; then
+            BRANCH="testing"
+          else
+            BRANCH="nightly"
+          fi
+          cat ../source/os/steam/release.vdf | sed 's/@@DESCRIPTION@@/openttd-${{ inputs.version }}/;s/@@BRANCH@@/'${BRANCH}'/' > release.vdf
+          cat release.vdf
+          echo "::endgroup::"
+
+          echo "::group::Upload to Steam"
+          steamcmd +login ${{ secrets.STEAM_USERNAME }} ${{ secrets.STEAM_PASSWORD }} ${{ steps.steam-totp.outputs.code }} +run_app_build $(pwd)/release.vdf +quit
+          echo "::endgroup::"
+        )

CMakeLists.txt

@@ -1,13 +1,15 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.9)
 
 if(NOT BINARY_NAME)
     set(BINARY_NAME openttd)
 endif()
 
-project(${BINARY_NAME})
+project(${BINARY_NAME}
+    VERSION 13.2
+)
 
 if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
-    message(FATAL_ERROR "In-source builds not allowed. Please run \"cmake ..\" from the bin directory")
+    message(FATAL_ERROR "In-source builds not allowed. Please run \"cmake ..\" from the build directory. You may need to delete \"${CMAKE_SOURCE_DIR}/CMakeCache.txt\" first.")
 endif()
 
 # Debug mode by default.
@@ -20,13 +22,16 @@ if (EMSCRIPTEN)
 endif()
 
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
-set(CMAKE_OSX_DEPLOYMENT_TARGET 10.9)
+set(CMAKE_OSX_DEPLOYMENT_TARGET 10.13)
 
 # Use GNUInstallDirs to allow customisation
-# but set our own default data dir
+# but set our own default data and bin dir
 if(NOT CMAKE_INSTALL_DATADIR)
     set(CMAKE_INSTALL_DATADIR "share/games")
 endif()
+if(NOT CMAKE_INSTALL_BINDIR)
+    set(CMAKE_INSTALL_BINDIR "games")
+endif()
 include(GNUInstallDirs)
 
 include(Options)
@@ -69,6 +74,9 @@ add_custom_target(find_version
         ${CMAKE_COMMAND}
                 -DFIND_VERSION_BINARY_DIR=${CMAKE_BINARY_DIR}/generated
                 -DCPACK_BINARY_DIR=${CMAKE_BINARY_DIR}
+                -DREV_MAJOR=${PROJECT_VERSION_MAJOR}
+                -DREV_MINOR=${PROJECT_VERSION_MINOR}
+                -DWINDOWS=${WIN32}
                 -P "${CMAKE_SOURCE_DIR}/cmake/scripts/FindVersion.cmake"
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
         BYPRODUCTS ${GENERATED_SOURCE_FILES}
@@ -101,6 +109,11 @@ if(OPTION_TOOLS_ONLY)
     return()
 endif()
 
+if(APPLE)
+	# Avoid searching for headers in Frameworks, and libraries in LIBDIR.
+	set(CMAKE_FIND_FRAMEWORK LAST)
+endif()
+
 # Prefer -pthread over -lpthread, which is often the better option of the two.
 set(CMAKE_THREAD_PREFER_PTHREAD YES)
 # Make sure we have Threads available.
@@ -111,25 +124,33 @@ find_package(LibLZMA)
 find_package(LZO)
 find_package(PNG)
 
-if(NOT WIN32)
-    find_package(Allegro)
-    find_package(Freetype)
-    if(NOT APPLE)
-        find_package(SDL2)
-        if(NOT SDL2_FOUND)
-            find_package(SDL)
+if(NOT OPTION_DEDICATED)
+    if(NOT WIN32)
+        find_package(Allegro)
+        if(NOT APPLE)
+            find_package(Freetype)
+            find_package(SDL2)
+            if(NOT SDL2_FOUND)
+                find_package(SDL)
+            endif()
+            find_package(Fluidsynth)
+            find_package(Fontconfig)
+            find_package(ICU OPTIONAL_COMPONENTS i18n lx)
         endif()
-        find_package(Fluidsynth)
-        find_package(Fontconfig)
-        find_package(ICU OPTIONAL_COMPONENTS i18n lx)
-    else()
-        find_package(Iconv)
-
-        find_library(AUDIOTOOLBOX_LIBRARY AudioToolbox)
-        find_library(AUDIOUNIT_LIBRARY AudioUnit)
-        find_library(COCOA_LIBRARY Cocoa)
     endif()
 endif()
+if(APPLE)
+    find_package(Iconv)
+
+    find_library(AUDIOTOOLBOX_LIBRARY AudioToolbox)
+    find_library(AUDIOUNIT_LIBRARY AudioUnit)
+    find_library(COCOA_LIBRARY Cocoa)
+    find_library(QUARTZCORE_LIBRARY QuartzCore)
+endif()
+
+if(NOT EMSCRIPTEN AND NOT OPTION_DEDICATED)
+    find_package(OpenGL COMPONENTS OpenGL)
+endif()
 
 if(MSVC)
     find_package(Editbin REQUIRED)
@@ -140,19 +161,14 @@ find_package(Xaudio2)
 
 find_package(Grfcodec)
 
-# IPO is only properly supported from CMake 3.9. Despite the fact we are
-# CMake 3.5, still enable IPO if we detect we are 3.9+.
-if(POLICY CMP0069)
-    cmake_policy(SET CMP0069 NEW)
-    include(CheckIPOSupported)
-    check_ipo_supported(RESULT IPO_FOUND)
-endif()
+include(CheckIPOSupported)
+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)
-        message(FATAL_ERROR "SDL or SDL2 is required for this platform")
+    if(NOT SDL_FOUND AND NOT SDL2_FOUND AND NOT ALLEGRO_FOUND)
+        message(FATAL_ERROR "SDL, SDL2 or Allegro is required for this platform")
     endif()
 endif()
 if(APPLE)
@@ -165,6 +181,30 @@ if(APPLE)
     if(NOT COCOA_LIBRARY)
         message(FATAL_ERROR "Cocoa is required for this platform")
     endif()
+    if(NOT QUARTZCORE_LIBRARY)
+        message(FATAL_ERROR "QuartzCore is required for this platform")
+    endif()
+endif()
+
+if(OPTION_PACKAGE_DEPENDENCIES)
+    if(NOT UNIX)
+        message(FATAL_ERROR "Can only package dependencies on Linux")
+    endif()
+    if(OPTION_INSTALL_FHS)
+        message(FATAL_ERROR "Cannot install in FHS folders when we are packaging dependencies")
+    endif()
+    if(${CMAKE_VERSION} VERSION_LESS "3.16.0")
+        message(FATAL_ERROR "OPTION_PACKAGE_DEPENDENCIES can only work with CMake 3.16+; you are using ${CMAKE_VERSION}")
+    endif()
+
+    # If we are packaging dependencies, we do two things:
+    # 1) set the RPATH to include $ORIGIN/lib; $ORIGIN (that literal string)
+    #    is a Linux indicator for "path where application is". In CMake, we
+    #    have to do this before add_executable() is executed.
+    # 2) copy the libraries that we compile against to the "lib" folder.
+    #    This is done in InstallAndPackage.cmake.
+    set(CMAKE_INSTALL_RPATH "\$ORIGIN/lib")
+    set(CMAKE_BUILD_WITH_INSTALL_RPATH ON)
 endif()
 
 include(SourceList)
@@ -180,8 +220,14 @@ add_executable(openttd WIN32 ${GENERATED_SOURCE_FILES})
 set_target_properties(openttd PROPERTIES OUTPUT_NAME "${BINARY_NAME}")
 # All other files are added via target_sources()
 
+if(MSVC)
+    # Add DPI manifest to project; other WIN32 targets get this via ottdres.rc
+    target_sources(openttd PRIVATE "${CMAKE_SOURCE_DIR}/os/windows/openttd.manifest")
+endif()
+
+add_subdirectory(${CMAKE_SOURCE_DIR}/bin)
 add_subdirectory(${CMAKE_SOURCE_DIR}/src)
-add_subdirectory(${CMAKE_SOURCE_DIR}/media/baseset)
+add_subdirectory(${CMAKE_SOURCE_DIR}/media)
 
 add_dependencies(openttd
     find_version)
@@ -189,17 +235,22 @@ add_dependencies(openttd
 target_link_libraries(openttd
     openttd::languages
     openttd::settings
+    openttd::media
     openttd::basesets
     openttd::script_api
     Threads::Threads
 )
 
+if(HAIKU)
+    target_link_libraries(openttd "be" "network" "midi")
+endif()
+
 if(IPO_FOUND)
     set_target_properties(openttd PROPERTIES INTERPROCEDURAL_OPTIMIZATION_RELEASE True)
     set_target_properties(openttd PROPERTIES INTERPROCEDURAL_OPTIMIZATION_MINSIZEREL True)
     set_target_properties(openttd PROPERTIES INTERPROCEDURAL_OPTIMIZATION_RELWITHDEBINFO True)
 endif()
-set_target_properties(openttd PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/bin")
+set_target_properties(openttd PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_BINARY_DIR}")
 process_compile_flags()
 
 include(LinkPackage)
@@ -217,8 +268,20 @@ if(NOT OPTION_DEDICATED)
     link_package(Fontconfig TARGET Fontconfig::Fontconfig)
     link_package(ICU_lx)
     link_package(ICU_i18n)
+
+    if(SDL2_FOUND AND OPENGL_FOUND AND UNIX)
+        # SDL2 dynamically loads OpenGL if needed, so do not link to OpenGL when
+        # on Linux. For Windows, we need to link to OpenGL as we also have a win32
+        # driver using it.
+        add_definitions(-DWITH_OPENGL)
+        message(STATUS "OpenGL found -- -DWITH_OPENGL -- (via SDL2)")
+    else()
+        link_package(OpenGL TARGET OpenGL::GL)
+    endif()
 endif()
 
+include(CheckAtomic)
+
 if(APPLE)
     link_package(Iconv TARGET Iconv::Iconv)
 
@@ -226,6 +289,7 @@ if(APPLE)
         ${AUDIOTOOLBOX_LIBRARY}
         ${AUDIOUNIT_LIBRARY}
         ${COCOA_LIBRARY}
+        ${QUARTZCORE_LIBRARY}
     )
 
     add_definitions(
@@ -243,7 +307,7 @@ if(EMSCRIPTEN)
     add_definitions(-s DISABLE_EXCEPTION_CATCHING=0)
 
     # Export functions to Javascript.
-    target_link_libraries(WASM::WASM INTERFACE "-s EXPORTED_FUNCTIONS='[\"_main\", \"_em_openttd_add_server\"]' -s EXTRA_EXPORTED_RUNTIME_METHODS='[\"cwrap\"]'")
+    target_link_libraries(WASM::WASM INTERFACE "-s EXPORTED_FUNCTIONS='[\"_main\", \"_em_openttd_add_server\"]' -s EXPORTED_RUNTIME_METHODS='[\"cwrap\"]'")
 
     # Preload all the files we generate during build.
     # As we do not compile with FreeType / FontConfig, we also have no way to
@@ -297,20 +361,27 @@ if(WIN32)
         -DUNICODE
         -D_UNICODE
         -DWITH_UNISCRIBE
+        -DPSAPI_VERSION=1
     )
 
     target_link_libraries(openttd
         ws2_32
         winmm
         imm32
+        usp10
+        psapi
     )
 endif()
 
 if(CMAKE_SIZEOF_VOID_P EQUAL 8)
-    add_definitions(-D_SQ64)
+    add_definitions(-DPOINTER_IS_64BIT)
 endif()
 
 include(CreateRegression)
 create_regression()
 
+if(APPLE OR WIN32)
+    find_package(Pandoc)
+endif()
+
 include(InstallAndPackage)

COMPILING.md

@@ -2,26 +2,27 @@
 
 ## Required/optional libraries
 
-The following libraries are used by OpenTTD for:
+OpenTTD makes use of the following external libraries:
 
-- zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads,
+- (encouraged) zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads,
    heightmaps
-- liblzo2: (de)compressing of old (pre 0.3.0) savegames
-- liblzma: (de)compressing of savegames (1.1.0 and later)
-- libpng: making screenshots and loading heightmaps
+- (encouraged) liblzma: (de)compressing of savegames (1.1.0 and later)
+- (encouraged) libpng: making screenshots and loading heightmaps
+- (optional) liblzo2: (de)compressing of old (pre 0.3.0) savegames
+
+For Linux, the following additional libraries are used (for non-dedicated only):
+
+- libSDL2: hardware access (video, sound, mouse)
 - libfreetype: loading generic fonts and rendering them
 - libfontconfig: searching for fonts, resolving font names to actual fonts
 - libicu: handling of right-to-left scripts (e.g. Arabic and Persian) and
-   natural sorting of strings (Linux only)
-- libSDL2: hardware access (video, sound, mouse) (not required for Windows or macOS)
+   natural sorting of strings
 
 OpenTTD does not require any of the libraries to be present, but without
 liblzma you cannot open most recent savegames and without zlib you cannot
 open most older savegames or use the content downloading system.
-Without libSDL/liballegro on non-Windows and non-macOS machines you have
-no graphical user interface; you would be building a dedicated server.
 
-## Windows:
+## Windows
 
 You need Microsoft Visual Studio 2017 or more recent.
 
@@ -57,6 +58,9 @@ 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.
+(Typical values are shown in the MSVC project file command line example)
 
 Alternatively, you can create a MSVC project file via CMake. For this
 either download CMake from https://cmake.org/download/ or use the version
@@ -65,7 +69,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 16 2019" -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
@@ -73,6 +77,9 @@ 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.
+By default this produces a Debug build with assertations enabled.
+This is a far slower build than release builds.
 
 ```bash
 mkdir build
@@ -84,6 +91,25 @@ make
 For more information on how to use CMake (including how to make Release builds),
 we urge you to read [their excellent manual](https://cmake.org/cmake/help/latest/guide/user-interaction/index.html).
 
+## CMake Options
+
+Via CMake, several options can be influenced to get different types of
+builds.
+
+- `-DCMAKE_BUILD_TYPE=RelWithDebInfo`: build a release build. This is
+   significant faster than a debug build, but has far less useful information
+   in case of a crash.
+- `-DOPTION_DEDICATED=ON`: build OpenTTD without a GUI. Useful if you are
+   running a headless server, as it requires less libraries to operate.
+- `-DOPTION_USE_ASSERTS=OFF`: disable asserts. Use with care, as assert
+   statements capture early signs of trouble. Release builds have them
+   disabled by default.
+- `-DOPTION_USE_THREADS=OFF`: disable the use of threads. This will block
+   the interface in many places, and in general gives a worse experience of
+   the game. Use with care.
+- `-DOPTION_TOOLS_ONLY=ON`: only build tools like `strgen`. Does not build
+   the game itself. Useful for cross-compiling.
+
 ## Supported compilers
 
 Every compiler that is supported by CMake and supports C++17, should be

CONTRIBUTING.md

@@ -94,8 +94,8 @@ Although we really appreciate feedback and ideas, we will close feature requests
 
 Many of those ideas etc do have a place on the [forums](https://www.tt-forums.net); and if enough people like it, someone will stand up and make it.
 
-It's usually best discuss in [irc](https://wiki.openttd.org/en/Development/IRC%20channel) before opening a feature request or working on a large feature in a fork.
-Discussion in irc can take time, but it can be productive and avoid disappointment :)
+It's usually best to discuss on [Discord](https://discord.gg/openttd) before opening a feature request or working on a large feature in a fork.
+Discussion can take time, but it can be productive and avoid disappointment. :)
 
 
 ## Pull requests
@@ -137,7 +137,7 @@ git checkout upstream/master -b <topic-branch-name>
 ```
 
 4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](https://wiki.openttd.org/en/Development/Coding%20style#commit-message) or your code is unlikely to be merged into the main project.
-Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public.
+Use Git's [interactive rebase](https://docs.github.com/en/get-started/using-git/about-git-rebase) feature to tidy up your commits before making them public.
 
 5. Locally rebase the upstream development branch into your topic branch:
 
@@ -212,8 +212,8 @@ When it comes to gameplay features there are at least these groups of interests:
 - *Control freak:* micromanagement like conditional orders, refitting and loading etc.
 - *Casual:* automatisation like cargodist, path based signalling etc.
 
-To please everyone, the official branch tries to stay close to the original gameplay; after all, that is what everyone brought here.
-The preferred method to alter and extent the gameplay is via add-ons like NewGRF and GameScripts.
+To please everyone, the official branch tries to stay close to the original gameplay; after all, that is what brought everyone here.
+The preferred method to alter and extend the gameplay is via add-ons like NewGRF and GameScripts.
 
 For a long time, the official branch was also open to features which could be enabled/disabled, but the corner-cases that came with some configurations have rendered some parts of the code very complicated.
 Today, new features have to work with all the already existing features, which is not only challenging in corner cases, but also requires spending considerable more work than just "making it work in the game mode that I play".
@@ -265,5 +265,5 @@ If you would not like to accept this risk, please do either commit anonymously o
 
 ### Attribution of this Contributing Guide
 
-This contributing guide is adapted from [Bootstrap](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md) under the [Creative Commons Attribution 3.0 Unported License](https://github.com/twbs/bootstrap/blob/master/docs/LICENSE) terms for Bootstrap documentation.
+This contributing guide is adapted from [Bootstrap](https://github.com/twbs/bootstrap/blob/main/.github/CONTRIBUTING.md) under the [Creative Commons Attribution 3.0 Unported License](https://creativecommons.org/licenses/by/3.0/) terms for Bootstrap documentation.
 The GDPR notice is adapted from [rsyslog](https://github.com/rsyslog/rsyslog/blob/master/CONTRIBUTING.md) under the [GNU General Public License](https://github.com/rsyslog/rsyslog/blob/master/COPYING).

CREDITS.md

@@ -1,43 +1,44 @@
 ### The OpenTTD team (in alphabetical order):
 
-- Grzegorz Duczyński (adf88) - General coding (since 1.7.2)
-- Albert Hofkamp (Alberth) - GUI expert (since 0.7)
 - Matthijs Kooijman (blathijs) - Pathfinder-guru, Debian port (since 0.3)
-- Ulf Hermann (fonsinchen) - Cargo Distribution (since 1.3)
 - Christoph Elsenhans (frosch) - General coding (since 0.6)
-- Loïc Guilloux (glx) - Windows Expert (since 0.4.5)
+- Loïc Guilloux (glx) - General / Windows Expert (since 0.4.5)
 - Charles Pigott (LordAro) - General / Correctness police (since 1.9)
-- Michael Lutz (michi_cc) - Path based signals (since 0.7)
+- Michael Lutz (michi_cc) - General / Path based signals (since 0.7)
 - Niels Martin Hansen (nielsm) - Music system, general coding (since 1.9)
 - Owen Rudge (orudge) - Forum host, OS/2 port (since 0.1)
 - Peter Nelson (peter1138) - Spiritual descendant from newGRF gods (since 0.4.5)
-- Ingo von Borstel (planetmaker) - General coding, Support (since 1.1)
-- Remko Bijker (Rubidium) - Lead coder and way more (since 0.4.5)
-- José Soler (Terkhen) - General coding (since 1.0)
-- Leif Linse (Zuu) - AI/Game Script (since 1.2)
+- Remko Bijker (Rubidium) - Coder and way more (since 0.4.5)
+- Patric Stout (TrueBrain) - NoProgrammer (since 0.3), sys op
+- Tyler Trahan (2TallTyler) - General coding (since 13)
 
 ### Inactive Developers:
 
+- Grzegorz Duczyński (adf88) - General coding (1.7 - 1.8)
+- Albert Hofkamp (Alberth) - GUI expert (0.7 - 1.9)
 - Jean-François Claeys (Belugas) - GUI, newindustries and more (0.4.5 - 1.0)
 - Bjarni Corfitzen (Bjarni) - macOS port, coder and vehicles (0.3 - 0.7)
 - Victor Fischer (Celestar) - Programming everywhere you need him to (0.3 - 0.6)
+- Ulf Hermann (fonsinchen) - Cargo Distribution (1.3 - 1.6)
 - Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) (0.4.5 - 0.6)
 - Jonathan Coome (Maedhros) - High priest of the NewGRF Temple (0.5 - 0.6)
-- Attila Bán (MiHaMiX) - WebTranslator 1 and 2 (0.3 - 0.5)
+- Attila Bán (MiHaMiX) - Developer WebTranslator 1 and 2 (0.3 - 0.5)
+- Ingo von Borstel (planetmaker) - General coding, Support (1.1 - 1.9)
 - Zdeněk Sojka (SmatZ) - Bug finder and fixer (0.6 - 1.3)
+- José Soler (Terkhen) - General coding (1.0 - 1.4)
 - Christoph Mallon (Tron) - Programmer, code correctness police (0.3 - 0.5)
-- Patric Stout (TrueBrain) - NoProgrammer (0.3 - 1.2), sys op (active)
 - Thijs Marinussen (Yexo) - AI Framework, General (0.6 - 1.3)
+- Leif Linse (Zuu) - AI/Game Script (1.2 - 1.6)
 
 ### Retired Developers:
 
 - Tamás Faragó (Darkvater) - Ex-Lead coder (0.3 - 0.5)
 - Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3 - 0.3)
-- Emil Djupfeld (egladil) - macOS port (0.4 - 0.6)
+- Emil Djupfeld (egladil) - macOS port (0.4.5 - 0.6)
 - Simon Sasburg (HackyKid) - Bug fixer (0.4 - 0.4.5)
 - Ludvig Strigeus (ludde) - Original author of OpenTTD, main coder (0.1 - 0.3)
 - Cian Duffy (MYOB) - BeOS port / manual writing (0.1 - 0.3)
-- Petr Baudiš (pasky) - Many patches, newgrf support, etc. (0.3 - 0.3)
+- Petr Baudiš (pasky) - Many patches, newgrf support (0.3 - 0.3)
 - Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker (0.6 - 0.7)
 - Serge Paquet (vurlix) - 2nd contributor after ludde (0.1 - 0.3)
 
@@ -52,7 +53,7 @@
 - Alberto Demichelis - Squirrel scripting language
 - L. Peter Deutsch - MD5 implementation
 - Michael Blunck - For revolutionizing TTD with awesome graphics
-- George - Canal graphics
+- George - Canal/Lock graphics
 - Andrew Parkhouse (andythenorth) - River graphics
 - David Dallaston (Pikka) - Tram tracks
 - All Translators - For their support to make OpenTTD a truly international game

Doxyfile.in

@@ -41,7 +41,6 @@ INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 2
 ALIASES                =
-TCL_SUBST              =
 OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = NO
 OPTIMIZE_FOR_FORTRAN   = NO
@@ -155,7 +154,6 @@ VERBATIM_HEADERS       = YES
 # Configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
 ALPHABETICAL_INDEX     = NO
-COLS_IN_ALPHA_INDEX    = 5
 IGNORE_PREFIX          =
 #---------------------------------------------------------------------------
 # Configuration options related to the HTML output
@@ -224,7 +222,7 @@ LATEX_OUTPUT           = latex
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
 COMPACT_LATEX          = NO
-PAPER_TYPE             = a4wide
+PAPER_TYPE             = a4
 EXTRA_PACKAGES         =
 LATEX_HEADER           =
 LATEX_FOOTER           =

README.md

@@ -34,7 +34,7 @@ Both 'stable' and 'nightly' versions are available for download:
 - most people should choose the 'stable' version, as this has been more extensively tested
 - the 'nightly' version includes the latest changes and features, but may sometimes be less reliable
 
-On some platforms OpenTTD will also be available via your OS package manager or a similar service.
+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
@@ -46,15 +46,13 @@ OpenTTD has a [community-maintained wiki](https://wiki.openttd.org/), including
 
 OpenTTD has been ported to several platforms and operating systems.
 
-The currently working platforms are:
+The currently supported platforms are:
 
-- FreeBSD (SDL)
-- Haiku (SDL)
-- Linux (SDL)
-- macOS (universal) (Cocoa video and sound drivers)
-- OpenBSD (SDL)
-- OS/2 (SDL)
-- Windows (Win32 GDI (faster) or SDL)
+- Linux (SDL (OpenGL and non-OpenGL))
+- macOS (universal) (Cocoa)
+- Windows (Win32 GDI / OpenGL)
+
+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.
@@ -79,9 +77,9 @@ For some platforms, you will need to refer to [the installation guide](https://w
 The free data files, split into OpenGFX for graphics, OpenSFX for sounds and
 OpenMSX for music can be found at:
 
-- https://www.openttd.org/download-opengfx for OpenGFX
-- https://www.openttd.org/download-opensfx for OpenSFX
-- https://www.openttd.org/download-openmsx for OpenMSX
+- https://www.openttd.org/downloads/opengfx-releases/latest for OpenGFX
+- https://www.openttd.org/downloads/opensfx-releases/latest for OpenSFX
+- https://www.openttd.org/downloads/openmsx-releases/latest for OpenMSX
 
 Please follow the readme of these packages about the installation procedure.
 The Windows installer can optionally download and install these packages.
@@ -118,35 +116,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) AI opponents
-
-OpenTTD comes without AI opponents, so if you want to play with AIs you have to download them.
-
-The easiest way is via the 'Check Online Content' button in the main menu.
-
-You can select some AIs that you think are compatible with your playing style.
-
-AI help and discussions may also be found in the [AI section of the forum](https://www.tt-forums.net/viewforum.php?f=65).
-
-### 1.5.2) Scenarios and height maps
-
-Scenarios and heightmaps can be added via the 'Check Online Content' button in the main menu.
-
-### 1.5.3) NewGRFs
-
-A wide range of add-content is available as NewGRFs, including vehicles, industries, stations, landscape objects, town names and more.
-
-NewGRFs can be added via the 'Check Online Content' button in the main menu.
-
-See also the wiki [guide to NewGRFs](https://wiki.openttd.org/en/Manual/NewGRF) and [the forum graphics development section](https://www.tt-forums.net/viewforum.php?f=66).
-
-### 1.5.4) Game scripts
-
-Game scripts can provide additional challenges or changes to the standard OpenTTD gameplay, for example setting transport goals, or changing town growth behaviour.
-
-Game scripts can be added via the 'Check Online Content' button in the main menu.
-
-See also the wiki [guide to game scripts](https://wiki.openttd.org/en/Manual/Game%20script) and [the forum graphics game script section](https://www.tt-forums.net/viewforum.php?f=65).
 
 ### 1.6) OpenTTD directories
 
@@ -164,8 +133,9 @@ If you want to compile OpenTTD from source, instructions can be found in [COMPIL
 'Official' channels
 
 - [OpenTTD website](https://www.openttd.org)
+- [OpenTTD official Discord](https://discord.gg/openttd)
 - IRC chat using #openttd on irc.oftc.net [more info about our irc channel](https://wiki.openttd.org/en/Development/IRC%20channel)
-- [OpenTTD on Github](https://github.com/openTTD/) for code repositories and for reporting issues
+- [OpenTTD on Github](https://github.com/OpenTTD/) for code repositories and for reporting issues
 - [forum.openttd.org](https://forum.openttd.org/) - the primary community forum site for discussing OpenTTD and related games
 - [OpenTTD wiki](https://wiki.openttd.org/) community-maintained wiki, including topics like gameplay guide, detailed explanation of some game mechanics, how to use add-on content (mods) and much more
 
@@ -207,6 +177,9 @@ See the comments in the source files in `src/3rdparty/md5` for the complete lice
 The implementations of Posix `getaddrinfo` and `getnameinfo` for OS/2 in `src/3rdparty/os2` are distributed partly under the GNU Lesser General Public License 2.1, and partly under the (3-clause) BSD license.
 The exact licensing terms can be found in `src/3rdparty/os2/getaddrinfo.c` resp. `src/3rdparty/os2/getnameinfo.c`.
 
+The fmt implementation in `src/3rdparty/fmt` is licensed under the MIT license.
+See `src/3rdparty/fmt/LICENSE.rst` for the complete license text.
+
 
 ## 4.0 Credits
 

bin/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_subdirectory(ai)
+add_subdirectory(game)

bin/ai/CMakeLists.txt

@@ -0,0 +1,41 @@
+set(AI_COMPAT_SOURCE_FILES
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_0.7.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.0.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.1.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.2.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.3.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.4.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.5.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.6.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.7.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.8.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.9.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.10.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.11.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_12.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_13.nut
+)
+
+foreach(AI_COMPAT_SOURCE_FILE IN LISTS AI_COMPAT_SOURCE_FILES)
+    string(REPLACE "${CMAKE_SOURCE_DIR}/bin/" "" AI_COMPAT_SOURCE_FILE_NAME "${AI_COMPAT_SOURCE_FILE}")
+    string(CONCAT AI_COMPAT_BINARY_FILE "${CMAKE_BINARY_DIR}/" "${AI_COMPAT_SOURCE_FILE_NAME}")
+
+    add_custom_command(OUTPUT ${AI_COMPAT_BINARY_FILE}
+            COMMAND ${CMAKE_COMMAND} -E copy
+                    ${AI_COMPAT_SOURCE_FILE}
+                    ${AI_COMPAT_BINARY_FILE}
+            MAIN_DEPENDENCY ${AI_COMPAT_SOURCE_FILE}
+            COMMENT "Copying ${AI_COMPAT_SOURCE_FILE_NAME}"
+    )
+
+    list(APPEND AI_COMPAT_BINARY_FILES ${AI_COMPAT_BINARY_FILE})
+endforeach()
+
+# Create a new target which copies all compat files
+add_custom_target(ai_compat_files
+        DEPENDS ${AI_COMPAT_BINARY_FILES}
+)
+
+add_dependencies(openttd
+    ai_compat_files
+)

bin/ai/compat_0.7.nut

@@ -379,3 +379,16 @@ 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

@@ -131,3 +131,16 @@ 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

@@ -68,3 +68,16 @@ 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

@@ -6,3 +6,16 @@
  */
 
 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;
+}

bin/ai/compat_1.11.nut

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

bin/ai/compat_1.2.nut

@@ -20,3 +20,16 @@ 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.3.nut

@@ -20,3 +20,16 @@ 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.4.nut

@@ -20,3 +20,16 @@ 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.5.nut

@@ -20,3 +20,16 @@ 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.6.nut

@@ -20,3 +20,16 @@ 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.7.nut

@@ -20,3 +20,16 @@ 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.8.nut

@@ -20,3 +20,16 @@ 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.9.nut

@@ -6,3 +6,16 @@
  */
 
 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;
+}

bin/ai/compat_12.nut

@@ -0,0 +1,21 @@
+/*
+ * 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/>.
+ */
+
+AILog.Info("12 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;
+}

bin/ai/compat_13.nut

@@ -4,14 +4,3 @@
  * 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/>.
  */
-
-/** @file splash.h Functions to support splash screens for OSX. */
-
-#ifndef SPLASH_H
-#define SPLASH_H
-
-#define SPLASH_IMAGE_FILE "splash.png"
-
-void DisplaySplashImage();
-
-#endif /* SPLASH_H */

bin/game/CMakeLists.txt

@@ -0,0 +1,38 @@
+set(GS_COMPAT_SOURCE_FILES
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.2.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.3.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.4.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.5.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.6.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.7.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.8.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.9.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.10.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_1.11.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_12.nut
+	${CMAKE_CURRENT_SOURCE_DIR}/compat_13.nut
+)
+
+foreach(GS_COMPAT_SOURCE_FILE IN LISTS GS_COMPAT_SOURCE_FILES)
+    string(REPLACE "${CMAKE_SOURCE_DIR}/bin/" "" GS_COMPAT_SOURCE_FILE_NAME "${GS_COMPAT_SOURCE_FILE}")
+    string(CONCAT GS_COMPAT_BINARY_FILE "${CMAKE_BINARY_DIR}/" "${GS_COMPAT_SOURCE_FILE_NAME}")
+
+    add_custom_command(OUTPUT ${GS_COMPAT_BINARY_FILE}
+            COMMAND ${CMAKE_COMMAND} -E copy
+                    ${GS_COMPAT_SOURCE_FILE}
+                    ${GS_COMPAT_BINARY_FILE}
+            MAIN_DEPENDENCY ${GS_COMPAT_SOURCE_FILE}
+            COMMENT "Copying ${GS_COMPAT_SOURCE_FILE_NAME}"
+    )
+
+    list(APPEND GS_COMPAT_BINARY_FILES ${GS_COMPAT_BINARY_FILE})
+endforeach()
+
+# Create a new target which copies all compat files
+add_custom_target(gs_compat_files
+        DEPENDS ${GS_COMPAT_BINARY_FILES}
+)
+
+add_dependencies(openttd
+    gs_compat_files
+)

bin/game/compat_1.10.nut

@@ -13,3 +13,16 @@ 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;
+}

bin/game/compat_1.11.nut

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

@@ -35,3 +35,16 @@ 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;
+}

bin/game/compat_1.3.nut

@@ -35,3 +35,16 @@ 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;
+}

bin/game/compat_1.4.nut

@@ -28,3 +28,15 @@ 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;
+}

bin/game/compat_1.5.nut

@@ -20,3 +20,16 @@ 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;
+}

bin/game/compat_1.6.nut

@@ -20,3 +20,16 @@ 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;
+}

bin/game/compat_1.7.nut

@@ -20,3 +20,16 @@ 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;
+}

bin/game/compat_1.8.nut

@@ -20,3 +20,16 @@ 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;
+}

bin/game/compat_1.9.nut

@@ -13,3 +13,16 @@ 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;
+}

bin/game/compat_12.nut

@@ -0,0 +1,21 @@
+/*
+ * 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/>.
+ */
+
+GSLog.Info("12 API compatibility in effect.");
+
+/* 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_13.nut

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

changelog.txt

@@ -1,3 +1,627 @@
+13.2.1 (2023-06-11)
+------------------------------------------------------------------------
+Fix: [Win32] use full monitor resolution for fullscreen (#10985)
+
+
+13.2 (2023-06-10)
+------------------------------------------------------------------------
+Change: [Win32] position window in center of workspace of primary display (#10942)
+Change: Automatically disable hardware acceleration when GPU driver crashed the game last attempt (#10928)
+Change: [Linux] Default scroll mode to non-mouse-lock (#10920)
+Change: Include font style in font name for Freetype (#10879)
+Fix: Don't restore backed up vehicle name if it's no longer unique (#10979)
+Fix #10975: Train name wrongly marked as unique when joining trains (#10976)
+Fix: Crash when not even a single row fits for dropdowns on low resolution screens (#10934)
+Fix: Crash with tooltip on low resolution screens (#10933)
+Fix: Crash when window can't be placed on low resolution screens (#10932)
+Fix #10502: Apply engine refit before attaching free wagons (#10926)
+Fix: Wayland crash on startup due to Pango also using FontConfig (#10916)
+Fix: When syncing width of GUI items, take padding into account (#10915)
+Fix: Make dropdowns self-close when losing focus (#10912)
+Fix: Land info window maximum width was not scaled (#10894)
+Fix: Check max member count in squirrel classes (#10883)
+Fix: Ask FontConfig for the face index when opening fonts (#10878)
+Fix #10831: Level crossing parts left barred after crossing tile removal (#10874)
+Fix: Rail waypoint selection window not closed when parent windows closed (#10873)
+Fix #10846: [Script] Crash on trying to allocate an excessively large array (#10848)
+Fix: [Win32] Text line breaking did not properly handle punctuation characters (#10775)
+Fix: [Emscripten] Crash when saving games (#10758)
+Fix: [Win32] Wrong multi-line text layout due to incorrect whitespace handling (#10752)
+Fix #10741: Rail platforms left partially reserved after train crash (#10751)
+Fix: Shaded engines in purchase list incorrectly shaded (#10736)
+Fix #10735: [NewGRF] {POP_COLOUR} fails if string is drawn with extra flags (#10736)
+Fix #8177: Ships with max speed overflow to near-zero speed (#10695)
+Fix #10289: Don't silently fail when setting timetable start dates (#10690)
+Fix #8302: Improve "Maintenance intervals are in percents" helptext (#10686)
+Fix #10665: "No vehicles are available yet" message did not appear correctly on non-temperate climates (#10673)
+Fix #10630: Don't allow shifting service date earlier than year 0 (#10643)
+Fix #10637, #10638: Incorrect water infrastructure totals when building certain object types (#10639, #10640)
+Fix: Abort loading savegame if road vehicle is on invalid road type (#10622)
+
+
+13.1 (2023-04-10)
+------------------------------------------------------------------------
+Add: [NewGRF] Engine name callback for nested variants. (#10399)
+Fix: Improve main toolbar tooltips (#10616)
+Fix: [NewGRF] Additional validation for Action3 (+others) (#10601)
+Fix: Clear button for editbox didn't take account of padding (#10583)
+Fix: [Script] Access to enum/consts defined outside of main.nut (#10573)
+Fix #10568: Bogus warning when loading a save with a NewGRFs on dedicated servers (#10572)
+Fix #10554: Crash when scrolling in the autoreplace window with collapsed variants (#10555)
+Fix: Network server highlight invisible with RTL languages. (#10551)
+Fix: Client name was not being used as company manager name (#10535)
+Fix: Prevent road vehicles on crossing from crashing into the side of a train (#10496)
+Fix #10477: [macOS] Calculation for window sizes when using custom fonts was being rounded incorrectly (#10489)
+Fix #10486: Crash in debug window when GS started before AIs (#10487)
+Fix #10469: [Script] Negative numbers in League Table window were sorted incorrectly (#10471)
+Fix #10465: Crash on timeout if user never enters a password for server (#10466)
+Fix #10280, #10461: Crash on opening town windows as a spectator (#10462)
+Fix #10059: Script config values stored in the config file could cause crashes (#10444)
+
+
+13.0 (2023-02-05)
+------------------------------------------------------------------------
+Change #10077: Make maximum loan a positive multiple of the loan interval (#10355)
+Fix #10361: [Script] Don't try to give saved data to a dead script (#10433)
+Fix #10419: Water infrastructure accounting when building ship depots and docks (#10432)
+
+
+13.0-RC2 (2023-01-28)
+------------------------------------------------------------------------
+Feature: Press Ctrl to build a diagonal area of trees (#10342)
+Feature: Set a custom number of industries in map generation window (#10340)
+Change: Display font status as aa/noaa instead of true/false (#10352)
+Fix: [Script] Improved API documentation for scripts (#10413, #10412)
+Fix #10255: Reduce basic thickness of linkgraph GUI lines (#10410)
+Fix #10220: Don't select unselectable engine as default (#10404)
+Fix #10395: When loading old saves, don't forcibly bar level crossings (#10400)
+Fix #10377: Bad sorting of rail vehicles when primary variant is missing (#10378)
+Fix #10368: Server restarting game caused clients to hit assertion (#10369)
+Fix #10362: NewGRF bridges without speed limits (#10365)
+Fix #10363: CargoDist setting helptext shouldn't suggest symmetric distribution for diamonds in subtropic (#10364)
+Fix: [Script] Switch to OWNER_TOWN prevented OWNER_DEITY test during industry prospecting (#10360)
+Fix #10009: Bad overflow protection when taking out loans (#10359)
+Fix #9865: Removing files with the console always failed (#10357)
+Fix #10057: FallbackParagraphLayout fails to properly wrap (#10356)
+Fix #10177: Company list password padlock showed after switching to single player (#10354)
+Fix: Various Wide River issues (#10348)
+Fix: Link variants to parents when finalising engines (#10346)
+Fix #10333: Only show industry prospecting errors to local company (#10338)
+Fix #10335: Set initial scrollbar count for object GUI (#10336)
+Fix #10331: Starting new company during load must happen after AI start (#10332)
+Fix #10309: [SDL] Uninitialized width and height when turning off full screen (#10328)
+Fix #10032: Capacities of articulated vehicles in build window (#10326)
+Fix: Improve handling of corrupt NewGRF or image files (#10321, #10316)
+Fix: [NewGRF] Don't assume engclass 2 should be elrail (#10315)
+Fix: [Script] AIGroup.GetProfitLastYear could get values different than those displayed in GUI (#10227)
+Fix #10304: [Scripts] Don't start GS in intro game (#10305)
+Fix: [Script] Copy compat files for version 13 (#10303)
+
+
+13.0-RC1 (2023-01-01)
+------------------------------------------------------------------------
+Feature: 'font' console command to configure fonts within game (#10278)
+Feature: Ctrl-click to bulk edit timetable speeds/waiting times (#10265)
+Feature: [NewGRF] Vehicle variants in expandable purchase list (#10220)
+Feature: Expand all towns in the scenario editor (#10215)
+Add: [NewGRF] Slope-aware and roadtype-specific one-way sprites (#10282)
+Change: Display text files in black (#10291)
+Change: Make vehicle list dropdown buttons resize to fit strings (#10286)
+Change: [NewGRF] Support flipping shorter engines without explicit support (#10262)
+Change: Separate ground sprite from foundation sprite offsets (#10256)
+Change: Vertically centre sprite font relative to TrueType font (#10254)
+Change: [macOS] Set minimum macOS version to 10.13 (#10253)
+Change: Use lowered not disabled widget for current vehicle details tab (#10252)
+Change: Various improvements to NewGRF sprite aligner (#10249)
+Change: reset_engines console command now rerandomises introduction dates and reliability (#10220)
+Change: Show error message on failed industry prospecting (#10202)
+Fix: Local authority window rating list height ignored icon sizes (#10285)
+Fix #10150: Town signs could be truncated when using custom fonts (#10283)
+Fix #8971: Resize QueryStrings with interface scale change (#10281)
+Fix #10274: Crash when rescanning scripts with GS selected (#10276)
+Fix #10151: Use smaller padding for signs (#10272)
+Fix #10263: [Script] Restore tile validation for commands (#10269)
+Fix: Missing scrollbar for rail/roadtype dropdowns (#10264)
+Fix #10260: Incorrect rect height drawing image in vehicle details (#10261)
+Fix #10257: Incorrect catenary position on sloped bridge heads (#10258)
+Fix: Vertically centre chat prompt (#10250)
+Fix #10214: League and graph buttons in toolbar did not have a default action (#10246)
+Fix #10242: Allow a space for text shadow when clipping text (#10243)
+Fix #10206: Fully disable scripts in intro game (#10241)
+Fix #10218: Don't try to create river tiles along incorrect slopes (#10235)
+Fix #10208: [NewGRF] Allow using a specific underlay for road/tram tunnels (#10233)
+Fix #10224: Don't change fast-forward mode while saving (#10230)
+Fix #10147: Sound effect volume slider no longer set volume (#10228)
+Fix #10223: Crash when vehicle cloning fails on order cloning (#10225)
+Fix: Maximum space for engine preview image was never scaled (#10219)
+Fix #10216: Crash when upgrading savegame with crashed vehicles (#10217)
+Fix #10212: [Script] Nested ScriptAccounting scopes not restored properly (#10213)
+Fix #10114: Incorrect drag-highlight position with non-power-of-2 scaling (#10211)
+Fix #10198: Rearrange Intro GUI to make button rows narrower (#10203)
+Fix: Missing extra padding when drawing tooltip text (#10201)
+Fix: Bad alignment of button icons when using the original baseset (#10200)
+Fix: Signal icons incorrectly positioned in UI (#10199)
+Fix #10021: Object GUI resized when switching between different objects (#10196)
+Fix #9720: Delay start of GS/AI to after loading of savegame (#9745)
+
+
+13.0-beta2 (2022-11-27)
+------------------------------------------------------------------------
+Feature: Allow AI/GS to be fully modified in scenario editor (#10152)
+Feature: Display power-to-weight ratio in ground vehicle details GUI (#10123)
+Feature: Variable interface scaling (with chunky bevels!) (#10114)
+Feature: Hotkey to honk a vehicle's horn (#10110)
+Feature: Split AI/Game Script configuration windows and add them to world gen window (#10058)
+Feature: [GS] Scriptable league tables (#10001)
+Feature: Multi-track level crossings (#9931)
+Feature: Improved local authority action window (#9928)
+Feature: Automatic console command screenshot numbering with a filename ending in '#' (#9781)
+Feature: Add buttons to toggle music in the Game Options menu (#9727)
+Feature: Contextual actions for vehicles grouped by shared orders (#8425)
+Feature: Add cargo filter support to vehicle list (#8308)
+Feature: Show the cargoes the vehicles can carry in the vehicle list window (#8304)
+Change: Allow building canal by area outside editor (#10173)
+Change: Minor improvements to the new Finance GUI (#10168)
+Change: Let AI developers edit non-editable AI/Game Script Parameters (#8895)
+Change: Allow building docks on clearable watered object tiles (#8514)
+Fix #8770: Center vehicle status bar icon (#10178)
+Fix: Crash if error message window is too wide for screen. (#10172)
+Fix #10155: Network games not syncing company settings properly (#10158)
+Fix #10154: Network game desync related to setting a random company face (#10157)
+Fix #10011: Incorrect infrastructure totals when overbuilding bay road stop (#10143)
+Fix #10117: Object burst limit allowed one fewer object than the setting (#10120)
+Fix #10023: Allow negative input in text fields when needed (#10112)
+Fix #9908: Fix crash which could occur when a company was deleted when a depot window was open (#9912)
+
+
+13.0-beta1 (2022-10-31)
+------------------------------------------------------------------------
+Feature: Airport construction GUI displays infrastructure cost (#10094)
+Feature: Purchase land multiple tiles at a time (#10027)
+Feature: Add sticky pin & shade widgets to Object Selection UI panel (#10019, #10020)
+Feature: Improved handling of HiDPI and mixed-DPI screens (#9994, #9996, #9997, #10064)
+Feature: Alternative linkgraph colour schemes (#9866)
+Feature: Allow Shift+Insert as paste in edit box (#9836)
+Feature: Setting to make the local town authority rubber-stamp all actions (#9833)
+Feature: Add/extend console commands to enable screenshot automation (#9771)
+Feature: [Linkgraph] Show a tooltip with statistics when hovering a link (#9760)
+Feature: Build objects by area (#9709)
+Feature: Add setting to hide news about competitors vehicle crash (#9653)
+Feature: Ctrl-click to remove fully autoreplaced vehicles from list (#9639)
+Feature: Wide rivers on map generation (#9628)
+Add: [Script] ScriptCargo::GetWeight to get cargo weights (#9930)
+Add: Command line option to skip NewGRF scanning (#9879)
+Add: Show video driver name in Game Options window (#9872)
+Add: [NewGRF] Map seed as global variable (#9834)
+Add: [Script] IndustryType::ResolveNewGRFID to resolve industry id from grf_local_id and grfid (#9798)
+Add: [Script] ObjectType::ResolveNewGRFID to resolve object id from grfid and grf_local_id (#9795)
+Update: To all the friends we have lost and those we have gained (#10000)
+Change: Use the Simulation subcategory to openttd.desktop (#10015)
+Change: Constantly update destination of 'any depot' orders (#9959)
+Change: Use an indent, not a dash, to list train capacity (#9887)
+Change: [NewGRF] Increase vehicle sprite stack from 4 layers to 8 (#9863)
+Change: Don't pay Property Maintenance on stations when Infrastructure Maintenance is disabled (#9828)
+Change: Improved layout of the finance window (#9827)
+Change: [Admin] Bump admin port protocol due to command changes (#9754)
+Change: Suppress vehicle age warnings for stopped vehicles (#9718)
+Change: Make pf.yapf.rail_firstred_twoway_eol on by default (#9544)
+Change: Deliver cargo to the closest industry first (#9536)
+Fix: Lots of fixes to how windows handle resizing (#10040, #10042, #10046, #10051, #10056, #10068, #10070, #10098)
+Fix: Console commands list_ai output was truncated with a suitably large number of AIs (#10075)
+Fix #9876: MacBook Touch Bar crash / render issues w/ 32bpp graphics (#10060)
+Fix: Reduce framerate overhead in Train::Tick (#10055)
+Fix: Only open scenario editor date query once (#10050)
+Fix #10048: Don't relocate company HQ on the same exact location (#10049)
+Fix #10038: Missing upper bounds check when loading custom playlists (#10039)
+Fix: Wrong string used to determine size of zoomed out station sign (#10036)
+Fix: Disable "turn around" button for other companies' road vehicles (#10033)
+Fix: Online Players list mouse hover behaviour (#10031)
+Fix: [NewGRF] Weirdness of new stations (#10017)
+Fix #9854: DrawStringMultiLine() could draw beyond its bounding box (#10014)
+Fix: Incorrect player name in online players window (#10013)
+Fix #8099: News window zoom level fixes (#10005)
+Fix: [NewGRF] Upper 16 random bits should be the same for all station tiles in callback 140 (#9992)
+Fix #9989: £0 Net Profit is neither negative nor positive (#9991)
+Fix #9804: Only apply sprite_zoom_min setting when sprites available (#9988)
+Fix #9972: Add missing fill/resize flags on Framerate window widgets (#9982)
+Fix #9935: Use more selectivity when building SSE specific code (#9980)
+Fix #9940: Print debuglevel parse errors to console when changed from console (#9979)
+Fix #9977: Clearing the console with a large number of lines could cause a crash (#9978)
+Fix #9974: Console command getsysdate did not work due to off-by-one error (#9975)
+Fix: [NewGRF] Default value of RailVehicleInfo::railveh_type was inconsistent with other default properties (#9967)
+Fix #8584: Vehicles with shared orders getting invalid or unexpected start dates (#9955)
+Fix #9951: [NewGRF] Scenario editor random industries button broke NewGRF persistent storage (#9952)
+Fix: Validation of various internal command parameters that could have allowed a rogue client to crash servers (#9942, #9943, #9944, #9945, #9946, #9947, #9948, #9950)
+Fix #9937: Station industries_near incorrect after removing part moved sign (#9938)
+Fix: [Script] ScriptRoad::HasRoadType really check for RoadType (#9934)
+Fix #9363: Rebuild client list on reinit event (#9929)
+Fix #9925: Industry tile layout validation for layouts of only one tile (#9926)
+Fix #9918: Reset industy last production year on scenario start (#9920)
+Fix #9914: Prevent more useless pathfinder run for blocked vehicles (#9917)
+Fix: List a max of four share owners instead of three (#9905)
+Fix: [NewGRF] Industry layouts with zero regular tiles should be invalid (#9902)
+Fix #9869: Remove docking tile when doing a clear square (#9898)
+Fix: New player companies use favorite manager face, if saved (#9895)
+Fix: Towns don't build parallel, redundant bridges (#9891)
+Fix #9712: Cap town bridge length at original 11-tile limit (#9890)
+Fix #9883: Show cost/income float over end tile of rail or road construction (#9889)
+Fix #9870: Don't update infrastructure totals when overbuilding object on canal (#9888)
+Fix #9877: GS could trigger 'Cost: £0' cost message (#9878)
+Fix 44f2ef1: [strgen] Allow gender for {CARGO_SHORT} (#9873)
+Fix #9867: Industry::stations_near not filled at industry creation (#9868)
+Fix #9853: Incorrect merge of guiflags and flags for osk_activation (#9855)
+Fix #6544: Don't join AI company when loading network game in singleplayer (#9794)
+Fix: Company values do not properly account for shares (#9770)
+Fix #9546: Crash when no industries are present in game (#9726)
+Fix #9708: [Linkgraph] Don't assume vehicles have a non-zero max speed (#9693)
+Fix #9665: [Linkgraph] Fix travel times of non-direct journeys (#9693)
+Fix #8797: Use logical rail length when placing signals (#9652)
+Cleanup: [NewGRF] Remove unused flag sprites (#10052)
+
+
+12.2 (2022-04-02)
+------------------------------------------------------------------------
+Feature: Remember the last-used signal between games (#9792)
+Change: [MacOS] Allow touchbar usage on all supported OS versions (#9776)
+Change: Add a timestamp in name of crash files (#9761)
+Fix #9736: Duplicate multiplayer window opens upon canceling password entry (#9842)
+Fix: Removing long roads doesn't prioritise refusal of local authority over other errors (#9831)
+Fix #9020: Glitchy station coverage highlight when changing selection (#9825)
+Fix: Correct some Romanian town names (#9819)
+Fix: Original music playback rate was slightly too fast (#9814)
+Fix #9811: Use the NewGRF-defined vehicle center when dragging ships and aircraft (#9812)
+Fix: Do not let shares in the company taking over another company disappear (#9808)
+Fix #9802: Crash when using lots of NewGRF waypoint types (#9803)
+Fix #9766: Don't write uninitialised data in config file (#9767)
+Fix #9743: [MacOS] Don't try to render touchbar sprites with invalid zoom level (#9776)
+Fix #9774: Building roadstop in estimation mode updates station acceptance (#9775)
+Fix: If vehicles only refit to cargo-slots >= 32, the default cargo was wrong (#9744)
+Fix #9735: Possible desync when replacing a depot on same tile (#9738)
+Fix #9730: [Network] Connections can use an invalid socket due to a race condition (#9731)
+Fix: Don't show sign edit window for GS-owned signs (#9716)
+Fix #9702: Display order window for vehicle group on ctrl-click only when using shared orders (#9704)
+Fix #9680: Crash when loading really old savegames with aircraft in certain places (#9699)
+Fix: Update last servicing dates when using the date cheat (#9694)
+Fix: Error message shows about missing glyphs while suitable fallback font is found (#9692)
+
+
+12.1 (2021-11-08)
+------------------------------------------------------------------------
+Feature: Button to toggle showing advanced signal types (#9617)
+Change: Don't show screenshot GUI in screenshots (#9674)
+Change: Suppress panning in intro game, while user is interacting with the GUI (#9645)
+Change: Draw rotor in cursor when dragging helicopters in depots (#9612)
+Fix: Invalid memory access when loading a currency NewGRF (#9675)
+Fix #9579: Object and HQ construction is Construction cost, not Property Maintenance (#9673)
+Fix #9669: Ships exiting a blocked depot/lock could exit in the wrong direction (#9672)
+Fix: Every 16th client never reconnects after server restart (#9666)
+Fix #9643: Screenshots were always written as BMP files (#9644)
+Fix #9630: Intro game could zoom in/out more than allowed by settings (#9633)
+Fix #9626: Incorrect loading of script saved data (#9629)
+Fix: Emergency crash save had the wrong NewGRF list saved in it (#9627)
+Fix #9595: Always use plural forms of cargo for subsidy strings (#9619)
+Fix #9614: Refresh rate dropdown was still active when vsync was enabled (#9618)
+Fix: Don't use 'server address' string in server list when displaying an invite code (#9615)
+
+
+12.0 (2021-10-17)
+------------------------------------------------------------------------
+Add: [Network] Keep the refresh button in lowered state while refreshing (#9600)
+Add: Console command to list search directories for various things (#9583)
+Fix: Try all possible reverse directions when a ship reaches a dead end (#9610)
+Fix: Incorrect Romanian own name (#9598)
+Fix #9591: Update station docking tiles upon placing a water object on a docking tile (#9594)
+Fix #9548: [Squirrel] Crash during engine cleanup after reaching memory limit on realloc (#9592)
+Fix #9588: [Squirrel] Reaching memory limit during script registration could prevent further script detections (#9589)
+Fix: Make ships more likely to find their destination at the cost of slightly worse paths (#9576)
+Change: Reverse ship when leaving docks if a better path exists (#9610)
+Change: Allow all tiles around docks to be docking tiles (#9578)
+
+
+12.0-RC1 (2021-09-25)
+------------------------------------------------------------------------
+Feature: Display icon/text whether vehicle is lost in vehicle (list) window (#9543)
+Feature: [MacOS] Add selected toolbar buttons to MacBook Pro Touch Bar (#9511)
+Feature: Button to open order window from vehicle shared orders window (#9325)
+Feature: Ctrl-Clicking shared order vehicle list opens order window (#9325)
+Feature: Multiple rotating views on title screen (#8980)
+Feature: Hide block signals in GUI by default (#8688)
+Add: [Script] Allow GameScripts to build neutral objects (#9568)
+Add: [Network] Allow sending chat messages via admin port (#9563)
+Add: [AI/GS] Missing water related functions and objects (#8390)
+Fix: Industry funding window did not update when changing funding method (#9572)
+Fix #9562: [NewGRF] Handle case of invalid Action2 with zero results (#9564)
+Fix: Incorrect error messages when placing water in scenario editor (#9560)
+Fix #9484: Update locale currencies settings config map (#9559)
+Fix: Prevent train reversing when entirely inside a train depot (#9557)
+Fix: [Network] Add back 'Spectate' option to company toolbar menu (#9556)
+Fix #9463: [Win32] Work around XAudio2 crashes (#9549)
+Fix #8603: Don't give focus to text filter when opening Object GUI (#9547)
+Fix #9241: Grove and forest tree brushes did not also create rainforest terrain (#9542)
+Fix: [Network] Several crashes in our network code (#9534, #9456)
+Fix #9527: Crash when trying to place multi-tile objects at map edge (#9529)
+Fix: [Network] SendCmdNames only sent one name per packet (#9528)
+Fix #9407: Desync when founding a town nearby a station (#9526)
+Fix #9521: Don't load at just removed docks that were part of a multi-dock station (#9524)
+Fix: Ships always tried to avoid docking tiles when pathfinding (even if nothing was on them) (#9522)
+Fix: [Network] Convert server_advertise to server_game_type in config file (#9515)
+Fix #9490: [Network] A full server couldn't be queried (#9508)
+Fix: [Network] Don't show GameScript " (v0)" for old servers (#9507)
+Fix: [Network] Show query errors in the server listing instead of error popup (#9506)
+Fix: [Network] Crash when last-joined server was no longer available (#9503)
+Fix #9501: [Network] Crash when more than one game-info query was pending (#9502)
+Fix: Wrong error message when building canals over ship depots / locks (#9410)
+Fix: Reduce cost of building canals over objects on sea (#9410)
+Change: [Linkgraph] Delete links only served by vehicles stopped in depot (#9499)
+
+
+12.0-beta2 (2021-08-19)
+------------------------------------------------------------------------
+Feature: [Linkgraph] Prioritize faster routes for passengers, mail and express cargo (#9457)
+Fix: Wrong town window refreshed when building an airport with noise levels enabled (#9497)
+Fix: Improve wording of network-related messages (#9494, #9495, #9500)
+Fix: [Network] Report reuse of invite-code (#9487)
+Fix: [Network] Connecting with the same client name thrice hangs the server (#9485)
+
+
+12.0-beta1 (2021-08-15)
+------------------------------------------------------------------------
+Feature: [Network] Remove lobby window; pressing "Join Game" now immediately joins a server (#9467)
+Feature: [Network] Synchronize server name to clients and display in Online Players window (#9472)
+Feature: [Network] Mention you are a spectator in the status bar (#9471)
+Feature: [Network] No longer require port-forwarding to host a server (#9443, #9447)
+Feature: [Network] Allow setting your server visibility to "invite-only" (#9434)
+Feature: [Network] Join servers based on their invite code (#9432)
+Feature: Raise the maximum NewGRF limit to 255 (#9428)
+Feature: Persistent rotation of numbered auto/netsave after restart (#9395, #9397)
+Feature: [NewGRF] Maximum curve speed modifier for rail vehicles (#9346)
+Feature: Move sensitive information to secrets.cfg and private information to private.cfg (#9298)
+Feature: Signed Windows builds (#9294)
+Feature: [NewGRF] Define refittability of default vehicles using cargo classes (#9148)
+Feature: Configurable subsidy duration, up to 5000 years (#9081)
+Feature: [Network] Rework in-game Online Players window (#9067)
+Feature: [Network] Show previous chat history when the chat message box is open (#9025)
+Feature: Button to reset game settings to their default values (#8958)
+Feature: Press Ctrl to build diagonal rivers in Scenario Editor (#8880)
+Feature: Set wagon replacement per group when using autoreplace (#7441)
+Add: [Network] Open Online Players window on starting/joining a server (#9479)
+Add: [Script] Basic information about loaded NewGRFs for scripts (#9464)
+Add: [AI] Get the number of vehicles in a given group (#9462)
+Add: [Network] Inform network clients what game-script a server is running (#9441)
+Add: Hindi translation (#9086)
+Add: [Network] Ensure players fill in a name instead of defaulting to "Player" (#9080)
+Change: Allow pause/unpause console command in single player (#9342)
+Change: Make savegame format self-descriptive and consistent across all objects (#9322, #9335, #9338, #9339)
+Change: By default, make "unload all" leave stations empty (#9301)
+Change: Reworked the debug levels and messages for network logs (#9230, #9251)
+Change: [Emscripten] Set default scrolling mode to non-pointer-locking (#9191)
+Change: Use neutral pronouns for various strings (#9189, #9203, #9228)
+Change: Make the town directory horizontally resizable (#9157)
+Change: Allow non-ASCII currency separators (#9121)
+Change: [NewGRF] Display a pop-up window for Errors with severity ERROR (#9119)
+Change: Treat languages as finished, if translations are 75% completed (#9019, #9086)
+Change: Disable NewGRF window apply button if no change was made (#8934)
+Fix: [Script] Crash when iterating lists of which the key is larger than 32bit (#9465)
+Fix: [Network] Desync due to use of unstable sort when distributing cargo production (#9460)
+Fix #9440: Negative cargo payments not being handled correctly (#9455)
+Fix: [Network] Crash when joining a server again after a TCP disconnect (#9453)
+Fix: Don't enable rename button for network clients in build vehicle window (#9452)
+Fix: Money could underflow and wrap around (#9451)
+Fix: Parse the console settings the same way as config settings (#9438)
+Fix: Ensure no more than the allowed number of NewGRFs are loaded from the configuration (#9430)
+Fix: [NewGRF] Overflow when determining cargo mask for string code 9A 1E (#9423)
+Fix: Integers for scripts are 64bit, but saved as 32bit (#9415)
+Fix #9392: [Script] Return a valid value with GetBuildWithRefitCapacity even when AIs are maxed out in vehicles (#9393)
+Fix #8169: Crash when autoreplacing vehicle with no orders (#9387)
+Fix: Wrong cargo line position in IndustryCargo window (#9383)
+Fix: Race-condition during startup of NewGRF scan (#9382)
+Fix: Don't propagate Shift/Ctrl state till next game-tick (#9381)
+Fix: Prevent palette updates during copying to the video driver (#9379)
+Fix: [Network] Determining GetNetworkRevisionString could overflow and underflow its buffer (#9372)
+Fix #9358: Don't skip empty files in tar archives (#9367)
+Fix: For old savegames, station bus/truck station cache was not updated (#9366)
+Fix #9353: [Script] Garbage collecting on priority queues could crash the game (#9356)
+Fix: Respect the autosave_on_exit setting for Null video driver (#9343)
+Fix: Compatible NewGRFs in crash-log reported wrong MD5 hash (#9340)
+Fix: [Script] Ensure the saved script strings are properly validated and terminated (#9336)
+Fix #9316: Town bridge length limit check incorrect above 250k inhabitants (#9318)
+Fix: Limit heightmap sizes to 8192x8192 (#9307)
+Fix #9281: Money generating exploit when buying out a company (#9300)
+Fix: Part of a tile might not be redrawn when terraforming (#9296)
+Fix: [OpenGL] Increase timeout when waiting for the GPU to be done with the drawing buffer (#9282)
+Fix: Vehicles sent in the wrong direction if there is no path to the destination (#9280)
+Fix #9264: Do not attach temporary wagons to free wagon chains when autoreplacing (#9278)
+Fix #9267: [Script] Crash during garbage collection (#9275)
+Fix: Encountering two-way red signals could prune unrelated Pathfinder branches (#9271)
+Fix #9255: [Network] Crash when hostname is not found (#9259)
+Fix #9256: Invalid read after free when replacing train chains (#9258)
+Fix: [Emscripten] Force secure WebSockets over HTTPS (#9248)
+Fix #9242: Tree tick handler did not scale by map size (#9246)
+Fix: [Network] Mark server as offline when no longer reachable (#9244)
+Fix: [Network] Don't rebuild the host-list during iterating the list (#9240)
+Fix: [Network] Don't mark the last-joined server as a manually added server (#9239)
+Fix: [Network] Clients leaving because of broken connections was not broadcasted (#9238)
+Fix: [Network] Check on CIDR for netmask check considered everything valid (#9235)
+Fix: Creating screenshots on dedicated servers failed (#9232)
+Fix: Leaking file descriptors for downloaded content (#9229)
+Fix: Spelling of several town names (#9222)
+Fix #9209: Game hangs when resizing highscore/news window if the screen is too small (#9210)
+Fix: [Network] Optimize creating network connections for clients using IPv4 and IPv6 (#9199)
+Fix #9186: Fix incorrect bounding box height causing station sprite glitch (#9187)
+Fix: Truncating strings in settings could leave invalid UTF-8 characters (#9121)
+Fix: Many issues related to window scaling (#9087, #9219)
+Fix: Invalidate cached vehicle colourmaps when changing liveries setting (#9006)
+Fix #8981: Don't attempt to re-reserve path if already entering/entered depot (#9000)
+Fix: Missing 'Town names:' colon in map gen GUI (#8986)
+Fix: Sorting and filtering industries that produce/accept many cargoes (#8468)
+Remove: [Network] COMPANY_INFO packets (#9475)
+Remove: [Network] A server can no longer set a limit to the amount of spectators allowed (#9466)
+Remove: Arbitrary limit on number of statically loaded NewGRFs (#9431)
+Remove: [Network] Language and map-name from server information (#9070)
+
+
+1.11.2 (2021-05-03)
+------------------------------------------------------------------------
+Change: [Win32] Limit hardware accelerated video driver to OpenGL 3.2 or higher (#9077)
+Change: More improvements to the GUI at different scales (#9075, #9102, #9107, #9133, #9174, #9183)
+Fix: Query windows could be partially drawn (#9184)
+Fix #9113: Crash when removing an airport that exists in an aircraft's orders (#9182)
+Fix #9117: [Fluidsynth] Hang when changing song (#9181)
+Fix: String validation could leave invalid UTF-8 encoded strings (#9096)
+Fix: [Network] Out-of-bounds memory access with modified servers sending too short password salts (#9176)
+Fix: Crash when extra viewport with zero height has sign in view (#9175)
+Fix #9147: Crash when taking screenshots (#9169)
+Fix #6598: [Network] Prevent crashes when (re)joining network game by falling back to main menu first (#9163)
+Fix #9152: Screenshot success popup window was treated as an error (#9159)
+Fix: Fast-forward stuttering when vsync is enabled (#9140)
+Fix: [Network, Win32] Network errors were handled badly (#9116)
+Fix: [Network] Savegame transfer could stall in rare cases (#9106)
+Fix #9097: [NewGRF] Cargo initial payment variable was being truncated (#9098)
+Fix: [NewGRF] Industry variable 66 and object variable 46 erroneously truncated the distance (#9088)
+Fix: [NewGRF] Industry variables 65 and 66 ignored the parameter, and always used the north tile (#9088)
+Fix: Do not include regression test AI in bundle (#9068, #9164)
+Fix #9062: [Win32] Version in executable was not set to current release version (#9066, #9154)
+
+
+1.11.1 (2021-04-18)
+------------------------------------------------------------------------
+Feature: Toggle to enable/disable vsync (#8997)
+Feature: Volume controls in the Game Options window, and better defaults (#8943)
+Add: Hotkey to focus object and rail filters (#8908)
+Add: Better plural support for Romanian (#8936)
+Change: Improve layout and spacing of several windows at different GUI scales (#9041, #9042, #9044, #9050)
+Change: [Win32] Use user UI language setting for initial language selection (#8974)
+Change: Make effect volume scale more intuitively (#8945, #8950)
+Change: Improve padding of Object & Rail station windows (#8929)
+Fix #6322: [Script] Crash when script allocates too much memory, now kills script instead (#9047)
+Fix #7513: [Script] Crash on garbage collection with misbehaving script (#9040)
+Fix #9028: [OpenGL] Crash when changing max sprite zoom level (#9032)
+Fix #8874: show a warning when a NewGRF scan is requested multiple times (#9022)
+Fix: Desync when GS unlocks railtype with wagon unlock (#9021)
+Fix #9015: [Win32] Crash on running "pwd" command in the console (#9016)
+Fix #9008: Validate starting year given on the command line (-t) (#9014)
+Fix #8878: [Network] Slow DNS queries could block the server and disconnect clients (#9013)
+Fix: Improve validation of OpenGL video driver to avoid crashes (#9007)
+Fix: Credits scrolled too slowly with larger font sizes (#8994)
+Fix #8977: Crash when altering max sprite resolution (#8993)
+Fix #8956: Industry disaster news messages showed the wrong location (#8992)
+Fix: [Win32] Font glyphs of certain widths had broken rendering (#8990)
+Fix #8930: [Win32] Duplicate text input issue for systems using IME (#8976)
+Fix: [Network] Potential stale client entries in client list (#8959)
+Fix: Graphical issues when dragging measurement tooltips (#8951)
+Fix: [Fluidsynth] Use provided default soundfont if available (#8948, #8953)
+Fix #8935: [macOS] Crash on save (#8944)
+Fix #8922: Crash when selling shared vehicles with shared vehicle window open (#8926)
+Fix: Compiling on armhf (Raspberry Pi) (#8924)
+
+
+1.11.0 (2021-04-01)
+------------------------------------------------------------------------
+Feature: Allow setting a custom terrain type to define highest peak (#8891)
+Feature: Auto-detect map height limit based on generated map (#8891)
+Feature: Setting to indicate desert coverage for tropic climate and snow coverage for arctic climate (replaces snow line height) (#8891)
+Add: Allow setting the highest mountain for heightmaps (#8891)
+Change: Scale exported heightmaps to highest peak and inform the user of this value (#8891)
+Change: Remove "maximum map height" from the New Game GUI (#8891)
+Fix #8803: Only auto-remove signals when rail can be built (#8904)
+Fix #8565: Stopped road vehicle displays a speed different than 0 (#8901)
+Fix #8886: Don't try to resolve folders within tars named '.' (#8893)
+Fix: Placing random trees in SE crashes the game (#8892)
+Fix #8875: Filter string in station window breaks flow in user interface (#8885)
+Fix #8871: [OpenGL] Initialize all buffers after resize and clear back buffer (#8877)
+Fix: OpenGL performance with some AMD GPUs (#8876)
+Fix: Recompute road/railtype availability after disabling the engine (#8872)
+Fix: OSK layout not scaled for 2x or 4x GUI scale (#8868)
+
+
+1.11.0-RC1 (2021-03-14)
+------------------------------------------------------------------------
+Feature: Option to (dis-)allow hardware accelerated video drivers (#8819)
+Feature: Option to set display refresh rate (#8813)
+Feature: Allow custom width/height of screenshot and making heightmap screenshots via console (#8804)
+Feature: Allow filtering on name in rail station window (#8706)
+Feature: Setting for highest resolution of sprites to use (#8604)
+Add: Make NewGRF Scanner / World Generation update smoother and make aborting it react faster (#8830)
+Add: Malaysia Ringgit as Currency (#8783)
+Add: "Engines only" filter in build train window (#8733)
+Change: De-limit framerate window's framerate (#8772)
+Change: Clarify what effect town interactions have (#8744)
+Change: Don't show global goals in company goal windows (#8709)
+Change: Recolour graph windows to brown (#8700)
+Fix #8855: Bootstrap could result in an empty screen when bootstrap fails (#8856)
+Fix #8851: Don't allow infinite "exec" depth in script, but limit to 10 deep (#8852)
+Fix #8647: Incorrect drawing order of tram catenary sprites (#8843)
+Fix #8711: Having gui_zoom lower than zoom_min causes a crash (#8835)
+Fix #8810: "aircraft out of fuel" news shows the wrong place (#8832)
+Fix #8833: Don't reload NewGRFs when we are shutting down (#8830)
+Fix: Scale padding between elements the same as other padding (#8829)
+Fix #8808: [OSX, OpenGL] Crash on switching blitters due to double-mapping the video buffer (#8822)
+Fix #8784: Using Alt+Enter doesn't update the fullscreen toggle visibly (#8820)
+Fix #8817: Keep NewGRF order for object class sorting (#8818)
+Fix #8809: Crash when removing airport when hangar window open (#8815)
+Fix #8799: Crash when Search Internet in Multiplayer (#8801)
+Fix #8775: [Win32] Don't create the main window when Alt-Tabbing back into fullscreen (#8792)
+Fix #8774: Black screenshots when using 40bpp-blitter (#8791)
+Fix: [OSX] Hide dock when entering fullscreen (#8789)
+Fix: Bootstrap fails to start on clean install (#8788)
+Fix: Terraform limit acts random when maxing out per_64k_frames setting (#8782)
+Fix: Max-value of fast-forward-speed-limit can be outside its storage size (#8769)
+
+
+1.11.0-beta2 (2021-02-28)
+------------------------------------------------------------------------
+Feature: Add setting to limit fast-forward speed (#8766)
+Feature: Significant performance improvements to all video drivers (#8605, #8652, #8660, #8685, #8702, #8703, #8707, #8726, #8740)
+Feature: Configurable display refresh-rate, default to 60fps (#8680)
+Feature: Automatically upload releases to Steam (#8644)
+Feature: Generic Linux builds (#8641)
+Feature: [GS] Allow non-question type windows to have no buttons (#8638)
+Feature: [macOS] ZIP build (#8614)
+Feature: Object class selection string filtering (#8603)
+Feature: 'Remove all industries' button in scenario editor (#8550)
+Feature: Automatic UI and font zoom levels when supported by the OS (#8537)
+Feature: [macOS] Render screen at native resolution by default for HiDPI screens (#8519)
+Feature: OpenGL video driver (#7744)
+Add: Indonesia Rupiah currency (#8616)
+Change: Improve graph period markings (#8732)
+Change: Make pathfinder account for maximum order speed, if set (#8722)
+Change: Darken graph grid lines for legibility (#8690)
+Change: Make order window hotkeys toggle for load & unload variants (#8669)
+Change: Use a more specific error message when attempting to bulldoze your own HQ (#8667)
+Change: Convert .md to .rtf for Windows/Mac packages (#8617)
+Change: Move the 'tree placer algorithm' & 'road drive side' settings to the Settings window (#8566)
+Change: Move town name generator selection to mapgen GUI (#8566)
+Change: [macOS] Native font rendering (#8518)
+Fix: Display of network lobby windows for different GUI sizes (#8765)
+Fix: Don't desync if client leaves before you finish downloading map (#8755)
+Fix: Allow estimating vehicle clone cost even if short on money (#8748)
+Fix: Don't notify twice that a client left because of a timeout (#8746)
+Fix: Vehicle cursor size did not account for the interface zoom level (#8739)
+Fix #8123: Trams on half-tiles couldn't find depots (#8738)
+Fix #8276: [NewGRF] Crash when an object's size was not set (#8719)
+Fix #8349: Close depot vehicle list windows when closing the depot window (#8717)
+Fix #8594: [NRT] Road pathfinder did not account for roadtype speed limits or lengths of tunnels/bridges (#8710)
+Fix: Whole status bar instead of money widget refreshed on money change (#8692)
+Fix: Unnecessary status bar redraws when there is no news to show (#8691)
+Fix: New orders are non-stop by default (#8689)
+Fix: Framerate window showed a slightly higher rate than actually measured (#8682)
+Fix: Autorenew failure advice due to bad refit being shown to all companies (#8681)
+Fix #8625: Wrong ending year was displayed in highscore table (#8672)
+Fix #8620: Scale spacing between date & news in history window according to font scaling (#8671)
+Fix: [Win32] Set minimum resolution for timers to 1ms (#8660)
+Fix: Mention our websites with https:// (instead of http://) (#8657)
+Fix: [Emscripten] Open links in browser (#8655)
+Fix: Don't crash when towns upgrade road tiles during expansion (#8651)
+Fix #8029: [SDL2] Blank display when under Wayland (#8648)
+Fix: Default Network Server List sorter put compatible servers in wrong order (#8626)
+Fix: Use non-pulsating red highlight for coverage (#8622)
+Fix: Center text and image in vehicle statusbar vertically (#8602)
+Fix: Don't walk out of the map when trying to build tunnels (#8600)
+Fix: Off-by-one error in desert/rainforest positioning at world gen (#8588)
+Fix #8037: Crash when restarting AI that is controlling the same company as the player (#8587)
+Fix: Stopped ships shouldn't block depots (#8578)
+
+
 1.11.0-beta1 (2021-01-22)
 ------------------------------------------------------------------------
 Feature: [GS] Ability to set some extra text in the industry window (#8576)
@@ -2132,7 +2756,7 @@ Note: OpenTTD was migrated to GitHub for 1.9, so SVN revision and FlySpray numbe
 - Fix: [NewGRF] Additional text in fund industry window is NewGRF supplied and thus should have a default colour (r22631)
 - Fix: Also initialise _old_vds with newgame settings; TTD savegames do not contain these settings [FS#4622] (r22626)
 - Fix: Do not zero the orders of disaster vehicles when converting savegames [FS#4642] (r22625)
-- Fix: When closing an AI company the local player cheated to, we need to cheat him to another company [FS#4654] (r22624, r22623)
+- Fix: When closing an AI company the local player cheated to, we need to cheat them to another company [FS#4654] (r22624, r22623)
 - Fix: When closing down companies their shares in other companies must be sold even if share trading is disabled at that point of time (r22622)
 - Fix: When asking the user to confirm an unsafe unpausing, there is no need to execute a command if 'no' is chosen. This also prevents crashing when clicking unpause while the confirm window is shown (r22621)
 - Fix: Enforce refit orders to be 'always go to depot' orders; service-only and stop-in-depot orders make no sense with refitting [FS#4651] (r22620)
@@ -2854,7 +3478,7 @@ Note: OpenTTD was migrated to GitHub for 1.9, so SVN revision and FlySpray numbe
 - Fix: Chat message caused glitch when rejoining a network game [FS#3757] (r19629)
 - Fix: Desync when a command is received and in the queue while a client starts joining, i.e. save the game state. This can happen in two ways: with frame_freq > 1 a command received in a previous frame might not be executed yet or when a command is received in the same frame as the join but before the savegame is made. In both cases the joining client would not get all commands to get in-sync with the server (and the other clients) (r19620)
 - Fix: Company related graphs were not updated correctly after changing the company colour [FS#3763] (r19615)
-- Fix: Possible invalid read when server moves client to spectators before he finishes joining [FS#3755] (r19613)
+- Fix: Possible invalid read when server moves client to spectators before they finish joining [FS#3755] (r19613)
 - Fix: Crash when opening a savegame with a waypoint from around 0.4.0 [FS#3756] (r19612)
 - Fix: Improve joining behaviour; kicking clients when entering passwords that was just cleared, 'connection lost' for people failing the password, access restriction circumvention [CVE-2010-0401] [FS#3754] (r19610, r19609, r19608, r19607, r19606)
 - Fix: Desync debugging; false positives in the cache validity checks and saving/loading the command stream (r19619, r19617, r19602, r19601, r19600, r19596, r19593, r19592, r19589, r19587, r19586)
@@ -3209,7 +3833,7 @@ Note: OpenTTD was migrated to GitHub for 1.9, so SVN revision and FlySpray numbe
 - Fix: Do not account for path reservation costs when entering a signal block via a 'block' signal. This way you will not get double penalties, both red signals and reservation costs, for the block signalled tracks [FS#2722] (r18535)
 - Fix: [NewGRF] An industry NewGRF that defined a too small size for action0 prop 0A could cause a crash (r18527)
 - Fix: Allegro does not like to work with extmidi, so warn the user about that [FS#3272] (r18520)
-- Fix: When you pass a signal at danger, in a PBS controlled area, do not try to do the 'safe' thing and stop, but continue going; the user wanted the train to pass the signal at danger so (s)he has to suffer the consequences. Of course one can always stop the train manually [FS#2891] (r18515)
+- Fix: When you pass a signal at danger, in a PBS controlled area, do not try to do the 'safe' thing and stop, but continue going; the user wanted the train to pass the signal at danger so they have to suffer the consequences. Of course one can always stop the train manually [FS#2891] (r18515)
 - Fix: No error message was created for the first fatal NewGRF error [FS#3368] (r18506)
 - Fix: Improve airport movement on several airports [FS#3169] (r18505)
 - Fix: Autoreplace and autorenew always reset their cargo sub type to 0. Now find a sub cargo type with the exact same name and use that, otherwise fallback to 0. So cargo sub types can be maintained via autoreplace *if* the new vehicle supports the same cargo sub type [FS#3159] (r18499)
@@ -3692,7 +4316,7 @@ Note: OpenTTD was migrated to GitHub for 1.9, so SVN revision and FlySpray numbe
 - Fix: Make the join/spectate command require to be connected to a network game; in SP it could lead to crashes (r15514)
 - Fix: Generating a map with the original map generator with freeform edges on resulted in a crash [FS#2641] (r15511)
 - Fix: Pre-0.5 OpenTTD stored new_nonstop and full_load_any in a different way, savegame conversion was not working for them (r15500)
-- Fix: Crash when opening the game options when the currently loaded base graphics pack has less than 2 valid graphics files. For example when someone replaces all his/her original base graphics with custom work (but keeps the name) or renames the dos ones to windows or vice versa [FS#2630] (r15476)
+- Fix: Crash when opening the game options when the currently loaded base graphics pack has less than 2 valid graphics files. For example when someone replaces all their original base graphics with custom work (but keeps the name) or renames the dos ones to windows or vice versa [FS#2630] (r15476)
 
 
 0.7.0-beta1 (2009-02-16)
@@ -4454,7 +5078,7 @@ Note: OpenTTD was migrated to GitHub for 1.9, so SVN revision and FlySpray numbe
 - Fix: Switching players (using the cheat) crashed on Big Endian machines [FS#1150] (r11023)
 - Fix: The canal border determination did not take oil rigs into consideration (r11022)
 - Fix: Do not display income/expenses when they do not belong to a 'valid' tile, like the money cheat/giving money [FS#1175] (r11021)
-- Fix: One could not give money when (s)he had too much money or rather: when casting the amount of money to an int32 becomes negative [FS#1174] (r11020)
+- Fix: One could not give money when they had too much money or rather: when casting the amount of money to an int32 becomes negative [FS#1174] (r11020)
 - Fix: When determining the gender of a string, do not assume that the gender is in the front of the string when there can be case switching code at that location [FS#1104] (r10792)
 - Fix: Determining whether there is a tunnel going under the lowered area is only needed in two directions instead of all four, so take the directions (one for each axis) to the nearest border (along the given axis) [FS#1058] (r10686)
 - Fix: Graphical glitches when the 'link landscape toolbar' patch is turned on when opening one of the construction toolbars [FS#1076] (r10685)
@@ -4515,7 +5139,7 @@ Note: OpenTTD was migrated to GitHub for 1.9, so SVN revision and FlySpray numbe
 - Fix: Do not unconditionally assume that a tile has a depot (r11027)
 - Fix: Give a more correct error when building some things on tile 0 [FS#1173] (r11024)
 - Fix: Do not display income/expenses when they do not belong to a 'valid' tile, like the money cheat and giving money [FS#1175] (r11021)
-- Fix: One could not give money when (s)he had too much money [FS#1174] (r11020)
+- Fix: One could not give money when they had too much money [FS#1174] (r11020)
 - Fix: Disallow buying/selling shares in your own company or a bankrupt company [FS#1169] (r11018)
 - Fix: Crash when quitting the game in one of the end score windows [FS#1218] (r11071)
 
@@ -5475,7 +6099,7 @@ Note: OpenTTD was migrated to GitHub for 1.9, so SVN revision and FlySpray numbe
 - Fix: Vehicles slow down under bridge if the track is on a foundation
 - Fix: You can no longer change name of waypoints whom are owned by somebody else
 - Fix: Shares are now also sold when a company goes bankrupt [SF#1090313]
-- Fix: It is no longer possible to crash trains of other companies by building a depot close to a station; trains do no longer enter tiles that do not belong to his owner [SF#1087701]
+- Fix: It is no longer possible to crash trains of other companies by building a depot close to a station; trains do no longer enter tiles that do not belong to their owner [SF#1087701]
 - Fix: Crashed trains are not reported to have too few orders any more [SF#1087403]
 - Fix: Backup-order-list was not closed with an OT_NOTHING, [SF#1086375]
 - Fix: Docks now have a button to display the catchment area [SF#1085255]

cmake/CheckAtomic.cmake

@@ -0,0 +1,87 @@
+# atomic builtins are required for threading support.
+
+INCLUDE(CheckCXXSourceCompiles)
+INCLUDE(CheckLibraryExists)
+
+# Sometimes linking against libatomic is required for atomic ops, if
+# the platform doesn't support lock-free atomics.
+
+function(check_working_cxx_atomics varname)
+  set(OLD_CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS})
+  set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS} -std=c++17")
+  check_cxx_source_compiles("
+#include <atomic>
+std::atomic<int> x;
+std::atomic<short> y;
+std::atomic<char> z;
+int main() {
+  ++z;
+  ++y;
+  return ++x;
+}
+" ${varname})
+  set(CMAKE_REQUIRED_FLAGS ${OLD_CMAKE_REQUIRED_FLAGS})
+endfunction(check_working_cxx_atomics)
+
+function(check_working_cxx_atomics64 varname)
+  set(OLD_CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS})
+  set(CMAKE_REQUIRED_FLAGS "-std=c++17 ${CMAKE_REQUIRED_FLAGS}")
+  check_cxx_source_compiles("
+#include <atomic>
+#include <cstdint>
+std::atomic<uint64_t> x (0);
+int main() {
+  uint64_t i = x.load(std::memory_order_relaxed);
+  (void)i;
+  return 0;
+}
+" ${varname})
+  set(CMAKE_REQUIRED_FLAGS ${OLD_CMAKE_REQUIRED_FLAGS})
+endfunction(check_working_cxx_atomics64)
+
+
+# Check for (non-64-bit) atomic operations.
+if(MSVC)
+  set(HAVE_CXX_ATOMICS_WITHOUT_LIB True)
+else()
+  # First check if atomics work without the library.
+  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(atomic __atomic_fetch_add_4 "" HAVE_LIBATOMIC)
+    if(HAVE_LIBATOMIC)
+      list(APPEND CMAKE_REQUIRED_LIBRARIES "atomic")
+      check_working_cxx_atomics(HAVE_CXX_ATOMICS_WITH_LIB)
+      if (NOT HAVE_CXX_ATOMICS_WITH_LIB)
+        message(FATAL_ERROR "Host compiler must support std::atomic!")
+      endif()
+    else()
+      message(FATAL_ERROR "Host compiler appears to require libatomic, but cannot find it.")
+    endif()
+  endif()
+endif()
+
+# Check for 64 bit atomic operations.
+if(MSVC)
+  set(HAVE_CXX_ATOMICS64_WITHOUT_LIB True)
+else()
+  # First check if atomics work without the library.
+  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(atomic __atomic_load_8 "" HAVE_CXX_LIBATOMICS64)
+    if(HAVE_CXX_LIBATOMICS64)
+      list(APPEND CMAKE_REQUIRED_LIBRARIES "atomic")
+      check_working_cxx_atomics64(HAVE_CXX_ATOMICS64_WITH_LIB)
+      if (NOT HAVE_CXX_ATOMICS64_WITH_LIB)
+        message(FATAL_ERROR "Host compiler must support 64-bit std::atomic!")
+      endif()
+    else()
+      message(FATAL_ERROR "Host compiler appears to require libatomic for 64-bit operations, but cannot find it.")
+    endif()
+  endif()
+endif()
+
+if(HAVE_CXX_ATOMICS_WITH_LIB OR HAVE_CXX_ATOMICS64_WITH_LIB)
+  target_link_libraries(openttd atomic)
+endif()

cmake/CompileFlags.cmake

@@ -4,32 +4,33 @@
 #
 macro(compile_flags)
     if(MSVC)
-        # Switch to MT (static) instead of MD (dynamic) binary
+        if(VCPKG_TARGET_TRIPLET MATCHES "-static" AND NOT VCPKG_TARGET_TRIPLET MATCHES "-md")
+            # Switch to MT (static) instead of MD (dynamic) binary
 
-        # For MSVC two generators are available
-        # - a command line generator (Ninja) using CMAKE_BUILD_TYPE to specify the
-        #   configuration of the build tree
-        # - an IDE generator (Visual Studio) using CMAKE_CONFIGURATION_TYPES to
-        #   specify all configurations that will be available in the generated solution
-        list(APPEND MSVC_CONFIGS "${CMAKE_BUILD_TYPE}" "${CMAKE_CONFIGURATION_TYPES}")
+            # For MSVC two generators are available
+            # - a command line generator (Ninja) using CMAKE_BUILD_TYPE to specify the
+            #   configuration of the build tree
+            # - an IDE generator (Visual Studio) using CMAKE_CONFIGURATION_TYPES to
+            #   specify all configurations that will be available in the generated solution
+            list(APPEND MSVC_CONFIGS "${CMAKE_BUILD_TYPE}" "${CMAKE_CONFIGURATION_TYPES}")
 
-        # Set usage of static runtime for all configurations
-        foreach(MSVC_CONFIG ${MSVC_CONFIGS})
-            string(TOUPPER "CMAKE_CXX_FLAGS_${MSVC_CONFIG}" MSVC_FLAGS)
-            string(REPLACE "/MD" "/MT" ${MSVC_FLAGS} "${${MSVC_FLAGS}}")
-        endforeach()
+            # Set usage of static runtime for all configurations
+            foreach(MSVC_CONFIG ${MSVC_CONFIGS})
+                string(TOUPPER "CMAKE_CXX_FLAGS_${MSVC_CONFIG}" MSVC_FLAGS)
+                string(REPLACE "/MD" "/MT" ${MSVC_FLAGS} "${${MSVC_FLAGS}}")
+            endforeach()
+        endif()
 
         # "If /Zc:rvalueCast is specified, the compiler follows section 5.4 of the
         # C++11 standard". We need C++11 for the way we use threads.
         add_compile_options(/Zc:rvalueCast)
 
         if(NOT CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
-            # Enable multi-threaded compilation.
-            add_compile_options(/MP)
+            add_compile_options(
+                /MP # Enable multi-threaded compilation.
+                /FC # Display the full path of source code files passed to the compiler in diagnostics.
+            )
         endif()
-
-        # Add DPI manifest to project; other WIN32 targets get this via ottdres.rc
-        list(APPEND GENERATED_SOURCE_FILES "${CMAKE_SOURCE_DIR}/os/windows/openttd.manifest")
     endif()
 
     # Add some -D flags for Debug builds. We cannot use add_definitions(), because
@@ -42,6 +43,11 @@ macro(compile_flags)
         add_link_options(
             "$<$<NOT:$<CONFIG:Debug>>:-fstack-protector>" # Prevent undefined references when _FORTIFY_SOURCE > 0
         )
+        if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+            add_compile_options(
+                "$<$<CONFIG:Debug>:-Wa,-mbig-obj>" # Switch to pe-bigobj-x86-64 as x64 Debug builds push pe-x86-64 to the limits (linking errors with ASLR, ...)
+            )
+        endif()
     endif()
 
     # Prepare a generator that checks if we are not a debug, and don't have asserts
@@ -50,6 +56,11 @@ macro(compile_flags)
 
     if(MSVC)
         add_compile_options(/W3)
+        if(MSVC_VERSION GREATER 1929 AND CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
+            # Starting with version 19.30, there is an optimisation bug, see #9966 for details
+            # This flag disables the broken optimisation to work around the bug
+            add_compile_options(/d2ssa-rse-)
+        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
@@ -125,6 +136,10 @@ macro(compile_flags)
                 # -flifetime-dse=2 (default since GCC 6) doesn't play
                 # well with our custom pool item allocator
                 "$<$<BOOL:${LIFETIME_DSE_FOUND}>:-flifetime-dse=1>"
+
+                # We have a fight between clang wanting std::move() and gcc not wanting it
+                # and of course they both warn when the other compiler is happy
+                "-Wno-redundant-move"
             )
         endif()
 
@@ -157,7 +172,7 @@ macro(compile_flags)
         message(FATAL_ERROR "No warning flags are set for this compiler yet; please consider creating a Pull Request to add support for this compiler.")
     endif()
 
-    if(NOT WIN32)
+    if(NOT WIN32 AND NOT HAIKU)
         # rdynamic is used to get useful stack traces from crash reports.
         set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -rdynamic")
     endif()

cmake/CreateGrfCommand.cmake

@@ -35,9 +35,9 @@ function(create_grf_command)
                     -DNFORENUM_EXECUTABLE=${NFORENUM_EXECUTABLE}
                     -DGRFCODEC_EXECUTABLE=${GRFCODEC_EXECUTABLE}
                     -P ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateGRF.cmake
-            MAIN_DEPENDENCY ${GRF_NFO_SOURCE_FILES}
+            MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateGRF.cmake
             DEPENDS ${GRF_PNG_BINARY_FILES}
-                    ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateGRF.cmake
+                    ${GRF_NFO_SOURCE_FILES}
             WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
             COMMENT "Generating ${GRF_SOURCE_FOLDER_NAME}.grf"
     )

cmake/CreateRegression.cmake

@@ -10,8 +10,8 @@ macro(create_regression)
     # build folder before we can run the regression
     file(GLOB_RECURSE REGRESSION_SOURCE_FILES ${CMAKE_SOURCE_DIR}/regression/*)
     foreach(REGRESSION_SOURCE_FILE IN LISTS REGRESSION_SOURCE_FILES)
-        string(REGEX REPLACE "^${CMAKE_SOURCE_DIR}/regression/" "${CMAKE_BINARY_DIR}/ai/" REGRESSION_BINARY_FILE "${REGRESSION_SOURCE_FILE}")
-        string(REGEX REPLACE "^${CMAKE_SOURCE_DIR}/regression/" "" REGRESSION_SOURCE_FILE_NAME "${REGRESSION_SOURCE_FILE}")
+        string(REPLACE "${CMAKE_SOURCE_DIR}/regression/" "" REGRESSION_SOURCE_FILE_NAME "${REGRESSION_SOURCE_FILE}")
+        string(CONCAT REGRESSION_BINARY_FILE "${CMAKE_BINARY_DIR}/ai/" "${REGRESSION_SOURCE_FILE_NAME}")
 
         if("${REGRESSION_SOURCE_FILE_NAME}" STREQUAL "regression.cfg")
             continue()

cmake/FindAllegro.cmake

@@ -31,7 +31,7 @@ The following cache variables may also be set:
 #]=======================================================================]
 
 find_package(PkgConfig QUIET)
-pkg_check_modules(PC_Allegro QUIET allegro)
+pkg_check_modules(PC_Allegro QUIET allegro<5)
 
 find_path(Allegro_INCLUDE_DIR
     NAMES allegro.h

cmake/FindICU.cmake

@@ -1,3 +1,8 @@
+# CMake provides a FindICU module since version 3.7.
+# But it doesn't use pkgconfig, doesn't set expected variables,
+# And it returns incomplete dependencies if only some modules are searched.
+
+
 #[=======================================================================[.rst:
 FindICU
 -------

cmake/FindPandoc.cmake

@@ -0,0 +1,3 @@
+if(NOT EXISTS ${PANDOC_EXECUTABLE})
+    find_program(PANDOC_EXECUTABLE pandoc)
+endif()

cmake/InstallAndPackage.cmake

@@ -26,11 +26,13 @@ install(TARGETS openttd
 install(DIRECTORY
                 ${CMAKE_BINARY_DIR}/lang
                 ${CMAKE_BINARY_DIR}/baseset
-                ${CMAKE_SOURCE_DIR}/bin/ai
-                ${CMAKE_SOURCE_DIR}/bin/game
+                ${CMAKE_BINARY_DIR}/ai
+                ${CMAKE_BINARY_DIR}/game
                 ${CMAKE_SOURCE_DIR}/bin/scripts
         DESTINATION ${DATA_DESTINATION_DIR}
-        COMPONENT language_files)
+        COMPONENT language_files
+        REGEX "ai/[^\.]+$" EXCLUDE # Ignore subdirs in ai dir
+)
 
 install(FILES
                 ${CMAKE_SOURCE_DIR}/COPYING.md
@@ -58,8 +60,18 @@ if(OPTION_INSTALL_FHS)
             COMPONENT manual)
 endif()
 
-# TODO -- Media files
-# TODO -- Menu files
+if(UNIX AND NOT APPLE)
+    install(DIRECTORY
+                    ${CMAKE_BINARY_DIR}/media/icons
+                    ${CMAKE_BINARY_DIR}/media/pixmaps
+            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}
+            COMPONENT media)
+
+    install(FILES
+                    ${CMAKE_BINARY_DIR}/media/${BINARY_NAME}.desktop
+            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/applications
+            COMPONENT menu)
+endif()
 
 if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64")
     set(ARCHITECTURE "amd64")
@@ -95,7 +107,14 @@ set(CPACK_PACKAGE_HOMEPAGE_URL "https://www.openttd.org/")
 set(CPACK_PACKAGE_CONTACT "OpenTTD <info@openttd.org>")
 set(CPACK_PACKAGE_INSTALL_DIRECTORY "OpenTTD")
 set(CPACK_PACKAGE_CHECKSUM "SHA256")
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/COPYING.md")
+
+if((APPLE OR WIN32) AND EXISTS ${PANDOC_EXECUTABLE})
+    execute_process(COMMAND ${PANDOC_EXECUTABLE} "${CMAKE_SOURCE_DIR}/COPYING.md" -s -o "${CMAKE_BINARY_DIR}/COPYING.rtf")
+    set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_BINARY_DIR}/COPYING.rtf")
+else()
+    set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/COPYING.md")
+endif()
+
 set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
 set(CPACK_MONOLITHIC_INSTALL YES)
 set(CPACK_PACKAGE_EXECUTABLES "openttd;OpenTTD")
@@ -103,6 +122,8 @@ set(CPACK_STRIP_FILES YES)
 set(CPACK_OUTPUT_FILE_PREFIX "bundles")
 
 if(APPLE)
+    # Stripping would produce unreadable stacktraces.
+    set(CPACK_STRIP_FILES NO)
     set(CPACK_GENERATOR "Bundle")
     include(PackageBundle)
 
@@ -110,7 +131,7 @@ if(APPLE)
         set(CPACK_PACKAGE_FILE_NAME "openttd-#CPACK_PACKAGE_VERSION#-macos-universal")
     else()
         set(CPACK_PACKAGE_FILE_NAME "openttd-#CPACK_PACKAGE_VERSION#-macos-${CPACK_SYSTEM_NAME}")
-	endif()
+    endif()
 elseif(WIN32)
     set(CPACK_GENERATOR "ZIP")
     if(OPTION_USE_NSIS)
@@ -119,12 +140,23 @@ elseif(WIN32)
     endif()
 
     set(CPACK_PACKAGE_FILE_NAME "openttd-#CPACK_PACKAGE_VERSION#-windows-${CPACK_SYSTEM_NAME}")
+
+    if(WINDOWS_CERTIFICATE_COMMON_NAME)
+      add_custom_command(TARGET openttd
+        POST_BUILD
+        COMMAND "${CMAKE_SOURCE_DIR}/os/windows/sign.bat" "$<TARGET_FILE:openttd>" "${WINDOWS_CERTIFICATE_COMMON_NAME}"
+      )
+    endif()
 elseif(UNIX)
     # With FHS, we can create deb/rpm/... Without it, they would be horribly broken
     # and not work. The other way around is also true; with FHS they are not
     # usable, and only flat formats work.
-    if(NOT OPTION_INSTALL_FHS)
+    if(OPTION_PACKAGE_DEPENDENCIES)
         set(CPACK_GENERATOR "TXZ")
+        set(PLATFORM "generic")
+    elseif(NOT OPTION_INSTALL_FHS)
+        set(CPACK_GENERATOR "TXZ")
+        set(PLATFORM "unknown")
     else()
         find_program(LSB_RELEASE_EXEC lsb_release)
         execute_process(COMMAND ${LSB_RELEASE_EXEC} -is
@@ -149,8 +181,12 @@ elseif(UNIX)
             string(REGEX MATCH "ID=(.*)" _ ${OS_RELEASE_CONTENTS})
             set(DISTRO_ID ${CMAKE_MATCH_1})
             if(DISTRO_ID STREQUAL "arch")
-                set(PLATFORM "generic")
+                set(PLATFORM "arch")
                 set(CPACK_GENERATOR "TXZ")
+            elseif(DISTRO_ID STREQUAL "fedora" OR DISTRO_ID STREQUAL "rhel")
+                set(PLATFORM "fedora")
+                set(CPACK_GENERATOR "RPM")
+                include(PackageRPM)
             else()
                 set(UNSUPPORTED_PLATFORM_NAME "Linux distribution '${DISTRO_ID}' from /etc/os-release")
             endif()
@@ -163,12 +199,39 @@ elseif(UNIX)
             set(CPACK_GENERATOR "TXZ")
             message(WARNING "Unknown ${UNSUPPORTED_PLATFORM_NAME} found for packaging; can only pack to a txz. Please consider creating a Pull Request to add support for this distribution.")
         endif()
-
-        set(CPACK_PACKAGE_FILE_NAME "openttd-#CPACK_PACKAGE_VERSION#-linux-${PLATFORM}-${CPACK_SYSTEM_NAME}")
     endif()
 
+    set(CPACK_PACKAGE_FILE_NAME "openttd-#CPACK_PACKAGE_VERSION#-linux-${PLATFORM}-${CPACK_SYSTEM_NAME}")
+
 else()
     message(FATAL_ERROR "Unknown OS found for packaging; please consider creating a Pull Request to add support for this OS.")
 endif()
 
 include(CPack)
+
+if(OPTION_PACKAGE_DEPENDENCIES)
+    # Install all dependencies we can resolve, with the exception of ones that
+    # every Linux machine should have. This should make this build as generic
+    # as possible, where it runs on any machine with the same or newer libc
+    # than the one this is compiled with.
+    # We copy these libraries into lib/ folder, so they can be found on game
+    # startup. See comment in root CMakeLists.txt for how this works exactly.
+    install(CODE [[
+        file(GET_RUNTIME_DEPENDENCIES
+                RESOLVED_DEPENDENCIES_VAR DEPENDENCIES
+                UNRESOLVED_DEPENDENCIES_VAR UNRESOLVED_DEPENDENCIES
+                EXECUTABLES openttd
+                POST_EXCLUDE_REGEXES "ld-linux|libc.so|libdl.so|libm.so|libgcc_s.so|libpthread.so|librt.so|libstdc...so")
+        file(INSTALL
+                DESTINATION "${CMAKE_INSTALL_PREFIX}/lib"
+                FILES ${DEPENDENCIES}
+                FOLLOW_SYMLINK_CHAIN)
+
+        # This should not be possible, but error out when a dependency cannot
+        # be resolved.
+        list(LENGTH UNRESOLVED_DEPENDENCIES UNRESOLVED_LENGTH)
+        if(${UNRESOLVED_LENGTH} GREATER 0)
+            message(FATAL_ERROR "Unresolved dependencies: ${UNRESOLVED_DEPENDENCIES}")
+        endif()
+    ]])
+endif()

cmake/LinkPackage.cmake

@@ -18,6 +18,6 @@ function(link_package NAME)
             message(STATUS "${NAME} found -- -DWITH_${UCNAME} -- ${${NAME}_INCLUDE_DIRS} ${${NAME}_INCLUDE_DIR} -- ${${NAME}_LIBRARIES} ${${NAME}_LIBRARY}")
         endif()
     elseif(LP_ENCOURAGED)
-        message(WARNING "${NAME} not found; compiling OpenTTD without ${NAME} is strongly disencouraged")
+        message(WARNING "${NAME} not found; compiling OpenTTD without ${NAME} is strongly discouraged")
     endif()
 endfunction()

cmake/MSVCFilters.cmake

@@ -3,6 +3,7 @@
 source_group("AI Core" REGULAR_EXPRESSION "src/ai/")
 source_group("Blitters" REGULAR_EXPRESSION "src/blitter/")
 source_group("Core Source Code" REGULAR_EXPRESSION "src/core/")
+source_group("Font Cache" REGULAR_EXPRESSION "src/fontcache/")
 source_group("Game Core" REGULAR_EXPRESSION "src/game/")
 source_group("MD5" REGULAR_EXPRESSION "src/3rdparty/md5/")
 source_group("Misc" REGULAR_EXPRESSION "src/misc/")
@@ -11,11 +12,13 @@ source_group("Network Core" REGULAR_EXPRESSION "src/network/core/")
 source_group("OSX" REGULAR_EXPRESSION "src/os/macosx/")
 source_group("Pathfinder" REGULAR_EXPRESSION "src/pathfinder/")
 source_group("Save/Load handlers" REGULAR_EXPRESSION "src/saveload/")
+source_group("Save/Load handlers\\Compat" REGULAR_EXPRESSION "src/saveload/compat/")
 source_group("Sound" REGULAR_EXPRESSION "src/sound/")
 source_group("Sprite loaders" REGULAR_EXPRESSION "src/spriteloader/")
 source_group("Squirrel" REGULAR_EXPRESSION "src/3rdparty/squirrel/squirrel/")
 source_group("Tables" REGULAR_EXPRESSION "src/table/")
 source_group("Video" REGULAR_EXPRESSION "src/video/")
+source_group("Video\\GL" REGULAR_EXPRESSION "src/3rdparty/opengl/")
 source_group("Widgets" REGULAR_EXPRESSION "src/widgets/")
 source_group("Windows files" REGULAR_EXPRESSION "src/os/windows/|\.rc$")
 

cmake/Options.cmake

@@ -44,7 +44,9 @@ endfunction()
 # set_options()
 #
 function(set_options)
-    if(UNIX AND NOT APPLE)
+    option(OPTION_PACKAGE_DEPENDENCIES "Copy dependencies into lib/ for easy packaging (Linux only)" OFF)
+
+    if(UNIX AND NOT APPLE AND NOT OPTION_PACKAGE_DEPENDENCIES)
         set(DEFAULT_OPTION_INSTALL_FHS ON)
     else()
         set(DEFAULT_OPTION_INSTALL_FHS OFF)
@@ -54,7 +56,7 @@ function(set_options)
 
     option(OPTION_DEDICATED "Build dedicated server only (no GUI)" OFF)
     option(OPTION_INSTALL_FHS "Install with Filesystem Hierarchy Standard folders" ${DEFAULT_OPTION_INSTALL_FHS})
-    option(OPTION_USE_ASSERTS "Use assertions; leave enabled for nightlies, betas, and RCs" ON)
+    option(OPTION_USE_ASSERTS "Use assertions; leave enabled for nightlies, betas, and RCs" OFF)
     if(EMSCRIPTEN)
         # Although pthreads is supported, it is not in a way yet that is
         # useful for us.
@@ -76,6 +78,7 @@ endfunction()
 # show_options()
 #
 function(show_options)
+    message(STATUS "Option Package Dependencies - ${OPTION_PACKAGE_DEPENDENCIES}")
     message(STATUS "Option Dedicated - ${OPTION_DEDICATED}")
     message(STATUS "Option Install FHS - ${OPTION_INSTALL_FHS}")
     message(STATUS "Option Use assert - ${OPTION_USE_ASSERTS}")

cmake/PackageRPM.cmake

@@ -0,0 +1 @@
+set(CPACK_RPM_PACKAGE_ARCHITECTURE "${ARCHITECTURE}")

cmake/scripts/Baseset.cmake

@@ -4,6 +4,16 @@ cmake_minimum_required(VERSION 3.5)
 # Create a single baseset meta file with the correct translations.
 #
 
+if(NOT BASESET_SOURCE_FILE)
+    message(FATAL_ERROR "Script needs BASESET_SOURCE_FILE defined")
+endif()
+if(NOT BASESET_BINARY_FILE)
+    message(FATAL_ERROR "Script needs BASESET_BINARY_FILE defined")
+endif()
+if(NOT BASESET_EXTRAGRF_FILE)
+    message(FATAL_ERROR "Script needs BASESET_EXTRAGRF_FILE defined")
+endif()
+
 set(ARGC 1)
 set(ARG_READ NO)
 

cmake/scripts/CreateGRF.cmake

@@ -39,6 +39,20 @@ foreach(NFO_LINE IN LISTS NFO_LINES)
     endif()
 endforeach()
 
-execute_process(COMMAND ${NFORENUM_EXECUTABLE} -s sprites/${GRF_SOURCE_FOLDER_NAME}.nfo)
-execute_process(COMMAND ${GRFCODEC_EXECUTABLE} -n -s -e -p1 ${GRF_SOURCE_FOLDER_NAME}.grf)
+execute_process(COMMAND ${NFORENUM_EXECUTABLE} -s sprites/${GRF_SOURCE_FOLDER_NAME}.nfo RESULT_VARIABLE RESULT)
+if(RESULT)
+    if(NOT RESULT MATCHES "^[0-9]*$")
+        message(FATAL_ERROR "Failed to run NFORenum (${RESULT}), please check NFORENUM_EXECUTABLE variable")
+    endif()
+    message(FATAL_ERROR "NFORenum failed")
+endif()
+
+execute_process(COMMAND ${GRFCODEC_EXECUTABLE} -n -s -e -p1 ${GRF_SOURCE_FOLDER_NAME}.grf RESULT_VARIABLE RESULT)
+if(RESULT)
+    if(NOT RESULT MATCHES "^[0-9]*$")
+        message(FATAL_ERROR "Failed to run GRFCodec (${RESULT}), please check GRFCODEC_EXECUTABLE variable")
+    endif()
+    message(FATAL_ERROR "GRFCodec failed")
+endif()
+
 execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${GRF_SOURCE_FOLDER_NAME}.grf ${GRF_BINARY_FILE})

cmake/scripts/Desktop.cmake

@@ -0,0 +1,60 @@
+cmake_minimum_required(VERSION 3.5)
+
+#
+# Create a desktop file with the correct translations.
+#
+
+if(NOT DESKTOP_SOURCE_FILE)
+    message(FATAL_ERROR "Script needs DESKTOP_SOURCE_FILE defined")
+endif()
+if(NOT DESKTOP_BINARY_FILE)
+    message(FATAL_ERROR "Script needs DESKTOP_BINARY_FILE defined")
+endif()
+if(NOT BINARY_NAME)
+    message(FATAL_ERROR "Script needs BINARY_NAME defined")
+endif()
+
+set(ARGC 1)
+set(ARG_READ NO)
+
+# Read all the arguments given to CMake; we are looking for -- and everything
+# that follows. Those are our language files.
+while(ARGC LESS CMAKE_ARGC)
+    set(ARG ${CMAKE_ARGV${ARGC}})
+
+    if(ARG_READ)
+        list(APPEND LANG_SOURCE_FILES "${ARG}")
+    endif()
+
+    if(ARG STREQUAL "--")
+        set(ARG_READ YES)
+    endif()
+
+    math(EXPR ARGC "${ARGC} + 1")
+endwhile()
+
+# Place holder format is @<ini_key>_<str_id>@
+file(STRINGS "${DESKTOP_SOURCE_FILE}" PLACE_HOLDER REGEX "^@")
+string(REGEX REPLACE "@([^_]+).*@" "\\1" INI_KEY "${PLACE_HOLDER}")
+string(REGEX REPLACE "@[^_]+_(.*)@" "\\1" STR_ID "${PLACE_HOLDER}")
+string(REGEX REPLACE "@(.*)@" "\\1" PLACE_HOLDER "${PLACE_HOLDER}")
+
+# Get the translations
+foreach(LANGFILE IN LISTS LANG_SOURCE_FILES)
+    file(STRINGS "${LANGFILE}" LANGLINES REGEX "^(##isocode|${STR_ID})" ENCODING UTF-8)
+    string(FIND "${LANGLINES}" "${STR_ID}" HAS_STR_ID)
+    if(HAS_STR_ID LESS 0)
+        continue()
+    endif()
+    string(REGEX REPLACE "##isocode ([^;]+).*" "\\1" ISOCODE "${LANGLINES}")
+    if("${ISOCODE}" STREQUAL "en_GB")
+        string(REGEX REPLACE "[^:]*:(.*)" "${INI_KEY}=\\1" LANGLINES "${LANGLINES}")
+    else()
+        string(REGEX REPLACE "[^:]*:(.*)" "${INI_KEY}[${ISOCODE}]=\\1" LANGLINES "${LANGLINES}")
+    endif()
+    list(APPEND ${PLACE_HOLDER} ${LANGLINES})
+endforeach()
+list(SORT ${PLACE_HOLDER})
+string(REPLACE ";" "\n" ${PLACE_HOLDER} "${${PLACE_HOLDER}}")
+
+configure_file(${DESKTOP_SOURCE_FILE} ${DESKTOP_BINARY_FILE})

cmake/scripts/FindVersion.cmake

@@ -1,5 +1,12 @@
 cmake_minimum_required(VERSION 3.5)
 
+if(NOT REV_MAJOR)
+    set(REV_MAJOR 0)
+endif()
+if(NOT REV_MINOR)
+    set(REV_MINOR 0)
+endif()
+
 #
 # Finds the current version of the current folder.
 #
@@ -83,7 +90,7 @@ if(GIT_FOUND AND EXISTS "${CMAKE_SOURCE_DIR}/.git")
         set(REV_ISTAG 1)
 
         string(REGEX REPLACE "^[0-9.]+$" "" STABLETAG "${TAG}")
-        if(NOT STABLETAG STREQUAL "")
+        if(STABLETAG STREQUAL "")
             set(REV_ISSTABLETAG 1)
         else()
             set(REV_ISSTABLETAG 0)
@@ -128,7 +135,7 @@ else()
     configure_file("${CMAKE_SOURCE_DIR}/src/rev.cpp.in"
             "${FIND_VERSION_BINARY_DIR}/rev.cpp")
 
-    if(WIN32)
+    if(WINDOWS)
         message(STATUS "Generating ottdres.rc")
         configure_file("${CMAKE_SOURCE_DIR}/src/os/windows/ottdres.rc.in"
                 "${FIND_VERSION_BINARY_DIR}/ottdres.rc")

cmake/scripts/GenerateWidget.cmake

@@ -13,6 +13,7 @@ cmake_minimum_required(VERSION 3.5)
 # The parameter "enumname" specifies the enumeration to extract. This can also be a regular expression.
 # The parameter "filename" specifies the relative path to the file, where the enumeration is extracted from. This can also be a glob expression.
 #
+# All files where enumerations are extracted from are automatically added via #include
 #
 
 if(NOT GENERATE_SOURCE_FILE)
@@ -41,6 +42,7 @@ foreach(ENUM IN LISTS ENUM_LINES)
 
         string(REPLACE "${CMAKE_CURRENT_SOURCE_DIR}/" "" FILE ${FILE})
         string(APPEND ${PLACE_HOLDER} "\n${ADD_INDENT}/* automatically generated from ${FILE} */")
+        list(APPEND INCLUDES "#include \"${FILE}\"")
 
         foreach(LINE IN LISTS SOURCE_LINES)
             string(REPLACE "${RM_INDENT}" "" LINE "${LINE}")
@@ -116,4 +118,7 @@ foreach(ENUM IN LISTS ENUM_LINES)
     endforeach()
  endforeach()
 
+ list(REMOVE_DUPLICATES INCLUDES)
+ string(REPLACE ";" "\n" INCLUDES "${INCLUDES}")
+
 configure_file(${GENERATE_SOURCE_FILE} ${GENERATE_BINARY_FILE})

cmake/scripts/Regression.cmake

@@ -35,6 +35,7 @@ execute_process(COMMAND ${OPENTTD_EXECUTABLE}
                         -vnull:ticks=30000
                         -d script=2
                         -d misc=9
+                        -Q
                 OUTPUT_VARIABLE REGRESSION_OUTPUT
                 ERROR_VARIABLE REGRESSION_RESULT
                 OUTPUT_STRIP_TRAILING_WHITESPACE
@@ -53,6 +54,9 @@ string(REPLACE "0x(nil)" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}")
 string(REPLACE "0x0000000000000000" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}")
 string(REPLACE "0x0x0" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}")
 
+# Remove timestamps if any
+string(REGEX REPLACE "\[[0-9-]+ [0-9:]+\] " "" REGRESSION_RESULT "${REGRESSION_RESULT}")
+
 # Convert the output to a format that is expected (and more readable) by result.txt
 string(REPLACE "\ndbg: [script]" "\n" REGRESSION_RESULT "${REGRESSION_RESULT}")
 string(REPLACE "\n " "\nERROR: " REGRESSION_RESULT "${REGRESSION_RESULT}")

cmake/scripts/SquirrelExport.cmake

@@ -28,10 +28,10 @@ endmacro()
 macro(dump_class_templates NAME)
     string(REGEX REPLACE "^Script" "" REALNAME ${NAME})
 
-    string(APPEND SQUIRREL_EXPORT "\n	template <> inline ${NAME} *GetParam(ForceType<${NAME} *>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return  (${NAME} *)instance; }")
-    string(APPEND SQUIRREL_EXPORT "\n	template <> inline ${NAME} &GetParam(ForceType<${NAME} &>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(${NAME} *)instance; }")
-    string(APPEND SQUIRREL_EXPORT "\n	template <> inline const ${NAME} *GetParam(ForceType<const ${NAME} *>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return  (${NAME} *)instance; }")
-    string(APPEND SQUIRREL_EXPORT "\n	template <> inline const ${NAME} &GetParam(ForceType<const ${NAME} &>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(${NAME} *)instance; }")
+    string(APPEND SQUIRREL_EXPORT "\n	template <> inline ${NAME} *GetParam(ForceType<${NAME} *>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return  (${NAME} *)instance; }")
+    string(APPEND SQUIRREL_EXPORT "\n	template <> inline ${NAME} &GetParam(ForceType<${NAME} &>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; }")
+    string(APPEND SQUIRREL_EXPORT "\n	template <> inline const ${NAME} *GetParam(ForceType<const ${NAME} *>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return  (${NAME} *)instance; }")
+    string(APPEND SQUIRREL_EXPORT "\n	template <> inline const ${NAME} &GetParam(ForceType<const ${NAME} &>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; }")
     if("${NAME}" STREQUAL "ScriptEvent")
         string(APPEND SQUIRREL_EXPORT "\n	template <> inline int Return<${NAME} *>(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")
@@ -342,7 +342,7 @@ foreach(LINE IN LISTS SOURCE_LINES)
         else()
             string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.PreRegister(engine, \"${API_SUPER_CLS}\");")
         endif()
-        if(NOT "${SUPER_CLS}" STREQUAL "ScriptEvent")
+        if(NOT "${SUPER_CLS}" MATCHES "^ScriptEvent")
             if("${CLS_PARAM_2}" STREQUAL "v")
                 string(APPEND SQUIRREL_EXPORT "\n	SQ${API_CLS}.AddSQAdvancedConstructor(engine);")
             else()

cmake/scripts/SquirrelIncludes.cmake

@@ -12,25 +12,11 @@ endif()
 if(NOT APIUC)
     message(FATAL_ERROR "Script needs APIUC defined")
 endif()
+if(NOT API_FILES)
+    message(FATAL_ERROR "Script needs API_FILES defined")
+endif()
 
-set(ARGC 1)
-set(ARG_READ NO)
-
-# Read all the arguments given to CMake; we are looking for -- and everything
-# that follows. Those are our api files.
-while(ARGC LESS CMAKE_ARGC)
-    set(ARG ${CMAKE_ARGV${ARGC}})
-
-    if(ARG_READ)
-        list(APPEND SCRIPT_API_BINARY_FILES "${ARG}")
-    endif()
-
-    if(ARG STREQUAL "--")
-        set(ARG_READ YES)
-    endif()
-
-    math(EXPR ARGC "${ARGC} + 1")
-endwhile()
+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\\)$")

docs/company_colour_indexes.html

@@ -0,0 +1,557 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!-- derived from Iron Horse branch at https://github.com/andythenorth/iron-horse/tree/company_colour_indexes -->
+<head>
+	<title>OpenTTD Company Colour Indexes</title>
+	<meta charset="UTF-8" />
+<style>
+th { 
+	vertical-align: top; 
+	border-bottom:  solid 1px #ddd; 
+	padding-top:    30px; 
+	padding-right:  15px; 
+	text-align:     right;
+}
+tr.top td {
+	padding-top:    20px;
+}
+tr.bottom td {
+	border-bottom:  solid 1px #ddd; 
+	padding-bottom: 10px;
+}
+td {
+	text-align:     right;
+}
+span {
+	border:         solid 1px #000;
+	width:          32px;
+	height:         32px;
+	display:        inline-block;
+	vertical-align: top;
+	margin-left:    0px;
+}
+</style>
+</head>
+<body>
+	<h1>Company Colour Indexes</h1>
+	<p>Hex / dec indexes into the DOS palette</p>
+	<p>
+		Visual representation of values derived from <a href="https://github.com/frosch123/TTDViewer/blob/master/src/recolor.xml#L186">https://github.com/frosch123/TTDViewer/blob/master/src/recolor.xml#L186</a>
+	</p>
+	<table style="margin-top:30px;">
+		<tbody>
+			<tr class="top">
+				<th rowspan="3">COLOUR_DARK_BLUE</th>
+				<td><span style="background-color:rgb(  8,  24,  88)"></span></td>
+				<td><span style="background-color:rgb( 12,  36, 104)"></span></td>
+				<td><span style="background-color:rgb( 20,  52, 124)"></span></td>
+				<td><span style="background-color:rgb( 28,  68, 140)"></span></td>
+				<td><span style="background-color:rgb( 40,  92, 164)"></span></td>
+				<td><span style="background-color:rgb( 56, 120, 188)"></span></td>
+				<td><span style="background-color:rgb( 72, 152, 216)"></span></td>
+				<td><span style="background-color:rgb(100, 172, 224)"></span></td>
+			</tr>
+			<tr>
+				<td>0xc6</td>
+				<td>0xc7</td>
+				<td>0xc8</td>
+				<td>0xc9</td>
+				<td>0xca</td>
+				<td>0xcb</td>
+				<td>0xcc</td>
+				<td>0xcd</td>
+			</tr>
+			<tr class="bottom">
+				<td>198</td>
+				<td>199</td>
+				<td>200</td>
+				<td>201</td>
+				<td>202</td>
+				<td>203</td>
+				<td>204</td>
+				<td>205</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_PALE_GREEN</th>
+				<td><span style="background-color:rgb( 16,  52,  24)"></span></td>
+				<td><span style="background-color:rgb( 32,  72,  44)"></span></td>
+				<td><span style="background-color:rgb( 56,  96,  72)"></span></td>
+				<td><span style="background-color:rgb( 76, 116,  88)"></span></td>
+				<td><span style="background-color:rgb( 96, 136, 108)"></span></td>
+				<td><span style="background-color:rgb(120, 164, 136)"></span></td>
+				<td><span style="background-color:rgb(152, 192, 168)"></span></td>
+				<td><span style="background-color:rgb(184, 220, 200)"></span></td>
+			</tr>
+			<tr>
+				<td>0x60</td>
+				<td>0x61</td>
+				<td>0x62</td>
+				<td>0x63</td>
+				<td>0x64</td>
+				<td>0x65</td>
+				<td>0x66</td>
+				<td>0x67</td>
+			</tr>
+			<tr class="bottom">
+				<td>96</td>
+				<td>97</td>
+				<td>98</td>
+				<td>99</td>
+				<td>100</td>
+				<td>101</td>
+				<td>102</td>
+				<td>103</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_PINK</th>
+				<td><span style="background-color:rgb(112,  16,  32)"></span></td>
+				<td><span style="background-color:rgb(136,  32,  52)"></span></td>
+				<td><span style="background-color:rgb(160,  56,  76)"></span></td>
+				<td><span style="background-color:rgb(188,  84, 108)"></span></td>
+				<td><span style="background-color:rgb(204, 104, 124)"></span></td>
+				<td><span style="background-color:rgb(220, 132, 144)"></span></td>
+				<td><span style="background-color:rgb(236, 156, 164)"></span></td>
+				<td><span style="background-color:rgb(252, 188, 192)"></span></td>
+			</tr>
+			<tr>
+				<td>0x2a</td>
+				<td>0x2b</td>
+				<td>0x2c</td>
+				<td>0x2d</td>
+				<td>0x2e</td>
+				<td>0x2f</td>
+				<td>0x30</td>
+				<td>0x31</td>
+			</tr>
+			<tr class="bottom">
+				<td>42</td>
+				<td>43</td>
+				<td>44</td>
+				<td>45</td>
+				<td>46</td>
+				<td>47</td>
+				<td>48</td>
+				<td>49</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_YELLOW</th>
+				<td><span style="background-color:rgb(128,  68,   8)"></span></td>
+				<td><span style="background-color:rgb(156,  96,  16)"></span></td>
+				<td><span style="background-color:rgb(184, 120,  24)"></span></td>
+				<td><span style="background-color:rgb(212, 156,  32)"></span></td>
+				<td><span style="background-color:rgb(232, 184,  16)"></span></td>
+				<td><span style="background-color:rgb(252, 212,   0)"></span></td>
+				<td><span style="background-color:rgb(252, 248, 128)"></span></td>
+				<td><span style="background-color:rgb(252, 252, 192)"></span></td>
+			</tr>
+			<tr>
+				<td>0x3e</td>
+				<td>0x3f</td>
+				<td>0x40</td>
+				<td>0x41</td>
+				<td>0x42</td>
+				<td>0x43</td>
+				<td>0x44</td>
+				<td>0x45</td>
+			</tr>
+			<tr class="bottom">
+				<td>62</td>
+				<td>63</td>
+				<td>64</td>
+				<td>65</td>
+				<td>66</td>
+				<td>67</td>
+				<td>68</td>
+				<td>69</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_RED</th>
+				<td><span style="background-color:rgb( 92,   0,   0)"></span></td>
+				<td><span style="background-color:rgb(128,   0,   0)"></span></td>
+				<td><span style="background-color:rgb(160,   0,   0)"></span></td>
+				<td><span style="background-color:rgb(196,   0,   0)"></span></td>
+				<td><span style="background-color:rgb(224,   0,   0)"></span></td>
+				<td><span style="background-color:rgb(252,  52,  52)"></span></td>
+				<td><span style="background-color:rgb(252, 100,  88)"></span></td>
+				<td><span style="background-color:rgb(252, 144, 124)"></span></td>
+			</tr>
+			<tr>
+				<td>0xb3</td>
+				<td>0xb4</td>
+				<td>0xb5</td>
+				<td>0xb6</td>
+				<td>0xb7</td>
+				<td>0xa4</td>
+				<td>0xa5</td>
+				<td>0xa6</td>
+			</tr>
+			<tr class="bottom">
+				<td>179</td>
+				<td>180</td>
+				<td>181</td>
+				<td>182</td>
+				<td>183</td>
+				<td>164</td>
+				<td>165</td>
+				<td>166</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_LIGHT_BLUE</th>
+				<td><span style="background-color:rgb( 16,  64,  96)"></span></td>
+				<td><span style="background-color:rgb( 24,  80, 108)"></span></td>
+				<td><span style="background-color:rgb( 40,  96, 120)"></span></td>
+				<td><span style="background-color:rgb( 52, 112, 132)"></span></td>
+				<td><span style="background-color:rgb( 80, 140, 160)"></span></td>
+				<td><span style="background-color:rgb(116, 172, 192)"></span></td>
+				<td><span style="background-color:rgb(156, 204, 220)"></span></td>
+				<td><span style="background-color:rgb(204, 240, 252)"></span></td>
+			</tr>
+			<tr>
+				<td>0x9a</td>
+				<td>0x9b</td>
+				<td>0x9c</td>
+				<td>0x9d</td>
+				<td>0x9e</td>
+				<td>0x9f</td>
+				<td>0xa0</td>
+				<td>0xa1</td>
+			</tr>
+			<tr class="bottom">
+				<td>154</td>
+				<td>155</td>
+				<td>156</td>
+				<td>157</td>
+				<td>158</td>
+				<td>159</td>
+				<td>160</td>
+				<td>161</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_GREEN</th>
+				<td><span style="background-color:rgb( 32,  80,   4)"></span></td>
+				<td><span style="background-color:rgb( 48,  96,   4)"></span></td>
+				<td><span style="background-color:rgb( 64, 112,  12)"></span></td>
+				<td><span style="background-color:rgb( 84, 132,  20)"></span></td>
+				<td><span style="background-color:rgb( 92, 156,  52)"></span></td>
+				<td><span style="background-color:rgb(108, 176,  64)"></span></td>
+				<td><span style="background-color:rgb(124, 200,  76)"></span></td>
+				<td><span style="background-color:rgb(144, 224,  92)"></span></td>
+			</tr>
+			<tr>
+				<td>0x52</td>
+				<td>0x53</td>
+				<td>0x54</td>
+				<td>0x55</td>
+				<td>0xce</td>
+				<td>0xcf</td>
+				<td>0xd0</td>
+				<td>0xd1</td>
+			</tr>
+			<tr class="bottom">
+				<td>82</td>
+				<td>83</td>
+				<td>84</td>
+				<td>85</td>
+				<td>206</td>
+				<td>207</td>
+				<td>208</td>
+				<td>209</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_DARK_GREEN</th>
+				<td><span style="background-color:rgb( 28,  52,  24)"></span></td>
+				<td><span style="background-color:rgb( 44,  68,  32)"></span></td>
+				<td><span style="background-color:rgb( 60,  88,  48)"></span></td>
+				<td><span style="background-color:rgb( 80, 104,  60)"></span></td>
+				<td><span style="background-color:rgb(104, 124,  76)"></span></td>
+				<td><span style="background-color:rgb(128, 148,  92)"></span></td>
+				<td><span style="background-color:rgb(152, 176, 108)"></span></td>
+				<td><span style="background-color:rgb(180, 204, 124)"></span></td>
+			</tr>
+			<tr>
+				<td>0x58</td>
+				<td>0x59</td>
+				<td>0x5a</td>
+				<td>0x5b</td>
+				<td>0x5c</td>
+				<td>0x5d</td>
+				<td>0x5e</td>
+				<td>0x5f</td>
+			</tr>
+			<tr class="bottom">
+				<td>88</td>
+				<td>89</td>
+				<td>90</td>
+				<td>91</td>
+				<td>92</td>
+				<td>93</td>
+				<td>94</td>
+				<td>95</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_BLUE</th>
+				<td><span style="background-color:rgb(  0,  52, 160)"></span></td>
+				<td><span style="background-color:rgb(  0,  72, 184)"></span></td>
+				<td><span style="background-color:rgb(  0,  96, 212)"></span></td>
+				<td><span style="background-color:rgb( 24, 120, 220)"></span></td>
+				<td><span style="background-color:rgb( 56, 144, 232)"></span></td>
+				<td><span style="background-color:rgb( 88, 168, 240)"></span></td>
+				<td><span style="background-color:rgb(128, 196, 252)"></span></td>
+				<td><span style="background-color:rgb(188, 224, 252)"></span></td>
+			</tr>
+			<tr>
+				<td>0x92</td>
+				<td>0x93</td>
+				<td>0x94</td>
+				<td>0x95</td>
+				<td>0x96</td>
+				<td>0x97</td>
+				<td>0x98</td>
+				<td>0x99</td>
+			</tr>
+			<tr class="bottom">
+				<td>146</td>
+				<td>147</td>
+				<td>148</td>
+				<td>149</td>
+				<td>150</td>
+				<td>151</td>
+				<td>152</td>
+				<td>153</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_CREAM</th>
+				<td><span style="background-color:rgb(116,  68,  40)"></span></td>
+				<td><span style="background-color:rgb(136,  84,  56)"></span></td>
+				<td><span style="background-color:rgb(164,  96,  64)"></span></td>
+				<td><span style="background-color:rgb(184, 112,  80)"></span></td>
+				<td><span style="background-color:rgb(204, 128,  96)"></span></td>
+				<td><span style="background-color:rgb(212, 148, 112)"></span></td>
+				<td><span style="background-color:rgb(224, 168, 128)"></span></td>
+				<td><span style="background-color:rgb(236, 188, 148)"></span></td>
+			</tr>
+			<tr>
+				<td>0x72</td>
+				<td>0x73</td>
+				<td>0x74</td>
+				<td>0x75</td>
+				<td>0x76</td>
+				<td>0x77</td>
+				<td>0x78</td>
+				<td>0x79</td>
+			</tr>
+			<tr class="bottom">
+				<td>114</td>
+				<td>115</td>
+				<td>116</td>
+				<td>117</td>
+				<td>118</td>
+				<td>119</td>
+				<td>120</td>
+				<td>121</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_MAUVE</th>
+				<td><span style="background-color:rgb( 36,  40,  68)"></span></td>
+				<td><span style="background-color:rgb( 48,  52,  84)"></span></td>
+				<td><span style="background-color:rgb( 64,  64, 100)"></span></td>
+				<td><span style="background-color:rgb( 80,  80, 116)"></span></td>
+				<td><span style="background-color:rgb(100, 100, 136)"></span></td>
+				<td><span style="background-color:rgb(132, 132, 164)"></span></td>
+				<td><span style="background-color:rgb(172, 172, 192)"></span></td>
+				<td><span style="background-color:rgb(212, 212, 224)"></span></td>
+			</tr>
+			<tr>
+				<td>0x80</td>
+				<td>0x81</td>
+				<td>0x82</td>
+				<td>0x83</td>
+				<td>0x84</td>
+				<td>0x85</td>
+				<td>0x86</td>
+				<td>0x87</td>
+			</tr>
+			<tr class="bottom">
+				<td>128</td>
+				<td>129</td>
+				<td>130</td>
+				<td>131</td>
+				<td>132</td>
+				<td>133</td>
+				<td>134</td>
+				<td>135</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_PURPLE</th>
+				<td><span style="background-color:rgb( 40,  20, 112)"></span></td>
+				<td><span style="background-color:rgb( 64,  44, 144)"></span></td>
+				<td><span style="background-color:rgb( 88,  64, 172)"></span></td>
+				<td><span style="background-color:rgb(104,  76, 196)"></span></td>
+				<td><span style="background-color:rgb(120,  88, 224)"></span></td>
+				<td><span style="background-color:rgb(140, 104, 252)"></span></td>
+				<td><span style="background-color:rgb(160, 136, 252)"></span></td>
+				<td><span style="background-color:rgb(188, 168, 252)"></span></td>
+			</tr>
+			<tr>
+				<td>0x88</td>
+				<td>0x89</td>
+				<td>0x8a</td>
+				<td>0x8b</td>
+				<td>0x8c</td>
+				<td>0x8d</td>
+				<td>0x8e</td>
+				<td>0x8f</td>
+			</tr>
+			<tr class="bottom">
+				<td>136</td>
+				<td>137</td>
+				<td>138</td>
+				<td>139</td>
+				<td>140</td>
+				<td>141</td>
+				<td>142</td>
+				<td>143</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_ORANGE</th>
+				<td><span style="background-color:rgb(184, 120,  24)"></span></td>
+				<td><span style="background-color:rgb(204, 136,   8)"></span></td>
+				<td><span style="background-color:rgb(228, 144,   4)"></span></td>
+				<td><span style="background-color:rgb(252, 156,   0)"></span></td>
+				<td><span style="background-color:rgb(252, 176,  48)"></span></td>
+				<td><span style="background-color:rgb(252, 196, 100)"></span></td>
+				<td><span style="background-color:rgb(252, 216, 152)"></span></td>
+				<td><span style="background-color:rgb(244, 220, 176)"></span></td>
+			</tr>
+			<tr>
+				<td>0x40</td>
+				<td>0xc0</td>
+				<td>0xc1</td>
+				<td>0xc2</td>
+				<td>0xc3</td>
+				<td>0xc4</td>
+				<td>0xc5</td>
+				<td>0x27</td>
+			</tr>
+			<tr class="bottom">
+				<td>64</td>
+				<td>192</td>
+				<td>193</td>
+				<td>194</td>
+				<td>195</td>
+				<td>196</td>
+				<td>197</td>
+				<td>39</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_BROWN</th>
+				<td><span style="background-color:rgb( 72,  44,   4)"></span></td>
+				<td><span style="background-color:rgb( 88,  60,  20)"></span></td>
+				<td><span style="background-color:rgb(104,  80,  44)"></span></td>
+				<td><span style="background-color:rgb(124, 104,  72)"></span></td>
+				<td><span style="background-color:rgb(152, 132,  92)"></span></td>
+				<td><span style="background-color:rgb(184, 160, 120)"></span></td>
+				<td><span style="background-color:rgb(212, 188, 148)"></span></td>
+				<td><span style="background-color:rgb(244, 220, 176)"></span></td>
+			</tr>
+			<tr>
+				<td>0x20</td>
+				<td>0x21</td>
+				<td>0x22</td>
+				<td>0x23</td>
+				<td>0x24</td>
+				<td>0x25</td>
+				<td>0x26</td>
+				<td>0x27</td>
+			</tr>
+			<tr class="bottom">
+				<td>32</td>
+				<td>33</td>
+				<td>34</td>
+				<td>35</td>
+				<td>36</td>
+				<td>37</td>
+				<td>38</td>
+				<td>39</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_GREY</th>
+				<td><span style="background-color:rgb( 64,  64,  64)"></span></td>
+				<td><span style="background-color:rgb( 80,  80,  80)"></span></td>
+				<td><span style="background-color:rgb(100, 100, 100)"></span></td>
+				<td><span style="background-color:rgb(116, 116, 116)"></span></td>
+				<td><span style="background-color:rgb(132, 132, 132)"></span></td>
+				<td><span style="background-color:rgb(148, 148, 148)"></span></td>
+				<td><span style="background-color:rgb(168, 168, 168)"></span></td>
+				<td><span style="background-color:rgb(184, 184, 184)"></span></td>
+			</tr>
+			<tr>
+				<td>0x4</td>
+				<td>0x5</td>
+				<td>0x6</td>
+				<td>0x7</td>
+				<td>0x8</td>
+				<td>0x9</td>
+				<td>0xa</td>
+				<td>0xb</td>
+			</tr>
+			<tr class="bottom">
+				<td>4</td>
+				<td>5</td>
+				<td>6</td>
+				<td>7</td>
+				<td>8</td>
+				<td>9</td>
+				<td>10</td>
+				<td>11</td>
+			</tr>
+			
+			<tr class="top">
+				<th rowspan="3">COLOUR_WHITE</th>
+				<td><span style="background-color:rgb(132, 132, 132)"></span></td>
+				<td><span style="background-color:rgb(148, 148, 148)"></span></td>
+				<td><span style="background-color:rgb(168, 168, 168)"></span></td>
+				<td><span style="background-color:rgb(184, 184, 184)"></span></td>
+				<td><span style="background-color:rgb(200, 200, 200)"></span></td>
+				<td><span style="background-color:rgb(216, 216, 216)"></span></td>
+				<td><span style="background-color:rgb(232, 232, 232)"></span></td>
+				<td><span style="background-color:rgb(252, 252, 252)"></span></td>
+			</tr>
+			<tr>
+				<td>0x8</td>
+				<td>0x9</td>
+				<td>0xa</td>
+				<td>0xb</td>
+				<td>0xc</td>
+				<td>0xd</td>
+				<td>0xe</td>
+				<td>0xf</td>
+			</tr>
+			<tr class="bottom">
+				<td>8</td>
+				<td>9</td>
+				<td>10</td>
+				<td>11</td>
+				<td>12</td>
+				<td>13</td>
+				<td>14</td>
+				<td>15</td>
+			</tr>
+		</tbody>
+	</table>
+</body>
+</html>

docs/eints.md

@@ -0,0 +1,117 @@
+# Translations for OpenTTD
+
+Eints is [OpenTTD's WebTranslator](https://translator.openttd.org/).
+
+- Registered translators translate from English to their language.
+- Eints validates the translations syntactically and that parameter usage matches the English base language.
+- Eints synchronises translations to OpenTTD's repository every day, shortly before the nightly build.
+
+When adding or altering strings in english.txt, you should stick to some rules, so translations are handled smoothly by Eints and translators.
+This document gives some guidelines.
+
+
+## I want to change a translation.
+
+### I want to become a regular translator.
+
+Just [sign up](https://github.com/OpenTTD/team/issues/new/choose) as a translator.
+
+### I only want to point out some issues / typos in the current translation, or suggest a change.
+
+[Open an issue](https://github.com/OpenTTD/OpenTTD/issues/new/choose), so it can be assigned to the translation team of the language.
+The translators will decide whether, where and how to apply your suggestion.
+
+### I want to submit translations via PR.
+
+Sorry, we don't offer this option.
+
+### I want to change the language definition (plural form, genders, cases) of a translation.
+
+Please [create an issue](https://github.com/OpenTTD/OpenTTD/issues/new/choose) for this.
+
+### I want to add an entirely new translation language.
+
+OpenTTD has more than 4000 strings, translating all of them is a lot of work.
+Despite the initial enthusiasm, only few people have the endurance to get to even 20% translation progress.
+
+As such, starting a new translation requires the prospect that there is also translation interest in the future.
+And, frankly, OpenTTD probably already covers all languages to which this applies, and a few more.
+
+If you still want to make the case, that your language is spoken by several 100 million people, please [create an issue](https://github.com/OpenTTD/OpenTTD/issues/new/choose) for adding a new language.
+
+
+## I want to change the English base language (english.txt).
+
+### I want to change the wording / fix a typo in an English string, without changing the meaning (drastically).
+
+Just change it in your PR.
+
+Translators will be notified that their translation became "outdated", so they can double-check whether the translation needs updating.
+
+### I want to add/change/remove parameters from an English string.
+
+Just change the parameters in english.txt in your PR.
+Don't touch the translations, please ignore compile warnings about them.
+
+Translators will be notified that their translation became "invalid", so they can adjust the translation.
+Eints will remember the old translations for translators to view, but remove them from the git repository, while they are "invalid"; so there won't be any compile warnings after the nightly sync.
+
+### I want to change the meaning of an English string, so that no existing translation makes any sense anymore.
+
+In this case, please change the STR_xxx string identifier of the string; basically: remove the old string, add a new one.
+Don't touch the translations, please ignore compile warnings about them.
+
+Eints will discard all memory of the old strings in the nightly sync, and translators can start fresh with a new string.
+
+### I want to add a new string.
+
+Add the new string somewhere in english.txt, where it fits with the neighbouring strings.
+Don't touch the translations, even if you can speak some of the languages.
+
+### I want to remove an unused string.
+
+Remove the string from english.txt.
+Don't touch the translations, please ignore compile warnings about them.
+
+Eints will remove the translations from the git repository in the nightly sync.
+
+### I want to reorder strings in english.txt without changing them.
+
+Reorder english.txt as you like. Don't touch the translations.
+
+Eints will reorder all translations to match english.txt in the nightly sync.
+
+### I want to add/change '#' comments.
+
+Change comments in english.txt as you like. Don't touch the translations.
+
+Eints will replicate comments into all translations in the nightly sync. Comments are not translated.
+
+### I want to change the STR_xxx string identifier for code style reasons, without changing the English text.
+
+This is the only case, where your PR should also edit translations.
+The STR_xxx string identifier is used by Eints as key value to track strings and translations. If you change it, that's the same as deleting a string and adding an unrelated new one.
+So, to keep translations, you have to replace the STR_xxx for all translations in the PR as well.
+
+However, you will only be able to keep the translations which are part of the git repository.
+Translation history and information about translations being "outdated" will be lost.
+So, keep your code style OCD to a minimum :)
+
+
+## I want to fight a bot and lose.
+
+Here are some things, people sometimes want to do, but which won't work.
+
+### I want to enforce re-translation by clearing current translations.
+
+You have to change the STR_xxx string identifier, that's the only option.
+
+You cannot "clear" translations by removing them via PR; eints will reinstall the previous "syntactically perfect valid" translation.
+
+### I want to revert a broken change, some translator just did via eints.
+
+You have to revert the translations via the WebTranslator interface.
+If there are many changes, ask someone with Admin access to eints, so they can manually upload a fixed translation file to eints.
+
+You cannot revert translations changes via PR. Eints merges translations from git and from web by keeping a translation history, and committing the newest translation to git.
+If you revert to an old translation in git, eints will simply think git did not yet get the newer translation, and commit it again.

docs/game_coordinator.md

@@ -0,0 +1,83 @@
+# Game Coordinator
+
+To allow two players to play together, OpenTTD uses a Game Coordinator to
+facilitate this.
+
+When a server starts, it can register itself to the Game Coordinator. This
+happens when `server_game_type` is set to either `invite-only` or `public`.
+Upon registration, the Game Coordinator probes the network of the server, and
+assigns the server an unique code, called an `invite code`.
+
+When a client wants to join a server, it asks the Game Coordinator to help
+with this by giving it the `invite code` of the server. The Game Coordinator
+will, in this order, attempt several ways to connect the client and server
+together:
+
+## 1) Via direct IPv4 / IPv6
+
+Upon registration, the Game Coordinator probes the server to see if a
+direction connection to the server is possible based on the game port. It
+tries this over the public IPv4 and IPv6, as announced by the server.
+If either (or both) are successful, a client will always be asked to try
+these direct IPs first when it wants to connect to this server.
+
+- If the server is IPv4 only, the client is only asked to connect via IPv4.
+- If the server is IPv6 only, the client is only asked to connect via IPv6.
+- If the server is both IPv4 and IPv6, the client is asked to connect to to
+  one of those first. If that fails, it is asked to connect to the other.
+  Whether it tries IPv4 or IPv6 first, strongly depends on several network
+  infrastructure related events. The biggest influence is the network
+  latency over both protocols to the OpenTTD infrastructure.
+
+In the end, if either the server is not reachable directly from the Internet
+or the client fails to connect to either one of them, the connection attempt
+continues with the next available method.
+
+## 2) Via STUN
+
+When a client wants to join a server via STUN, both the client and server
+are asked to create a connection to the STUN server (normally
+`stun.openttd.org`) via both IPv4 and IPv6. If the client or server has no
+IPv4 or IPv6, it will not make a connection attempt via that protocol.
+
+The STUN server collects the public IPv4 and/or IPv6 of the client and server,
+together with the port the connection came in from. For most NAT gateways it
+holds true that as long as you use the same local IP + port, your public
+IP + port will remain the same, and allow for bi-directional communication.
+And this fact is used to later on pair the client and server.
+
+The STUN server reports this information directly to the Game Coordinator
+(this in contrast to most STUN implementation, where this information is
+first reported back to the peer itself, which has to relay it back to the
+coordinator. OpenTTD skips this step, as the STUN server can directly talk to
+the Game Coordinator). When the Game Coordinator sees a matching pair (in
+terms of IPv4 / IPv6), it will ask both the client and server to connect to
+their peer based on this public IP + port.
+
+As the NAT gateway forwards the traffic on the public IP + port to the local
+port, this creates a bi-directional socket between client and server. The
+connection to the STUN server can now safely be closed, and the client and
+server can continue to talk to each other.
+
+Some NAT gateways do not allow this method; for those this attempt will fail,
+and this also means that it is not possible to create a connection between
+the client and server.
+
+## 3) Via TURN
+
+As a last resort, the Game Coordinator can decide to connect the client and
+server together via TURN. TURN is a relay service, relaying the messages
+between client and server.
+
+As the client and server can already connect to the Game Coordinator, it is
+very likely this is successful.
+
+It is important to note that a relay service has full view of the traffic
+send between client and server, and as such it is important that you trust
+the relay service used.
+For official binaries, this relay service is hosted by openttd.org. The relay
+service as hosted by openttd.org only validates it is relaying valid OpenTTD
+packets and does no further inspection of the payload itself.
+Although in our experience most patch-packs also use the services as offered
+by openttd.org, it is possible they use different services. Please be mindful
+about this.

docs/landscape_grid.html

@@ -5,10 +5,14 @@
   <meta name="Description" content="Structure of OpenTTD (OTTD) landscape arrays #2">
   <title>OpenTTD Landscape Internals - #2</title>
   <style type="text/css">
-    span.abuse { font-family: "Courier New", Courier, mono; background-color: rgb(255, 58, 31); }
-    span.option{ font-family: "Courier New", Courier, mono; background-color: rgb(255,255, 30); }
-    span.free  { font-family: "Courier New", Courier, mono; background-color: rgb(30, 178, 54); }
-    span.used  { font-family: "Courier New", Courier, mono; }
+    span.free     { font-family: "Courier New", Courier, mono; background-color: rgb( 70, 190,  70); }
+    span.usable   { font-family: "Courier New", Courier, mono; background-color: rgb( 50, 150, 150); }
+    span.used     { font-family: "Courier New", Courier, mono; background-color: rgb(120, 120, 255); }
+    span.pool     { font-family: "Courier New", Courier, mono; background-color: rgb(220, 120, 255); }
+    span.patch    { font-family: "Courier New", Courier, mono; background-color: rgb(255, 165,   0); }
+    span.abuse    { font-family: "Courier New", Courier, mono; background-color: rgb(255, 100, 100); }
+    span.rearrange{ font-family: "Courier New", Courier, mono; background-color: rgb(160, 160, 255); }
+
     td.bits    { white-space: nowrap; text-align: center; font-family: "Courier New", Courier, mono; }
     td.caption { white-space: nowrap; text-align: left; }
     td li      { white-space: nowrap; text-align: left; }
@@ -20,13 +24,7 @@
 <span style="font-weight: bold;"></span>Nine attributes hold the information about a tile.
 This can be seen in the <a href="landscape.html">Landscape</a> document. This page tries to give an overview of used and free bits of
 the array so you can quickly see what is used and what is not.
-<ul>
-  <li><span style="font-weight: bold;"><span class="free">O</span></span> - bit is free</li>
-  <li><span style="font-weight: bold;"><span class="used">X</span></span> - bit is used</li>
-  <li><span style="font-weight: bold;"><span class="abuse">&nbsp;</span></span> - bit of attribute is abused for different purposes, i.e. other bits define the actual meaning.</li>
-  <li><span style="font-weight: bold;"><span class="option">~</span></span> - bit is accessed, but does not really have a meaning (e.g. owner of clear land is always OWNER_NONE)</li>
-</ul>
-<p>
+
 <ul>
   <li><span style="font-weight: bold;">type</span> - 8 bits in size, tile class (bits 4..7), bridge (bits 2..3) tropic zone (bits 0..1, only valid in tropic climate)</li>
   <li><span style="font-weight: bold;">height</span> - 8 bits in size, stores tile height</li>
@@ -39,6 +37,16 @@ the array so you can quickly see what is used and what is not.
   <li><span style="font-weight: bold;">m7</span> - 8 bits in size, is used for general storage</li>
   <li><span style="font-weight: bold;">m8</span> - 16 bits in size, is used for general storage</li>
 </ul>
+<p>
+<ul>
+  <li><span style="font-weight: bold;"><span class="free">O</span></span> - bit is free</li>
+  <li><span style="font-weight: bold;"><span class="usable">X</span></span> - bit is used, but could be freed if needed</li>
+  <li><span style="font-weight: bold;"><span class="used">X</span></span> - bit is used</li>
+  <li><span style="font-weight: bold;"><span class="pool">X</span></span> - bit is used for an index on a pool</li>
+  <li><span style="font-weight: bold;"><span class="patch">X</span></span> - bit is introduced by a patch</li>
+  <li><span style="font-weight: bold;"><span class="abuse">X</span></span> - bit of attribute is abused for different purposes, i.e. other bits define the actual meaning</li>
+  <li><span style="font-weight: bold;"><span class="rearrange">X</span></span> - bit is accessed, but a rearrangement of the map array could free some of these bits (probably not done for bit alignment)</li>
+</ul>
 
 <table align=center border="1" cellpadding="2" cellspacing="2">
   <tbody>
@@ -71,134 +79,103 @@ 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">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOO</span><span class="option">~ ~~~~</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
-      <td class="bits">XXXX XX<span class="free">OO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOO</span>X XX<span class="free">OO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></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=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>
+      <td class="bits" rowspan=2><span class="used" title="Type of hedge on SW border">XXX</span> <span class="used" title="Type of hedge on SE border">XXX</span><span class="free">OO</span></td>
+      <td class="bits" rowspan=2><span class="used" title="Update counter">XXX</span> <span class="used" title="Type: grass, rough land, rocks, fields, snow, desert">XXX</span> <span class="used" title="Density">XX</span></td><td class="bits" rowspan=2><span class="free" >OOO</span><span class="used" title="Type of hedge on NW border">X XX</span><span class="free">OO</span></td>
+      <td class="bits" rowspan=2><span class="free">OOOO OOOO</span></td>
+      <td class="bits" rowspan=2><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">farmland</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XXXX XXXX XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOO</span>X XX<span class="free">OO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
+      <td class="bits"><span class="pool" title="Industry index on pool">XXXX XXXX XXXX XXXX</span></td>
+      <td class="bits"><span class="used" title="Type of hedge on NE border">XXX</span> <span class="used" title="Field production stage">XXXXX</span></td>
     </tr>
     <tr>
       <td rowspan=3>1</td>
       <td class="caption">rail</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">X<span class="free">OO</span>X XXXX</td>
-      <td class="bits"><span class="free">OOOO</span> XXXX <span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO</span> XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OO</span>XX XXXX</td>
+      <td class="bits" rowspan=3><span class="used" title="Ship docking tile status (for half-tile with water)">X</span><span class="free">OO</span><span class="used" title="Owner">X XXXX</span></td>
+      <td class="bits"><span class="free">OOOO</span> <span class="used" title="Reserved tracks">XXXX</span> <span class="free">OOOO OOOO</span></td>
+      <td class="bits"><span class="free">OOOO OOOO</span> </td>
+      <td class="bits"><span class="free">OOOO</span> <span class="used" title="Ground type: fences, snow, desert">XXXX</span></td>
+      <td class="bits"><span class="used" title="Rail tile type: rail, rail with signals, depot">OO</span> <span class="used" title="Track pieces">XXXXXX</span></td>
+      <td class="bits" rowspan=3><span class="free">OOOO OOOO</span></td>
+      <td class="bits" rowspan=3><span class="free">OOOO OOOO</span></td>
+      <td class="bits" rowspan=3><span class="free">OOOO OOOO OO</span><span class="used" title="Railway type">XX XXXX</span></td>
     </tr>
     <tr>
       <td class="caption">rail with signals</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO</span> XXXX XXXX XXXX</td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits">-inherit-</td>
+      <td class="bits"><span class="free">OOOO</span> <span class="used" title="Reserved tracks">XXXX</span> <span class="used" title="Signal types and sempahore/lights">XXXX XXXX</span></td>
+      <td class="bits"><span class="used" title="Signals present">XXXX</span> <span class="free">OOOO</span></td>
+      <td class="bits"><span class="used" title="Signals colors">XXXX</span> <span class="used" title="Ground type: fences, snow, desert">XXXX</span></td>
+      <td class="bits"><span class="used" title="Rail tile type: rail, rail with signals, depot">O1</span> <span class="used" title="Track pieces">XXXXXX</span></td>
     </tr>
     <tr>
       <td class="caption">depot</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XXXX XXXX XXXX XXXX</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO</span> XXXX</td>
-      <td class="bits">XX<span class="free">O</span>X <span class="free">OO</span>XX</td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits">-inherit-</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</span> <span class="free">OOOO</span></td>
+      <td class="bits"><span class="free">OOOO</span> <span class="used" title="Ground type: fences, snow, desert (fences on depot are not valid)">XXXX</span></td>
+      <td class="bits"><span class="used" title="Rail tile type: rail, rail with signals, depot">11</span><span class="free">O</span><span class="used" title="PBS reservation">X</span> <span class="free">OO</span><span class="used" title="Depot exit direction">XX</span></td>
     </tr>
     <tr>
       <td rowspan=3>2</td>
       <td class="caption">road</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOO</span>X XXXX</td>
-      <td class="bits">XXXX XXXX XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
-      <td class="bits"><span class="free">OO</span>X<span class="free">O</span> XXXX</td>
-      <td class="bits"><span class="free">OOOO</span> XXXX XX<span class="free">OO OOOO</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="pool" title="Town index on pool">XXXX XXXX XXXX XXXX</span></td>
+      <td class="bits"><span class="used" title="Owner of tram">XXXX</span> <span class="used" title="Tram pieces">XXXX</span></td>
+      <td class="bits" rowspan=3><span class="free">OO</span><span class="used" title="Road type">XX XXXX</span></td>
+      <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>
     </tr>
     <tr>
       <td class="caption">level crossing</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits">XXXX <span class="free">OOO</span>X</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
-      <td class="bits"><span class="free">OO</span>XX XXXX</td>
-      <td class="bits"><span class="free">OOOO</span> XXXX XXXX XXXX</td>
+      <td class="bits"><span class="free">OOO</span><span class="used" title="Owner of rail track">X XXXX</span></td>
+      <td class="bits"><span class="used" title="Owner of tram">XXXX</span> <span class="free">OOOO</span></td>
+      <td class="bits"><span class="used" title="Tile type: simple road (00), level crossing (01), road depot (10)">O1</span> <span class="used" title="Lights are on">X</span> <span class="used" title="PBS reservation">X</span><span class="free">OOO</span><span class="used" title="Direction of the rail and roads">X</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="used" title="Owner of road">XXXXX</span></td>
+      <td class="bits" rowspan=1><span class="free">OOOO</span> <span class="used" title="Tram type">XXXX XX</span> <span class="used" title="Railway type">XXXXXX</span></td>
     </tr>
     <tr>
       <td class="caption">road depot</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOO</span><span class="used" title="Owner of the depot">X XXXX</span></td>
+      <td class="bits"><span class="pool" title="Depot index on pool">XXXX XXXX XXXX XXXX</span></td>
+      <td class="bits"><span class="usable" title="Owner of tram depot">XXXX</span> <span class="free">OOOO</span></td>
+      <td class="bits"><span class="used" title="Tile type: simple road (00), level crossing (01), road depot (10)">1O</span><span class="free">OO OO</span><span class="used" title="Depot exit direction">XX</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OO</span>X<span class="free">O</span> XXXX</td>
-      <td class="bits">-inherit-</td>
+      <td class="bits"><span class="free">OO</span><span class="used" title="Snow/desert present">X</span> <span class="usable" title="Owner of road depot">XXXXX</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>3</td>
-      <td class="caption">house</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX XXXX XXXX</td>
-      <td class="bits">XX<span class="free">O</span><span class="option">~ ~~</span>XX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXX<span class="abuse">X XXXX</span></td>
-      <td class="bits"><span class="abuse">XXXX XX</span><span class="free">OO</span></td>
-      <td class="bits">XXXX <span class="abuse">XXXX</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
+      <td rowspan=2>3</td>
+      <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="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="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>
+    </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>
     </tr>
     <tr>
       <td>4</td>
       <td class="caption">trees</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">O</span>XX<span class="option">~ ~~~~</span></td>
-      <td class="bits"><span class="free">OOOO OOO</span>X XXXX XXXX</td>
-      <td class="bits"><span class="option">~~</span>XX XXXX</td>
+      <td class="bits"><span class="free">O</span><span class="used" title="Water class">XX</span><span class="usable" title="Owner (always OWNER_NONE)">1 OOOO</span></td>
+      <td class="bits"><span class="free">OOOO OOO</span><span class="used" title="Tree ground">XXX</span> <span class="used" title="Tree density">XX</span> <span class="used" title="Tree counter">XXXX</span></td>
+      <td class="bits"><span class="usable" title="Tree type unused bits">XX</span><span class="used" title="Tree type">XX XXXX</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits">XX<span class="free">OO O</span>XXX</td>
+      <td class="bits"><span class="used" title="Number of trees on tile (+1)">XX</span><span class="free">OO O</span><span class="used" title="Tree growth">XXX</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
@@ -206,189 +183,155 @@ the array so you can quickly see what is used and what is not.
     <tr>
       <td rowspan=7>5</td>
       <td class="caption">rail station</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX XXXX XXXX</td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX XX<span class="free">OO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO OO</span>XX XXXX</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=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="free">OO</span><span class="used" title="Station type">XXX</span> <span class="used" title="Reserved track">X</span><span class="free">OO</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>
     <tr>
       <td class="caption">rail waypoint</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
+      <td class="bits"><span class="usable" title="Graphics index">OOOO OOO</span><span class="used" title="Graphics index">X</span></td>
     </tr>
     <tr>
       <td class="caption">road stop</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
-      <td class="bits"><span class="free">OO</span>XX XXXX</td>
-      <td class="bits"><span class="option">~~~~ ~</span>XXX</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
-      <td class="bits"><span class="free">OOO</span>X XXXX</td>
-      <td class="bits"><span class="free">OOOO</span> XXXX XX<span class="free">OO OOOO</span></td>
-    </tr>
-    <tr>
-      <td class="caption">dock</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="option">~~~~ ~</span>XXX</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></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"><span class="free">OOOO</span> <span class="used" title="Tram type">XXXX XX<span class="free">OO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">airport</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
+      <td class="bits"><span class="used" title="Random bits">XXXX</span> <span class="free">OOOO</span></td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
+      <td class="bits"><span class="used" title="Graphics index">XXXX XXXX</span></td>
+      <td class="bits"><span class="used" title="Animation frame">XXXX XXXX</span></td>
+      <td class="bits" rowspan=4><span class="free">OOOO OOOO OOOO OOOO</span></td>
+    </tr>
+    <tr>
+      <td class="caption">dock</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
+      <td class="bits"><span class="usable" title="Graphics index">OOOO </span><span class="usable" title="Graphics index">O</span><span class="used" title="Graphics index">XXX</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">buoy</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="option">~~~~ ~~~~</span></td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
+      <td class="bits"><span class="usable">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">oilrig</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="option">~~~~ ~~~~</span></td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
+      <td class="bits"><span class="usable">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
     <tr>
-      <td rowspan=3>6</td>
+      <td rowspan=4>6</td>
       <td class="caption">sea, shore</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></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="free">OOOO OOOO</span></td>
-      <td class="bits">X<span class="option">~~</span>X XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
+      <td class="bits"><span class="used" title="Water tile type: coast, clear, lock, depot">O<span class="usable">OO</span>O</span> <span class="free">OOO</span><span class="used" title="Sea shore flag">X</span></td>
+      <td class="bits" rowspan=4><span class="free">OOOO OOOO</span></td>
+      <td class="bits" rowspan=4><span class="free">OOOO OOOO</td>
+      <td class="bits" rowspan=4><span class="free">OOOO OOOO OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">canal, river</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></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>
+    </tr>
+    <tr>
+      <td class="caption">lock</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO 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>
     </tr>
     <tr>
       <td class="caption">shipdepot</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">XXXX XXXX XXXX XXXX</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="free">OOOO OOOO</span></td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OOOO OOOO 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>
     </tr>
     <tr>
-      <td>8</td>
-      <td class="caption">industry</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXX<span class="free">O</span> <span class="abuse">XXXX</span></td>
-      <td class="bits">XXXX XXXX XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX XX<span class="free">OO</span></td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
+      <td rowspan=2>8</td>
+      <td class="caption">finished industry</td>
+      <td class="bits"><span class="used" title="Completed industry">1</span> <span class="used" title="Water class">XX</span><span class="free">O</span> <span class="free">OOOO</span></td>
+      <td class="bits" rowspan=2><span class="pool" title="Industry index on pool">XXXX XXXX XXXX XXXX</span></td>
+      <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="used" title="Animation frame">XXXX XXXX</span></td>
+      <td class="bits" rowspan=2><span class="free">OOOO OOOO OOOO OOOO</span></td>
+    </tr>
+    <tr>
+      <td class="caption">industry under construction</td>
+      <td class="bits"><span class="used" title="Completed industry">O</span> <span class="used" title="Water class">XX</span><span class="free">O</span> <span class="used" title="If under construction, construction counter and stage of construction">XXXX</span></td>
     </tr>
     <tr>
       <td rowspan=2>9</td>
       <td class="caption">tunnel entrance</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">X<span class="free">OO</span>X XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
-      <td class="bits">XXXX <span class="free">OOOO</span></td>
-      <td class="bits"><span class="free">OO</span>XX XXXX</td>
-      <td class="bits">X<span class="free">OO</span>X XXXX</td>
+      <td class="bits" rowspan=2><span class="used" title="Ship docking tile status (for aqueducts)">X</span><span class="free">OO</span> <span class="used" title="Owner">XXXXX</span></td>
+      <td class="bits" rowspan=2><span class="free">OOOO OOOO OOOO OOOO</span></td>
+      <td class="bits" rowspan=2><span class="rearrange" title="Owner of tram (road only; a rearrangement can free some of these bits)">XXXX</span> <span class="free">OOOO</span></td>
+      <td class="bits" rowspan=2><span class="free">OO</span><span class="used" title="Road type">XX XXXX</span></td>
+      <td class="bits"><span class="used" title="Bridge or tunnel bit">O</span><span class="free">OO</span><span class="rearrange" title="PBS reservation (rail; a rearrangement can free some of these bits)">X</span> <span class="used" title="Transport type">XX</span> <span class="used" title="Direction of the tunnel/bridge">XX</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
-      <td class="bits"><span class="free">OO</span>XX XXXX</td>
-      <td class="bits"><span class="free">OOOO</span> XXXX XXXX XXXX</td>
+      <td class="bits" rowspan=2><span class="free">OO</span><span class="used" title="Snow/desert present">X</span><span class="rearrange" title="Owner of road (road only; a rearrangement can free some of these bits)">X XXXX</span></td>
+      <td class="bits" rowspan=2><span class="free">OOOO</span> <span class="used" title="Tram type">XXXX XX</span><span class="rearrange" title="Railway type (rail only; a rearrangement can free some of these bits)">XX XXXX</span></td>
     </tr>
     <tr>
       <td>bridge ramp</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
-      <td class="bits"><span class="free">OO</span>XX XX<span class="free">OO</span></td>
-      <td class="bits">-inherit-</td>
-      <td class="bits">-inherit-</td>
+      <td class="bits"><span class="used" title="Bridge or tunnel bit">1</span><span class="free">OO</span><span class="rearrange" title="PBS reservation (rail; a rearrangement can free some of these bits)">X</span> <span class="used" title="Transport type">XX</span> <span class="used" title="Direction of the tunnel/bridge">XX</span></td>
+      <td class="bits"><span class="free">OO</span><span class="used" title="Bridge type: wooden, steel,...">XX XX</span><span class="free">OO</span></td>
     </tr>
     <tr>
-      <td rowspan=2>A</td>
+      <td>A</td>
       <td class="caption">objects</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">O</span>XXX XXXX</td>
-      <td class="bits">XXXX XXXX XXXX XXXX</td>
-      <td class="bits">XXXX XXXX</td>
+      <td class="bits"><span class="free">O</span><span class="used" title="Water class">XX</span> <span class="used" title="Owner">XXXXX</span></td>
+      <td class="bits"><span class="pool" title="Object index on pool (m2 + m5)">XXXX XXXX XXXX XXXX</span></td>
+      <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">XXXX XXXX</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">XXXX XXXX</td>
-      <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</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>
+    <tr>
+      <td colspan=2 class="caption">bits</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">FEDC BA98 7654 3210</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">7654 3210</td>
+      <td class="bits">FEDC BA98 7654 3210</td>
+    </tr>
+    <tr>
+      <th colspan=2>class</th>
+      <th>type (8)</th>
+      <th>height (8)</th>
+      <th>m1 (8)</th>
+      <th>m2 (16)</th>
+      <th>m3 (8)</th>
+      <th>m4 (8)</th>
+      <th>m5 (8)</th>
+      <th>m6 (8)</th>
+      <th>m7 (8)</th>
+      <th>m8 (16)</th>
     </tr>
   </tbody>
 </table>

docs/multiplayer.md

@@ -1,213 +1,207 @@
 # Multiplayer manual for OpenTTD
 
-Last updated:    2011-02-16
-
-
 ## Table of contents
 
 - 1.0) [Starting a server](#10-starting-a-server)
 - 2.0) [Connecting to a server](#20-connecting-to-a-server)
-    - 2.1) [Connecting to a server over the console](#21-connecting-to-a-server-over-the-console)
+  - 2.1) [Connecting to a server over the console](#21-connecting-to-a-server-over-the-console)
 - 3.0) [Playing internet games](#30-playing-internet-games)
 - 4.0) [Tips for servers](#40-tips-for-servers)
-    - 4.1)[Imposing landscaping limits](#41-imposing-landscaping-limits)
+  - 4.1)[Imposing landscaping limits](#41-imposing-landscaping-limits)
 - 5.0) [Some useful things](#50-some-useful-things)
 - 6.0) [Troubleshooting](#60-troubleshooting)
 
 
 ## 1.0) Starting a server
 
- - Make sure that you have your firewall of the computer as well as possible
-   routers or modems of the server configured such that:
-    - port 3979 is free for both UDP and TCP connections in- and outgoing
-    - port 3978 is free outbound for UDP in order to advertise with the master
-     server (if desired). Otherwise you'll have to tell players your IP.
-    - port 3977 if use of the admin interface is desired (see admin_network.txt)
- - Click "multiplayer" on the startup screen
- - Click "start server"
- - Type in a game name
- - Select the type of game ('LAN/Internet' or 'Internet (advertise)'. With the
-   last one other people are able to see you online. Else they need your IP and
-   port to join)
- - Click "start game", "load game" or "load scenario"
- - Start playing
-
+- Click on "Multiplayer" in the Start Menu.
+- Click on "Start Server".
+- Give your server a name.
+- Select the visibility of your server:
+  - "Public": your server will be publicly listed.
+  - "Invite Only": only players who have the invite code for your server can
+    join.
+  - "Local": only players on your local network can join.
+- (optional) Set a password for your server.
+- Click "New Game", "Load Game", or "Play Scenario".
+- Start playing.
 
 ## 2.0) Connecting to a server
 
- - Click "multiplayer" on the startup screen
- - If you want to connect to any network game in your LAN click on 'LAN', then
-   on 'Find Server'
- - If you want to see which servers all online on the Internet, click on
-   'Internet' and 'Find Server'
- - If there were more than one server
-    - select one in the list below the buttons
-    - click on 'join game'
- - If you want to play and you have the ip or hostname of the game server you
-   want connect to.
-    - click add server
-    - type in the ip address or hostname
-    - if you want to add a port use :<port>
- - Now you can select a company and press: "Join company", to help that company
-    - Or you can press "Spectate game", to spectate the game
-    - Or you can press "New company", and start your own company (if there are
-   slots free)
- - You see a progressbar how far you are with joining the server.
- - Happy playing
+- Click on "Multiplayer" in the Start Menu.
+- There are three ways to join a server:
+  - If you want to connect to a local server, click "Search LAN".
+  - If you want to connect to a public game, click "Search internet".
+  - If the server-owner shared an invite code with you:
+    - Click "Add Server".
+    - Fill in the invite code, which always starts with a `+`.
+    - Click "OK".
+- Click on the server you want to join.
+- Click "Join Game".
+- If the server has a password, it will ask you for this.
+- You see a progressbar how far you are with joining the server.
+- Happy playing.
 
 ## 2.1) Connecting to a server over the console
 
- - Open the console and type in the following command:
-    connect `<ip/host>:<port>#<company-no>`
-
+- Open the console and type `connect` for help how to connect via the console.
 
 ## 3.0) Playing internet games
 
- - Servers with a red dot behind it have a different version then you have. You
-   will not be able to join those servers.
+- Servers with a red dot behind it have a different version then you have. You
+  will not be able to join those servers.
 
- - Servers with a yellow dot behind it have NewGRFs that you do not have. You
-   will not be able to join those servers. However, via "NewGRF Settings" and
-   "Find missing content online" you might be able to download the needed
-   NewGRFs after which you can join the server.
+- Servers with a yellow dot behind it have NewGRFs that you do not have. You
+  will not be able to join those servers. However, via "NewGRF Settings" and
+  "Find missing content online" you might be able to download the needed
+  NewGRFs after which you can join the server.
 
- - It can happen that a connection is that slow, or you have that many clients
-   connected to your server, that your clients start to loose their connection.
-   Some things you can do about it:
-   - [network] frame_freq:
-     change it in console with: 'set network.frame_freq <number>'
-     the number should be between the 0 and 10, not much higher. It indicates
-     the delay between clicking and showing up. The higher, the more you notice
-     it, but the less bandwidth you use.
-     A good value for Internet-games is 2 or 3.
+- It can happen that a connection is that slow, or you have that many clients
+  connected to your server, that your clients start to loose their connection.
+  Some things you can do about it:
+  - `[network] frame_freq`:
+    change it in console with: `set network.frame_freq <number>`
+    the number should be between the 0 and 10, not much higher. It indicates
+    the delay between clicking and showing up. The higher, the more you notice
+    it, but the less bandwidth you use.
+    A good value for Internet-games is 2 or 3.
 
-   - [network] sync_freq:
-     change it in console with: 'set network.sync_freq <number>'
-     the number should be between the 50 and 1000, not much lower, not much
-     higher. It indicates the time between sync-frames. A sync-frame is a frame
-     which checks if all clients are still in sync. When the value it too high,
-     clients can desync in 1960, but the server detects it in 1970. Not really
-     handy. The lower the value, the more bandwidth it uses.
-
-   NB: changing frame_freq has more effect on the bandwidth then sync_freq.
+  - `[network] sync_freq`:
+    change it in console with: `set network.sync_freq <number>`
+    the number should be between the 50 and 1000, not much lower, not much
+    higher. It indicates the time between sync-frames. A sync-frame is a frame
+    which checks if all clients are still in sync. When the value it too high,
+    clients can desync in 1960, but the server detects it in 1970. Not really
+    handy. The lower the value, the more bandwidth it uses.
 
+   NB: changing `frame_freq` has more effect on the bandwidth then `sync_freq`.
 
 ## 4.0) Tips for servers
 
- - You can launch a dedicated server by adding -D as parameter.
- - In UNIX like systems, you can fork your dedicated server by adding -f as
-   parameter.
+- You can launch a dedicated server by adding `-D` as parameter.
+- In UNIX like systems, you can fork your dedicated server by adding `-f` as
+  parameter.
 
- - You can automatically clean companies that do not have a client connected to
-   them, for, let's say, 3 years. You can do this via: 'set autoclean_companies'
-   and 'set autoclean_protected' and 'set autoclean_unprotected'. Unprotected
-   removes a password from a company when it is not used for more then the
-   defined amount of months. 'set autoclean_novehicles' can be used to remove
-   companies without any vehicles quickly.
+- You can automatically clean companies that do not have a client connected to
+  them, for, let's say, 3 years. You can do this via: `set autoclean_companies`
+  and `set autoclean_protected` and `set autoclean_unprotected`. Unprotected
+  removes a password from a company when it is not used for more then the
+  defined amount of months. `set autoclean_novehicles` can be used to remove
+  companies without any vehicles quickly.
 
- - You can also do this manually via the console: 'reset_company'.
+- You can also do this manually via the console: `reset_company`.
 
- - You can let your server automatically restart a map when, let's say, year 2030
-   is reached. See 'set restart_game_date' for detail.
+- You can let your server automatically restart a map when, let's say,
+  year 2030 is reached. See `set restart_game_date` for detail.
 
- - If you want to be on the server-list, enable Advertising. To do this, select
-   'Internet (advertise)' in the Start Server menu, or type in console:
-   'set server_advertise 1'.
+- If you want to be on the server-list, make your server public. You can do
+  this either from the Start Server window, via the in-game Online Players
+  window, or by typing in the console: `set server_game_type public`.
 
- - You can protect your server with a password via the console: 'set server_pw',
-   or via the Start Server menu.
+- You can protect your server with a password via the console: `set server_pw`,
+  or via the Start Server menu.
 
- - When you have many clients connected to your server via Internet, watch your
-   bandwidth (if you have any limit on it, set by your ISP). One client uses
-   about 1.5 kilobytes per second up and down. To decrease this amount, setting
-   'frame_freq' to 1 will reduce it to roughly 1 kilobyte per second per client.
+- When you have many clients connected to your server via Internet, watch your
+  bandwidth (if you have any limit on it, set by your ISP). One client uses
+  about 1.5 kilobytes per second up and down. To decrease this amount, setting
+  `frame_freq` to 1 will reduce it to roughly 1 kilobyte per second per client.
 
- - OpenTTD's default settings for maximum number of clients, and amount of data
-   from clients to process are chosen to not influence the normal playing of
-   people, but to prevent or at least make it less likely that someone can
-   perform a (distributed) denial-of-service attack on your server by causing
-   an out-of-memory event by flooding the server with data to send to all
-   clients. The major factor in this is the maximum number of clients; with
-   32 clients "only" sending one chat message causes 1024 messages to be
-   distributed in total, with 64 clients that already quadruples to 4096. Given
-   that upstream bandwidth is usually the limiting factor, a queue of packets
-   that need to be sent will be created.
-   To prevent clients from exploiting this "explosion" of packets to send we
-   limit the number of incoming data, resulting in effectively limiting the
-   amount of data that OpenTTD will send to the clients. Even with the default
-   limits it is possible to generate about 70.000 packets per second, or about
-   7 megabit per second of traffic.
-   Given that OpenTTD kicks clients after they have not reacted within about 9
-   seconds from sending a frame update packet it would be possible that OpenTTD
-   keeps about 600.000 packets in memory, using about 50 megabytes of memory.
-   Given that OpenTTD allows short bursts of packets, you can have slightly
-   more packets in memory in case of a distributed denial of service attack.
-   When increasing the amount of incoming data, or the maximum number of
-   clients the amount of memory OpenTTD needs in case of a distributed denial
-   of service attack is linearly related to the amount of incoming data and
-   quadratic to the amount of clients. In short, a rule of thumb for, the
-   maximum memory usage for packets is:
-       #max_clients * #max_clients * bytes_per_frame * 10 KiB.
+- OpenTTD's default settings for maximum number of clients, and amount of data
+  from clients to process are chosen to not influence the normal playing of
+  people, but to prevent or at least make it less likely that someone can
+  perform a (distributed) denial-of-service attack on your server by causing
+  an out-of-memory event by flooding the server with data to send to all
+  clients. The major factor in this is the maximum number of clients; with
+  32 clients "only" sending one chat message causes 1024 messages to be
+  distributed in total, with 64 clients that already quadruples to 4096. Given
+  that upstream bandwidth is usually the limiting factor, a queue of packets
+  that need to be sent will be created.
+  To prevent clients from exploiting this "explosion" of packets to send we
+  limit the number of incoming data, resulting in effectively limiting the
+  amount of data that OpenTTD will send to the clients. Even with the default
+  limits it is possible to generate about 70.000 packets per second, or about
+  7 megabit per second of traffic.
+  Given that OpenTTD kicks clients after they have not reacted within about 9
+  seconds from sending a frame update packet it would be possible that OpenTTD
+  keeps about 600.000 packets in memory, using about 50 megabytes of memory.
+  Given that OpenTTD allows short bursts of packets, you can have slightly
+  more packets in memory in case of a distributed denial of service attack.
+  When increasing the amount of incoming data, or the maximum number of
+  clients the amount of memory OpenTTD needs in case of a distributed denial
+  of service attack is linearly related to the amount of incoming data and
+  quadratic to the amount of clients. In short, a rule of thumb for, the
+  maximum memory usage for packets is:
+  `#max_clients * #max_clients * bytes_per_frame * 10 KiB`.
 
 ### 4.1) Imposing landscaping limits
 
- - You can impose limits on companies by the following 4 settings:
-   - terraform_per_64k_frames
-   - terraform_frame_burst
-   - clear_per_64k_frames
-   - clear_frame_burst
+- You can impose limits on companies by the following 4 settings:
+  - `terraform_per_64k_frames`
+  - `terraform_frame_burst`
+  - `clear_per_64k_frames`
+  - `clear_frame_burst`
 
- - Explaining 'per_64K_frames' and 'burst'
-    - 'burst' defines 3 things, the maximum limit, the limit of a single action,
-      and the initial value for the limit assigned to a new company.
-      This setting is fairly simple and requires no math.
+- Explaining `NNN_burst` and `NNN_per_64K_frames`
+  - `NNN_burst` defines 3 things, the maximum limit, the limit of a single
+    action, and the initial value for the limit assigned to a new company.
+    This setting is fairly simple and requires no math.
 
-      A value of 1 means a single tile can be affected by a single action.
-      This results in having to click 400 times when wanting to cover an area
-      of 20 x 20 tiles.
+    A value of 1 means a single tile can be affected by a single action.
+    This results in having to click 400 times when wanting to cover an area
+    of 20 x 20 tiles.
 
-      The default value 4096 covers an area of 64 x 64 tiles.
+    The default value 4096 covers an area of 64 x 64 tiles.
 
-    - 'per_64k_frames' defines the number of tiles added to each companies limit
-      per frame (however not past the possible maximum value,the 'burst').
-      64k rather resembles the exact number of 65536 frames. So setting this
-      variable to 65536 means: 65536 / 65536 = 1 tile per frame.
-      As a day consists of 74 frames, a company's limit is increased by 74
-      tiles during the course of a single day (2.22 seconds).
+  - `NNN_per_64K_frames` defines the number of tiles added to each companies
+    limit per frame (however not past the possible maximum value,the
+    `NNN_burst`). 64k rather resembles the exact number of 65536 frames. So
+    setting this variable to 65536 means: `65536 / 65536 = 1 tile per frame`.
 
-      To achieve a 1 tile per day increase the following calculation is needed:
-      1 / 74 (frames per day) * 65536 (per_64k_frames) = 885.62...
-      after rounding: a value of 886 means adding a bit over 1 tile per day.
+    As a day consists of 74 frames, a company's limit is increased by 74
+    tiles during the course of a single day (2.22 seconds).
+    To achieve a 1 tile per day increase the following calculation is needed:
+    `1 / 74 (frames per day) * 65536 (per_64k_frames) = 885.62...`.
+    After rounding: a value of 886 means adding a bit over 1 tile per day.
 
-      There is still enough space to scale this value downwards:
-      decreasing this value to 127 results in a bit over 1 tile added to the
-      allowance per week (7 days).
+    There is still enough space to scale this value downwards:
+    decreasing this value to 127 results in a bit over 1 tile added to the
+    allowance per week (7 days).
 
-      To create a setup in which a company gets an initial allowance only,
-      set the value to 0 - no increase of the allowance per frame.
-
- - Even though construction actions include a clear tile action, they are not
-   affected by the above settings.
+    To create a setup in which a company gets an initial allowance only,
+    set the value to 0 - no increase of the allowance per frame.
 
+- Even though construction actions include a clear tile action, they are not
+  affected by the above settings.
 
 ## 5.0) Some useful things
 
- - You can protect your company so nobody else can join uninvited. To do this,
-   set a password in your Company Screen
+- You can protect your company so nobody else can join uninvited. To do this,
+  set a password in your Company window.
 
- - You can give other players some money via the ClientList (under the 'head'
-   in the mainbar).
-
- - You can chat with other players via ENTER or via SHIFT+T or via the ClientList
-
- - Servers can now kick players, so don't make them use it!
+- You can chat with other players via ENTER or via SHIFT+T or via the Online
+  Players window
 
+- Servers can kick players, so don't make them use it!
 
 ## 6.0) Troubleshooting
 
- - My advertising server does not show up in list at servers.openttd.org
-     Run openttd with the '-d net=2' parameter. That will show which incoming
-     communication is received, whether the replies from the master server or
-     communication from an admin tool reach the programme. See section 1
-     'Starting a server' further up for the ports and protocols used by OpenTTD.
-     The ports can be configured in the config file.
+### My server does not show up in the serverlist
+
+Check if the visibility of your server is set to `public`.
+
+If it is, and your server still isn't showing up, start OpenTTD with
+`-d net=4` as extra argument. This will show debug message related to the
+network, including communication to/from the Game Coordinator.
+
+### My server warns a lot about getaddrinfo taking N seconds
+
+This could be a transient issue with your (local) DNS server, but if the
+problem persists there is likely a configuration issue in DNS resolving on
+your computer.
+
+#### Running OpenTTD in a Docker container?
+
+This is an issue with dual-stack Docker containers. If there is no default
+IPv6 resolver and IPv6 traffic is preferred, DNS requests will time out after
+5 seconds. To resolve this, use an IPv4 DNS server for your Docker container,
+for example by adding `--dns 1.1.1.1` to your `docker run` command.

docs/savegame_format.md

@@ -0,0 +1,214 @@
+# OpenTTD's Savegame Format
+
+Last updated: 2021-06-15
+
+## Outer container
+
+Savegames for OpenTTD start with an outer container, to contain the compressed data for the rest of the savegame.
+
+`[0..3]` - The first four bytes indicate what compression is used.
+In ASCII, these values are possible:
+
+- `OTTD` - Compressed with LZO (deprecated, only really old savegames would use this).
+- `OTTN` - No compression.
+- `OTTZ` - Compressed with zlib.
+- `OTTX` - Compressed with LZMA.
+
+`[4..5]` - The next two bytes indicate which savegame version used.
+
+`[6..7]` - The next two bytes can be ignored, and were only used in really old savegames.
+
+`[8..N]` - Next follows a binary blob which is compressed with the indicated compression algorithm.
+
+The rest of this document talks about this decompressed blob of data.
+
+## Data types
+
+The savegame is written in Big Endian, so when we talk about a 16-bit unsigned integer (`uint16`), we mean it is stored in Big Endian.
+
+The following types are valid:
+
+- `1` - `int8` / `SLE_FILE_I8` -8-bit signed integer
+- `2` - `uint8` / `SLE_FILE_U8` - 8-bit unsigned integer
+- `3` - `int16` / `SLE_FILE_I16` - 16-bit signed integer
+- `4` - `uint16` / `SLE_FILE_U16` - 16-bit unsigned integer
+- `5` - `int32` / `SLE_FILE_I32` - 32-bit signed integer
+- `6` - `uint32` / `SLE_FILE_U32` - 32-bit unsigned integer
+- `7` - `int64` / `SLE_FILE_I64` - 64-bit signed integer
+- `8` - `uint64` / `SLE_FILE_U64` - 64-bit unsigned integer
+- `9` - `StringID` / `SLE_FILE_STRINGID` - a StringID inside the OpenTTD's string table
+- `10` - `str` / `SLE_FILE_STRING` - a string (prefixed with a length-field)
+- `11` - `struct` / `SLE_FILE_STRUCT` - a struct
+
+### Gamma value
+
+There is also a field-type called `gamma`.
+This is most often used for length-fields, and uses as few bytes as possible to store an integer.
+For values <= 127, it uses a single byte.
+For values > 127, it uses two bytes and sets the highest bit to high.
+For values > 32767, it uses three bytes and sets the two highest bits to high.
+And this continues till the value fits.
+In a more visual approach:
+```
+  0xxxxxxx
+  10xxxxxx xxxxxxxx
+  110xxxxx xxxxxxxx xxxxxxxx
+  1110xxxx xxxxxxxx xxxxxxxx xxxxxxxx
+  11110--- xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx
+```
+
+## Chunks
+
+Savegames for OpenTTD store their data in chunks.
+Each chunk contains data for a certain part of the game, for example "Companies", "Vehicles", etc.
+
+`[0..3]` - Each chunk starts with four bytes to indicate the tag.
+If the tag is `\x00\x00\x00\x00` it means the end of the savegame is reached.
+An example of a valid tag is `PLYR` when looking at it via ASCII, which contains the information of all the companies.
+
+`[4..4]` - Next follows a byte where the lower 4 bits contain the type.
+The possible valid types are:
+
+- `0` - `CH_RIFF` - This chunk is a binary blob.
+- `1` - `CH_ARRAY` - This chunk is a list of items.
+- `2` - `CH_SPARSE_ARRAY` - This chunk is a list of items.
+- `3` - `CH_TABLE` - This chunk is self-describing list of items.
+- `4` - `CH_SPARSE_TABLE` - This chunk is self-describing list of items.
+
+Now per type the format is (slightly) different.
+
+### CH_RIFF
+
+(since savegame version 295, this chunk type is only used for MAP-chunks, containing bit-information about each tile on the map)
+
+A `CH_RIFF` starts with an `uint24` which together with the upper-bits of the type defines the length of the chunk.
+In pseudo-code:
+
+```
+type = read uint8
+if type == 0
+    length = read uint24
+    length |= ((type >> 4) << 24)
+```
+
+The next `length` bytes are part of the chunk.
+What those bytes mean depends on the tag of the chunk; further details per chunk can be found in the source-code.
+
+### CH_ARRAY / CH_SPARSE_ARRAY
+
+(this chunk type is deprecated since savegame version 295 and is no longer in use)
+
+`[0..G1]` - A `CH_ARRAY` / `CH_SPARSE_ARRAY` starts with a `gamma`, indicating the size of the next item plus one.
+If this size value is zero, it indicates the end of the list.
+This indicates the full length of the next item minus one.
+In psuedo-code:
+
+```
+loop
+    size = read gamma - 1
+    if size == -1
+        break loop
+    read <size> bytes
+```
+
+`[]` - For `CH_ARRAY` there is an implicit index.
+The loop starts at zero, and every iteration adds one to the index.
+For entries in the game that were not allocated, the `size` will be zero.
+
+`[G1+1..G2]` - For `CH_SPARSE_ARRAY` there is an explicit index.
+The `gamma` following the size indicates the index.
+
+The content of the item is a binary blob, and similar to `CH_RIFF`, it depends on the tag of the chunk what it means.
+Please check the source-code for further details.
+
+### CH_TABLE / CH_SPARSE_TABLE
+
+(this chunk type only exists since savegame version 295)
+
+Both `CH_TABLE` and `CH_SPARSE_TABLE` are very similar to `CH_ARRAY` / `CH_SPARSE_ARRAY` respectively.
+The only change is that the chunk starts with a header.
+This header describes the chunk in details; with the header you know the meaning of each byte in the binary blob that follows.
+
+`[0..G]` - The header starts with a `gamma` to indicate the size of all the headers in this chunk plus one.
+If this size value is zero, it means there is no header, which should never be the case.
+
+Next follows a list of `(type, key)` pairs:
+
+- `[0..0]` - Type of the field.
+- `[1..G]` - `gamma` to indicate length of key.
+- `[G+1..N]` - Key (in UTF-8) of the field.
+
+If at any point `type` is zero, the list stops (and no `key` follows).
+
+The `type`'s lower 4 bits indicate the data-type (see chapter above).
+The `type`'s 5th bit (so `0x10`) indicates if the field is a list, and if this field in every record starts with a `gamma` to indicate how many times the `type` is repeated.
+
+If the `type` indicates either a `struct` or `str`, the `0x10` flag is also always set.
+
+As the savegame format allows (list of) structs in structs, if any `struct` type is found, this header will be followed by a header of that struct.
+This nesting of structs is stored depth-first, so given this table:
+
+```
+type   | key
+-----------------
+uint8  | counter
+struct | substruct1
+struct | substruct2
+```
+
+With `substruct1` being like:
+
+```
+type   | key
+-----------------
+uint8  | counter
+struct | substruct3
+```
+
+The headers will be, in order: `table`, `substruct1`, `substruct3`, `substruct2`, each ending with a `type` is zero field.
+
+After reading all the fields of all the headers, there is a list of records.
+To read this, see `CH_ARRAY` / `CH_SPARSE_ARRAY` for details.
+
+As each `type` has a well defined length, you can read the records even without knowing anything about the chunk-tag yourself.
+
+Do remember, that if the `type` had the `0x10` flag active, the field in the record first has a `gamma` to indicate how many times that `type` is repeated.
+
+#### Guidelines for network-compatible patch-packs
+
+For network-compatible patch-packs (client-side patches that can play together with unpatched clients) we advise to prefix the field-name with `__<shortname>` when introducing new fields to an existing chunk.
+
+Example: you have an extra setting called `auto_destroy_rivers` you want to store in the savegame for your patched client called `mypp`.
+We advise you to call this setting `__mypp_auto_destroy_rivers` in the settings chunk.
+
+Doing it this way ensures that a savegame created by these patch-packs can still safely be loaded by unpatched clients.
+They will simply ignore the field and continue loading the savegame as usual.
+The prefix is strongly advised to avoid conflicts with future-settings in an unpatched client or conflicts with other patch-packs.
+
+## Scripts custom data format
+
+Script chunks (`AIPL` and `GSDT`) use `CH_TABLE` chunk type.
+
+At the end of each record there's an `uint8` to indicate if there's custom data (1) or not (0).
+
+There are 6 data types for scripts, called `script-data-type`.
+When saving, each `script-data-type` starts with the type marker saved as `uint8` followed by the actual data.
+- `0` - `SQSL_INT`:
+  - an `int64` with the actual value (`int32` before savegame version 296).
+- `1` - `SQSL_STRING`:
+  - an `uint8` with the string length.
+  - a list of `int8` for the string itself.
+- `2` - `SQSL_ARRAY`:
+  - each element saved as `script-data-type`.
+  - an `SQSL_ARRAY_TABLE_END` (0xFF) marker (`uint8`).
+- `3` - `SQSL_TABLE`:
+  - for each element:
+    - key saved as `script-data-type`.
+    - value saved as `script-data-type`.
+  - an `SQSL_ARRAY_TABLE_END` (0xFF) marker (`uint8`).
+- `4` - `SQSL_BOOL`:
+  - an `uint8` with 0 (false) or 1 (true).
+- `5` - `SQSL_NULL`:
+  - (no data follows)
+
+The first data type is always a `SQSL_TABLE`.

known-bugs.txt

@@ -1,6 +1,4 @@
 OpenTTD's known bugs
-Last updated:    2021-01-22
-Release version: 1.11.0-beta1
 ------------------------------------------------------------------------
 
 
@@ -364,35 +362,6 @@ Trains might not stop at platforms that are currently being changed [#5553]:
         list multiple times in a row or if there is only one station
         in theorder list (see #5684).
 
-Inconsistent catchment areas [#5661]:
-        Due to performance decisions the catchment area for cargo accepted by a
-        station for delivery to houses or industries differs from the catchment
-        area for cargo that is delivered to stations from houses or industries.
-
-        Conceptually they work the same, but the effect in game differs. They
-        work by finding the closest destination "around" the source which is
-        within a certain distance. This distance depends on the type of station,
-        e.g. road stops have a smaller catchment area than large airports.
-        In both cases the bounding box, the smallest rectangle that contains
-        all tiles of something, is searched for the target of the cargo,
-        and then spiraling outwards finding the closest tile of the target.
-
-        In the case of a station with two tiles spread far apart with a house
-        that is within the station's bounding box, it would be possible that
-        the spiraling search from the house does not reach one of the station
-        tiles before the search ends, i.e. all tiles within that distance
-        are searched. So the house does not deliver cargo to the station.
-        On the other hand, the station will deliver cargo because the house
-        falls within the bounding box, and thus search area.
-
-        It is possible to make these consistent, but then cargo from a house
-        to a station needs to search up to 32 tiles around itself, i.e. 64
-        by 64 tiles, to find all possible stations it could deliver to
-        instead of 10 by 10 tiles (40 times more tiles). Alternatively the
-        search from a station could be changed to use the actual tiles, but
-        that would require considering checking 10 by 10 tiles for each of
-        the tiles of a station, instead of just once.
-
 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
@@ -409,3 +378,12 @@ Involuntary cargo exchange with cargodist via neutral station [#6114]:
         shared station make the order "no unload" and if you're unloading make
         it "no load". Cargodist will then figure out that it should not create
         such a route.
+
+Incorrect ending year displayed in end of game newspaper [#8625]
+        The ending year of the game is configurable, but the date displayed in
+        the newspaper at the end of the game is part of the graphics, not text.
+        So to fix this would involve fixing the graphics in every baseset,
+        including the original. Additionally, basesets are free to put this
+        text in different positions (which they do), making a proper solution
+        to this infinitely more complex for a part of the game that fewer than
+        1% of players ever see.

media/CMakeLists.txt

@@ -0,0 +1,98 @@
+add_subdirectory(baseset)
+
+add_library(media
+        INTERFACE
+)
+add_library(openttd::media ALIAS media)
+
+if(NOT UNIX OR APPLE)
+    return()
+endif()
+
+set(MEDIA_PNG_SOURCE_FILES
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.16.png
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.32.png
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.48.png
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.64.png
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.128.png
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.256.png
+)
+
+# Walk over all the png files, and generate a command to copy them
+foreach(MEDIA_PNG_SOURCE_FILE IN LISTS MEDIA_PNG_SOURCE_FILES)
+        get_filename_component(MEDIA_PNG_FILE_NAME "${MEDIA_PNG_SOURCE_FILE}" NAME)
+        string(REGEX REPLACE "[^.]+.([0-9]*).*" "${CMAKE_CURRENT_BINARY_DIR}/icons/hicolor/\\1x\\1/apps/${BINARY_NAME}.png" MEDIA_PNG_BINARY_FILE "${MEDIA_PNG_FILE_NAME}")
+
+        add_custom_command(OUTPUT ${MEDIA_PNG_BINARY_FILE}
+            COMMAND ${CMAKE_COMMAND} -E copy
+                    ${MEDIA_PNG_SOURCE_FILE}
+                    ${MEDIA_PNG_BINARY_FILE}
+            MAIN_DEPENDENCY ${MEDIA_PNG_SOURCE_FILE}
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            COMMENT "Copying ${MEDIA_PNG_FILE_NAME} file"
+        )
+
+        list(APPEND MEDIA_BINARY_FILES ${MEDIA_PNG_BINARY_FILE})
+endforeach()
+
+set(MEDIA_XPM_SOURCE_FILES
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.32.xpm
+        ${CMAKE_CURRENT_SOURCE_DIR}/openttd.64.xpm
+)
+
+# Walk over all the xpm files, and generate a command to copy them
+foreach(MEDIA_XPM_SOURCE_FILE IN LISTS MEDIA_XPM_SOURCE_FILES)
+        get_filename_component(MEDIA_XPM_FILE_NAME "${MEDIA_XPM_SOURCE_FILE}" NAME)
+        get_filename_component(MEDIA_XPM_FILE_EXT "${MEDIA_XPM_FILE_NAME}" EXT)
+        set(MEDIA_XPM_BINARY_FILE "${CMAKE_CURRENT_BINARY_DIR}/pixmaps/${BINARY_NAME}${MEDIA_XPM_FILE_EXT}")
+
+        add_custom_command(OUTPUT ${MEDIA_XPM_BINARY_FILE}
+            COMMAND ${CMAKE_COMMAND} -E copy
+                    ${MEDIA_XPM_SOURCE_FILE}
+                    ${MEDIA_XPM_BINARY_FILE}
+            MAIN_DEPENDENCY ${MEDIA_XPM_SOURCE_FILE}
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            COMMENT "Copying ${MEDIA_XPM_FILE_NAME} file"
+        )
+
+        list(APPEND MEDIA_BINARY_FILES ${MEDIA_XPM_BINARY_FILE})
+endforeach()
+
+# Create a new target which copies media files
+add_custom_target(media_files
+        DEPENDS
+        ${MEDIA_BINARY_FILES}
+)
+
+add_dependencies(media
+        media_files
+)
+
+get_target_property(LANG_SOURCE_FILES language_files LANG_SOURCE_FILES)
+
+set(DESKTOP_BINARY_NAME ${BINARY_NAME}.desktop)
+
+add_custom_command_timestamp(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${DESKTOP_BINARY_NAME}
+        COMMAND ${CMAKE_COMMAND}
+                -DDESKTOP_SOURCE_FILE=${CMAKE_CURRENT_SOURCE_DIR}/openttd.desktop
+                -DDESKTOP_BINARY_FILE=${CMAKE_CURRENT_BINARY_DIR}/${DESKTOP_BINARY_NAME}
+                -DBINARY_NAME=${BINARY_NAME}
+                -P ${CMAKE_SOURCE_DIR}/cmake/scripts/Desktop.cmake
+                --
+                ${LANG_SOURCE_FILES}
+        MAIN_DEPENDENCY ${CMAKE_CURRENT_SOURCE_DIR}/openttd.desktop
+        DEPENDS ${LANG_SOURCE_FILES}
+                ${CMAKE_SOURCE_DIR}/cmake/scripts/Desktop.cmake
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating desktop file"
+)
+
+# Create a new target which generates desktop file
+add_custom_target_timestamp(desktop_file
+        DEPENDS
+        ${CMAKE_CURRENT_BINARY_DIR}/${DESKTOP_BINARY_NAME}
+)
+
+add_dependencies(media
+        desktop_file
+)

media/baseset/CMakeLists.txt

@@ -17,6 +17,7 @@ set(BASESET_OTHER_SOURCE_FILES
         ${CMAKE_CURRENT_SOURCE_DIR}/openttd.grf
         ${CMAKE_CURRENT_SOURCE_DIR}/opntitle.dat
         ${CMAKE_CURRENT_SOURCE_DIR}/orig_extra.grf
+        ${CMAKE_CURRENT_SOURCE_DIR}/../openttd.32.bmp
 )
 
 # Done by the subdirectories, if nforenum / grfcodec is installed

media/baseset/openttd/flags.nfo

@@ -1,43 +0,0 @@
-// This file is part of OpenTTD.
-// OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
-// OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-// See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
-//
-   -1 * 0	 0C "Flag graphics"
-   -1 * 3	 05 14 24
-   -1 sprites/flags.png 8bpp  34    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp  50    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp  66    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp  82    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp  98    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 114    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 130    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 146    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 162    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 178    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 194    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 210    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 226    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 242    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 258    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 274    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 290    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 306    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 322    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 338    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 354    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 370    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 386    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 402    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 418    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 434    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 450    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 466    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 482    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 498    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 514    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 530    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 546    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 562    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 578    8  11   8   0   0 normal
-   -1 sprites/flags.png 8bpp 594    8  11   8   0   0 normal

media/baseset/openttd/oneway.nfo

@@ -4,10 +4,24 @@
 // See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 //
    -1 * 0	 0C "One way road graphics"
-   -1 * 3	 05 09 06
-   -1 sprites/oneway.png 8bpp  34    8  24  16 -12  -8 normal
-   -1 sprites/oneway.png 8bpp  66    8  24  16 -12  -8 normal
-   -1 sprites/oneway.png 8bpp  98    8  24  16 -12  -8 normal
-   -1 sprites/oneway.png 8bpp 130    8  24  16 -12  -8 normal
-   -1 sprites/oneway.png 8bpp 162    8  24  16 -12  -8 normal
-   -1 sprites/oneway.png 8bpp 194    8  24  16 -12  -8 normal
+   -1 * 3	 05 09 12
+   -1 sprites/oneway.png 8bpp  34    8  24  16 -10   -9 normal
+   -1 sprites/oneway.png 8bpp  66    8  24  16 -13   -7 normal
+   -1 sprites/oneway.png 8bpp  98    8  24  16 -12   -8 normal
+   -1 sprites/oneway.png 8bpp 130    8  24  16 -15  -10 normal
+   -1 sprites/oneway.png 8bpp 162    8  24  16 -12   -9 normal
+   -1 sprites/oneway.png 8bpp 194    8  24  16 -11   -8 normal
+
+   -1 sprites/oneway.png 8bpp  34   40  24  16 -13  -10 normal
+   -1 sprites/oneway.png 8bpp  66   40  24  16 -12   -8 normal
+   -1 sprites/oneway.png 8bpp  98   40  24  16 -12   -9 normal
+   -1 sprites/oneway.png 8bpp 130   40  24  16 -11   -8 normal
+   -1 sprites/oneway.png 8bpp 162   40  24  16  -9  -10 normal
+   -1 sprites/oneway.png 8bpp 194   40  24  16 -10   -9 normal
+
+   -1 sprites/oneway.png 8bpp  34   72  24  16  -8  -11 normal
+   -1 sprites/oneway.png 8bpp  66   72  24  16 -11   -5 normal
+   -1 sprites/oneway.png 8bpp  98   72  24  16 -12   -8 normal
+   -1 sprites/oneway.png 8bpp 130   72  24  16 -12   -5 normal
+   -1 sprites/oneway.png 8bpp 162   72  24  16 -14  -10 normal
+   -1 sprites/oneway.png 8bpp 194   72  24  16 -12   -8 normal

media/baseset/openttd/openttd.nfo

@@ -92,7 +92,6 @@
 #include "roadstops.nfo"
 #include "aqueduct.nfo"
 #include "autorail.nfo"
-#include "flags.nfo"
 #include "openttdgui.nfo"
 #include "airport_preview.nfo"
 #include "chars.nfo"

media/baseset/openttd/openttdgui.nfo

@@ -4,7 +4,7 @@
 // See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 //
    -1 * 0	 0C "OpenTTD GUI graphics"
-   -1 * 3	 05 15 \b 186 // OPENTTD_SPRITE_COUNT
+   -1 * 3	 05 15 \b 191 // OPENTTD_SPRITE_COUNT
    -1 sprites/openttdgui.png 8bpp  66    8  64  31 -31   7 normal
    -1 sprites/openttdgui.png 8bpp 146    8  64  31 -31   7 normal
    -1 sprites/openttdgui.png 8bpp 226    8  64  31 -31   7 normal
@@ -191,3 +191,8 @@
    -1 sprites/openttdgui_convert_tram.png 8bpp  24   0  32  32   0   0 normal
    -1 sprites/openttdgui.png 8bpp 513  440  10  10   0   0 normal
    -1 sprites/openttdgui.png 8bpp 526  440  10  10   0   0 normal
+   -1 sprites/openttdgui.png 8bpp 539  440  12  10   0   0 normal
+   -1 sprites/openttdgui.png 8bpp 553  440  12  10   0   0 normal
+   -1 sprites/openttdgui.png 8bpp 567  440  12  10   0   0 normal
+   -1 sprites/openttdgui.png 8bpp 581  440  10  10   0   0 normal
+   -1 sprites/openttdgui.png 8bpp 593  440  10  10   0   0 normal