Remove dependency on VCRUNTIME140.dll.

(cherry picked from commit bb6400f6f8585523c31dfeb7ab95073263aadd3c)

.editorconfig

@@ -1,16 +1,213 @@
 ; Top-most http://editorconfig.org/ file
 root = true
+charset=utf-8
 
 ; Unix-style newlines
 [*]
 end_of_line = LF
+insert_final_newline = true
+trim_trailing_whitespace = true
 
-; 4-column tab indentation
+; 4-column tab indentation and .NET coding conventions
 [*.cs]
 indent_style = tab
 indent_size = 4
 
+dotnet_separate_import_directive_groups = false
+dotnet_sort_system_directives_first = true
+
+csharp_style_var_elsewhere = true:suggestion
+csharp_style_var_for_built_in_types = true:suggestion
+csharp_style_var_when_type_is_apparent = true:suggestion
+
+csharp_prefer_braces = when_multiline:suggestion
+csharp_using_directive_placement = outside_namespace:suggestion
+csharp_new_line_before_open_brace = all
+csharp_space_around_binary_operators = before_and_after
+
+## Naming styles:
+
+dotnet_naming_style.camel_case.capitalization = camel_case
+
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.i_prefix_pascal_case.capitalization = pascal_case
+dotnet_naming_style.i_prefix_pascal_case.required_prefix = I
+
+## Symbol specifications:
+
+dotnet_naming_symbols.const_locals.applicable_kinds = local
+dotnet_naming_symbols.const_locals.applicable_accessibilities = *
+dotnet_naming_symbols.const_locals.required_modifiers = const
+
+dotnet_naming_symbols.const_fields.applicable_kinds = field
+dotnet_naming_symbols.const_fields.applicable_accessibilities = *
+dotnet_naming_symbols.const_fields.required_modifiers = const
+
+dotnet_naming_symbols.static_readonly_fields.applicable_kinds = field
+dotnet_naming_symbols.static_readonly_fields.applicable_accessibilities = *
+dotnet_naming_symbols.static_readonly_fields.required_modifiers = static, readonly
+
+dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field
+dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, internal, protected, protected_internal, private_protected
+dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly
+
+dotnet_naming_symbols.private_or_protected_fields.applicable_kinds = field
+dotnet_naming_symbols.private_or_protected_fields.applicable_accessibilities = private, protected, private_protected
+
+dotnet_naming_symbols.interfaces.applicable_kinds = interface
+dotnet_naming_symbols.interfaces.applicable_accessibilities = *
+
+dotnet_naming_symbols.parameters_and_locals.applicable_kinds = parameter, local
+dotnet_naming_symbols.parameters_and_locals.applicable_accessibilities = *
+
+dotnet_naming_symbols.most_symbols.applicable_kinds = namespace, class, struct, enum, field, property, method, local_function, event, delegate, type_parameter
+dotnet_naming_symbols.most_symbols.applicable_accessibilities = *
+
+## Naming rules:
+
+dotnet_naming_rule.const_locals_should_be_pascal_case.symbols = const_locals
+dotnet_naming_rule.const_locals_should_be_pascal_case.style = pascal_case
+dotnet_naming_rule.const_locals_should_be_pascal_case.severity = warning
+
+dotnet_naming_rule.const_fields_should_be_pascal_case.symbols = const_fields
+dotnet_naming_rule.const_fields_should_be_pascal_case.style = pascal_case
+dotnet_naming_rule.const_fields_should_be_pascal_case.severity = warning
+
+dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.symbols = static_readonly_fields
+dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.style = pascal_case
+dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.severity = warning
+
+dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.symbols = non_private_readonly_fields
+dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.style = pascal_case
+dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = warning
+
+dotnet_naming_rule.private_or_protected_fields_should_be_camel_case.symbols = private_or_protected_fields
+dotnet_naming_rule.private_or_protected_fields_should_be_camel_case.style = camel_case
+dotnet_naming_rule.private_or_protected_fields_should_be_camel_case.severity = warning
+
+dotnet_naming_rule.interfaces_should_be_i_prefix_pascal_case.symbols = interfaces
+dotnet_naming_rule.interfaces_should_be_i_prefix_pascal_case.style = i_prefix_pascal_case
+dotnet_naming_rule.interfaces_should_be_i_prefix_pascal_case.severity = warning
+
+dotnet_naming_rule.parameters_and_locals_should_be_camel_case.symbols = parameters_and_locals
+dotnet_naming_rule.parameters_and_locals_should_be_camel_case.style = camel_case
+dotnet_naming_rule.parameters_and_locals_should_be_camel_case.severity = warning
+
+dotnet_naming_rule.most_symbols_should_be_pascal_case.symbols = most_symbols
+dotnet_naming_rule.most_symbols_should_be_pascal_case.style = pascal_case
+dotnet_naming_rule.most_symbols_should_be_pascal_case.severity = warning
+
+## Formatting:
+
+# Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
+csharp_space_after_colon_in_inheritance_clause = true
+
+# Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
+csharp_space_before_colon_in_inheritance_clause = true
+
+# Also handled by StyleCopAnalyzers - SA1000: KeywordsMustBeSpacedCorrectly.
+csharp_space_after_keywords_in_control_flow_statements = true
+
+# Leave code block on single line.
+csharp_preserve_single_line_blocks = true
+
+# Leave statements and member declarations on the same line.
+csharp_preserve_single_line_statements = true
+
+# IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias.
+dotnet_style_predefined_type_for_member_access = true
+
+# IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias.
+dotnet_style_predefined_type_for_locals_parameters_members = true
+
+## Others:
+
+# Show an IDE warning when default access modifiers are explicitly specified.
+dotnet_style_require_accessibility_modifiers = omit_if_default:warning
+
+# use 'var' instead of explicit type
+dotnet_diagnostic.IDE0007.severity = warning
+
+# Don't prefer braces (for one liners).
+dotnet_diagnostic.IDE0011.severity = silent
+
+# Object initialization can be simplified / Use object initializer.
+dotnet_diagnostic.IDE0017.severity = warning
+
+# Collection initialization can be simplified
+dotnet_diagnostic.IDE0028.severity = warning
+
+# Simplify 'default' expression
+dotnet_diagnostic.IDE0034.severity = warning
+
+# Modifiers are not ordered.
+dotnet_diagnostic.IDE0036.severity = warning
+
+# Raise a warning on build when default access modifiers are explicitly specified.
+dotnet_diagnostic.IDE0040.severity = warning
+
+# Make field readonly.
+dotnet_diagnostic.IDE0044.severity = warning
+
+# Unused private member.
+dotnet_diagnostic.IDE0052.severity = warning
+
+# Unnecessary value assignment.
+dotnet_diagnostic.IDE0059.severity = warning
+
+# Unused parameter.
+dotnet_diagnostic.IDE0060.severity = warning
+
+# Naming rule violation.
+dotnet_diagnostic.IDE1006.severity = warning
+
+# Avoid unnecessary zero-length array allocations.
+dotnet_diagnostic.CA1825.severity = warning
+
+# Do not use Enumerable methods on indexable collections. Instead use the collection directly.
+dotnet_diagnostic.CA1826.severity = warning
+
+# Count() is used where Any() could be used instead to improve performance.
+dotnet_diagnostic.CA1827.severity = warning
+
+# Use Length/Count property instead of Enumerable.Count method.
+dotnet_diagnostic.CA1829.severity = warning
+
+# Use string.Contains(char) instead of string.Contains(string) with single characters.
+dotnet_diagnostic.CA1847.severity = warning
+
 ; 4-column tab indentation
 [*.yaml]
 indent_style = tab
-indent_size = 4
+indent_size = 4
+
+# Use 'Count' property instead of 'Any' method.
+dotnet_diagnostic.RCS1080.severity = warning
+
+# Use read-only auto-implemented property.
+dotnet_diagnostic.RCS1170.severity = warning
+
+# Unnecessary interpolated string.
+dotnet_diagnostic.RCS1214.severity = warning
+
+# Unnecessary usage of verbatim string literal.
+dotnet_diagnostic.RCS1192.severity = warning
+
+# Use pattern matching instead of combination of 'as' operator and null check.
+dotnet_diagnostic.RCS1221.severity = warning
+
+# Expression is always equal to 'true'.
+dotnet_diagnostic.RCS1215.severity = warning
+
+# Use StringComparison when comparing strings.
+dotnet_diagnostic.RCS1155.severity = warning
+
+# Abstract type should not have public constructors.
+dotnet_diagnostic.RCS1160.severity = warning
+
+# Optimize 'Dictionary<TKey, TValue>.ContainsKey' call.
+dotnet_diagnostic.RCS1235.severity = warning
+
+# Call extension method as instance method.
+dotnet_diagnostic.RCS1196.severity = warning

.gitattributes

@@ -1,12 +1,10 @@
 # Enforce LF normalization on Windows
 *.yaml eol=lf
 *.lua eol=lf
+*.cs eol=lf
+*.csproj eol=lf
+*.sln eol=lf
 * text=lf
 
 # Custom for Visual Studio
 *.cs     diff=csharp
-*.sln    merge=union
-*.csproj merge=union
-*.vbproj merge=union
-*.fsproj merge=union
-*.dbproj merge=union

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Report unexpected behavior or any issues you experienced in OpenRA.
+title: ''
+labels: Bug
+assignees: ''
+
+---
+
+<!-- This is a guideline that shall help you to include information we need to understand and fix the issue you experienced. Please follow the instructions and replace any placeholders that are written in capital letters. Instructions like this comment will not be visible in your report. -->
+
+<!-- Important: Help us to avoid duplicates and use the search function to find existing reports for your issue. Please do not submit duplicate reports! Try to help others to find your report by using a precise title. -->
+
+## Issue Summary
+<!-- Please provide a a clear and concise description of what the issue is below. -->
+
+DESCRIPTION
+
+
+## Reproduction
+<!-- Please provide information about how the issue can be reproduced below. -->
+
+STEPS TO REPRODUCE THE ISSUE
+
+
+## Expected behavior
+<!-- Please explain what you expected to happen below. -->
+
+EXPECTED BEHAVIOR
+
+
+## Screenshots / Screen recordings / Replays
+<!-- If applicable, attach screenshots, screen recordings or replays to help explain your problem. -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Frequently Asked Questions
+    url: https://github.com/OpenRA/OpenRA/wiki/FAQ#frequently-asked-questions
+    about: Explanations for common problems and questions.
+  - name: OpenRA Forum
+    url: https://forum.openra.net/
+    about: Please ask questions about modding here.
+  - name: OpenRA Discord server
+    url: https://discord.openra.net/
+    about: Join the community Discord server for community discussion and support.
+  - name: OpenRA IRC Channel
+    url: https://web.libera.chat/#openra
+    about: Join our development IRC channel on Libera for discussion of development topics.

.github/ISSUE_TEMPLATE/crash-report.md

@@ -0,0 +1,35 @@
+---
+name: Crash report
+about: Report a game crash. Check the FAQ first https://github.com/OpenRA/OpenRA/wiki/FAQ#common-issues
+title: My game crashed
+labels: Crash
+assignees: ''
+
+---
+
+<!-- This is a guideline that shall help you to include all the required information we depend on to investigate and fix game-breaking bugs. Please follow the instructions and replace any placeholders that are written in capital letters. Instructions like this comment will not be visible in your report. -->
+
+## System Information
+<!-- Information about the operating system, engine version, game mod and package source are mandatory for investigating and fixing crashes. -->
+
+- Operating System:  OPERATING SYSTEM
+- OpenRA Version: ENGINE VERSION
+- OpenRA Mod: GAME MOD
+- Source: Official download package OR self-compiled OR third-party package
+- For self-compiled or third-party packages: Mono version
+
+
+## Exception log
+<!-- Please replace the placeholder below with the content of the exception.log file. The three backticks before and after the placeholder are used for formatting, so don't remove them. If you don't find the log folder consult https://github.com/OpenRA/OpenRA/wiki/FAQ#my-game-just-crashed. -->
+
+```
+PASTE LOG HERE
+```
+
+
+## Replay
+<!-- If you have a replay file for the game that crashed, and it crashes again when you play it back, it will be a great help for us to fix the issue. Please compress the replay into a zip file and drag it here to include it in the report. -->
+
+
+## Additional information
+<!-- Please tell us below everything that you think is important for us to know about the crash. Specifically, what you were doing in the moment before the crash or ideally steps to reproduce it are very valuable information. -->

.github/ISSUE_TEMPLATE/feature---enhancement-request.md

@@ -0,0 +1,35 @@
+---
+name: Feature / Enhancement request
+about: Describe what you think is missing or could be improved in OpenRA.
+title: ''
+labels: Idea/Wishlist
+assignees: ''
+
+---
+
+<!-- This is a guideline that shall help you to describe your idea for a missing feature or enhancement. Please follow the instructions and replace any placeholders that are written in capital letters. Instructions like this comment will not be visible in your report. -->
+
+<!-- Important: Help us to avoid duplicates and use the search function to find existing requests. Please do not submit duplicate requests! Try to help others to find your request by using a precise title. -->
+
+## Motivation
+<!-- Please provide a clear and concise description of the motivation behind the request. If your request is related to a problem or limitation, describe it below. -->
+
+REQUEST MOTIVATION
+
+
+## Proposed solution
+<!-- Please describe your idea and how it is intended to address the motivation of your request. Provide a clear and concise description of the proposed changes. -->
+
+PROPOSED SOLUTION
+
+
+## Side effects
+<!-- Changes often have side effects or unintended consequences. If you expect that your solution has any side effects, please describe them below. -->
+
+EXPECTED SIDE EFFECTS
+
+
+## Alternatives
+<!-- Please outline any alternative solutions you have considered. -->
+
+ALTERNATIVES

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+Thank you for your contribution to OpenRA!
+
+Please be aware that we do not have enough project maintainers to match the rate of contributions, so it may take several days before somebody is able to respond to your Pull Request.
+
+You can help speed up the review process by following a few steps:
+
+* Make sure that you have read and understand the OpenRA Coding Standard (see https://github.com/OpenRA/OpenRA/wiki/Coding-Standard).
+* Write quality commit messages (see https://chris.beams.io/posts/git-commit/).
+* Only commit changes that directly relate to your Pull Request.  Use your Git interface to unstage any unrelated changes to project files, line endings, whitespace, or other files.
+* Review the code diff view below to double check that your changes satisfy the above three points.
+* Use the `make test` and `make check` commands to check for (and fix!) any issues that are reported by our automated tests.
+* If you are changing shared mod or engine code, make sure that you have tested your changes in all four default mods.
+* Respond to review comments as soon as you reasonably can.  Reviewers will usually prioritize Pull Requests that are still fresh in their minds.  Make sure to leave a comment when you push new changes, otherwise GitHub does not automatically notify reviewers!
+* Leave a polite comment asking for reviews if a week or more has passed without feedback.
+
+If you need any help you can ask on Discord (https://discord.openra.net) or in the #openra IRC channel on Libera (not as active as Discord).

.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: Continuous Integration
+
+on:
+  push:
+  pull_request:
+    branches: [ bleed, 'prep-*' ]
+
+jobs:
+  linux:
+    name: Linux (.NET 6.0)
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+
+      - name: Install .NET 6.0
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Check Code
+        run: |
+          make check
+
+      - name: Check Mods
+        run: |
+          sudo apt-get install lua5.1
+          make check-scripts
+          make test
+
+  linux-mono:
+    name: Linux (mono)
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+
+      - name: Check Code
+        run: |
+          mono --version
+          make RUNTIME=mono check
+
+      - name: Check Mods
+        run: |
+          # check-scripts does not depend on .net/mono, so is not needed here
+          make RUNTIME=mono test
+
+  windows:
+    name: Windows (.NET 6.0)
+    runs-on: windows-2019
+
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+
+      - name: Install .NET 6.0
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Check Code
+        shell: powershell
+        run: |
+          # Work around runtime failures on the GH Actions runner
+          dotnet nuget add source https://api.nuget.org/v3/index.json -n nuget.org
+          .\make.ps1 check
+          dotnet build OpenRA.Test\OpenRA.Test.csproj -c Debug --nologo -p:TargetPlatform=win-x64
+          dotnet test bin\OpenRA.Test.dll --test-adapter-path:.
+
+      - name: Check Mods
+        run: |
+          chocolatey install lua --version 5.1.5.52
+          $ENV:Path = $ENV:Path + ";C:\Program Files (x86)\Lua\5.1\"
+          .\make.ps1 check-scripts
+          .\make.ps1 test

.github/workflows/documentation.yml

@@ -0,0 +1,140 @@
+name: Deploy Documentation
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Git Tag'
+        required: true
+        default: 'release-xxxxxxxx'
+
+jobs:
+  wiki:
+    name: Update Wiki
+    if: github.repository == 'openra/openra'
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.tag }}
+
+      - name: Install .NET 6
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Prepare Environment
+        run: |
+          make all
+
+      - name: Clone Wiki
+        uses: actions/checkout@v2
+        with:
+          repository: openra/openra.wiki
+          token: ${{ secrets.DOCS_TOKEN }}
+          path: wiki
+
+      - name: Update Wiki (Playtest)
+        if: startsWith(github.event.inputs.tag, 'playtest-')
+        env:
+          GIT_TAG: ${{ github.event.inputs.tag }}
+        run: |
+          ./utility.sh all --settings-docs "${GIT_TAG}" > "wiki/Settings (playtest).md"
+
+      - name: Update Wiki (Release)
+        if: startsWith(github.event.inputs.tag, 'release-')
+        env:
+          GIT_TAG: ${{ github.event.inputs.tag }}
+        run: |
+          ./utility.sh all --settings-docs "${GIT_TAG}" > "wiki/Settings.md"
+
+      - name: Push Wiki
+        env:
+          GIT_TAG: ${{ github.event.inputs.tag }}
+        run: |
+          cd wiki
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Actions"
+          git add --all
+          git commit -m "Update auto-generated documentation for ${GIT_TAG}"
+          git push origin master
+
+  docs:
+    name: Update docs.openra.net
+    if: github.repository == 'openra/openra'
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.tag }}
+
+      - name: Install .NET 6
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Prepare Environment
+        run: |
+          make all
+
+      - name: Clone docs.openra.net (Playtest)
+        if: startsWith(github.event.inputs.tag, 'playtest-')
+        uses: actions/checkout@v2
+        with:
+          repository: openra/docs
+          token: ${{ secrets.DOCS_TOKEN }}
+          path: docs
+          ref: playtest
+
+      - name: Clone docs.openra.net (Release)
+        if: startsWith(github.event.inputs.tag, 'release-')
+        uses: actions/checkout@v2
+        with:
+          repository: openra/docs
+          token: ${{ secrets.DOCS_TOKEN }}
+          path: docs
+          ref: release
+
+      - name: Update docs.openra.net (Playtest)
+        if: startsWith(github.event.inputs.tag, 'playtest-')
+        env:
+          GIT_TAG: ${{ github.event.inputs.tag }}
+        run: |
+          ./utility.sh all --docs "${GIT_TAG}" | python3 ./packaging/format-docs.py > "docs/api/traits.md"
+          ./utility.sh all --weapon-docs "${GIT_TAG}" | python3 ./packaging/format-docs.py > "docs/api/weapons.md"
+          ./utility.sh all --sprite-sequence-docs "${GIT_TAG}" | python3 ./packaging/format-docs.py > "docs/api/sprite-sequences.md"
+          ./utility.sh all --lua-docs "${GIT_TAG}" > "docs/api/lua.md"
+
+      - name: Update docs.openra.net (Release)
+        if: startsWith(github.event.inputs.tag, 'release-')
+        env:
+          GIT_TAG: ${{ github.event.inputs.tag }}
+        run: |
+          ./utility.sh all --docs "${GIT_TAG}" | python3 ./packaging/format-docs.py > "docs/api/traits.md"
+          ./utility.sh all --weapon-docs "${GIT_TAG}" | python3 ./packaging/format-docs.py > "docs/api/weapons.md"
+          ./utility.sh all --sprite-sequence-docs "${GIT_TAG}" | python3 ./packaging/format-docs.py > "docs/api/sprite-sequences.md"
+          ./utility.sh all --lua-docs "${GIT_TAG}" > "docs/api/lua.md"
+
+      - name: Commit docs.openra.net
+        env:
+          GIT_TAG: ${{ github.event.inputs.tag }}
+        run: |
+          cd docs
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Actions"
+          git add api/*.md
+          git commit -m "Update auto-generated documentation for ${GIT_TAG}"
+
+      - name: Push docs.openra.net (Release)
+        if: startsWith(github.event.inputs.tag, 'release-')
+        run: |
+          cd docs
+          git push origin release
+
+      - name: Push docs.openra.net (Playtest)
+        if: startsWith(github.event.inputs.tag, 'playtest-')
+        run: |
+          cd docs
+          git push origin playtest

.github/workflows/itch.yml

@@ -0,0 +1,86 @@
+name: Deploy itch.io Packages
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Git Tag'
+        required: true
+        default: 'release-xxxxxxxx'
+
+jobs:
+  itch:
+    name: Deploy to itch.io
+    runs-on: ubuntu-20.04
+    if: github.repository == 'openra/openra'
+    steps:
+      - name: Download Packages
+        run: |
+          wget -q "https://github.com/${{ github.repository }}/releases/download/${{ github.event.inputs.tag }}/OpenRA-${{ github.event.inputs.tag }}-x64.exe"
+          wget -q "https://github.com/${{ github.repository }}/releases/download/${{ github.event.inputs.tag }}/OpenRA-${{ github.event.inputs.tag }}-x64-winportable.zip" -O "OpenRA-${{ github.event.inputs.tag }}-x64-win-itch.zip"
+          wget -q "https://github.com/${{ github.repository }}/releases/download/${{ github.event.inputs.tag }}/OpenRA-${{ github.event.inputs.tag }}.dmg"
+          wget -q "https://github.com/${{ github.repository }}/releases/download/${{ github.event.inputs.tag }}/OpenRA-Dune-2000-x86_64.AppImage"
+          wget -q "https://github.com/${{ github.repository }}/releases/download/${{ github.event.inputs.tag }}/OpenRA-Red-Alert-x86_64.AppImage"
+          wget -q "https://github.com/${{ github.repository }}/releases/download/${{ github.event.inputs.tag }}/OpenRA-Tiberian-Dawn-x86_64.AppImage"
+          wget -q "https://raw.githubusercontent.com/${{ github.repository }}/${{ github.event.inputs.tag }}/packaging/.itch.toml"
+          zip -u "OpenRA-${{ github.event.inputs.tag }}-x64-win-itch.zip" .itch.toml
+
+      - name: Publish Windows Installer
+        uses: josephbmanley/butler-publish-itchio-action@master
+        env:
+          BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
+          CHANNEL: win
+          ITCH_GAME: openra
+          ITCH_USER: openra
+          VERSION: ${{ github.event.inputs.tag }}
+          PACKAGE: OpenRA-${{ github.event.inputs.tag }}-x64.exe
+
+      - name: Publish Windows Itch Bundle
+        uses: josephbmanley/butler-publish-itchio-action@master
+        env:
+          BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
+          CHANNEL: itch
+          ITCH_GAME: openra
+          ITCH_USER: openra
+          VERSION: ${{ github.event.inputs.tag }}
+          PACKAGE: OpenRA-${{ github.event.inputs.tag }}-x64-win-itch.zip
+
+      - name: Publish macOS Package
+        uses: josephbmanley/butler-publish-itchio-action@master
+        env:
+          BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
+          CHANNEL: macos
+          ITCH_GAME: openra
+          ITCH_USER: openra
+          VERSION: ${{ github.event.inputs.tag }}
+          PACKAGE: OpenRA-${{ github.event.inputs.tag }}.dmg
+
+      - name: Publish RA AppImage
+        uses: josephbmanley/butler-publish-itchio-action@master
+        env:
+          BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
+          CHANNEL: linux-ra
+          ITCH_GAME: openra
+          ITCH_USER: openra
+          VERSION: ${{ github.event.inputs.tag }}
+          PACKAGE: OpenRA-Red-Alert-x86_64.AppImage
+
+      - name: Publish TD AppImage
+        uses: josephbmanley/butler-publish-itchio-action@master
+        env:
+          BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
+          CHANNEL: linux-cnc
+          ITCH_GAME: openra
+          ITCH_USER: openra
+          VERSION: ${{ github.event.inputs.tag }}
+          PACKAGE: OpenRA-Tiberian-Dawn-x86_64.AppImage
+
+      - name: Publish D2k AppImage
+        uses: josephbmanley/butler-publish-itchio-action@master
+        env:
+          BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
+          CHANNEL: linux-d2k
+          ITCH_GAME: openra
+          ITCH_USER: openra
+          VERSION: ${{ github.event.inputs.tag }}
+          PACKAGE: OpenRA-Dune-2000-x86_64.AppImage

.github/workflows/packaging.yml

@@ -0,0 +1,129 @@
+name: Release Packaging
+
+on:
+  push:
+    tags:
+    - 'release-*'
+    - 'playtest-*'
+    - 'devtest-*'
+
+jobs:
+  source:
+    name: Source Tarball
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+
+      - name: Prepare Environment
+        run: echo "GIT_TAG=${GITHUB_REF#refs/tags/}" >> ${GITHUB_ENV}
+
+      - name: Package Source
+        run: |
+          mkdir -p build/source
+          ./packaging/source/buildpackage.sh "${GIT_TAG}" "${PWD}/build/source"
+
+      - name: Upload Packages
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true
+          file: build/source/*
+
+  linux:
+    name: Linux AppImages
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+
+      - name: Install .NET 6.0
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Prepare Environment
+        run: echo "GIT_TAG=${GITHUB_REF#refs/tags/}" >> ${GITHUB_ENV}
+
+      - name: Package AppImages
+        run: |
+          mkdir -p build/linux
+          ./packaging/linux/buildpackage.sh "${GIT_TAG}" "${PWD}/build/linux"
+
+      - name: Upload Packages
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true
+          file: build/linux/*
+
+  macos:
+    name: macOS Disk Image
+    runs-on: macos-11
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+
+      - name: Install .NET 6.0
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Prepare Environment
+        run: echo "GIT_TAG=${GITHUB_REF#refs/tags/}" >> ${GITHUB_ENV}
+
+      - name: Package Disk Image
+        env:
+          MACOS_DEVELOPER_IDENTITY: ${{ secrets.MACOS_DEVELOPER_IDENTITY }}
+          MACOS_DEVELOPER_CERTIFICATE_BASE64: ${{ secrets.MACOS_DEVELOPER_CERTIFICATE_BASE64 }}
+          MACOS_DEVELOPER_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_DEVELOPER_CERTIFICATE_PASSWORD }}
+          MACOS_DEVELOPER_USERNAME: ${{ secrets.MACOS_DEVELOPER_USERNAME }}
+          MACOS_DEVELOPER_PASSWORD: ${{ secrets.MACOS_DEVELOPER_PASSWORD }}
+        run: |
+          mkdir -p build/macos
+          ./packaging/macos/buildpackage.sh "${GIT_TAG}" "${PWD}/build/macos"
+
+      - name: Upload Package
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true
+          file: build/macos/*
+
+  windows:
+    name: Windows Installers
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone Repository
+        uses: actions/checkout@v2
+
+      - name: Install .NET 6.0
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Prepare Environment
+        run: |
+          echo "GIT_TAG=${GITHUB_REF#refs/tags/}" >> ${GITHUB_ENV}
+          sudo apt-get update
+          sudo apt-get install nsis wine64
+
+      - name: Package Installers
+        run: |
+          mkdir -p build/windows
+          ./packaging/windows/buildpackage.sh "${GIT_TAG}" "${PWD}/build/windows"
+
+      - name: Upload Packages
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true
+          file: build/windows/*

.gitignore

@@ -1,73 +1,56 @@
-# Visual Studio
-Release
-bin
-obj
-*.ncb
-*.vcproj*
-*.suo
-*.user
-*.sln.cache
-*.manifest
-*.CodeAnalysisLog.xml
-*.lastcodeanalysissucceeded
-_ReSharper.*/
-
-# movies
-*.vqa
-
-# archives
-*.mix
-
-# binaries
-mods/*/*.dll
-mods/*/*.mdb
-/*.dll
-/*.dll.config
-/*.so
-/*.dylib
-/*.pdb
-/*.mdb
-/*.exe
-thirdparty/download/*
-*.mmdb.gz
-
-# backup files by various editors
-*~
-*.orig
-\#*
-.*.sw?
-
-# Monodevelop
-*.pidb
-*.userprefs
-
-# Mac OS X
-.DS_Store
-
-# XCode
-packaging/osx/launcher/build/
-packaging/osx/launcher/OpenRA.xcodeproj/*.pbxuser
-packaging/osx/launcher/OpenRA.xcodeproj/*.perspectivev3
-packaging/osx/launcher/OpenRA.xcodeproj/*.mode1v3
-temp.c
-temp.o
-temp.s
-OpenRA.Launcher.Mac/build/
-OpenRA.Launcher.Mac/OpenRA.xcodeproj/*.pbxuser
-OpenRA.Launcher.Mac/OpenRA.xcodeproj/*.perspectivev3
-OpenRA.Launcher.Mac/OpenRA.xcodeproj/*.mode1v3
-*.resources
-
-# auto-generated documentation
-DOCUMENTATION.md
-Lua-API.md
-*.html
-openra.6
-
-# StyleCop
-*.Cache
-StyleCopViolations.xml
-
-# SublimeText
-*.sublime-project
-*.sublime-workspace
+# Visual Studio
+Release
+bin
+obj
+*.ncb
+*.vcproj*
+*.suo
+*.user
+*.sln.cache
+*.manifest
+*.CodeAnalysisLog.xml
+*.lastcodeanalysissucceeded
+_ReSharper.*/
+/.vs
+
+# Visual Studio Code
+/.vscode/settings.json
+
+# binaries
+IP2LOCATION-LITE-DB1.IPV6.BIN.ZIP
+
+# backup files by various editors
+*~
+*.orig
+\#*
+.*.sw?
+
+# Monodevelop
+*.pidb
+*.userprefs
+
+# Mac OS X
+.DS_Store
+
+# auto-generated documentation
+DOCUMENTATION.md
+WEAPONS.md
+Lua-API.md
+Settings.md
+*.html
+openra.6
+update.log
+
+# SublimeText
+*.sublime-project
+*.sublime-workspace
+
+# NUnit
+/TestResult.xml
+/lib/
+
+# Support directory
+/Support
+
+# IntelliJ files
+.idea

.kateproject

@@ -0,0 +1,9 @@
+{
+  "name": "OpenRA"
+, "files": [ { "git": 1 } ]
+, "build": {
+  "directory": "."
+  , "build": "make all"
+  , "clean": "make clean"
+  }
+}

.travis.yml

@@ -1,77 +0,0 @@
-# Travis-CI Build for OpenRA
-# see travis-ci.org for details
-
-language: csharp
-mono: 3.12.0
-
-# http://docs.travis-ci.com/user/migrating-from-legacy
-sudo: false
-
-cache:
-  directories:
-  - thirdparty/download
-
-addons:
-  apt:
-    packages:
-    - nsis
-    - nsis-common
-    - dpkg
-    - markdown
-
-# Environment variables
-env:
-  secure: "C0+Hlfa0YGErxUuWV00Tj6p45otC/D3YwYFuLpi2mj1rDFn/4dgh5WRngjvdDBVbXJ3duaZ78jPHWm1jr7vn2jqj9yETsCIK9psWd38ep/FEBM0SDr6MUD89OuXk/YyvxJAE+UXF6bXg7giey09g/CwBigjMW7ynET3wNAWPHPs="
-
-# Fetch dependencies
-# Run the build script
-# Check source code with StyleCop
-# call OpenRA to check for YAML errors
-script:
- - travis_retry make all-dependencies
- - make all
- - make check
- - make test
-
-# Automatically update the trait documentation and Lua API
-after_success:
- - test $TRAVIS_PULL_REQUEST == "false" && make docs && cd packaging && ./update-wiki.sh $TRAVIS_BRANCH; cd ..
-
-# Only watch the development branch and tagged release.
-branches:
- only:
-   - /^release-.*$/
-   - /^playtest-.*$/
-   - /^pkgtest-.*$/
-   - /^prep-.*$/
-   - bleed
-
-# Notify developers when build passed/failed.
-notifications:
-  irc:
-    template:
-      - "%{repository}#%{build_number} %{commit} %{author}: %{message} %{build_url}"
-    channels:
-      - "irc.freenode.net#openra"
-    use_notice: true
-    skip_join: true
-
-before_deploy:
- - export PATH=$PATH:$HOME/usr/bin
- - DOTVERSION=`echo ${TRAVIS_TAG} | sed "s/-/\\./g"`
- - cd packaging
- - mkdir build
- - ./package-all.sh ${TRAVIS_TAG} ${PWD}/build/
-deploy:
-  provider: releases
-  api_key:
-    secure: "g/LU11f+mjqv+lj0sR1UliHwogXL4ofJUwoG5Dbqlvdf5UTLWytw/OWSCv8RGyuh10miyWeaoqHh1cn2C1IFhUEqN1sSeKKKOWOTvJ2FR5mzi9uH3d/MOBzG5icQ7Qh0fZ1YPz5RaJJhYu6bmfvA/1gD49GoaX2kxQL4J5cEBgg="
-  file:
-    - build/OpenRA-${TRAVIS_TAG}.exe
-    - build/OpenRA-${TRAVIS_TAG}.zip
-    - build/openra_${DOTVERSION}_all.deb
-  skip_cleanup: true
-  on:
-    all_branches: true
-    tags: true
-    repo: OpenRA/OpenRA

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+	"recommendations": [
+		"ms-dotnettools.csharp",
+		"openra.oraide-vscode",
+		"openra.vscode-openra-lua",
+		"EditorConfig.EditorConfig",
+		"macabeus.vscode-fluent",
+	]
+}

.vscode/launch.json

@@ -0,0 +1,63 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Launch (TD)",
+			"type": "coreclr",
+			"request": "launch",
+			"program": "${workspaceRoot}/bin/OpenRA.dll",
+			"windows": {
+				"program": "${workspaceRoot}/bin/OpenRA.exe",
+			},
+			"args": ["Game.Mod=cnc", "Engine.EngineDir=.."],
+			"preLaunchTask": "build",
+		},
+		{
+			"name": "Launch (RA)",
+			"type": "coreclr",
+			"request": "launch",
+			"program": "${workspaceRoot}/bin/OpenRA.dll",
+			"windows": {
+				"program": "${workspaceRoot}/bin/OpenRA.exe",
+			},
+			"args": ["Game.Mod=ra", "Engine.EngineDir=.."],
+			"preLaunchTask": "build",
+		},
+		{
+			"name": "Launch (D2k)",
+			"type": "coreclr",
+			"request": "launch",
+			"program": "${workspaceRoot}/bin/OpenRA.dll",
+			"windows": {
+				"program": "${workspaceRoot}/bin/OpenRA.exe",
+			},
+			"args": ["Game.Mod=d2k", "Engine.EngineDir=.."],
+			"preLaunchTask": "build",
+		},
+		{
+			"name": "Launch (TS)",
+			"type": "coreclr",
+			"request": "launch",
+			"program": "${workspaceRoot}/bin/OpenRA.dll",
+			"windows": {
+				"program": "${workspaceRoot}/bin/OpenRA.exe",
+			},
+			"args": ["Game.Mod=ts", "Engine.EngineDir=.."],
+			"preLaunchTask": "build",
+		},
+		{
+			"name": "Launch Utility",
+			"type": "coreclr",
+			"request": "launch",
+			"program": "${workspaceRoot}/bin/OpenRA.Utility.dll",
+			"windows": {
+				"program": "${workspaceRoot}/bin/OpenRA.Utility.exe",
+			},
+			"args": ["all", "--docs", "{DEV_VERSION}"],
+			"env": {
+				"ENGINE_DIR": ".."
+			},
+			"preLaunchTask": "build",
+		},
+	]
+}

.vscode/tasks.json

@@ -0,0 +1,36 @@
+{
+	"version": "2.0.0",
+	"options": {
+		"env": {
+			"ENGINE_DIR": ".."
+		}
+	},
+	"tasks": [
+		{
+			"label": "build",
+			"command": "make",
+			"args": ["all", "CONFIGURATION=Debug"],
+			"windows": {
+				"command": "make.cmd"
+			}
+		},
+		{
+			"label": "Run Utility",
+			"command": "dotnet ${workspaceRoot}/bin/OpenRA.Utility.dll ${input:modId} ${input:command}",
+			"type": "shell",
+		}
+	],
+	"inputs": [
+		{
+			"id": "modId",
+			"description": "ID of the mod to run",
+			"default": "all",
+			"type": "promptString"
+		}, {
+			"id": "command",
+			"description": "Name of the command + parameters",
+			"default": "",
+			"type": "promptString"
+		},
+	]
+}

AUTHORS

@@ -2,30 +2,34 @@ OpenRA wouldn't be where it is today without the
 hard work of many contributors.
 
 The OpenRA developers are:
-    * Chris Forbes (chrisf)
-    * Igor Popov (ihptru)
+    * Gustas Kažukauskas (PunkPun)
     * Lukas Franke (abcdefg30)
     * Matthias Mailänder (Mailaender)
-    * Oliver Brakmann (obrakmann)
-    * Paul Chote (pchote)
-    * Pavel Penev (penev92)
-    * Reaperrr
-    * Tom Roostan (RoosterDragon)
 
 Previous developers included:
     * Alli Witheford (alzeih)
     * Caleb Anderson (RobotCaleb)
+    * Chris Forbes (chrisf)
     * Curtis Shmyr (hamb)
     * Daniel Hernandez (Mancano)
+    * Igor Popov (ihptru)
     * Megan Bowra-Dean (beedee)
     * Mike Bundy (kehaar)
+    * Oliver Brakmann (obrakmann)
+    * Paul Chote (pchote)
+    * Pavel Penev (penev92)
+    * Reaperrr
     * Robert Pepperell (ytinasni)
     * ScottNZ
+    * Tom Roostan (RoosterDragon)
 
 Also thanks to:
+    * abmyii
+    * anvilvapre (anvilvapre)
     * Adam Valy (Tschokky)
     * Akseli Virtanen (RAGEQUIT)
     * Alexander Fast (mizipzor)
+    * Alexis Hunt (alercah)
     * Allen262
     * Andrew Aldridge (i80and)
     * Andrew Perkins
@@ -35,57 +39,88 @@ Also thanks to:
     * Arik Lirette (Angusm3)
     * Barnaby Smith (mvi)
     * Bellator
+    * Bernd Stellwag (burned42)
+    * Biofreak
     * Braxton Williams (Buddytex)
+    * Brendan Gluth (Mechanical_Man)
+    * Brent Gardner (bggardner)
     * Bryan Wilbur
     * Bugra Cuhadaroglu (BugraC)
-    * Christer Ulfsparre (Holloweye)
+    * Chris Cameron (Vesuvian)
     * Chris Grant (Unit158)
+    * Christer Ulfsparre (Holloweye)
+    * Christoph Lahner (chlah)
+    * clem
     * Cody Brittain (Generalcamo)
+    * Constantin Helmig (CH4Code)
     * D2k Sardaukar
+    * D'Arcy Rush (r34ch)
     * Daniel Derejvanik (Harisson)
     * Danny Keary (Dan9550)
     * David Jiménez (Rydra)
     * David Russell (DavidARussell)
     * DeadlySurprise
     * Dmitri Suvorov (suvjunmd)
+    * dtluna
+    * Eduardo Cáceres (eduherminio)
     * Erasmus Schroder (rasco)
     * Eric Bajumpaa (SteelPhase)
+    * Evgeniy Sergeev (evgeniysergeev)
     * Fahrradkette
+    * Florian Wiesbauer (FiveAces)
     * Frank Razenberg (zzattack)
     * Gareth Needham (Ripley`)
-    * Glen Anderson (GlenAnderson)
+    * Glen Anderson (glen7)
     * Glenn Martin Jensen (Baxxster)
     * Gordon Martin (Happy0)
     * Guido Lipke (LipkeGu)
-    * Gyula Zimmermann (Graion Dilach)
+    * Hervé Matysiak (Herve-M)
     * Huw Pascoe
     * Ian T. Jacobsen (Smilex)
     * Imago
     * Iran
+    * Ishan Bhargava (ishantheperson)
+    * Ivaylo Draganov (dragunoff)
     * Jacob Dufault (jacobdufault)
     * James Dunne (jsd)
+    * James Gilbert (DSUK)
     * Jan-Willem Buurlage (jwbuurlage)
     * Jason (atlimit8)
     * Jeff Harris (jeff_1amstudios)
+    * Jefri Sevkin (Arular)
     * Jes
     * Joakim Lindberg (booom3)
+    * Joe Alam (joealam)
+    * John Turner (whinis)
+    * Jonas A. Lind (SoScared)
+    * Joppy Furr
     * Kanar
     * Kenny Hoxworth (hoxworth)
+    * Kevin Azzam (ChaoticMind)
     * Krishnakanth Mallik
+    * Kyle Smith (Smitty)
     * Kyrre Soerensen (zypres)
     * Lawrence Wang
     * Lesueur Benjamin (Valkirie)
     * Maarten Meuris (Nyerguds)
+    * Manuel Geiger (Ectras)
     * Mark Olson (markolson)
+    * Markus Hartung (hartmark)
     * Matija Hustic (matija-hustic)
     * Matthew Gatland (mgatland)
     * Matthew Uzzell (MUzzell)
     * Matthijs Benschop (Nerdie)
     * Max621
     * Max Ugrumov (katzsmile)
+    * Mazar Farran (mazarf)
+    * Michael Rätzel
+    * Michael Silber (frühstück)
     * Michael Sztolcman (s1w_)
+    * Mike Gagné (AngryBirdz)
+    * Muh
     * Mustafa Alperen Seki (MustaphaTR)
     * Neil Shivkar (havok13888)
+    * Nikolay Fomin (netnazgul)
     * Nooze
     * Nukem
     * Okunev Yu Dmitry (xaionaro)
@@ -93,23 +128,35 @@ Also thanks to:
     * Paolo Chiodi (paolochiodi)
     * Paul Dovydaitis (pdovy)
     * Pavlos Touboulidis (pav)
+    * Pedro Ferreira Ramos (bateramos)
+    * Peter Amrehn (jongleur1983)
     * Pizzaoverhead
+    * Pi Delport (pjdelport)
     * Psydev
+    * Raphael Vogt (TheRaffy, Yellow)
     * Raymond Bedrossian (Squiggles211)
     * Raymond Martineau (mart0258)
     * Riderr3
+    * riiga
     * Rikhardur Bjarni Einarsson (WolfGaming)
     * Sascha Biedermann (bidifx)
-    * Sebastien Kerguen (xanax)
+    * Sean Hunt (coppro)
     * Shawn Collins (UberWaffe)
     * Simon Verbeke (Saticmotion)
+    * Stuart McHattie (SDJMcHattie)
     * Taryn Hill (Phrohdoh)
     * Teemu Nieminen (Temeez)
+    * Thomas Christlieb (ThomasChr)
     * Tim Mylemans (gecko)
     * Tirili
+    * Tomas Einarsson (Mesacer)
+    * Tom van Leth (tovl)
+    * Trevor Nichols (ocdi)
     * Tristan Keating (Kilkakon)
     * Tristan Mühlbacher (MicroBit)
+    * UnknownProgrammer
     * Vladimir Komarov (VrKomarov)
+    * Wojciech Walaszek (Voidwalker)
     * Wuschel
 
 Using GNU FreeFont distributed under the GNU GPL
@@ -123,20 +170,8 @@ FreeType License.
 
 Using OpenAL Soft distributed under the GNU LGPL.
 
-Using MaxMind GeoIP2 .NET API distributed under
-the Apache 2.0 license.
-
-Using GeoLite2 data created by MaxMind and
-distributed under the CC BY-SA 3.0 license.
-
-Using SharpFont created by Robert Rouhani and
-distributed under the MIT license.
-
-Using the Open Toolkit distributed under the
-MIT license.
-
-Using SDL2# created by Ethan Lee and released
-under the zlib license.
+Using SDL2-CS and OpenAL-CS created by Ethan
+Lee and released under the zlib license.
 
 Using Eluant created by Chris Howie and released
 under the MIT license.
@@ -144,14 +179,41 @@ under the MIT license.
 Using FuzzyLogicLibrary (fuzzynet) by Dmitry
 Kaluzhny and released under the GNU GPL terms.
 
-Using Mono.Nat by Alan McGovern and Ben
-Motmans and distributed under the MIT license.
+Using Mono.Nat by Alan McGovern, Ben Motmans,
+Nicholas Terry distributed under the MIT license.
+
+Using MP3Sharp by Robert Bruke and Zane Wagner
+licensed under the GNU LGPL Version 3.
+
+Using TagLib# by Stephen Shaw licensed under the
+GNU LGPL Version 2.1.
+
+Using NVorbis by Andrew Ward distributed under
+the MIT license.
 
 Using ICSharpCode.SharpZipLib initially by Mike
 Krueger and distributed under the GNU GPL terms.
 
+Using rix0rrr.BeaconLib developed by Rico Huijbers
+distributed under MIT License.
+
+Using DiscordRichPresence developed by Lachee
+distributed under MIT License.
+
+Using Json.NET developed by James Newton-King
+distributed under MIT License.
+
+Using ANGLE distributed under the BS3 3-Clause license.
+
+Using Pfim developed by Nick Babcock
+distributed under the MIT license.
+
+Using Linguini by the Space Station 14 team
+licensed under Apache and MIT terms.
+
+This site or product includes IP2Location LITE data
+available from http://www.ip2location.com.
 
 Finally, special thanks goes to the original teams
 at Westwood Studios and EA for creating the classic
 games which OpenRA aims to reimagine.
-

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by private-messaging a project team member (users with a + in front
+of their name) via our IRC channel (#openra on Libera –
+[webchat](https://web.libera.chat/#openra)). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -1,5 +1,8 @@
 # OpenRA Contributing Guidelines
 
+## Participating
+Help us keep OpenRA open and inclusive. Please read and follow our [Code of Conduct](https://github.com/OpenRA/OpenRA/blob/bleed/CODE_OF_CONDUCT.md).
+
 ## Bug reports
 
 * Have you read the [FAQ](https://github.com/OpenRA/OpenRA/wiki/FAQ)?
@@ -17,7 +20,7 @@
 
 Please `git rebase` to the latest revision of the bleed branch.
 
-Don't forget to add youself to [AUTHORS](https://github.com/OpenRA/OpenRA/blob/bleed/AUTHORS).
+Don't forget to add yourself to [AUTHORS](https://github.com/OpenRA/OpenRA/blob/bleed/AUTHORS).
 
 Please propose a [CHANGELOG](https://github.com/OpenRA/OpenRA/wiki/CHANGELOG) entry in the pull-request comments.
 

Directory.Build.props

@@ -0,0 +1,52 @@
+<Project>
+  <PropertyGroup>
+    <OutputType>Library</OutputType>
+    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Optimize>true</Optimize>
+    <LangVersion>7.3</LangVersion>
+    <DebugSymbols>true</DebugSymbols>
+    <EngineRootPath Condition="'$(EngineRootPath)' == ''">..</EngineRootPath>
+    <OutputPath>$(EngineRootPath)/bin</OutputPath>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <ExternalConsole>false</ExternalConsole>
+    <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
+    <CodeAnalysisRuleSet>$(EngineRootPath)/OpenRA.ruleset</CodeAnalysisRuleSet>
+    <Nullable>disable</Nullable>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <TargetFramework Condition="'$(MSBuildRuntimeType)'!='Mono'">net6.0</TargetFramework>
+    <TargetFramework Condition="'$(MSBuildRuntimeType)'=='Mono'">netstandard2.1</TargetFramework>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <TargetPlatform Condition="$([MSBuild]::IsOsPlatform('Windows'))">win-x64</TargetPlatform>
+    <TargetPlatform Condition="$([MSBuild]::IsOsPlatform('Linux'))">linux-x64</TargetPlatform>
+    <TargetPlatform Condition="$([MSBuild]::IsOsPlatform('OSX'))">osx-x64</TargetPlatform>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <Optimize>false</Optimize>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <!-- Work around an issue where Rider does not detect files in the project root using the default glob -->
+    <Compile Include="**/*.cs" Exclude="$(DefaultItemExcludes)" />
+  </ItemGroup>
+
+  <Target Name="DisableAnalyzers" BeforeTargets="CoreCompile" Condition="'$(Configuration)'=='Release'">
+    <!-- Disable code style analysis on Release builds to improve compile-time performance -->
+    <ItemGroup Condition="'$(Configuration)'=='Release'">
+      <Analyzer Remove="@(Analyzer)" />
+    </ItemGroup>
+  </Target>
+
+  <!-- StyleCop -->
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.2" PrivateAssets="All" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
+  </ItemGroup>
+</Project>

INSTALL.md

@@ -6,68 +6,78 @@ The following lists per-platform dependencies required to build from source.
 Windows
 =======
 
-* [Windows PowerShell >= 4.0](http://microsoft.com/powershell)
-* [.NET Framework >= 4.0 (Client Profile)](http://www.microsoft.com/en-us/download/details.aspx?id=17113)
-* [SDL 2](http://www.libsdl.org/download-2.0.php) (included)
-* [FreeType](http://gnuwin32.sourceforge.net/packages/freetype.htm) (included)
-* [zlib](http://gnuwin32.sourceforge.net/packages/zlib.htm) (included)
-* [OpenAL](http://kcat.strangesoft.net/openal.html) (included)
-* [liblua 5.1](http://luabinaries.sourceforge.net/download.html) (included)
+Compiling OpenRA requires the following dependencies:
+* [Windows PowerShell >= 4.0](http://microsoft.com/powershell) (included by default in recent Windows 10 versions)
+* [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0) (or via Visual Studio)
 
-You need to fetch the thirdparty dependencies using [NuGet](http://www.nuget.org) and place them at the appropriate places by typing `make dependencies` in a command terminal.
+To compile OpenRA, open the `OpenRA.sln` solution in the main folder, build it from the command-line with `dotnet` or use the Makefile analogue command `make all` scripted in PowerShell syntax.
 
-To compile OpenRA, open the `OpenRA.sln` solution in the main folder, build it from the command-line with MSBuild or use the Makefile analogue command `make all` scripted in PowerShell syntax.
-
-Run the game with `OpenRA.Game.exe Game.Mod=ra` for Red Alert or `OpenRA.Game.exe Game.Mod=cnc` for Tiberian Dawn.
+Run the game with `launch-game.cmd`. It can be handed arguments that specify the exact mod one wishes to run, for example, run `launch-game.cmd Game.Mod=ra` to launch Red Alert, `launch-game.cmd Game.Mod=cnc` to start Tiberian dawn or `launch-game.cmd Game.Mod=d2k` to launch Dune 2000.
 
 Linux
 =====
 
-Use `make dependencies` to map the native libraries to your system, fetch the remaining CLI dependencies using [NuGet](http://www.nuget.org) and place them at the appropriate places.
+.NET 6 or Mono (version 6.4 or later) is required to compile OpenRA. We recommend using .NET 6 when possible, as Mono is poorly packaged by most Linux distributions (e.g. missing the required `msbuild` toolchain), and has been deprecated as a standalone project.
 
-To compile OpenRA, run `make all` from the command line.
+The [.NET 6 download page](https://dotnet.microsoft.com/download/dotnet/6.0) provides repositories for various package managers and binary releases for several architectures. If you prefer to use Mono, we suggest adding the [upstream repository](https://www.mono-project.com/download/stable/#download-lin) for your distro to obtain the latest version and the `msbuild` toolchain.
 
-Run with either `launch-game.sh` or `mono --debug OpenRA.Game.exe`.
+To compile OpenRA, run `make` from the command line (or `make RUNTIME=mono` if using Mono). After this one can run the game with `./launch-game.sh`. It is also possible to specify the mod you wish to run from the command line, e.g. with `./launch-game.sh Game.Mod=ts` if you wish to try the experimental Tiberian Sun mod.
 
-Type `sudo make install-all` for system wide installation. Run `make install-linux-shortcuts` to get startup scripts, icons and desktop files. You can then run from the `openra` shortcut.
+The default behaviour on the x86_64 architecture is to download several pre-compiled native libraries using the Nuget packaging manager. If you prefer to use system libraries, compile instead using `make TARGETPLATFORM=unix-generic`.
 
-Debian/Ubuntu
--------------
+If you choose to use system libraries, or your system is not x86_64, you will need to install [SDL 2](https://www.libsdl.org/download-2.0.php), [FreeType](http://gnuwin32.sourceforge.net/packages/freetype.htm), [OpenAL](https://openal-soft.org/), and [liblua 5.1](http://luabinaries.sourceforge.net/download.html) before compiling OpenRA.
 
-* mono-dmcs
-* libmono-system-windows-forms4.0-cil
-* nuget
-* cli-common-dev (>= 2.10)
-* libfreetype6
-* libopenal1
-* liblua5.1-0
-* libsdl2-2.0-0
-* xdg-utils
-* zenity
+These can be installed using your package manager on various distros:
 
-openSUSE
---------
+<details><summary>Arch Linux</summary>
 
-* mono-devel
-* nuget
-* openal
-* freetype2
-* SDL2
-* lua51
-* xdg-utils
-* zenity
+```
+sudo pacman -S openal libgl freetype2 sdl2 lua51
+```
+</details>
+<details><summary>Debian/Ubuntu</summary>
 
-Gentoo
-------
+```
+sudo apt install libfreetype6 libopenal1 liblua5.1-0 libsdl2-2.0-0
+```
+</details>
+<details><summary>Fedora</summary>
 
-* dev-lang/mono
-* dev-dotnet/libgdiplus
-* dev-dotnet/nuget
-* media-libs/freetype:2
-* media-libs/libsdl2
-* media-libs/openal
-* virtual/jpeg
-* virtual/opengl
-* dev-lang/lua-5.1.5
-* x11-misc/xdg-utils
-* gnome-extra/zenity
+```
+sudo dnf install SDL2 freetype "lua = 5.1" openal-soft
+```
+</details>
+<details><summary>Gentoo</summary>
+
+```
+sudo emerge -av media-libs/freetype:2 media-libs/libsdl2 media-libs/openal virtual/opengl '=dev-lang/lua-5.1.5*'
+```
+</details>
+<details><summary>Mageia</summary>
+
+```
+sudo dnf install SDL2 freetype "lib*lua5.1" "lib*freetype2" "lib*sdl2.0_0" openal-soft
+```
+</details>
+<details><summary>openSUSE</summary>
+
+```
+sudo zypper in openal-soft freetype2 SDL2 lua51
+```
+</details>
+<details><summary>Red Hat Enterprise Linux (and rebuilds, e.g. CentOS)</summary>
+The EPEL repository is required in order for the following command to run properly.
+
+```
+sudo yum install SDL2 freetype "lua = 5.1" openal-soft
+```
+</details>
+
+Type `sudo make install` for system-wide installation. Run `sudo make install-linux-shortcuts` to get startup scripts, icons and desktop files. You can then run the Red Alert by executing the `openra-ra` command, the Dune 2000 mod by running the `openra-d2k` command and Tiberian Dawn by the `openra-cnc` command. Alternatively, you can also run these mods by clicking on their desktop shortcuts if you ran `sudo make install-linux-shortcuts`.
+
+macOS
+=====
+
+[.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) or [Mono](https://www.mono-project.com/download/stable/#download-mac) (version 6.4 or later) is required to compile OpenRA. We recommend using .NET 6 unless you are running a very old version of macOS (10.9 through 10.14).
+
+To compile OpenRA, run `make` from the command line (or `make RUNTIME=mono` if using Mono). Run with `./launch-game.sh`.

Makefile

@@ -1,60 +1,43 @@
 ############################# INSTRUCTIONS #############################
 #
 # to compile, run:
-#   make [DEBUG=false]
+#   make
 #
-# to compile with development tools, run:
-#   make all [DEBUG=false]
+# to compile using Mono (version 6.4 or greater) instead of .NET 6, run:
+#   make RUNTIME=mono
+#
+# to compile using system libraries for native dependencies, run:
+#   make [RUNTIME=net6] TARGETPLATFORM=unix-generic
 #
 # to check the official mods for erroneous yaml files, run:
-#   make test
+#   make [RUNTIME=net6] test
 #
-# to check the official mod dlls for StyleCop violations, run:
-#   make check
+# to check the engine and official mod dlls for code style violations, run:
+#   make [RUNTIME=net6] check
 #
-# to generate documentation aimed at modders, run:
-#   make docs
+# to compile and install Red Alert, Tiberian Dawn, and Dune 2000, run:
+#   make [RUNTIME=net6] [prefix=/foo] [bindir=/bar/bin] install
 #
-# to install, run:
-#   make [prefix=/foo] [bindir=/bar/bin] install
+# to compile and install Red Alert, Tiberian Dawn, and Dune 2000
+# using system libraries for native dependencies, run:
+#   make [prefix=/foo] [bindir=/bar/bin] TARGETPLATFORM=unix-generic install
 #
-# to install with development tools, run:
-#   make [prefix=/foo] [bindir=/bar/bin] install-all
+# to install FreeDesktop startup scripts, desktop files, icons, and MIME metadata
+#   make install-linux-shortcuts
 #
-# to install Linux startup scripts, desktop files and icons:
-#   make install-linux-shortcuts [DEBUG=false]
+# to install FreeDesktop AppStream metadata
+#   make install-linux-appdata
 #
-# to uninstall, run:
-#   make uninstall
+# to install the Unix man page
+#   make install-man
 #
 # for help, run:
 #   make help
 #
-# to start the game, run:
-#   openra
-
-
-
-############################## TOOLCHAIN ###############################
-#
-CSC         = dmcs
-CSFLAGS     = -nologo -warn:4 -codepage:utf8 -unsafe -warnaserror
-DEFINE      = TRACE
-COMMON_LIBS = System.dll System.Core.dll System.Data.dll System.Data.DataSetExtensions.dll System.Drawing.dll System.Xml.dll thirdparty/download/ICSharpCode.SharpZipLib.dll thirdparty/download/FuzzyLogicLibrary.dll thirdparty/download/Mono.Nat.dll thirdparty/download/MaxMind.Db.dll thirdparty/download/MaxMind.GeoIP2.dll thirdparty/download/Eluant.dll
-
-DEBUG = true
-ifeq ($(DEBUG), $(filter $(DEBUG),false no n off 0))
-CSFLAGS   += -debug:pdbonly -optimize+
-else
-CSFLAGS   += -debug:full -optimize-
-DEFINE    := DEBUG;$(DEFINE)
-endif
-
-
 
 ######################### UTILITIES/SETTINGS ###########################
 #
-# install locations
+# Install locations for local installs and downstream packaging
 prefix ?= /usr/local
 datarootdir ?= $(prefix)/share
 datadir ?= $(datarootdir)
@@ -63,407 +46,166 @@ bindir ?= $(prefix)/bin
 libdir ?= $(prefix)/lib
 gameinstalldir ?= $(libdir)/openra
 
-BIN_INSTALL_DIR = $(DESTDIR)$(bindir)
-DATA_INSTALL_DIR = $(DESTDIR)$(gameinstalldir)
-
-# install tools
+# Toolchain
+CWD = $(shell pwd)
+MSBUILD = msbuild -verbosity:m -nologo
+DOTNET = dotnet
+MONO = mono
 RM = rm
 RM_R = $(RM) -r
 RM_F = $(RM) -f
 RM_RF = $(RM) -rf
-CP = cp
-CP_R = $(CP) -r
-INSTALL = install
-INSTALL_DIR = $(INSTALL) -d
-INSTALL_PROGRAM = $(INSTALL) -m755
-INSTALL_DATA = $(INSTALL) -m644
 
-# program targets
-CORE = rsdl2 rnull game utility
-TOOLS = gamemonitor
-VERSION     = $(shell git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || echo git-`git rev-parse --short HEAD`)
+RUNTIME ?= net6
+CONFIGURATION ?= Release
+DOTNET_RID = $(shell ${DOTNET} --info | grep RID: | cut -w -f3)
+ARCH_X64 = $(shell echo ${DOTNET_RID} | grep x64)
 
-# dependencies
+# Only for use in target version:
+VERSION := $(shell git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || (c=$$(git rev-parse --short HEAD 2>/dev/null) && echo git-$$c))
+
+# Detect target platform for dependencies if not given by the user
+ifndef TARGETPLATFORM
 UNAME_S := $(shell uname -s)
+UNAME_M := $(shell uname -m)
 ifeq ($(UNAME_S),Darwin)
-os-dependencies = osx-dependencies
+ifeq ($(ARCH_X64),)
+TARGETPLATFORM = osx-arm64
 else
-os-dependencies = linux-dependencies
+TARGETPLATFORM = osx-x64
+endif
+else
+ifeq ($(UNAME_M),x86_64)
+TARGETPLATFORM = linux-x64
+else
+ifeq ($(UNAME_M),aarch64)
+TARGETPLATFORM = linux-arm64
+else
+TARGETPLATFORM = unix-generic
+endif
+endif
+endif
 endif
 
-
-
-######################## PROGRAM TARGET RULES ##########################
+##################### DEVELOPMENT BUILDS AND TESTS #####################
 #
-# Core binaries
+all:
+	@echo "Compiling in ${CONFIGURATION} mode..."
+ifeq ($(RUNTIME), mono)
+	@command -v $(firstword $(MSBUILD)) >/dev/null || (echo "OpenRA requires the '$(MSBUILD)' tool provided by Mono >= 6.4."; exit 1)
+	@$(MSBUILD) -t:Build -restore -p:Configuration=${CONFIGURATION} -p:TargetPlatform=$(TARGETPLATFORM)
+else
+	@$(DOTNET) build -c ${CONFIGURATION} -nologo -p:TargetPlatform=$(TARGETPLATFORM)
+endif
+ifeq ($(TARGETPLATFORM), unix-generic)
+	@./configure-system-libraries.sh
+endif
+	@./fetch-geoip.sh
 
-game_SRCS := $(shell find OpenRA.Game/ -iname '*.cs')
-game_TARGET = OpenRA.Game.exe
-game_KIND = winexe
-game_LIBS = $(COMMON_LIBS) $(game_DEPS) thirdparty/download/SDL2-CS.dll thirdparty/download/SharpFont.dll
-game_FLAGS = -win32icon:OpenRA.Game/OpenRA.ico
-PROGRAMS += game
-game: $(game_TARGET)
+# dotnet clean and msbuild -t:Clean leave files that cause problems when switching between mono/dotnet
+# Deleting the intermediate / output directories ensures the build directory is actually clean
+clean:
+	@-$(RM_RF) ./bin ./*/obj
+	@-$(RM_F) IP2LOCATION-LITE-DB1.IPV6.BIN.ZIP
 
-# Renderer dlls
-rsdl2_SRCS := $(shell find OpenRA.Renderer.Sdl2/ -iname '*.cs')
-rsdl2_TARGET = OpenRA.Renderer.Sdl2.dll
-rsdl2_KIND = library
-rsdl2_DEPS = $(game_TARGET)
-rsdl2_LIBS = $(COMMON_LIBS) thirdparty/download/SDL2-CS.dll $(rsdl2_DEPS)
-
-rnull_SRCS := $(shell find OpenRA.Renderer.Null/ -iname '*.cs')
-rnull_TARGET = OpenRA.Renderer.Null.dll
-rnull_KIND = library
-rnull_DEPS = $(game_TARGET)
-rnull_LIBS = $(COMMON_LIBS) $(rnull_DEPS)
-PROGRAMS += rsdl2 rnull
-renderers: $(rsdl2_TARGET) $(rnull_TARGET)
-
-# Mods Common
-mod_common_SRCS := $(shell find OpenRA.Mods.Common/ -iname '*.cs')
-mod_common_TARGET = mods/common/OpenRA.Mods.Common.dll
-mod_common_KIND = library
-mod_common_DEPS = $(game_TARGET)
-mod_common_LIBS = $(COMMON_LIBS) $(STD_MOD_LIBS) thirdparty/download/StyleCop.dll thirdparty/download/StyleCop.CSharp.dll thirdparty/download/StyleCop.CSharp.Rules.dll
-PROGRAMS += mod_common
-mod_common: $(mod_common_TARGET)
-
-##### Official Mods #####
-
-STD_MOD_LIBS	= $(game_TARGET)
-STD_MOD_DEPS	= $(STD_MOD_LIBS)
-
-# Red Alert
-mod_ra_SRCS := $(shell find OpenRA.Mods.RA/ -iname '*.cs')
-mod_ra_TARGET = mods/ra/OpenRA.Mods.RA.dll
-mod_ra_KIND = library
-mod_ra_DEPS = $(STD_MOD_DEPS) $(mod_common_TARGET)
-mod_ra_LIBS = $(COMMON_LIBS) $(STD_MOD_LIBS) $(mod_common_TARGET)
-PROGRAMS += mod_ra
-mod_ra: $(mod_ra_TARGET)
-
-# Command and Conquer
-mod_cnc_SRCS := $(shell find OpenRA.Mods.Cnc/ -iname '*.cs')
-mod_cnc_TARGET = mods/cnc/OpenRA.Mods.Cnc.dll
-mod_cnc_KIND = library
-mod_cnc_DEPS = $(STD_MOD_DEPS) $(mod_common_TARGET)
-mod_cnc_LIBS = $(COMMON_LIBS) $(STD_MOD_LIBS) $(mod_common_TARGET)
-PROGRAMS += mod_cnc
-mod_cnc: $(mod_cnc_TARGET)
-
-# Dune 2000
-mod_d2k_SRCS := $(shell find OpenRA.Mods.D2k/ -iname '*.cs')
-mod_d2k_TARGET = mods/d2k/OpenRA.Mods.D2k.dll
-mod_d2k_KIND = library
-mod_d2k_DEPS = $(STD_MOD_DEPS) $(mod_common_TARGET)
-mod_d2k_LIBS = $(COMMON_LIBS) $(STD_MOD_LIBS) $(mod_common_TARGET)
-PROGRAMS += mod_d2k
-mod_d2k: $(mod_d2k_TARGET)
-
-# Tiberian Sun
-mod_ts_SRCS := $(shell find OpenRA.Mods.TS/ -iname '*.cs')
-mod_ts_TARGET = mods/ts/OpenRA.Mods.TS.dll
-mod_ts_KIND = library
-mod_ts_DEPS = $(STD_MOD_DEPS) $(mod_common_TARGET)
-mod_ts_LIBS = $(COMMON_LIBS) $(STD_MOD_LIBS) $(mod_common_TARGET)
-PROGRAMS += mod_ts
-mod_ts: $(mod_ts_TARGET)
-
-check: utility mods
+check:
 	@echo
-	@echo "Checking for code style violations in OpenRA.Game..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Game
+	@echo "Compiling in Debug mode..."
+ifeq ($(RUNTIME), mono)
+# Enabling EnforceCodeStyleInBuild and GenerateDocumentationFile as a workaround for some code style rules (in particular IDE0005) being bugged and not reporting warnings/errors otherwise.
+	@$(MSBUILD) -t:build -restore -p:Configuration=Debug -warnaserror -p:TargetPlatform=$(TARGETPLATFORM) -p:EnforceCodeStyleInBuild=true -p:GenerateDocumentationFile=true
+else
+# Enabling EnforceCodeStyleInBuild and GenerateDocumentationFile as a workaround for some code style rules (in particular IDE0005) being bugged and not reporting warnings/errors otherwise.
+	@$(DOTNET) build -c Debug -nologo -warnaserror -p:TargetPlatform=$(TARGETPLATFORM) -p:EnforceCodeStyleInBuild=true -p:GenerateDocumentationFile=true
+endif
+ifeq ($(TARGETPLATFORM), unix-generic)
+	@./configure-system-libraries.sh
+endif
 	@echo
-	@echo "Checking for code style violations in OpenRA.Renderer.Null..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Renderer.Null
+	@echo "Checking for explicit interface violations..."
+	@./utility.sh all --check-explicit-interfaces
 	@echo
-	@echo "Checking for code style violations in OpenRA.GameMonitor..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.GameMonitor
-	@echo
-	@echo "Checking for code style violations in OpenRA.Mods.Common..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Mods.Common
-	@echo
-	@echo "Checking for code style violations in OpenRA.Mods.RA..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Mods.RA
-	@echo
-	@echo "Checking for code style violations in OpenRA.Mods.Cnc..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Mods.Cnc
-	@echo
-	@echo "Checking for code style violations in OpenRA.Mods.D2k..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Mods.D2k
-	@echo
-	@echo "Checking for code style violations in OpenRA.Mods.TS..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Mods.TS
-	@echo
-	@echo "Checking for code style violations in OpenRA.Renderer.Sdl2..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Renderer.Sdl2
-	@echo
-	@echo "Checking for code style violations in OpenRA.Utility..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Utility
-	@echo
-	@echo "Checking for code style violations in OpenRA.Test..."
-	@mono --debug OpenRA.Utility.exe ra --check-code-style OpenRA.Test
+	@echo "Checking for incorrect conditional trait interface overrides..."
+	@./utility.sh all --check-conditional-trait-interface-overrides
 
-test: utility mods
+check-scripts:
+	@echo
+	@echo "Checking for Lua syntax errors..."
+	@find lua/ mods/*/{maps,scripts}/ -iname "*.lua" -print0 | xargs -0n1 luac -p
+
+test: all
 	@echo
 	@echo "Testing Tiberian Sun mod MiniYAML..."
-	@mono --debug OpenRA.Utility.exe ts --check-yaml
+	@./utility.sh ts --check-yaml
 	@echo
 	@echo "Testing Dune 2000 mod MiniYAML..."
-	@mono --debug OpenRA.Utility.exe d2k --check-yaml
+	@./utility.sh d2k --check-yaml
 	@echo
 	@echo "Testing Tiberian Dawn mod MiniYAML..."
-	@mono --debug OpenRA.Utility.exe cnc --check-yaml
+	@./utility.sh cnc --check-yaml
 	@echo
 	@echo "Testing Red Alert mod MiniYAML..."
-	@mono --debug OpenRA.Utility.exe ra --check-yaml
+	@./utility.sh ra --check-yaml
 
-
-##### Launchers / Utilities #####
-
-gamemonitor_SRCS := $(shell find OpenRA.GameMonitor/ -iname '*.cs')
-gamemonitor_TARGET = OpenRA.exe
-gamemonitor_KIND = winexe
-gamemonitor_DEPS = $(game_TARGET)
-gamemonitor_LIBS = $(COMMON_LIBS) $(gamemonitor_DEPS) System.Windows.Forms.dll
-gamemonitor_FLAGS = -win32icon:OpenRA.Game/OpenRA.ico
-PROGRAMS += gamemonitor
-gamemonitor: $(gamemonitor_TARGET)
-
-# Backend for the launcher apps - queries game/mod info and applies actions to an install
-utility_SRCS := $(shell find OpenRA.Utility/ -iname '*.cs')
-utility_TARGET = OpenRA.Utility.exe
-utility_KIND = exe
-utility_DEPS = $(game_TARGET)
-utility_LIBS = $(COMMON_LIBS) $(utility_DEPS) thirdparty/download/ICSharpCode.SharpZipLib.dll
-PROGRAMS += utility
-utility: $(utility_TARGET)
-
-# Patches binary headers to work around a mono bug
-fixheader.exe: packaging/fixheader.cs
-	@echo CSC fixheader.exe
-	@$(CSC) packaging/fixheader.cs $(CSFLAGS) -out:fixheader.exe -t:exe $(COMMON_LIBS:%=-r:%)
-
-# Generate build rules for each target defined above in PROGRAMS
-define BUILD_ASSEMBLY
-
-$$($(1)_TARGET): $$($(1)_SRCS) Makefile $$($(1)_DEPS) fixheader.exe
-	@echo CSC $$(@)
-	@$(CSC) $$($(1)_LIBS:%=-r:%) \
-		-out:$$(@) $(CSFLAGS) $$($(1)_FLAGS) \
-		-define:"$(DEFINE)" \
-		-t:"$$($(1)_KIND)" \
-		$$($(1)_EXTRA) \
-		$$($(1)_SRCS)
-	@mono fixheader.exe $$(@) > /dev/null
-	@test `echo $$(@) | sed 's/^.*\.//'` = "dll" && chmod a-x $$(@) || ``
-	@$$($(1)_EXTRA_CMDS)
-endef
-
-$(foreach prog,$(PROGRAMS),$(eval $(call BUILD_ASSEMBLY,$(prog))))
-
-
-
-########################## MAKE/INSTALL RULES ##########################
+############# LOCAL INSTALLATION AND DOWNSTREAM PACKAGING ##############
 #
-default: core
-
-core: game renderers mods utility
-
-tools: gamemonitor
-
-package: all-dependencies core tools docs version
-
-mods: mod_common mod_ra mod_cnc mod_d2k mod_ts
-
-all: dependencies core tools
-
-clean:
-	@-$(RM_F) *.exe *.dll *.dylib *.dll.config ./OpenRA*/*.dll ./OpenRA*/*.mdb *.mdb mods/**/*.dll mods/**/*.mdb *.resources
-	@-$(RM_RF) ./*/bin ./*/obj
-	@-$(RM_RF) ./thirdparty/download
-
-distclean: clean
-
-cli-dependencies:
-	@./thirdparty/fetch-thirdparty-deps.sh
-	@ $(CP_R) thirdparty/download/*.dll .
-	@ $(CP_R) thirdparty/download/*.dll.config .
-	@ $(CP) thirdparty/SDL2-CS.dll.config .
-
-linux-dependencies: cli-dependencies linux-native-dependencies
-
-linux-native-dependencies:
-	@./thirdparty/configure-native-deps.sh
-
-windows-dependencies:
-	@./thirdparty/fetch-thirdparty-deps-windows.sh
-
-osx-dependencies: cli-dependencies
-	@./thirdparty/fetch-thirdparty-deps-osx.sh
-	@ $(CP_R) thirdparty/download/osx/*.dylib .
-	@ $(CP_R) thirdparty/download/osx/*.dll.config .
-
-dependencies: $(os-dependencies)
-	@./thirdparty/fetch-geoip-db.sh
-	@ $(CP) thirdparty/download/GeoLite2-Country.mmdb.gz .
-
-all-dependencies: cli-dependencies windows-dependencies osx-dependencies
-
-version: mods/ra/mod.yaml mods/cnc/mod.yaml mods/d2k/mod.yaml mods/ts/mod.yaml mods/modchooser/mod.yaml mods/all/mod.yaml
-	@for i in $? ; do \
-		awk '{sub("Version:.*$$","Version: $(VERSION)"); print $0}' $${i} > $${i}.tmp && \
-		mv -f $${i}.tmp $${i} ; \
-	done
-
-docs: utility mods version
-	@mono --debug OpenRA.Utility.exe all --docs > DOCUMENTATION.md
-	@mono --debug OpenRA.Utility.exe all --lua-docs > Lua-API.md
-
-man-page: utility mods
-	@mono --debug OpenRA.Utility.exe all --man-page > openra.6
-
-install: install-core
-
-install-all: install-core install-tools
-
-install-linux-shortcuts: install-linux-scripts install-linux-icons install-linux-desktop
-
-install-core: default
-	@-echo "Installing OpenRA to $(DATA_INSTALL_DIR)"
-	@$(INSTALL_DIR) "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) $(foreach prog,$(CORE),$($(prog)_TARGET)) "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_DIR) "$(DATA_INSTALL_DIR)/mods"
-	@$(CP_R) mods/common "$(DATA_INSTALL_DIR)/mods/"
-	@$(INSTALL_PROGRAM) $(mod_common_TARGET) "$(DATA_INSTALL_DIR)/mods/common"
-	@$(CP_R) mods/cnc "$(DATA_INSTALL_DIR)/mods/"
-	@$(INSTALL_PROGRAM) $(mod_cnc_TARGET) "$(DATA_INSTALL_DIR)/mods/cnc"
-	@$(CP_R) mods/ra "$(DATA_INSTALL_DIR)/mods/"
-	@$(INSTALL_PROGRAM) $(mod_ra_TARGET) "$(DATA_INSTALL_DIR)/mods/ra"
-	@$(CP_R) mods/d2k "$(DATA_INSTALL_DIR)/mods/"
-	@$(INSTALL_PROGRAM) $(mod_d2k_TARGET) "$(DATA_INSTALL_DIR)/mods/d2k"
-	@$(CP_R) mods/modchooser "$(DATA_INSTALL_DIR)/mods/"
-
-	@$(INSTALL_DATA) "global mix database.dat" "$(DATA_INSTALL_DIR)/global mix database.dat"
-	@$(INSTALL_DATA) "GeoLite2-Country.mmdb.gz" "$(DATA_INSTALL_DIR)/GeoLite2-Country.mmdb.gz"
-	@$(INSTALL_DATA) AUTHORS "$(DATA_INSTALL_DIR)/AUTHORS"
-	@$(INSTALL_DATA) COPYING "$(DATA_INSTALL_DIR)/COPYING"
-
-	@$(CP_R) glsl "$(DATA_INSTALL_DIR)"
-	@$(CP_R) lua "$(DATA_INSTALL_DIR)"
-	@$(CP) SDL2-CS* "$(DATA_INSTALL_DIR)"
-	@$(CP) Eluant* "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) ICSharpCode.SharpZipLib.dll "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) FuzzyLogicLibrary.dll "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) SharpFont.dll "$(DATA_INSTALL_DIR)"
-	@$(CP) SharpFont.dll.config "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) Mono.Nat.dll "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) MaxMind.Db.dll "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) MaxMind.GeoIP2.dll "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) Newtonsoft.Json.dll "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) RestSharp.dll "$(DATA_INSTALL_DIR)"
-
-ifneq ($(UNAME_S),Darwin)
-	@$(CP) *.sh "$(DATA_INSTALL_DIR)"
+version: VERSION mods/ra/mod.yaml mods/cnc/mod.yaml mods/d2k/mod.yaml mods/ts/mod.yaml mods/modcontent/mod.yaml mods/all/mod.yaml
+ifeq ($(VERSION),)
+	$(error Unable to determine new version (requires git or override of variable VERSION))
 endif
+	@sh -c '. ./packaging/functions.sh; set_engine_version "$(VERSION)" .'
+	@sh -c '. ./packaging/functions.sh; set_mod_version "$(VERSION)" mods/ra/mod.yaml mods/cnc/mod.yaml mods/d2k/mod.yaml mods/ts/mod.yaml mods/modcontent/mod.yaml mods/all/mod.yaml'
 
-install-tools: tools
-	@-echo "Installing OpenRA tools to $(DATA_INSTALL_DIR)"
-	@$(INSTALL_DIR) "$(DATA_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) $(foreach prog,$(TOOLS),$($(prog)_TARGET)) "$(DATA_INSTALL_DIR)"
+install:
+	@sh -c '. ./packaging/functions.sh; install_assemblies $(CWD) $(DESTDIR)$(gameinstalldir) $(TARGETPLATFORM) $(RUNTIME) True True True'
+	@sh -c '. ./packaging/functions.sh; install_data $(CWD) $(DESTDIR)$(gameinstalldir) cnc d2k ra'
 
-install-linux-icons:
-	@$(INSTALL_DIR) "$(DESTDIR)$(datadir)/icons/"
-	@$(CP_R) packaging/linux/hicolor "$(DESTDIR)$(datadir)/icons/"
-
-install-linux-desktop:
-	@$(INSTALL_DIR) "$(DESTDIR)$(datadir)/applications"
-	@$(INSTALL_DATA) packaging/linux/openra.desktop "$(DESTDIR)$(datadir)/applications"
-
-install-linux-mime:
-	@$(INSTALL_DIR) "$(DESTDIR)$(datadir)/mime/packages/"
-	@$(INSTALL_DATA) packaging/linux/openra-mimeinfo.xml "$(DESTDIR)$(datadir)/mime/packages/openra.xml"
-
-	@$(INSTALL_DIR) "$(DESTDIR)$(datadir)/applications"
-	@$(INSTALL_DATA) packaging/linux/openra-join-servers.desktop "$(DESTDIR)$(datadir)/applications"
-	@$(INSTALL_DATA) packaging/linux/openra-replays.desktop "$(DESTDIR)$(datadir)/applications"
+install-linux-shortcuts:
+	@sh -c '. ./packaging/functions.sh; install_linux_shortcuts $(CWD) "$(DESTDIR)" "$(gameinstalldir)" "$(bindir)" "$(datadir)" "$(shell head -n1 VERSION)" cnc d2k ra'
 
 install-linux-appdata:
-	@$(INSTALL_DIR) "$(DESTDIR)$(datadir)/appdata/"
-	@$(INSTALL_DATA) packaging/linux/openra.appdata.xml "$(DESTDIR)$(datadir)/appdata/"
+	@sh -c '. ./packaging/functions.sh; install_linux_appdata $(CWD) "$(DESTDIR)" "$(datadir)" cnc d2k ra'
 
-install-man-page: man-page
-	@$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man6/"
-	@$(INSTALL_DATA) openra.6 "$(DESTDIR)$(mandir)/man6/"
-
-install-linux-scripts:
-	@echo "#!/bin/sh" > openra
-	@echo 'cd "$(gameinstalldir)"' >> openra
-ifeq ($(DEBUG), $(filter $(DEBUG),false no n off 0))
-	@echo 'mono OpenRA.Game.exe "$$@"' >> openra
-else
-	@echo 'mono --debug OpenRA.Game.exe "$$@"' >> openra
-endif
-	@echo 'if [ $$? != 0 -a $$? != 1 ]' >> openra
-	@echo 'then' >> openra
-	@echo 'ZENITY=`which zenity` || echo "OpenRA needs zenity installed to display a graphical error dialog. See ~/.openra. for log files."' >> openra
-	@echo '$$ZENITY --question --title "OpenRA" --text "OpenRA has encountered a fatal error.\nLog Files are available in ~/.openra." --ok-label "Quit" --cancel-label "View FAQ" || xdg-open https://github.com/OpenRA/OpenRA/wiki/FAQ' >> openra
-	@echo 'exit 1' >> openra
-	@echo 'fi' >> openra
-
-	@$(INSTALL_DIR) "$(BIN_INSTALL_DIR)"
-	@$(INSTALL_PROGRAM) -m +rx openra "$(BIN_INSTALL_DIR)"
-	@-$(RM) openra
-
-uninstall:
-	@-$(RM_R) "$(DATA_INSTALL_DIR)"
-	@-$(RM_F) "$(BIN_INSTALL_DIR)/openra"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/applications/openra.desktop"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/icons/hicolor/16x16/apps/openra.png"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/icons/hicolor/32x32/apps/openra.png"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/icons/hicolor/48x48/apps/openra.png"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/icons/hicolor/64x64/apps/openra.png"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/icons/hicolor/128x128/apps/openra.png"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/mime/packages/openra.xml"
-	@-$(RM_F) "$(DESTDIR)$(datadir)/appdata/openra.appdata.xml"
-	@-$(RM_F) "$(DESTDIR)$(mandir)/man6/openra.6"
+install-man: all
+	@mkdir -p $(DESTDIR)$(mandir)/man6/
+	@./utility.sh all --man-page > $(DESTDIR)$(mandir)/man6/openra.6
 
 help:
-	@echo to compile, run:
-	@echo \ \ make [DEBUG=false]
+	@echo 'to compile, run:'
+	@echo '  make'
 	@echo
-	@echo to compile with development tools, run:
-	@echo \ \ make all [DEBUG=false]
+	@echo 'to compile using Mono (version 6.4 or greater) instead of .NET 6, run:'
+	@echo '  make RUNTIME=mono'
 	@echo
-	@echo to check the official mods for erroneous yaml files, run:
-	@echo \ \ make test
+	@echo 'to compile using system libraries for native dependencies, run:'
+	@echo '  make [RUNTIME=net6] TARGETPLATFORM=unix-generic'
 	@echo
-	@echo to generate documentation aimed at modders, run:
-	@echo \ \ make docs
+	@echo 'to check the official mods for erroneous yaml files, run:'
+	@echo '  make [RUNTIME=net6] test'
 	@echo
-	@echo to install, run:
-	@echo \ \ make \[prefix=/foo\] \[bindir=/bar/bin\] install
+	@echo 'to check the engine and official mod dlls for code style violations, run:'
+	@echo '  make [RUNTIME=net6] check'
 	@echo
-	@echo to install with development tools, run:
-	@echo \ \ make \[prefix=/foo\] \[bindir=/bar/bin\] install-all
+	@echo 'to compile and install Red Alert, Tiberian Dawn, and Dune 2000 run:'
+	@echo '  make [RUNTIME=net6] [prefix=/foo] [TARGETPLATFORM=unix-generic] install'
 	@echo
-	@echo to install Linux startup scripts, desktop files and icons
-	@echo \ \ make install-linux-shortcuts [DEBUG=false]
+	@echo 'to compile and install Red Alert, Tiberian Dawn, and Dune 2000'
+	@echo 'using system libraries for native dependencies, run:'
+	@echo '   make [RUNTIME=net6] [prefix=/foo] [bindir=/bar/bin] TARGETPLATFORM=unix-generic install'
 	@echo
-	@echo to uninstall, run:
-	@echo \ \ make uninstall
+	@echo 'to install FreeDesktop startup scripts, desktop files, icons, and MIME metadata'
+	@echo '  make install-linux-shortcuts'
 	@echo
-	@echo to start the game, run:
-	@echo \ \ openra
-
-
-
+	@echo 'to install FreeDesktop AppStream metadata'
+	@echo '  make install-linux-appdata'
+	@echo
+	@echo 'to install a Unix man page'
+	@echo '  make install-man'
 
 ########################### MAKEFILE SETTINGS ##########################
 #
-.DEFAULT_GOAL := default
+.DEFAULT_GOAL := all
 
 .SUFFIXES:
 
-.PHONY: core tools package all mods clean distclean dependencies version $(PROGRAMS)
+.PHONY: all clean check check-scripts test version install install-linux-shortcuts install-linux-appdata install-man help

OpenRA.Game.exe.config

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<configuration>
-  <runtime>
-    <loadFromRemoteSources enabled="true" />
-  </runtime>
-</configuration>

OpenRA.Game/Activities/Activity.cs

@@ -1,54 +1,291 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
+using OpenRA.Graphics;
+using OpenRA.Primitives;
 using OpenRA.Traits;
 
 namespace OpenRA.Activities
 {
-	public abstract class Activity
+	public enum ActivityState { Queued, Active, Canceling, Done }
+
+	public class TargetLineNode
 	{
-		public Activity NextActivity { get; set; }
-		protected bool IsCanceled { get; private set; }
+		public readonly Target Target;
+		public readonly Color Color;
+		public readonly Sprite Tile;
 
-		public abstract Activity Tick(Actor self);
-
-		public virtual void Cancel(Actor self)
+		public TargetLineNode(in Target target, Color color, Sprite tile = null)
 		{
-			IsCanceled = true;
-			NextActivity = null;
+			// Note: Not all activities are drawable. In that case, pass Target.Invalid as target,
+			// if "yield break" in TargetLineNode(Actor self) is not feasible.
+			Target = target;
+			Color = color;
+			Tile = tile;
+		}
+	}
+
+	/*
+	 * Things to be aware of when writing activities:
+	 *
+	 * - Use "return true" at least once somewhere in the tick method.
+	 * - Do not "reuse" activity objects (by queuing them as next or child, for example) that have already started running.
+	 *   Queue a new instance instead.
+	 * - Avoid calling actor.CancelActivity(). It is almost always a bug. Call activity.Cancel() instead.
+	 * - Do not evaluate dynamic state (an actor's location, health, conditions, etc.) in the activity's constructor,
+	 *   as that might change before the activity gets to tick for the first time.  Use the OnFirstRun() method instead.
+	 */
+	public abstract class Activity : IActivityInterface
+	{
+		public ActivityState State { get; private set; }
+
+		Activity childActivity;
+		protected Activity ChildActivity
+		{
+			get => SkipDoneActivities(childActivity);
+			private set => childActivity = value;
 		}
 
-		public virtual void Queue(Activity activity)
+		Activity nextActivity;
+		public Activity NextActivity
 		{
-			if (NextActivity != null)
-				NextActivity.Queue(activity);
+			get => SkipDoneActivities(nextActivity);
+			private set => nextActivity = value;
+		}
+
+		internal static Activity SkipDoneActivities(Activity first)
+		{
+			// If first.Cancel() was called while it was queued (i.e. before it first ticked), its state will be Done
+			// rather than Queued (the activity system guarantees that it cannot be Active or Canceling).
+			// An unknown number of ticks may have elapsed between the Cancel() call and now,
+			// so we cannot make any assumptions on the value of first.NextActivity.
+			// We must not return first (ticking it would be bogus), but returning null would potentially
+			// drop valid activities queued after it. Walk the queue until we find a valid activity or
+			// (more likely) run out of activities.
+			while (first != null && first.State == ActivityState.Done)
+				first = first.nextActivity;
+
+			return first;
+		}
+
+		public bool IsInterruptible { get; protected set; }
+		public bool ChildHasPriority { get; protected set; }
+		public bool IsCanceling => State == ActivityState.Canceling;
+		bool finishing;
+		bool firstRunCompleted;
+		bool lastRun;
+
+		public Activity()
+		{
+			IsInterruptible = true;
+			ChildHasPriority = true;
+		}
+
+		public Activity TickOuter(Actor self)
+		{
+			if (State == ActivityState.Done)
+				throw new InvalidOperationException($"Actor {self} attempted to tick activity {GetType()} after it had already completed.");
+
+			if (State == ActivityState.Queued)
+			{
+				OnFirstRun(self);
+				firstRunCompleted = true;
+				State = ActivityState.Active;
+			}
+
+			if (!firstRunCompleted)
+				throw new InvalidOperationException($"Actor {self} attempted to tick activity {GetType()} before running its OnFirstRun method.");
+
+			// Only run the parent tick when the child is done.
+			// We must always let the child finish on its own before continuing.
+			if (ChildHasPriority)
+			{
+				lastRun = TickChild(self) && (finishing || Tick(self));
+				finishing |= lastRun;
+			}
+
+			// The parent determines whether the child gets a chance at ticking.
 			else
-				NextActivity = activity;
+				lastRun = Tick(self);
+
+			// Avoid a single tick delay if the childactivity was just queued.
+			var ca = ChildActivity;
+			if (ca != null && ca.State == ActivityState.Queued)
+			{
+				if (ChildHasPriority)
+					lastRun = TickChild(self) && finishing;
+				else
+					TickChild(self);
+			}
+
+			if (lastRun)
+			{
+				State = ActivityState.Done;
+				OnLastRun(self);
+				return NextActivity;
+			}
+
+			return this;
+		}
+
+		protected bool TickChild(Actor self)
+		{
+			ChildActivity = ActivityUtils.RunActivity(self, ChildActivity);
+			return ChildActivity == null;
+		}
+
+		/// <summary>
+		/// Called every tick to run activity logic. Returns false if the activity should
+		/// remain active, or true if it is complete. Cancelled activities must ensure they
+		/// return the actor to a consistent state before returning true.
+		///
+		/// Child activities can be queued using QueueChild, and these will be ticked
+		/// instead of the parent while they are active. Activities that need to run logic
+		/// in parallel with child activities should set ChildHasPriority to false and
+		/// manually call TickChildren.
+		///
+		/// Queuing one or more child activities and returning true is valid, and causes
+		/// the activity to be completed immediately (without ticking again) once the
+		/// children have completed.
+		/// </summary>
+		public virtual bool Tick(Actor self)
+		{
+			return true;
+		}
+
+		/// <summary>
+		/// Runs once immediately before the first Tick() execution.
+		/// </summary>
+		protected virtual void OnFirstRun(Actor self) { }
+
+		/// <summary>
+		/// Runs once immediately after the last Tick() execution.
+		/// </summary>
+		protected virtual void OnLastRun(Actor self) { }
+
+		/// <summary>
+		/// Runs once on Actor.Dispose() (through OnActorDisposeOuter) and can be used to perform activity clean-up on actor death/disposal,
+		/// for example by force-triggering OnLastRun (which would otherwise be skipped).
+		/// </summary>
+		protected virtual void OnActorDispose(Actor self) { }
+
+		/// <summary>
+		/// Runs once on Actor.Dispose().
+		/// Main purpose is to ensure ChildActivity.OnActorDispose runs as well (which isn't otherwise accessible due to protection level).
+		/// </summary>
+		internal void OnActorDisposeOuter(Actor self)
+		{
+			ChildActivity?.OnActorDisposeOuter(self);
+
+			OnActorDispose(self);
+		}
+
+		public virtual void Cancel(Actor self, bool keepQueue = false)
+		{
+			if (!keepQueue)
+				NextActivity = null;
+
+			if (!IsInterruptible)
+				return;
+
+			ChildActivity?.Cancel(self);
+
+			// Directly mark activities that are queued and therefore didn't run yet as done
+			State = State == ActivityState.Queued ? ActivityState.Done : ActivityState.Canceling;
+		}
+
+		public void Queue(Activity activity)
+		{
+			var it = this;
+			while (it.nextActivity != null)
+				it = it.nextActivity;
+			it.nextActivity = activity;
+		}
+
+		public void QueueChild(Activity activity)
+		{
+			if (childActivity != null)
+				childActivity.Queue(activity);
+			else
+				childActivity = activity;
+		}
+
+		/// <summary>
+		/// Prints the activity tree, starting from the top or optionally from a given origin.
+		///
+		/// Call this method from any place that's called during a tick, such as the Tick() method itself or
+		/// the Before(First|Last)Run() methods. The origin activity will be marked in the output.
+		/// </summary>
+		/// <param name="self">The actor performing this activity.</param>
+		/// <param name="origin">Activity from which to start traversing, and which to mark. If null, mark the calling activity, and start traversal from the top.</param>
+		/// <param name="level">Initial level of indentation.</param>
+		protected void PrintActivityTree(Actor self, Activity origin = null, int level = 0)
+		{
+			if (origin == null)
+				self.CurrentActivity.PrintActivityTree(self, this);
+			else
+			{
+				Console.Write(new string(' ', level * 2));
+				if (origin == this)
+					Console.Write("*");
+
+				Console.WriteLine(GetType().ToString().Split('.').Last());
+
+				ChildActivity?.PrintActivityTree(self, origin, level + 1);
+
+				NextActivity?.PrintActivityTree(self, origin, level);
+			}
 		}
 
 		public virtual IEnumerable<Target> GetTargets(Actor self)
 		{
 			yield break;
 		}
-	}
 
-	public static class ActivityExts
-	{
-		public static IEnumerable<Target> GetTargetQueue(this Actor self)
+		public virtual IEnumerable<TargetLineNode> TargetLineNodes(Actor self)
 		{
-			return self.GetCurrentActivity()
-				.Iterate(u => u.NextActivity)
-				.TakeWhile(u => u != null)
-				.SelectMany(u => u.GetTargets(self));
+			yield break;
+		}
+
+		public IEnumerable<string> DebugLabelComponents()
+		{
+			var act = this;
+			while (act != null)
+			{
+				yield return act.GetType().Name;
+				act = act.ChildActivity;
+			}
+		}
+
+		public IEnumerable<T> ActivitiesImplementing<T>(bool includeChildren = true) where T : IActivityInterface
+		{
+			// Skips Done child and next activities
+			if (includeChildren)
+			{
+				var ca = ChildActivity;
+				if (ca != null)
+					foreach (var a in ca.ActivitiesImplementing<T>())
+						yield return a;
+			}
+
+			if (this is T)
+				yield return (T)(object)this;
+
+			var na = NextActivity;
+			if (na != null)
+				foreach (var a in na.ActivitiesImplementing<T>())
+					yield return a;
 		}
 	}
 }

OpenRA.Game/Activities/CallFunc.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -15,25 +16,18 @@ namespace OpenRA.Activities
 	public class CallFunc : Activity
 	{
 		public CallFunc(Action a) { this.a = a; }
-		public CallFunc(Action a, bool interruptable)
+		public CallFunc(Action a, bool interruptible)
 		{
 			this.a = a;
-			this.interruptable = interruptable;
+			IsInterruptible = interruptible;
 		}
 
-		Action a;
-		bool interruptable;
+		readonly Action a;
 
-		public override Activity Tick(Actor self)
+		public override bool Tick(Actor self)
 		{
-			if (a != null) a();
-			return NextActivity;
-		}
-
-		public override void Cancel(Actor self)
-		{
-			if (interruptable)
-				base.Cancel(self);
+			a.Invoke();
+			return true;
 		}
 	}
 }

OpenRA.Game/Actor.cs

@@ -1,16 +1,18 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
 using System.Collections.Generic;
-using System.Drawing;
+using System.Collections.ObjectModel;
+using System.IO;
 using System.Linq;
 using Eluant;
 using Eluant.ObjectBinding;
@@ -22,66 +24,117 @@ using OpenRA.Traits;
 
 namespace OpenRA
 {
+	[Flags]
+	public enum SystemActors
+	{
+		Player = 0,
+		EditorPlayer = 1,
+		World = 2,
+		EditorWorld = 4
+	}
+
 	public sealed class Actor : IScriptBindable, IScriptNotifyBind, ILuaTableBinding, ILuaEqualityBinding, ILuaToStringBinding, IEquatable<Actor>, IDisposable
 	{
+		internal readonly struct SyncHash
+		{
+			public readonly ISync Trait;
+			readonly Func<object, int> hashFunction;
+			public SyncHash(ISync trait) { Trait = trait; hashFunction = Sync.GetHashFunction(trait); }
+			public int Hash() { return hashFunction(Trait); }
+		}
+
 		public readonly ActorInfo Info;
 
 		public readonly World World;
 
 		public readonly uint ActorID;
 
-		[Sync] public Player Owner { get; set; }
+		public Player Owner { get; internal set; }
 
 		public bool IsInWorld { get; internal set; }
+		public bool WillDispose { get; private set; }
 		public bool Disposed { get; private set; }
 
 		Activity currentActivity;
-
-		public Group Group;
-		public int Generation;
-
-		Lazy<Rectangle> bounds;
-		Lazy<Rectangle> visualBounds;
-		Lazy<IFacing> facing;
-		Lazy<Health> health;
-		Lazy<IOccupySpace> occupySpace;
-		Lazy<IEffectiveOwner> effectiveOwner;
-
-		public Rectangle Bounds { get { return bounds.Value; } }
-		public Rectangle VisualBounds { get { return visualBounds.Value; } }
-		public IOccupySpace OccupiesSpace { get { return occupySpace.Value; } }
-		public IEffectiveOwner EffectiveOwner { get { return effectiveOwner.Value; } }
-
-		public bool IsIdle { get { return currentActivity == null; } }
-		public bool IsDead { get { return Disposed || (health.Value == null ? false : health.Value.IsDead); } }
-
-		public CPos Location { get { return occupySpace.Value.TopLeft; } }
-		public WPos CenterPosition { get { return occupySpace.Value.CenterPosition; } }
-
-		public WRot Orientation
+		public Activity CurrentActivity
 		{
-			get
-			{
-				// TODO: Support non-zero pitch/roll in IFacing (IOrientation?)
-				var facingValue = facing.Value != null ? facing.Value.Facing : 0;
-				return new WRot(WAngle.Zero, WAngle.Zero, WAngle.FromFacing(facingValue));
-			}
+			get => Activity.SkipDoneActivities(currentActivity);
+			private set => currentActivity = value;
 		}
 
+		public int Generation;
+		public Actor ReplacedByActor;
+
+		public IEffectiveOwner EffectiveOwner { get; }
+		public IOccupySpace OccupiesSpace { get; }
+		public ITargetable[] Targetables { get; }
+		public IEnumerable<ITargetablePositions> EnabledTargetablePositions { get; private set; }
+
+		public bool IsIdle => CurrentActivity == null;
+		public bool IsDead => Disposed || (health != null && health.IsDead);
+
+		public CPos Location => OccupiesSpace.TopLeft;
+		public WPos CenterPosition => OccupiesSpace.CenterPosition;
+
+		public WRot Orientation => facing?.Orientation ?? WRot.None;
+
+		/// <summary>Value used to represent an invalid token.</summary>
+		public static readonly int InvalidConditionToken = -1;
+
+		class ConditionState
+		{
+			/// <summary>Delegates that have registered to be notified when this condition changes.</summary>
+			public readonly List<VariableObserverNotifier> Notifiers = new List<VariableObserverNotifier>();
+
+			/// <summary>Unique integers identifying granted instances of the condition.</summary>
+			public readonly HashSet<int> Tokens = new HashSet<int>();
+		}
+
+		readonly Dictionary<string, ConditionState> conditionStates = new Dictionary<string, ConditionState>();
+
+		/// <summary>Each granted condition receives a unique token that is used when revoking.</summary>
+		readonly Dictionary<int, string> conditionTokens = new Dictionary<int, string>();
+
+		int nextConditionToken = 1;
+
+		/// <summary>Cache of condition -> enabled state for quick evaluation of token counter conditions.</summary>
+		readonly Dictionary<string, int> conditionCache = new Dictionary<string, int>();
+
+		/// <summary>Read-only version of conditionCache that is passed to IConditionConsumers.</summary>
+		readonly IReadOnlyDictionary<string, int> readOnlyConditionCache;
+
+		internal SyncHash[] SyncHashes { get; }
+
+		readonly IFacing facing;
+		readonly IHealth health;
+		readonly IResolveOrder[] resolveOrders;
 		readonly IRenderModifier[] renderModifiers;
 		readonly IRender[] renders;
-		readonly IDisable[] disables;
+		readonly IMouseBounds[] mouseBounds;
+		readonly IVisibilityModifier[] visibilityModifiers;
+		readonly IDefaultVisibility defaultVisibility;
+		readonly INotifyBecomingIdle[] becomingIdles;
+		readonly INotifyIdle[] tickIdles;
+		readonly IEnumerable<WPos> enabledTargetableWorldPositions;
+		bool created;
 
 		internal Actor(World world, string name, TypeDictionary initDict)
 		{
+			var duplicateInit = initDict.WithInterface<ISingleInstanceInit>().GroupBy(i => i.GetType())
+				.FirstOrDefault(i => i.Count() > 1);
+
+			if (duplicateInit != null)
+				throw new InvalidDataException($"Duplicate initializer '{duplicateInit.Key.Name}'");
+
 			var init = new ActorInitializer(this, initDict);
 
+			readOnlyConditionCache = new ReadOnlyDictionary<string, int>(conditionCache);
+
 			World = world;
 			ActorID = world.NextAID();
-			if (initDict.Contains<OwnerInit>())
-				Owner = init.Get<OwnerInit, Player>();
-
-			occupySpace = Exts.Lazy(() => TraitOrDefault<IOccupySpace>());
+			var ownerInit = init.GetOrDefault<OwnerInit>();
+			if (ownerInit != null)
+				Owner = ownerInit.Value(world);
 
 			if (name != null)
 			{
@@ -91,59 +144,142 @@ namespace OpenRA
 					throw new NotImplementedException("No rules definition for unit " + name);
 
 				Info = world.Map.Rules.Actors[name];
-				foreach (var trait in Info.TraitsInConstructOrder())
-					AddTrait(trait.Create(init));
+
+				var resolveOrdersList = new List<IResolveOrder>();
+				var renderModifiersList = new List<IRenderModifier>();
+				var rendersList = new List<IRender>();
+				var mouseBoundsList = new List<IMouseBounds>();
+				var visibilityModifiersList = new List<IVisibilityModifier>();
+				var becomingIdlesList = new List<INotifyBecomingIdle>();
+				var tickIdlesList = new List<INotifyIdle>();
+				var targetablesList = new List<ITargetable>();
+				var targetablePositionsList = new List<ITargetablePositions>();
+				var syncHashesList = new List<SyncHash>();
+
+				foreach (var traitInfo in Info.TraitsInConstructOrder())
+				{
+					var trait = traitInfo.Create(init);
+					AddTrait(trait);
+
+					// PERF: Cache all these traits as soon as the actor is created. This is a fairly cheap one-off cost per
+					// actor that allows us to provide some fast implementations of commonly used methods that are relied on by
+					// performance-sensitive parts of the core game engine, such as pathfinding, visibility and rendering.
+					// Note: The blocks are required to limit the scope of the t's, so we make an exception to our normal style
+					// rules for spacing in order to keep these assignments compact and readable.
+					{ if (trait is IOccupySpace t) OccupiesSpace = t; }
+					{ if (trait is IEffectiveOwner t) EffectiveOwner = t; }
+					{ if (trait is IFacing t) facing = t; }
+					{ if (trait is IHealth t) health = t; }
+					{ if (trait is IResolveOrder t) resolveOrdersList.Add(t); }
+					{ if (trait is IRenderModifier t) renderModifiersList.Add(t); }
+					{ if (trait is IRender t) rendersList.Add(t); }
+					{ if (trait is IMouseBounds t) mouseBoundsList.Add(t); }
+					{ if (trait is IVisibilityModifier t) visibilityModifiersList.Add(t); }
+					{ if (trait is IDefaultVisibility t) defaultVisibility = t; }
+					{ if (trait is INotifyBecomingIdle t) becomingIdlesList.Add(t); }
+					{ if (trait is INotifyIdle t) tickIdlesList.Add(t); }
+					{ if (trait is ITargetable t) targetablesList.Add(t); }
+					{ if (trait is ITargetablePositions t) targetablePositionsList.Add(t); }
+					{ if (trait is ISync t) syncHashesList.Add(new SyncHash(t)); }
+				}
+
+				resolveOrders = resolveOrdersList.ToArray();
+				renderModifiers = renderModifiersList.ToArray();
+				renders = rendersList.ToArray();
+				mouseBounds = mouseBoundsList.ToArray();
+				visibilityModifiers = visibilityModifiersList.ToArray();
+				becomingIdles = becomingIdlesList.ToArray();
+				tickIdles = tickIdlesList.ToArray();
+				Targetables = targetablesList.ToArray();
+				var targetablePositions = targetablePositionsList.ToArray();
+				EnabledTargetablePositions = targetablePositions.Where(Exts.IsTraitEnabled);
+				enabledTargetableWorldPositions = EnabledTargetablePositions.SelectMany(tp => tp.TargetablePositions(this));
+				SyncHashes = syncHashesList.ToArray();
+			}
+		}
+
+		internal void Initialize(bool addToWorld = true)
+		{
+			created = true;
+
+			// Make sure traits are usable for condition notifiers
+			foreach (var t in TraitsImplementing<INotifyCreated>())
+				t.Created(this);
+
+			var allObserverNotifiers = new HashSet<VariableObserverNotifier>();
+			foreach (var provider in TraitsImplementing<IObservesVariables>())
+			{
+				foreach (var variableUser in provider.GetVariableObservers())
+				{
+					allObserverNotifiers.Add(variableUser.Notifier);
+					foreach (var variable in variableUser.Variables)
+					{
+						var cs = conditionStates.GetOrAdd(variable);
+						cs.Notifiers.Add(variableUser.Notifier);
+
+						// Initialize conditions that have not yet been granted to 0
+						// NOTE: Some conditions may have already been granted by INotifyCreated calling GrantCondition,
+						// and we choose to assign the token count to safely cover both cases instead of adding an if branch.
+						conditionCache[variable] = cs.Tokens.Count;
+					}
+				}
 			}
 
-			facing = Exts.Lazy(() => TraitOrDefault<IFacing>());
-			health = Exts.Lazy(() => TraitOrDefault<Health>());
-			effectiveOwner = Exts.Lazy(() => TraitOrDefault<IEffectiveOwner>());
+			// Update all traits with their initial condition state
+			foreach (var notify in allObserverNotifiers)
+				notify(this, readOnlyConditionCache);
 
-			bounds = Exts.Lazy(() =>
+			// TODO: Other traits may need initialization after being notified of initial condition state.
+
+			// TODO: A post condition initialization notification phase may allow queueing activities instead.
+			// The initial activity should run before any activities queued by INotifyCreated.Created
+			// However, we need to know which traits are enabled (via conditions), so wait for after the calls and insert the activity as the first
+			ICreationActivity creationActivity = null;
+			foreach (var ica in TraitsImplementing<ICreationActivity>())
 			{
-				var si = Info.Traits.GetOrDefault<SelectableInfo>();
-				var size = (si != null && si.Bounds != null) ? new int2(si.Bounds[0], si.Bounds[1]) :
-					TraitsImplementing<IAutoSelectionSize>().Select(x => x.SelectionSize(this)).FirstOrDefault();
+				if (!ica.IsTraitEnabled())
+					continue;
 
-				var offset = -size / 2;
-				if (si != null && si.Bounds != null && si.Bounds.Length > 2)
-					offset += new int2(si.Bounds[2], si.Bounds[3]);
+				if (creationActivity != null)
+					throw new InvalidOperationException($"More than one enabled ICreationActivity trait: {creationActivity.GetType().Name} and {ica.GetType().Name}");
 
-				return new Rectangle(offset.X, offset.Y, size.X, size.Y);
-			});
+				var activity = ica.GetCreationActivity();
+				if (activity == null)
+					continue;
 
-			visualBounds = Exts.Lazy(() =>
-			{
-				var sd = Info.Traits.GetOrDefault<ISelectionDecorationsInfo>();
-				if (sd == null || sd.SelectionBoxBounds == null)
-					return bounds.Value;
+				creationActivity = ica;
 
-				var size = new int2(sd.SelectionBoxBounds[0], sd.SelectionBoxBounds[1]);
+				activity.Queue(CurrentActivity);
+				CurrentActivity = activity;
+			}
 
-				var offset = -size / 2;
-				if (sd.SelectionBoxBounds.Length > 2)
-					offset += new int2(sd.SelectionBoxBounds[2], sd.SelectionBoxBounds[3]);
-
-				return new Rectangle(offset.X, offset.Y, size.X, size.Y);
-			});
-
-			renderModifiers = TraitsImplementing<IRenderModifier>().ToArray();
-			renders = TraitsImplementing<IRender>().ToArray();
-			disables = TraitsImplementing<IDisable>().ToArray();
+			if (addToWorld)
+				World.Add(this);
 		}
 
 		public void Tick()
 		{
 			var wasIdle = IsIdle;
-			currentActivity = Traits.Util.RunActivity(this, currentActivity);
+			CurrentActivity = ActivityUtils.RunActivity(this, CurrentActivity);
 
 			if (!wasIdle && IsIdle)
-				foreach (var n in TraitsImplementing<INotifyBecomingIdle>())
+			{
+				foreach (var n in becomingIdles)
 					n.OnBecomingIdle(this);
+
+				// If IsIdle is true, it means the last CurrentActivity.Tick returned null.
+				// If a next activity has been queued via OnBecomingIdle, we need to start running it now,
+				// to avoid an 'empty' null tick where the actor will (visibly, if moving) do nothing.
+				CurrentActivity = ActivityUtils.RunActivity(this, CurrentActivity);
+			}
+			else if (wasIdle)
+				foreach (var tickIdle in tickIdles)
+					tickIdle.TickIdle(this);
 		}
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
+			// PERF: Avoid LINQ.
 			var renderables = Renderables(wr);
 			foreach (var modifier in renderModifiers)
 				renderables = modifier.ModifyRender(this, wr, renderables);
@@ -152,35 +288,69 @@ namespace OpenRA
 
 		IEnumerable<IRenderable> Renderables(WorldRenderer wr)
 		{
+			// PERF: Avoid LINQ.
+			// Implementations of Render are permitted to return both an eagerly materialized collection or a lazily
+			// generated sequence.
+			// For large amounts of renderables, a lazily generated sequence (e.g. as returned by LINQ, or by using
+			// `yield`) will avoid the need to allocate a large collection.
+			// For small amounts of renderables, allocating a small collection can often be faster and require less
+			// memory than creating the objects needed to represent a sequence.
 			foreach (var render in renders)
 				foreach (var renderable in render.Render(this, wr))
 					yield return renderable;
 		}
 
+		public IEnumerable<Rectangle> ScreenBounds(WorldRenderer wr)
+		{
+			var bounds = Bounds(wr);
+			foreach (var modifier in renderModifiers)
+				bounds = modifier.ModifyScreenBounds(this, wr, bounds);
+			return bounds;
+		}
+
+		IEnumerable<Rectangle> Bounds(WorldRenderer wr)
+		{
+			// PERF: Avoid LINQ. See comments for Renderables
+			foreach (var render in renders)
+				foreach (var r in render.ScreenBounds(this, wr))
+					if (!r.IsEmpty)
+						yield return r;
+		}
+
+		public Polygon MouseBounds(WorldRenderer wr)
+		{
+			foreach (var mb in mouseBounds)
+			{
+				var bounds = mb.MouseoverBounds(this, wr);
+				if (!bounds.IsEmpty)
+					return bounds;
+			}
+
+			return Polygon.Empty;
+		}
+
 		public void QueueActivity(bool queued, Activity nextActivity)
 		{
 			if (!queued)
 				CancelActivity();
+
 			QueueActivity(nextActivity);
 		}
 
 		public void QueueActivity(Activity nextActivity)
 		{
-			if (currentActivity == null)
-				currentActivity = nextActivity;
+			if (!created)
+				throw new InvalidOperationException("An activity was queued before the actor was created. Queue it inside the INotifyCreated.Created callback instead.");
+
+			if (CurrentActivity == null)
+				CurrentActivity = nextActivity;
 			else
-				currentActivity.Queue(nextActivity);
+				CurrentActivity.Queue(nextActivity);
 		}
 
 		public void CancelActivity()
 		{
-			if (currentActivity != null)
-				currentActivity.Cancel(this);
-		}
-
-		public Activity GetCurrentActivity()
-		{
-			return currentActivity;
+			CurrentActivity?.Cancel(this);
 		}
 
 		public override int GetHashCode()
@@ -190,8 +360,7 @@ namespace OpenRA
 
 		public override bool Equals(object obj)
 		{
-			var o = obj as Actor;
-			return o != null && Equals(o);
+			return obj is Actor o && Equals(o);
 		}
 
 		public bool Equals(Actor other)
@@ -201,6 +370,7 @@ namespace OpenRA
 
 		public override string ToString()
 		{
+			// PERF: Avoid format strings.
 			var name = Info.Name + " " + ActorID;
 			if (!IsInWorld)
 				name += " (not in world)";
@@ -222,11 +392,6 @@ namespace OpenRA
 			return World.TraitDict.WithInterface<T>(this);
 		}
 
-		public bool HasTrait<T>()
-		{
-			return World.TraitDict.Contains<T>(this);
-		}
-
 		public void AddTrait(object trait)
 		{
 			World.TraitDict.AddTrait(this, trait);
@@ -234,6 +399,13 @@ namespace OpenRA
 
 		public void Dispose()
 		{
+			// If CurrentActivity isn't null, run OnActorDisposeOuter in case some cleanups are needed.
+			// This should be done before the FrameEndTask to avoid dependency issues.
+			CurrentActivity?.OnActorDisposeOuter(this);
+
+			// Allow traits/activities to prevent a race condition when they depend on disposing the actor (e.g. Transforms)
+			WillDispose = true;
+
 			World.AddFrameEndTask(w =>
 			{
 				if (Disposed)
@@ -248,53 +420,181 @@ namespace OpenRA
 				World.TraitDict.RemoveActor(this);
 				Disposed = true;
 
-				if (luaInterface != null)
-					luaInterface.Value.OnActorDestroyed();
+				luaInterface?.Value.OnActorDestroyed();
 			});
 		}
 
+		public void ResolveOrder(Order order)
+		{
+			foreach (var r in resolveOrders)
+				r.ResolveOrder(this, order);
+		}
+
 		// TODO: move elsewhere.
 		public void ChangeOwner(Player newOwner)
 		{
-			World.AddFrameEndTask(w =>
-			{
-				if (Disposed)
-					return;
-
-				var oldOwner = Owner;
-				var wasInWorld = IsInWorld;
-
-				// momentarily remove from world so the ownership queries don't get confused
-				if (wasInWorld)
-					w.Remove(this);
-
-				Owner = newOwner;
-				Generation++;
-
-				if (wasInWorld)
-					w.Add(this);
-
-				foreach (var t in this.TraitsImplementing<INotifyOwnerChanged>())
-					t.OnOwnerChanged(this, oldOwner, newOwner);
-			});
+			World.AddFrameEndTask(_ => ChangeOwnerSync(newOwner));
 		}
 
-		public void Kill(Actor attacker)
+		/// <summary>
+		/// Change the actors owner without queuing a FrameEndTask.
+		/// This must only be called from inside an existing FrameEndTask.
+		/// </summary>
+		public void ChangeOwnerSync(Player newOwner)
 		{
-			if (health.Value == null)
+			if (Disposed)
 				return;
 
-			health.Value.InflictDamage(this, attacker, health.Value.MaxHP, null, true);
+			var oldOwner = Owner;
+			var wasInWorld = IsInWorld;
+
+			// momentarily remove from world so the ownership queries don't get confused
+			if (wasInWorld)
+				World.Remove(this);
+
+			Owner = newOwner;
+			Generation++;
+
+			foreach (var t in TraitsImplementing<INotifyOwnerChanged>())
+				t.OnOwnerChanged(this, oldOwner, newOwner);
+
+			foreach (var t in World.WorldActor.TraitsImplementing<INotifyOwnerChanged>())
+				t.OnOwnerChanged(this, oldOwner, newOwner);
+
+			if (wasInWorld)
+				World.Add(this);
 		}
 
-		public bool IsDisabled()
+		public DamageState GetDamageState()
 		{
-			foreach (var disable in disables)
-				if (disable.Disabled)
+			if (Disposed)
+				return DamageState.Dead;
+
+			return (health == null) ? DamageState.Undamaged : health.DamageState;
+		}
+
+		public void InflictDamage(Actor attacker, Damage damage)
+		{
+			if (Disposed || health == null)
+				return;
+
+			health.InflictDamage(this, attacker, damage, false);
+		}
+
+		public void Kill(Actor attacker, BitSet<DamageType> damageTypes = default)
+		{
+			if (Disposed || health == null)
+				return;
+
+			health.Kill(this, attacker, damageTypes);
+		}
+
+		public bool CanBeViewedByPlayer(Player player)
+		{
+			// PERF: Avoid LINQ.
+			foreach (var visibilityModifier in visibilityModifiers)
+				if (!visibilityModifier.IsVisible(this, player))
+					return false;
+
+			return defaultVisibility.IsVisible(this, player);
+		}
+
+		public BitSet<TargetableType> GetAllTargetTypes()
+		{
+			// PERF: Avoid LINQ.
+			var targetTypes = default(BitSet<TargetableType>);
+			foreach (var targetable in Targetables)
+				targetTypes = targetTypes.Union(targetable.TargetTypes);
+			return targetTypes;
+		}
+
+		public BitSet<TargetableType> GetEnabledTargetTypes()
+		{
+			// PERF: Avoid LINQ.
+			var targetTypes = default(BitSet<TargetableType>);
+			foreach (var targetable in Targetables)
+				if (targetable.IsTraitEnabled())
+					targetTypes = targetTypes.Union(targetable.TargetTypes);
+			return targetTypes;
+		}
+
+		public bool IsTargetableBy(Actor byActor)
+		{
+			// PERF: Avoid LINQ.
+			foreach (var targetable in Targetables)
+				if (targetable.TargetableBy(this, byActor))
 					return true;
+
 			return false;
 		}
 
+		public IEnumerable<WPos> GetTargetablePositions()
+		{
+			if (EnabledTargetablePositions.Any())
+				return enabledTargetableWorldPositions;
+
+			return new[] { CenterPosition };
+		}
+
+		#region Conditions
+
+		void UpdateConditionState(string condition, int token, bool isRevoke)
+		{
+			var conditionState = conditionStates.GetOrAdd(condition);
+
+			if (isRevoke)
+				conditionState.Tokens.Remove(token);
+			else
+				conditionState.Tokens.Add(token);
+
+			conditionCache[condition] = conditionState.Tokens.Count;
+
+			// Conditions may be granted or revoked before the state is initialized.
+			// These notifications will be processed after INotifyCreated.Created.
+			if (created)
+				foreach (var notify in conditionState.Notifiers)
+					notify(this, readOnlyConditionCache);
+		}
+
+		/// <summary>
+		/// Grants a specified condition if it is valid.
+		/// Otherwise, just returns InvalidConditionToken.
+		/// </summary>
+		/// <returns>The token that is used to revoke this condition.</returns>
+		public int GrantCondition(string condition)
+		{
+			if (string.IsNullOrEmpty(condition))
+				return InvalidConditionToken;
+
+			var token = nextConditionToken++;
+			conditionTokens.Add(token, condition);
+			UpdateConditionState(condition, token, false);
+			return token;
+		}
+
+		/// <summary>
+		/// Revokes a previously granted condition.
+		/// </summary>
+		/// <param name="token">The token ID returned by GrantCondition.</param>
+		/// <returns>The invalid token ID.</returns>
+		public int RevokeCondition(int token)
+		{
+			if (!conditionTokens.TryGetValue(token, out var condition))
+				throw new InvalidOperationException($"Attempting to revoke condition with invalid token {token} for {this}.");
+
+			conditionTokens.Remove(token);
+			UpdateConditionState(condition, token, true);
+			return InvalidConditionToken;
+		}
+
+		/// <summary>Returns whether the specified token is valid for RevokeCondition</summary>
+		public bool TokenValid(int token)
+		{
+			return conditionTokens.ContainsKey(token);
+		}
+
+		#endregion
+
 		#region Scripting interface
 
 		Lazy<ScriptActorInterface> luaInterface;
@@ -306,14 +606,13 @@ namespace OpenRA
 
 		public LuaValue this[LuaRuntime runtime, LuaValue keyValue]
 		{
-			get { return luaInterface.Value[runtime, keyValue]; }
-			set { luaInterface.Value[runtime, keyValue] = value; }
+			get => luaInterface.Value[runtime, keyValue];
+			set => luaInterface.Value[runtime, keyValue] = value;
 		}
 
 		public LuaValue Equals(LuaRuntime runtime, LuaValue left, LuaValue right)
 		{
-			Actor a, b;
-			if (!left.TryGetClrValue<Actor>(out a) || !right.TryGetClrValue<Actor>(out b))
+			if (!left.TryGetClrValue(out Actor a) || !right.TryGetClrValue(out Actor b))
 				return false;
 
 			return a == b;
@@ -321,7 +620,7 @@ namespace OpenRA
 
 		public LuaValue ToString(LuaRuntime runtime)
 		{
-			return "Actor ({0})".F(this);
+			return $"Actor ({this})";
 		}
 
 		public bool HasScriptProperty(string name)

OpenRA.Game/CPos.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -15,44 +16,67 @@ using OpenRA.Scripting;
 
 namespace OpenRA
 {
-	public struct CPos : IScriptBindable, ILuaAdditionBinding, ILuaSubtractionBinding, ILuaEqualityBinding, ILuaTableBinding, IEquatable<CPos>
+	public readonly struct CPos : IScriptBindable, ILuaAdditionBinding, ILuaSubtractionBinding, ILuaEqualityBinding, ILuaTableBinding, IEquatable<CPos>
 	{
-		public readonly int X, Y;
+		// Coordinates are packed in a 32 bit signed int
+		// X and Y are 12 bits (signed): -2048...2047
+		// Layer is an unsigned byte
+		// Packing is XXXX XXXX XXXX YYYY YYYY YYYY LLLL LLLL
+		public readonly int Bits;
 
-		public CPos(int x, int y) { X = x; Y = y; }
-		public static readonly CPos Zero = new CPos(0, 0);
+		// X is padded to MSB, so bit shift does the correct sign extension
+		public int X => Bits >> 20;
+
+		// Align Y with a short, cast, then shift the rest of the way
+		// The signed short bit shift does the correct sign extension
+		public int Y => ((short)(Bits >> 4)) >> 4;
+
+		public byte Layer => (byte)Bits;
+
+		public CPos(int bits) { Bits = bits; }
+		public CPos(int x, int y)
+			: this(x, y, 0) { }
+		public CPos(int x, int y, byte layer)
+		{
+			Bits = (x & 0xFFF) << 20 | (y & 0xFFF) << 8 | layer;
+		}
+
+		public static readonly CPos Zero = new CPos(0, 0, 0);
 
 		public static explicit operator CPos(int2 a) { return new CPos(a.X, a.Y); }
 
-		public static CPos operator +(CVec a, CPos b) { return new CPos(a.X + b.X, a.Y + b.Y); }
-		public static CPos operator +(CPos a, CVec b) { return new CPos(a.X + b.X, a.Y + b.Y); }
-		public static CPos operator -(CPos a, CVec b) { return new CPos(a.X - b.X, a.Y - b.Y); }
+		public static CPos operator +(CVec a, CPos b) { return new CPos(a.X + b.X, a.Y + b.Y, b.Layer); }
+		public static CPos operator +(CPos a, CVec b) { return new CPos(a.X + b.X, a.Y + b.Y, a.Layer); }
+		public static CPos operator -(CPos a, CVec b) { return new CPos(a.X - b.X, a.Y - b.Y, a.Layer); }
 		public static CVec operator -(CPos a, CPos b) { return new CVec(a.X - b.X, a.Y - b.Y); }
 
-		public static bool operator ==(CPos me, CPos other) { return me.X == other.X && me.Y == other.Y; }
+		public static bool operator ==(CPos me, CPos other) { return me.Bits == other.Bits; }
 		public static bool operator !=(CPos me, CPos other) { return !(me == other); }
 
-		public static CPos Max(CPos a, CPos b) { return new CPos(Math.Max(a.X, b.X), Math.Max(a.Y, b.Y)); }
-		public static CPos Min(CPos a, CPos b) { return new CPos(Math.Min(a.X, b.X), Math.Min(a.Y, b.Y)); }
+		public override int GetHashCode() { return Bits.GetHashCode(); }
 
-		public override int GetHashCode() { return X.GetHashCode() ^ Y.GetHashCode(); }
-
-		public bool Equals(CPos other) { return X == other.X && Y == other.Y; }
+		public bool Equals(CPos other) { return Bits == other.Bits; }
 		public override bool Equals(object obj) { return obj is CPos && Equals((CPos)obj); }
 
-		public override string ToString() { return X + "," + Y; }
+		public override string ToString()
+		{
+			if (Layer == 0)
+				return X + "," + Y;
+
+			return X + "," + Y + "," + Layer;
+		}
 
 		public MPos ToMPos(Map map)
 		{
-			return ToMPos(map.TileShape);
+			return ToMPos(map.Grid.Type);
 		}
 
-		public MPos ToMPos(TileShape shape)
+		public MPos ToMPos(MapGridType gridType)
 		{
-			if (shape == TileShape.Rectangle)
+			if (gridType == MapGridType.Rectangular)
 				return new MPos(X, Y);
 
-			// Convert from diamond cell (x, y) position to rectangular map position (u, v)
+			// Convert from RectangularIsometric cell (x, y) position to rectangular map position (u, v)
 			//  - The staggered rows make this fiddly (hint: draw a diagram!)
 			// (a) Consider the relationships:
 			//  - +1x (even -> odd) adds (0, 1) to (u, v)
@@ -71,28 +95,35 @@ namespace OpenRA
 
 		public LuaValue Add(LuaRuntime runtime, LuaValue left, LuaValue right)
 		{
-			CPos a;
-			CVec b;
-			if (!left.TryGetClrValue<CPos>(out a) || !right.TryGetClrValue<CVec>(out b))
-				throw new LuaException("Attempted to call CPos.Add(CPos, CVec) with invalid arguments ({0}, {1})".F(left.WrappedClrType().Name, right.WrappedClrType().Name));
+			if (!left.TryGetClrValue(out CPos a) || !right.TryGetClrValue(out CVec b))
+				throw new LuaException($"Attempted to call CPos.Add(CPos, CVec) with invalid arguments ({left.WrappedClrType().Name}, {right.WrappedClrType().Name})");
 
 			return new LuaCustomClrObject(a + b);
 		}
 
 		public LuaValue Subtract(LuaRuntime runtime, LuaValue left, LuaValue right)
 		{
-			CPos a;
-			CVec b;
-			if (!left.TryGetClrValue<CPos>(out a) || !right.TryGetClrValue<CVec>(out b))
-				throw new LuaException("Attempted to call CPos.Subtract(CPos, CVec) with invalid arguments ({0}, {1})".F(left.WrappedClrType().Name, right.WrappedClrType().Name));
+			var rightType = right.WrappedClrType();
+			if (!left.TryGetClrValue(out CPos a))
+				throw new LuaException($"Attempted to call CPos.Subtract(CPos, (CPos|CVec)) with invalid arguments ({left.WrappedClrType().Name}, {rightType.Name})");
 
-			return new LuaCustomClrObject(a - b);
+			if (rightType == typeof(CPos))
+			{
+				right.TryGetClrValue(out CPos b);
+				return new LuaCustomClrObject(a - b);
+			}
+			else if (rightType == typeof(CVec))
+			{
+				right.TryGetClrValue(out CVec b);
+				return new LuaCustomClrObject(a - b);
+			}
+
+			throw new LuaException($"Attempted to call CPos.Subtract(CPos, (CPos|CVec)) with invalid arguments ({left.WrappedClrType().Name}, {rightType.Name})");
 		}
 
 		public LuaValue Equals(LuaRuntime runtime, LuaValue left, LuaValue right)
 		{
-			CPos a, b;
-			if (!left.TryGetClrValue<CPos>(out a) || !right.TryGetClrValue<CPos>(out b))
+			if (!left.TryGetClrValue(out CPos a) || !right.TryGetClrValue(out CPos b))
 				return false;
 
 			return a == b;
@@ -106,16 +137,14 @@ namespace OpenRA
 				{
 					case "X": return X;
 					case "Y": return Y;
-					default: throw new LuaException("CPos does not define a member '{0}'".F(key));
+					case "Layer": return Layer;
+					default: throw new LuaException($"CPos does not define a member '{key}'");
 				}
 			}
 
-			set
-			{
-				throw new LuaException("CPos is read-only. Use CPos.New to create a new value");
-			}
+			set => throw new LuaException("CPos is read-only. Use CPos.New to create a new value");
 		}
 
 		#endregion
 	}
-}
+}

OpenRA.Game/CVec.cs

@@ -1,22 +1,23 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
-using System.Drawing;
 using Eluant;
 using Eluant.ObjectBinding;
+using OpenRA.Primitives;
 using OpenRA.Scripting;
 
 namespace OpenRA
 {
-	public struct CVec : IScriptBindable, ILuaAdditionBinding, ILuaSubtractionBinding, ILuaUnaryMinusBinding, ILuaEqualityBinding, ILuaTableBinding, IEquatable<CVec>
+	public readonly struct CVec : IScriptBindable, ILuaAdditionBinding, ILuaSubtractionBinding, ILuaUnaryMinusBinding, ILuaEqualityBinding, ILuaTableBinding, IEquatable<CVec>
 	{
 		public readonly int X, Y;
 
@@ -41,8 +42,8 @@ namespace OpenRA
 
 		public CVec Sign() { return new CVec(Math.Sign(X), Math.Sign(Y)); }
 		public CVec Abs() { return new CVec(Math.Abs(X), Math.Abs(Y)); }
-		public int LengthSquared { get { return X * X + Y * Y; } }
-		public int Length { get { return Exts.ISqrt(LengthSquared); } }
+		public int LengthSquared => X * X + Y * Y;
+		public int Length => Exts.ISqrt(LengthSquared);
 
 		public CVec Clamp(Rectangle r)
 		{
@@ -74,18 +75,16 @@ namespace OpenRA
 
 		public LuaValue Add(LuaRuntime runtime, LuaValue left, LuaValue right)
 		{
-			CVec a, b;
-			if (!left.TryGetClrValue<CVec>(out a) || !right.TryGetClrValue<CVec>(out b))
-				throw new LuaException("Attempted to call CVec.Add(CVec, CVec) with invalid arguments ({0}, {1})".F(left.WrappedClrType().Name, right.WrappedClrType().Name));
+			if (!left.TryGetClrValue(out CVec a) || !right.TryGetClrValue(out CVec b))
+				throw new LuaException($"Attempted to call CVec.Add(CVec, CVec) with invalid arguments ({left.WrappedClrType().Name}, {right.WrappedClrType().Name})");
 
 			return new LuaCustomClrObject(a + b);
 		}
 
 		public LuaValue Subtract(LuaRuntime runtime, LuaValue left, LuaValue right)
 		{
-			CVec a, b;
-			if (!left.TryGetClrValue<CVec>(out a) || !right.TryGetClrValue<CVec>(out b))
-				throw new LuaException("Attempted to call CVec.Subtract(CVec, CVec) with invalid arguments ({0}, {1})".F(left.WrappedClrType().Name, right.WrappedClrType().Name));
+			if (!left.TryGetClrValue(out CVec a) || !right.TryGetClrValue(out CVec b))
+				throw new LuaException($"Attempted to call CVec.Subtract(CVec, CVec) with invalid arguments ({left.WrappedClrType().Name}, {right.WrappedClrType().Name})");
 
 			return new LuaCustomClrObject(a - b);
 		}
@@ -97,8 +96,7 @@ namespace OpenRA
 
 		public LuaValue Equals(LuaRuntime runtime, LuaValue left, LuaValue right)
 		{
-			CVec a, b;
-			if (!left.TryGetClrValue<CVec>(out a) || !right.TryGetClrValue<CVec>(out b))
+			if (!left.TryGetClrValue(out CVec a) || !right.TryGetClrValue(out CVec b))
 				return false;
 
 			return a == b;
@@ -112,14 +110,11 @@ namespace OpenRA
 				{
 					case "X": return X;
 					case "Y": return Y;
-					default: throw new LuaException("CVec does not define a member '{0}'".F(key));
+					default: throw new LuaException($"CVec does not define a member '{key}'");
 				}
 			}
 
-			set
-			{
-				throw new LuaException("WVec is read-only. Use CVec.New to create a new value");
-			}
+			set => throw new LuaException("CVec is read-only. Use CVec.New to create a new value");
 		}
 
 		#endregion

OpenRA.Game/CacheStorage.cs

@@ -1,19 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-namespace OpenRA
-{
-	public interface ICacheStorage<T>
-	{
-		void Remove(string key);
-		void Store(string key, T data);
-		T Retrieve(string key);
-	}
-}

OpenRA.Game/CryptoUtil.cs

@@ -0,0 +1,261 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.IO;
+using System.Linq;
+using System.Security.Cryptography;
+using System.Text;
+
+namespace OpenRA
+{
+	public static class CryptoUtil
+	{
+		// Fixed byte pattern for the OID header
+		static readonly byte[] OIDHeader = { 0x30, 0xD, 0x6, 0x9, 0x2A, 0x86, 0x48, 0x86, 0xF7, 0xD, 0x1, 0x1, 0x1, 0x5, 0x0 };
+
+		public static string PublicKeyFingerprint(RSAParameters parameters)
+		{
+			// Public key fingerprint is defined as the SHA1 of the modulus + exponent bytes
+			return SHA1Hash(parameters.Modulus.Append(parameters.Exponent).ToArray());
+		}
+
+		public static string EncodePEMPublicKey(RSAParameters parameters)
+		{
+			var data = Convert.ToBase64String(EncodePublicKey(parameters));
+			var output = new StringBuilder();
+			output.AppendLine("-----BEGIN PUBLIC KEY-----");
+			for (var i = 0; i < data.Length; i += 64)
+				output.AppendLine(data.Substring(i, Math.Min(64, data.Length - i)));
+			output.Append("-----END PUBLIC KEY-----");
+
+			return output.ToString();
+		}
+
+		public static RSAParameters DecodePEMPublicKey(string key)
+		{
+			try
+			{
+				// Reconstruct original key data
+				var lines = key.Split('\n');
+				var data = Convert.FromBase64String(lines.Skip(1).Take(lines.Length - 2).JoinWith(""));
+
+				// Pull the modulus and exponent bytes out of the ASN.1 tree
+				// Expect this to blow up if the key is not correctly formatted
+				using (var s = new MemoryStream(data))
+				{
+					// SEQUENCE
+					s.ReadByte();
+					ReadTLVLength(s);
+
+					// SEQUENCE -> fixed header junk
+					s.ReadByte();
+					var headerLength = ReadTLVLength(s);
+					s.Position += headerLength;
+
+					// SEQUENCE -> BIT_STRING
+					s.ReadByte();
+					ReadTLVLength(s);
+					s.ReadByte();
+
+					// SEQUENCE -> BIT_STRING -> SEQUENCE
+					s.ReadByte();
+					ReadTLVLength(s);
+
+					// SEQUENCE -> BIT_STRING -> SEQUENCE -> INTEGER (modulus)
+					s.ReadByte();
+					var modulusLength = ReadTLVLength(s);
+					s.ReadByte();
+					var modulus = s.ReadBytes(modulusLength - 1);
+
+					// SEQUENCE -> BIT_STRING -> SEQUENCE -> INTEGER (exponent)
+					s.ReadByte();
+					var exponentLength = ReadTLVLength(s);
+					s.ReadByte();
+					var exponent = s.ReadBytes(exponentLength - 1);
+
+					return new RSAParameters
+					{
+						Modulus = modulus,
+						Exponent = exponent
+					};
+				}
+			}
+			catch (Exception e)
+			{
+				throw new InvalidDataException("Invalid PEM public key", e);
+			}
+		}
+
+		static byte[] EncodePublicKey(RSAParameters parameters)
+		{
+			using (var stream = new MemoryStream())
+			{
+				var writer = new BinaryWriter(stream);
+
+				var modExpLength = TripletFullLength(parameters.Modulus.Length + 1) + TripletFullLength(parameters.Exponent.Length + 1);
+				var bitStringLength = TripletFullLength(modExpLength + 1);
+				var sequenceLength = TripletFullLength(bitStringLength + OIDHeader.Length);
+
+				// SEQUENCE
+				writer.Write((byte)0x30);
+				WriteTLVLength(writer, sequenceLength);
+
+				// SEQUENCE -> fixed header junk
+				writer.Write(OIDHeader);
+
+				// SEQUENCE -> BIT_STRING
+				writer.Write((byte)0x03);
+				WriteTLVLength(writer, bitStringLength);
+				writer.Write((byte)0x00);
+
+				// SEQUENCE -> BIT_STRING -> SEQUENCE
+				writer.Write((byte)0x30);
+				WriteTLVLength(writer, modExpLength);
+
+				// SEQUENCE -> BIT_STRING -> SEQUENCE -> INTEGER
+				// Modulus is padded with a zero to avoid issues with the sign bit
+				writer.Write((byte)0x02);
+				WriteTLVLength(writer, parameters.Modulus.Length + 1);
+				writer.Write((byte)0);
+				writer.Write(parameters.Modulus);
+
+				// SEQUENCE -> BIT_STRING -> SEQUENCE -> INTEGER
+				// Exponent is padded with a zero to avoid issues with the sign bit
+				writer.Write((byte)0x02);
+				WriteTLVLength(writer, parameters.Exponent.Length + 1);
+				writer.Write((byte)0);
+				writer.Write(parameters.Exponent);
+
+				return stream.ToArray();
+			}
+		}
+
+		static void WriteTLVLength(BinaryWriter writer, int length)
+		{
+			if (length < 0x80)
+			{
+				// Length < 128 is stored in a single byte
+				writer.Write((byte)length);
+			}
+			else
+			{
+				// If 128 <= length < 256**128 first byte encodes number of bytes required to hold the length
+				// High-bit is set as a flag to use this long-form encoding
+				var lengthBytes = BitConverter.GetBytes(length).Reverse().SkipWhile(b => b == 0).ToArray();
+				writer.Write((byte)(0x80 | lengthBytes.Length));
+				writer.Write(lengthBytes);
+			}
+		}
+
+		static int ReadTLVLength(Stream s)
+		{
+			var length = s.ReadByte();
+			if (length < 0x80)
+				return length;
+
+			var data = new byte[4];
+			s.ReadBytes(data, 0, Math.Min(length & 0x7F, 4));
+			return BitConverter.ToInt32(data.ToArray(), 0);
+		}
+
+		static int TripletFullLength(int dataLength)
+		{
+			if (dataLength < 0x80)
+				return 2 + dataLength;
+
+			return 2 + dataLength + BitConverter.GetBytes(dataLength).Reverse().SkipWhile(b => b == 0).Count();
+		}
+
+		public static string DecryptString(RSAParameters parameters, string data)
+		{
+			try
+			{
+				using (var rsa = new RSACryptoServiceProvider())
+				{
+					rsa.ImportParameters(parameters);
+					return Encoding.UTF8.GetString(rsa.Decrypt(Convert.FromBase64String(data), false));
+				}
+			}
+			catch (Exception e)
+			{
+				Log.Write("debug", "Failed to decrypt string with exception: {0}", e);
+				Console.WriteLine("String decryption failed: {0}", e);
+				return null;
+			}
+		}
+
+		public static string Sign(RSAParameters parameters, string data)
+		{
+			return Sign(parameters, Encoding.UTF8.GetBytes(data));
+		}
+
+		public static string Sign(RSAParameters parameters, byte[] data)
+		{
+			try
+			{
+				using (var rsa = new RSACryptoServiceProvider())
+				{
+					rsa.ImportParameters(parameters);
+					using (var csp = SHA1.Create())
+						return Convert.ToBase64String(rsa.SignHash(csp.ComputeHash(data), CryptoConfig.MapNameToOID("SHA1")));
+				}
+			}
+			catch (Exception e)
+			{
+				Log.Write("debug", "Failed to sign string with exception: {0}", e);
+				Console.WriteLine("String signing failed: {0}", e);
+				return null;
+			}
+		}
+
+		public static bool VerifySignature(RSAParameters parameters, string data, string signature)
+		{
+			return VerifySignature(parameters, Encoding.UTF8.GetBytes(data), signature);
+		}
+
+		public static bool VerifySignature(RSAParameters parameters, byte[] data, string signature)
+		{
+			try
+			{
+				using (var rsa = new RSACryptoServiceProvider())
+				{
+					rsa.ImportParameters(parameters);
+					using (var csp = SHA1.Create())
+						return rsa.VerifyHash(csp.ComputeHash(data), CryptoConfig.MapNameToOID("SHA1"), Convert.FromBase64String(signature));
+				}
+			}
+			catch (Exception e)
+			{
+				Log.Write("debug", "Failed to verify signature with exception: {0}", e);
+				Console.WriteLine("Signature validation failed: {0}", e);
+				return false;
+			}
+		}
+
+		public static string SHA1Hash(Stream data)
+		{
+			using (var csp = SHA1.Create())
+				return new string(csp.ComputeHash(data).SelectMany(a => a.ToString("x2")).ToArray());
+		}
+
+		public static string SHA1Hash(byte[] data)
+		{
+			using (var csp = SHA1.Create())
+				return new string(csp.ComputeHash(data).SelectMany(a => a.ToString("x2")).ToArray());
+		}
+
+		public static string SHA1Hash(string data)
+		{
+			return SHA1Hash(Encoding.UTF8.GetBytes(data));
+		}
+	}
+}

OpenRA.Game/DefaultPlayer.cs

@@ -0,0 +1,20 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using OpenRA.Primitives;
+
+namespace OpenRA
+{
+	public class DefaultPlayer : IGlobalModData
+	{
+		public readonly Color Color = Color.FromArgb(0xEE, 0xEE, 0xEE);
+	}
+}

OpenRA.Game/Download.cs

@@ -1,79 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.ComponentModel;
-using System.Net;
-
-namespace OpenRA
-{
-	public class Download
-	{
-		WebClient wc;
-		bool cancelled;
-
-		public static string FormatErrorMessage(Exception e)
-		{
-			var ex = e as WebException;
-			if (ex == null)
-				return e.Message;
-
-			switch (ex.Status)
-			{
-				case WebExceptionStatus.NameResolutionFailure:
-					return "DNS lookup failed";
-				case WebExceptionStatus.Timeout:
-					return "Connection timeout";
-				case WebExceptionStatus.ConnectFailure:
-					return "Cannot connect to remote server";
-				case WebExceptionStatus.ProtocolError:
-					return "File not found on remote server";
-				default:
-					return ex.Message;
-			}
-		}
-
-		public Download(string url, string path, Action<DownloadProgressChangedEventArgs> onProgress, Action<AsyncCompletedEventArgs, bool> onComplete)
-		{
-			wc = new WebClient();
-			wc.Proxy = null;
-
-			wc.DownloadProgressChanged += (_, a) => onProgress(a);
-			wc.DownloadFileCompleted += (_, a) => onComplete(a, cancelled);
-
-			Game.OnQuit += Cancel;
-			wc.DownloadFileCompleted += (_, a) => { Game.OnQuit -= Cancel; };
-
-			wc.DownloadFileAsync(new Uri(url), path);
-		}
-
-		public Download(string url, Action<DownloadProgressChangedEventArgs> onProgress, Action<DownloadDataCompletedEventArgs, bool> onComplete)
-		{
-			wc = new WebClient();
-			wc.Proxy = null;
-
-			wc.DownloadProgressChanged += (_, a) => onProgress(a);
-			wc.DownloadDataCompleted += (_, a) => onComplete(a, cancelled);
-
-			Game.OnQuit += Cancel;
-			wc.DownloadDataCompleted += (_, a) => { Game.OnQuit -= Cancel; };
-
-			wc.DownloadDataAsync(new Uri(url));
-		}
-
-		public void Cancel()
-		{
-			Game.OnQuit -= Cancel;
-			wc.CancelAsync();
-			wc.Dispose();
-			cancelled = true;
-		}
-	}
-}

OpenRA.Game/Effects/AsyncAction.cs

@@ -1,10 +1,11 @@
-#region Copyright & License Information
+#region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -16,8 +17,8 @@ namespace OpenRA.Effects
 {
 	public class AsyncAction : IEffect
 	{
-		Action a;
-		IAsyncResult ar;
+		readonly Action a;
+		readonly IAsyncResult ar;
 
 		public AsyncAction(IAsyncResult ar, Action a)
 		{

OpenRA.Game/Effects/DelayedAction.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -16,7 +17,7 @@ namespace OpenRA.Effects
 {
 	public class DelayedAction : IEffect
 	{
-		Action a;
+		readonly Action a;
 		int delay;
 
 		public DelayedAction(int delay, Action a)

OpenRA.Game/Effects/DelayedImpact.cs

@@ -0,0 +1,43 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System.Collections.Generic;
+using OpenRA.GameRules;
+using OpenRA.Graphics;
+using OpenRA.Traits;
+
+namespace OpenRA.Effects
+{
+	public class DelayedImpact : IEffect
+	{
+		readonly Target target;
+		readonly IWarhead wh;
+		readonly WarheadArgs args;
+
+		int delay;
+
+		public DelayedImpact(int delay, IWarhead wh, Target target, WarheadArgs args)
+		{
+			this.wh = wh;
+			this.delay = delay;
+			this.target = target;
+			this.args = args;
+		}
+
+		public void Tick(World world)
+		{
+			if (--delay <= 0)
+				world.AddFrameEndTask(w => { w.Remove(this); wh.DoImpact(target, args); });
+		}
+
+		public IEnumerable<IRenderable> Render(WorldRenderer wr) { yield break; }
+	}
+}

OpenRA.Game/Effects/FlashTarget.cs

@@ -1,54 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using System.Linq;
-using OpenRA.Graphics;
-
-namespace OpenRA.Effects
-{
-	public class FlashTarget : IEffect
-	{
-		Actor target;
-		Player player;
-		int remainingTicks;
-
-		public FlashTarget(Actor target, Player asPlayer = null, int ticks = 4)
-		{
-			this.target = target;
-			player = asPlayer;
-			remainingTicks = ticks;
-			target.World.RemoveAll(effect =>
-			{
-				var flashTarget = effect as FlashTarget;
-				return flashTarget != null && flashTarget.target == target;
-			});
-		}
-
-		public void Tick(World world)
-		{
-			if (--remainingTicks == 0 || !target.IsInWorld)
-				world.AddFrameEndTask(w => w.Remove(this));
-		}
-
-		public IEnumerable<IRenderable> Render(WorldRenderer wr)
-		{
-			if (target.IsInWorld && remainingTicks % 2 == 0)
-			{
-				var palette = wr.Palette(player == null ? "highlight" : "highlight" + player.InternalName);
-				return target.Render(wr)
-					.Where(r => !r.IsDecoration)
-					.Select(r => r.WithPalette(palette));
-			}
-
-			return SpriteRenderable.None;
-		}
-	}
-}

OpenRA.Game/Effects/IEffect.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -18,4 +19,10 @@ namespace OpenRA.Effects
 		void Tick(World world);
 		IEnumerable<IRenderable> Render(WorldRenderer r);
 	}
+
+	// Identifier interface for effects that are added to ScreenMap
+	public interface ISpatiallyPartitionable { }
+
+	public interface IEffectAboveShroud { IEnumerable<IRenderable> RenderAboveShroud(WorldRenderer wr); }
+	public interface IEffectAnnotation { IEnumerable<IRenderable> RenderAnnotation(WorldRenderer wr); }
 }

OpenRA.Game/Effects/SpriteEffect.cs

@@ -1,40 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using OpenRA.Graphics;
-
-namespace OpenRA.Effects
-{
-	public class SpriteEffect : IEffect
-	{
-		readonly string palette;
-		readonly Animation anim;
-		readonly WPos pos;
-
-		public SpriteEffect(WPos pos, World world, string image, string palette)
-		{
-			this.pos = pos;
-			this.palette = palette;
-			anim = new Animation(world, image);
-			anim.PlayThen("idle", () => world.AddFrameEndTask(w => w.Remove(this)));
-		}
-
-		public void Tick(World world)
-		{
-			anim.Tick();
-		}
-
-		public IEnumerable<IRenderable> Render(WorldRenderer wr)
-		{
-			return anim.Render(pos, WVec.Zero, 0, wr.Palette(palette), 1f / wr.Viewport.Zoom);
-		}
-	}
-}

OpenRA.Game/ExternalMods.cs

@@ -0,0 +1,290 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using OpenRA.FileFormats;
+using OpenRA.Graphics;
+using OpenRA.Primitives;
+
+namespace OpenRA
+{
+	[Flags]
+	enum ModRegistration { User = 1, System = 2 }
+
+	public class ExternalMod
+	{
+		public readonly string Id;
+		public readonly string Version;
+		public readonly string Title;
+		public readonly string LaunchPath;
+		public readonly string[] LaunchArgs;
+		public Sprite Icon { get; internal set; }
+		public Sprite Icon2x { get; internal set; }
+		public Sprite Icon3x { get; internal set; }
+
+		public static string MakeKey(Manifest mod) { return MakeKey(mod.Id, mod.Metadata.Version); }
+		public static string MakeKey(ExternalMod mod) { return MakeKey(mod.Id, mod.Version); }
+		public static string MakeKey(string modId, string modVersion) { return modId + "-" + modVersion; }
+	}
+
+	public class ExternalMods : IReadOnlyDictionary<string, ExternalMod>
+	{
+		readonly Dictionary<string, ExternalMod> mods = new Dictionary<string, ExternalMod>();
+		readonly SheetBuilder sheetBuilder;
+
+		Sheet CreateSheet()
+		{
+			var sheet = new Sheet(SheetType.BGRA, new Size(512, 512));
+
+			// We must manually force the buffer creation to avoid a crash
+			// that is indirectly triggered by rendering from a Sheet that
+			// has not yet been written to.
+			sheet.CreateBuffer();
+			sheet.GetTexture().ScaleFilter = TextureScaleFilter.Linear;
+
+			return sheet;
+		}
+
+		public ExternalMods()
+		{
+			// Don't try to load mod icons if we don't have a texture to put them in
+			if (Game.Renderer != null)
+				sheetBuilder = new SheetBuilder(SheetType.BGRA, CreateSheet);
+
+			// Several types of support directory types are available, depending on
+			// how the player has installed and launched the game.
+			// Read registration metadata from all of them
+			foreach (var source in GetSupportDirs(ModRegistration.User | ModRegistration.System))
+			{
+				var metadataPath = Path.Combine(source, "ModMetadata");
+				if (!Directory.Exists(metadataPath))
+					continue;
+
+				foreach (var path in Directory.GetFiles(metadataPath, "*.yaml"))
+				{
+					try
+					{
+						var yaml = MiniYaml.FromStream(File.OpenRead(path), path).First().Value;
+						LoadMod(yaml, path);
+					}
+					catch (Exception e)
+					{
+						Log.Write("debug", "Failed to parse mod metadata file '{0}'", path);
+						Log.Write("debug", e.ToString());
+					}
+				}
+			}
+		}
+
+		void LoadMod(MiniYaml yaml, string path = null, bool forceRegistration = false)
+		{
+			var mod = FieldLoader.Load<ExternalMod>(yaml);
+
+			if (sheetBuilder != null)
+			{
+				var iconNode = yaml.Nodes.FirstOrDefault(n => n.Key == "Icon");
+				if (iconNode != null && !string.IsNullOrEmpty(iconNode.Value.Value))
+					using (var stream = new MemoryStream(Convert.FromBase64String(iconNode.Value.Value)))
+						mod.Icon = sheetBuilder.Add(new Png(stream));
+
+				var icon2xNode = yaml.Nodes.FirstOrDefault(n => n.Key == "Icon2x");
+				if (icon2xNode != null && !string.IsNullOrEmpty(icon2xNode.Value.Value))
+					using (var stream = new MemoryStream(Convert.FromBase64String(icon2xNode.Value.Value)))
+						mod.Icon2x = sheetBuilder.Add(new Png(stream), 1f / 2);
+
+				var icon3xNode = yaml.Nodes.FirstOrDefault(n => n.Key == "Icon3x");
+				if (icon3xNode != null && !string.IsNullOrEmpty(icon3xNode.Value.Value))
+					using (var stream = new MemoryStream(Convert.FromBase64String(icon3xNode.Value.Value)))
+						mod.Icon3x = sheetBuilder.Add(new Png(stream), 1f / 3);
+			}
+
+			// Avoid possibly overwriting a valid mod with an obviously bogus one
+			var key = ExternalMod.MakeKey(mod);
+			if ((forceRegistration || File.Exists(mod.LaunchPath)) && (path == null || Path.GetFileNameWithoutExtension(path) == key))
+				mods[key] = mod;
+		}
+
+		internal void Register(Manifest mod, string launchPath, IEnumerable<string> launchArgs, ModRegistration registration)
+		{
+			if (mod.Metadata.Hidden)
+				return;
+
+			var key = ExternalMod.MakeKey(mod);
+			var yaml = new MiniYamlNode("Registration", new MiniYaml("", new List<MiniYamlNode>()
+			{
+				new MiniYamlNode("Id", mod.Id),
+				new MiniYamlNode("Version", mod.Metadata.Version),
+				new MiniYamlNode("Title", mod.Metadata.Title),
+				new MiniYamlNode("LaunchPath", launchPath),
+				new MiniYamlNode("LaunchArgs", new[] { "Game.Mod=" + mod.Id }.Concat(launchArgs).JoinWith(", "))
+			}));
+
+			using (var stream = mod.Package.GetStream("icon.png"))
+				if (stream != null)
+					yaml.Value.Nodes.Add(new MiniYamlNode("Icon", Convert.ToBase64String(stream.ReadAllBytes())));
+
+			using (var stream = mod.Package.GetStream("icon-2x.png"))
+				if (stream != null)
+					yaml.Value.Nodes.Add(new MiniYamlNode("Icon2x", Convert.ToBase64String(stream.ReadAllBytes())));
+
+			using (var stream = mod.Package.GetStream("icon-3x.png"))
+				if (stream != null)
+					yaml.Value.Nodes.Add(new MiniYamlNode("Icon3x", Convert.ToBase64String(stream.ReadAllBytes())));
+
+			var sources = new HashSet<string>();
+			if (registration.HasFlag(ModRegistration.System))
+				sources.Add(Platform.GetSupportDir(SupportDirType.System));
+
+			if (registration.HasFlag(ModRegistration.User))
+			{
+				sources.Add(Platform.GetSupportDir(SupportDirType.User));
+
+				// If using the modern support dir we must also write the registration
+				// to the legacy support dir for older engine versions, but ONLY if it exists
+				var legacyPath = Platform.GetSupportDir(SupportDirType.LegacyUser);
+				if (Directory.Exists(legacyPath))
+					sources.Add(legacyPath);
+			}
+
+			// Make sure the mod is available for this session, even if saving it fails
+			LoadMod(yaml.Value, forceRegistration: true);
+
+			var lines = new List<MiniYamlNode> { yaml }.ToLines().ToArray();
+			foreach (var source in sources)
+			{
+				var metadataPath = Path.Combine(source, "ModMetadata");
+
+				try
+				{
+					Directory.CreateDirectory(metadataPath);
+					File.WriteAllLines(Path.Combine(metadataPath, key + ".yaml"), lines);
+				}
+				catch (Exception e)
+				{
+					Log.Write("debug", "Failed to register current mod metadata");
+					Log.Write("debug", e.ToString());
+				}
+			}
+		}
+
+		/// <summary>
+		/// Removes invalid mod registrations:
+		/// * LaunchPath no longer exists
+		/// * LaunchPath and mod id matches the active mod, but the version is different
+		/// * Filename doesn't match internal key
+		/// * Fails to parse as a mod registration
+		/// </summary>
+		internal void ClearInvalidRegistrations(ModRegistration registration)
+		{
+			foreach (var source in GetSupportDirs(registration))
+			{
+				var metadataPath = Path.Combine(source, "ModMetadata");
+				if (!Directory.Exists(metadataPath))
+					continue;
+
+				foreach (var path in Directory.GetFiles(metadataPath, "*.yaml"))
+				{
+					string modKey = null;
+					try
+					{
+						var yaml = MiniYaml.FromStream(File.OpenRead(path), path).First().Value;
+						var m = FieldLoader.Load<ExternalMod>(yaml);
+						modKey = ExternalMod.MakeKey(m);
+
+						// Continue to the next entry if this one is valid
+						// HACK: Explicitly invalidate paths to OpenRA.dll to clean up bogus metadata files
+						// that were created after the initial migration from .NET Framework to Core/5.
+						if (File.Exists(m.LaunchPath) && Path.GetFileNameWithoutExtension(path) == modKey && Path.GetExtension(m.LaunchPath) != ".dll")
+							continue;
+					}
+					catch (Exception e)
+					{
+						Log.Write("debug", "Failed to parse mod metadata file '{0}'", path);
+						Log.Write("debug", e.ToString());
+					}
+
+					// Remove from the ingame mod switcher
+					if (Path.GetFileNameWithoutExtension(path) == modKey)
+						mods.Remove(modKey);
+
+					// Remove stale or corrupted metadata
+					try
+					{
+						File.Delete(path);
+						Log.Write("debug", "Removed invalid mod metadata file '{0}'", path);
+					}
+					catch (Exception e)
+					{
+						Log.Write("debug", "Failed to remove mod metadata file '{0}'", path);
+						Log.Write("debug", e.ToString());
+					}
+				}
+			}
+		}
+
+		internal void Unregister(Manifest mod, ModRegistration registration)
+		{
+			var key = ExternalMod.MakeKey(mod);
+			mods.Remove(key);
+
+			foreach (var source in GetSupportDirs(registration))
+			{
+				var path = Path.Combine(source, "ModMetadata", key + ".yaml");
+				try
+				{
+					if (File.Exists(path))
+						File.Delete(path);
+				}
+				catch (Exception e)
+				{
+					Log.Write("debug", "Failed to remove mod metadata file '{0}'", path);
+					Log.Write("debug", e.ToString());
+				}
+			}
+		}
+
+		IEnumerable<string> GetSupportDirs(ModRegistration registration)
+		{
+			var sources = new HashSet<string>(4);
+			if (registration.HasFlag(ModRegistration.System))
+				sources.Add(Platform.GetSupportDir(SupportDirType.System));
+
+			if (registration.HasFlag(ModRegistration.User))
+			{
+				// User support dir may be using the modern or legacy value, or overridden by the user
+				// Add all the possibilities and let the HashSet ignore the duplicates
+				sources.Add(Platform.GetSupportDir(SupportDirType.User));
+				sources.Add(Platform.GetSupportDir(SupportDirType.ModernUser));
+				sources.Add(Platform.GetSupportDir(SupportDirType.LegacyUser));
+			}
+
+			return sources;
+		}
+
+		public ExternalMod this[string key] => mods[key];
+		public int Count => mods.Count;
+		public ICollection<string> Keys => mods.Keys;
+		public ICollection<ExternalMod> Values => mods.Values;
+
+		IEnumerable<string> IReadOnlyDictionary<string, ExternalMod>.Keys => ((IReadOnlyDictionary<string, ExternalMod>)mods).Keys;
+
+		IEnumerable<ExternalMod> IReadOnlyDictionary<string, ExternalMod>.Values => ((IReadOnlyDictionary<string, ExternalMod>)mods).Values;
+
+		public bool ContainsKey(string key) { return mods.ContainsKey(key); }
+		public IEnumerator<KeyValuePair<string, ExternalMod>> GetEnumerator() { return mods.GetEnumerator(); }
+		public bool TryGetValue(string key, out ExternalMod value) { return mods.TryGetValue(key, out value); }
+		IEnumerator IEnumerable.GetEnumerator() { return mods.GetEnumerator(); }
+	}
+}

OpenRA.Game/Exts.cs

@@ -1,20 +1,20 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
 using System.Collections.Generic;
-using System.Drawing;
-using System.Drawing.Imaging;
 using System.Globalization;
 using System.Linq;
 using System.Reflection;
+using OpenRA.Primitives;
 using OpenRA.Support;
 using OpenRA.Traits;
 
@@ -38,12 +38,6 @@ namespace OpenRA
 			catch { return def; }
 		}
 
-		public static void Do<T>(this IEnumerable<T> e, Action<T> fn)
-		{
-			foreach (var ee in e)
-				fn(ee);
-		}
-
 		public static Lazy<T> Lazy<T>(Func<T> p) { return new Lazy<T>(p); }
 
 		public static IEnumerable<string> GetNamespaces(this Assembly a)
@@ -53,7 +47,7 @@ namespace OpenRA
 
 		public static bool HasAttribute<T>(this MemberInfo mi)
 		{
-			return mi.GetCustomAttributes(typeof(T), true).Length != 0;
+			return Attribute.IsDefined(mi, typeof(T));
 		}
 
 		public static T[] GetCustomAttributes<T>(this MemberInfo mi, bool inherit)
@@ -78,19 +72,9 @@ namespace OpenRA
 				return val;
 		}
 
-		public static bool Contains(this Rectangle r, int2 p)
-		{
-			return r.Contains(p.ToPoint());
-		}
-
-		public static bool Contains(this RectangleF r, int2 p)
-		{
-			return r.Contains(p.ToPointF());
-		}
-
 		static int WindingDirectionTest(int2 v0, int2 v1, int2 p)
 		{
-			return (v1.X - v0.X) * (p.Y - v0.Y) - (p.X - v0.X) * (v1.Y - v0.Y);
+			return Math.Sign((v1.X - v0.X) * (p.Y - v0.Y) - (p.X - v0.X) * (v1.Y - v0.Y));
 		}
 
 		public static bool PolygonContains(this int2[] polygon, int2 p)
@@ -111,21 +95,38 @@ namespace OpenRA
 			return windingNumber != 0;
 		}
 
+		public static bool LinesIntersect(int2 a, int2 b, int2 c, int2 d)
+		{
+			// If line segments AB and CD intersect:
+			//  - the triangles ACD and BCD must have opposite sense (clockwise or anticlockwise)
+			//  - the triangles CAB and DAB must have opposite sense
+			// Segments intersect if the orientation (clockwise or anticlockwise) of the two points in each line segment are opposite with respect to the other
+			// Assumes that lines are not collinear
+			return WindingDirectionTest(c, d, a) != WindingDirectionTest(c, d, b) && WindingDirectionTest(a, b, c) != WindingDirectionTest(a, b, d);
+		}
+
 		public static bool HasModifier(this Modifiers k, Modifiers mod)
 		{
+			// PERF: Enum.HasFlag is slower and requires allocations.
 			return (k & mod) == mod;
 		}
 
 		public static V GetOrAdd<K, V>(this Dictionary<K, V> d, K k)
 			where V : new()
 		{
-			return d.GetOrAdd(k, _ => new V());
+			return d.GetOrAdd(k, new V());
+		}
+
+		public static V GetOrAdd<K, V>(this Dictionary<K, V> d, K k, V v)
+		{
+			if (!d.TryGetValue(k, out var ret))
+				d.Add(k, ret = v);
+			return ret;
 		}
 
 		public static V GetOrAdd<K, V>(this Dictionary<K, V> d, K k, Func<K, V> createFn)
 		{
-			V ret;
-			if (!d.TryGetValue(k, out ret))
+			if (!d.TryGetValue(k, out var ret))
 				d.Add(k, ret = createFn(k));
 			return ret;
 		}
@@ -152,14 +153,34 @@ namespace OpenRA
 			if (xs.Count == 0)
 			{
 				if (throws)
-					throw new ArgumentException("Collection must not be empty.", "ts");
+					throw new ArgumentException("Collection must not be empty.", nameof(ts));
 				else
-					return default(T);
+					return default;
 			}
 			else
 				return xs.ElementAt(r.Next(xs.Count));
 		}
 
+		public static Rectangle Union(this IEnumerable<Rectangle> rects)
+		{
+			// PERF: Avoid LINQ.
+			var first = true;
+			var result = Rectangle.Empty;
+			foreach (var rect in rects)
+			{
+				if (first)
+				{
+					first = false;
+					result = rect;
+					continue;
+				}
+
+				result = Rectangle.Union(rect, result);
+			}
+
+			return result;
+		}
+
 		public static float Product(this IEnumerable<float> xs)
 		{
 			return xs.Aggregate(1f, (a, x) => a * x);
@@ -173,7 +194,11 @@ namespace OpenRA
 
 		public static IEnumerable<T> Iterate<T>(this T t, Func<T, T> f)
 		{
-			for (;;) { yield return t; t = f(t); }
+			while (true)
+			{
+				yield return t;
+				t = f(t);
+			}
 		}
 
 		public static T MinBy<T, U>(this IEnumerable<T> ts, Func<T, U> selector)
@@ -205,9 +230,9 @@ namespace OpenRA
 			{
 				if (!e.MoveNext())
 					if (throws)
-						throw new ArgumentException("Collection must not be empty.", "ts");
+						throw new ArgumentException("Collection must not be empty.", nameof(ts));
 					else
-						return default(T);
+						return default;
 				t = e.Current;
 				u = selector(t);
 				while (e.MoveNext())
@@ -247,7 +272,7 @@ namespace OpenRA
 		public static int ISqrt(int number, ISqrtRoundMode round = ISqrtRoundMode.Floor)
 		{
 			if (number < 0)
-				throw new InvalidOperationException("Attempted to calculate the square root of a negative integer: {0}".F(number));
+				throw new InvalidOperationException($"Attempted to calculate the square root of a negative integer: {number}");
 
 			return (int)ISqrt((uint)number, round);
 		}
@@ -288,7 +313,7 @@ namespace OpenRA
 		public static long ISqrt(long number, ISqrtRoundMode round = ISqrtRoundMode.Floor)
 		{
 			if (number < 0)
-				throw new InvalidOperationException("Attempted to calculate the square root of a negative integer: {0}".F(number));
+				throw new InvalidOperationException($"Attempted to calculate the square root of a negative integer: {number}");
 
 			return (long)ISqrt((ulong)number, round);
 		}
@@ -326,6 +351,19 @@ namespace OpenRA
 			return root;
 		}
 
+		public static int MultiplyBySqrtTwo(short number)
+		{
+			return number * 46341 / 32768;
+		}
+
+		public static int IntegerDivisionRoundingAwayFromZero(int dividend, int divisor)
+		{
+			var quotient = Math.DivRem(dividend, divisor, out var remainder);
+			if (remainder == 0)
+				return quotient;
+			return quotient + (Math.Sign(dividend) == Math.Sign(divisor) ? 1 : -1);
+		}
+
 		public static string JoinWith<T>(this IEnumerable<T> ts, string j)
 		{
 			return string.Join(j, ts);
@@ -336,6 +374,11 @@ namespace OpenRA
 			return ts.Concat(moreTs);
 		}
 
+		public static IEnumerable<T> Exclude<T>(this IEnumerable<T> ts, params T[] exclusions)
+		{
+			return ts.Except(exclusions);
+		}
+
 		public static HashSet<T> ToHashSet<T>(this IEnumerable<T> source)
 		{
 			return new HashSet<T>(source);
@@ -350,7 +393,7 @@ namespace OpenRA
 
 		public static Dictionary<TKey, TElement> ToDictionaryWithConflictLog<TSource, TKey, TElement>(
 			this IEnumerable<TSource> source, Func<TSource, TKey> keySelector, Func<TSource, TElement> elementSelector,
-			string debugName, Func<TKey, string> logKey, Func<TElement, string> logValue)
+			string debugName, Func<TKey, string> logKey = null, Func<TElement, string> logValue = null)
 		{
 			// Fall back on ToString() if null functions are provided:
 			logKey = logKey ?? (s => s.ToString());
@@ -358,37 +401,40 @@ namespace OpenRA
 
 			// Try to build a dictionary and log all duplicates found (if any):
 			var dupKeys = new Dictionary<TKey, List<string>>();
-			var d = new Dictionary<TKey, TElement>();
+			var capacity = source is ICollection<TSource> collection ? collection.Count : 0;
+			var d = new Dictionary<TKey, TElement>(capacity);
 			foreach (var item in source)
 			{
 				var key = keySelector(item);
 				var element = elementSelector(item);
 
+				// Discard elements with null keys
+				if (!typeof(TKey).IsValueType && key == null)
+					continue;
+
 				// Check for a key conflict:
-				if (d.ContainsKey(key))
+				if (!d.TryAdd(key, element))
 				{
-					List<string> dupKeyMessages;
-					if (!dupKeys.TryGetValue(key, out dupKeyMessages))
+					if (!dupKeys.TryGetValue(key, out var dupKeyMessages))
 					{
 						// Log the initial conflicting value already inserted:
-						dupKeyMessages = new List<string>();
-						dupKeyMessages.Add(logValue(d[key]));
+						dupKeyMessages = new List<string>
+						{
+							logValue(d[key])
+						};
 						dupKeys.Add(key, dupKeyMessages);
 					}
 
 					// Log this conflicting value:
 					dupKeyMessages.Add(logValue(element));
-					continue;
 				}
-
-				d.Add(key, element);
 			}
 
 			// If any duplicates were found, throw a descriptive error
 			if (dupKeys.Count > 0)
 			{
-				var badKeysFormatted = string.Join(", ", dupKeys.Select(p => "{0}: [{1}]".F(logKey(p.Key), string.Join(",", p.Value))));
-				var msg = "{0}, duplicate values found for the following keys: {1}".F(debugName, badKeysFormatted);
+				var badKeysFormatted = string.Join(", ", dupKeys.Select(p => $"{logKey(p.Key)}: [{string.Join(",", p.Value)}]"));
+				var msg = $"{debugName}, duplicate values found for the following keys: {badKeysFormatted}";
 				throw new ArgumentException(msg);
 			}
 
@@ -433,27 +479,6 @@ namespace OpenRA
 			return result;
 		}
 
-		public static Rectangle Bounds(this Bitmap b) { return new Rectangle(0, 0, b.Width, b.Height); }
-
-		public static Bitmap CloneWith32bbpArgbPixelFormat(this Bitmap original)
-		{
-			// Note: We would use original.Clone(original.Bounds(), PixelFormat.Format32bppArgb)
-			// but this doesn't work on mono.
-			var clone = new Bitmap(original.Width, original.Height, PixelFormat.Format32bppArgb);
-			try
-			{
-				using (var g = System.Drawing.Graphics.FromImage(clone))
-					g.DrawImage(original, original.Bounds());
-			}
-			catch (Exception)
-			{
-				clone.Dispose();
-				throw;
-			}
-
-			return clone;
-		}
-
 		public static int ToBits(this IEnumerable<bool> bits)
 		{
 			var i = 0;
@@ -473,20 +498,109 @@ namespace OpenRA
 			return int.Parse(s, NumberStyles.Integer, NumberFormatInfo.InvariantInfo);
 		}
 
+		public static byte ParseByte(string s)
+		{
+			return byte.Parse(s, NumberStyles.Integer, NumberFormatInfo.InvariantInfo);
+		}
+
 		public static bool TryParseIntegerInvariant(string s, out int i)
 		{
 			return int.TryParse(s, NumberStyles.Integer, NumberFormatInfo.InvariantInfo, out i);
 		}
 
-		public static bool IsTraitEnabled(this object trait)
+		public static bool TryParseInt64Invariant(string s, out long i)
 		{
-			return trait as IDisabledTrait == null || !(trait as IDisabledTrait).IsTraitDisabled;
+			return long.TryParse(s, NumberStyles.Integer, NumberFormatInfo.InvariantInfo, out i);
 		}
 
-		public static bool IsTraitEnabled<T>(T t)
+		public static bool IsTraitEnabled<T>(this T trait)
 		{
-			return IsTraitEnabled(t as object);
+			return !(trait is IDisabledTrait disabledTrait) || !disabledTrait.IsTraitDisabled;
 		}
+
+		public static T FirstEnabledTraitOrDefault<T>(this IEnumerable<T> ts)
+		{
+			// PERF: Avoid LINQ.
+			foreach (var t in ts)
+				if (t.IsTraitEnabled())
+					return t;
+
+			return default;
+		}
+
+		public static T FirstEnabledTraitOrDefault<T>(this T[] ts)
+		{
+			// PERF: Avoid LINQ.
+			foreach (var t in ts)
+				if (t.IsTraitEnabled())
+					return t;
+
+			return default;
+		}
+
+		public static T FirstEnabledConditionalTraitOrDefault<T>(this IEnumerable<T> ts) where T : IDisabledTrait
+		{
+			// PERF: Avoid LINQ.
+			foreach (var t in ts)
+				if (!t.IsTraitDisabled)
+					return t;
+
+			return default;
+		}
+
+		public static T FirstEnabledConditionalTraitOrDefault<T>(this T[] ts) where T : IDisabledTrait
+		{
+			// PERF: Avoid LINQ.
+			foreach (var t in ts)
+				if (!t.IsTraitDisabled)
+					return t;
+
+			return default;
+		}
+
+		public static LineSplitEnumerator SplitLines(this string str, char separator)
+		{
+			return new LineSplitEnumerator(str.AsSpan(), separator);
+		}
+	}
+
+	public ref struct LineSplitEnumerator
+	{
+		ReadOnlySpan<char> str;
+		readonly char separator;
+
+		public LineSplitEnumerator(ReadOnlySpan<char> str, char separator)
+		{
+			this.str = str;
+			this.separator = separator;
+			Current = default;
+		}
+
+		public LineSplitEnumerator GetEnumerator() => this;
+
+		public bool MoveNext()
+		{
+			var span = str;
+
+			// Reach the end of the string
+			if (span.Length == 0)
+				return false;
+
+			var index = span.IndexOf(separator);
+			if (index == -1)
+			{
+				// The remaining string is an empty string
+				str = ReadOnlySpan<char>.Empty;
+				Current = span;
+				return true;
+			}
+
+			Current = span.Slice(0, index);
+			str = span.Slice(index + 1);
+			return true;
+		}
+
+		public ReadOnlySpan<char> Current { get; private set; }
 	}
 
 	public static class Enum<T>
@@ -502,7 +616,7 @@ namespace OpenRA
 
 			if (values.Any(x => !names.Contains(x)))
 			{
-				value = default(T);
+				value = default;
 				return false;
 			}
 

OpenRA.Game/FieldSaver.cs

@@ -1,21 +1,21 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Drawing;
-using System.Drawing.Imaging;
 using System.Globalization;
 using System.Linq;
 using System.Reflection;
+using OpenRA.Primitives;
 
 namespace OpenRA
 {
@@ -28,7 +28,18 @@ namespace OpenRA
 
 			foreach (var info in FieldLoader.GetTypeLoadInfo(o.GetType(), includePrivateByDefault))
 			{
-				if (info.Attribute.FromYamlKey)
+				if (info.Attribute.DictionaryFromYamlKey)
+				{
+					var dict = (System.Collections.IDictionary)info.Field.GetValue(o);
+					foreach (var kvp in dict)
+					{
+						var key = ((System.Collections.DictionaryEntry)kvp).Key;
+						var value = ((System.Collections.DictionaryEntry)kvp).Value;
+
+						nodes.Add(new MiniYamlNode(FormatValue(key), FormatValue(value)));
+					}
+				}
+				else if (info.Attribute.FromYamlKey)
 					root = FormatValue(o, info.Field);
 				else
 					nodes.Add(new MiniYamlNode(info.YamlName, FormatValue(o, info.Field)));
@@ -55,51 +66,42 @@ namespace OpenRA
 			return new MiniYamlNode(field, FormatValue(o, o.GetType().GetField(field)));
 		}
 
-		public static string FormatValue(object v, Type t)
+		public static string FormatValue(object v)
 		{
 			if (v == null)
 				return "";
 
-			// Color.ToString() does the wrong thing; force it to format as an array
-			if (t == typeof(Color))
+			var t = v.GetType();
+			if (t.IsGenericType && t.GetGenericTypeDefinition() == typeof(BitSet<>))
+				return ((IEnumerable<string>)v).Select(FormatValue).JoinWith(", ");
+
+			if (t.IsArray && t.GetArrayRank() == 1)
+				return ((Array)v).Cast<object>().Select(FormatValue).JoinWith(", ");
+
+			if (t.IsGenericType && (t.GetGenericTypeDefinition() == typeof(HashSet<>) || t.GetGenericTypeDefinition() == typeof(List<>)))
+				return ((System.Collections.IEnumerable)v).Cast<object>().Select(FormatValue).JoinWith(", ");
+
+			// This is only for documentation generation
+			if (t.IsGenericType && t.GetGenericTypeDefinition() == typeof(Dictionary<,>))
 			{
-				var c = (Color)v;
-				return "{0},{1},{2},{3}".F(((int)c.A).Clamp(0, 255),
-					((int)c.R).Clamp(0, 255),
-					((int)c.G).Clamp(0, 255),
-					((int)c.B).Clamp(0, 255));
+				var result = "";
+				var dict = (System.Collections.IDictionary)v;
+				foreach (var kvp in dict)
+				{
+					var key = ((System.Collections.DictionaryEntry)kvp).Key;
+					var value = ((System.Collections.DictionaryEntry)kvp).Value;
+
+					var formattedKey = FormatValue(key);
+					var formattedValue = FormatValue(value);
+
+					result += $"{formattedKey}: {formattedValue}{Environment.NewLine}";
+				}
+
+				return result;
 			}
 
-			// Don't save using country-specific decimal separators which can be misunderstood as group seperators.
-			if (t == typeof(float))
-				return ((float)v).ToString(CultureInfo.InvariantCulture);
-			if (t == typeof(decimal))
-				return ((decimal)v).ToString(CultureInfo.InvariantCulture);
-			if (t == typeof(double))
-				return ((double)v).ToString(CultureInfo.InvariantCulture);
-
-			if (t == typeof(ImageFormat))
-			{
-				return ((ImageFormat)v).ToString();
-			}
-
-			if (t == typeof(Rectangle))
-			{
-				var r = (Rectangle)v;
-				return "{0},{1},{2},{3}".F(r.X, r.Y, r.Width, r.Height);
-			}
-
-			if (t.IsArray)
-			{
-				var elems = ((Array)v).OfType<object>();
-				return elems.JoinWith(", ");
-			}
-
-			if (t.IsGenericType && t.GetGenericTypeDefinition() == typeof(OpenRA.Primitives.Cache<,>))
-				return ""; // TODO
-
-			if (t == typeof(DateTime))
-				return ((DateTime)v).ToString("yyyy-MM-dd HH-mm-ss", CultureInfo.InvariantCulture);
+			if (v is DateTime d)
+				return d.ToString("yyyy-MM-dd HH-mm-ss", CultureInfo.InvariantCulture);
 
 			// Try the TypeConverter
 			var conv = TypeDescriptor.GetConverter(t);
@@ -119,7 +121,7 @@ namespace OpenRA
 
 		public static string FormatValue(object o, FieldInfo f)
 		{
-			return FormatValue(f.GetValue(o), f.FieldType);
+			return FormatValue(f.GetValue(o));
 		}
 	}
 }

OpenRA.Game/FileFormats/AudLoader.cs

@@ -1,159 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	[Flags]
-	enum SoundFlags
-	{
-		Stereo = 0x1,
-		_16Bit = 0x2,
-	}
-
-	enum SoundFormat
-	{
-		WestwoodCompressed = 1,
-		ImaAdpcm = 99,
-	}
-
-	struct Chunk
-	{
-		public int CompressedSize;
-		public int OutputSize;
-
-		public static Chunk Read(Stream s)
-		{
-			Chunk c;
-			c.CompressedSize = s.ReadUInt16();
-			c.OutputSize = s.ReadUInt16();
-			if (s.ReadUInt32() != 0xdeaf)
-				throw new InvalidDataException("Chunk header is bogus");
-			return c;
-		}
-	}
-
-	public static class AudLoader
-	{
-		static int[] indexAdjust = { -1, -1, -1, -1, 2, 4, 6, 8 };
-		static int[] stepTable =
-		{
-			7, 8, 9, 10, 11, 12, 13, 14, 16,
-			17, 19, 21, 23, 25, 28, 31, 34, 37,
-			41, 45, 50, 55, 60, 66, 73, 80, 88,
-			97, 107, 118, 130, 143, 157, 173, 190, 209,
-			230, 253, 279, 307, 337, 371, 408, 449, 494,
-			544, 598, 658, 724, 796, 876, 963, 1060, 1166,
-			1282, 1411, 1552, 1707, 1878, 2066, 2272, 2499, 2749,
-			3024, 3327, 3660, 4026, 4428, 4871, 5358, 5894, 6484,
-			7132, 7845, 8630, 9493, 10442, 11487, 12635, 13899, 15289,
-			16818, 18500, 20350, 22385, 24623, 27086, 29794, 32767
-		};
-
-		static short DecodeSample(byte b, ref int index, ref int current)
-		{
-			var sb = (b & 8) != 0;
-			b &= 7;
-
-			var delta = (stepTable[index] * b) / 4 + stepTable[index] / 8;
-			if (sb) delta = -delta;
-
-			current += delta;
-			if (current > short.MaxValue) current = short.MaxValue;
-			if (current < short.MinValue) current = short.MinValue;
-
-			index += indexAdjust[b];
-			if (index < 0) index = 0;
-			if (index > 88) index = 88;
-
-			return (short)current;
-		}
-
-		public static byte[] LoadSound(byte[] raw, ref int index)
-		{
-			var s = new MemoryStream(raw);
-			var dataSize = raw.Length;
-			var outputSize = raw.Length * 4;
-
-			var output = new byte[outputSize];
-			var offset = 0;
-			var currentSample = 0;
-
-			while (dataSize-- > 0)
-			{
-				var b = s.ReadUInt8();
-
-				var t = DecodeSample(b, ref index, ref currentSample);
-				output[offset++] = (byte)t;
-				output[offset++] = (byte)(t >> 8);
-
-				t = DecodeSample((byte)(b >> 4), ref index, ref currentSample);
-				output[offset++] = (byte)t;
-				output[offset++] = (byte)(t >> 8);
-			}
-
-			return output;
-		}
-
-		public static float SoundLength(Stream s)
-		{
-			var sampleRate = s.ReadUInt16();
-			/*var dataSize = */ s.ReadInt32();
-			var outputSize = s.ReadInt32();
-			var flags = (SoundFlags)s.ReadByte();
-
-			var samples = outputSize;
-			if (0 != (flags & SoundFlags.Stereo)) samples /= 2;
-			if (0 != (flags & SoundFlags._16Bit)) samples /= 2;
-			return samples / sampleRate;
-		}
-
-		public static byte[] LoadSound(Stream s)
-		{
-			/*var sampleRate =*/ s.ReadUInt16();
-			var dataSize = s.ReadInt32();
-			var outputSize = s.ReadInt32();
-			/*var flags = (SoundFlags)*/ s.ReadByte();
-			/*var format = (SoundFormat)*/ s.ReadByte();
-
-			var output = new byte[outputSize];
-			var offset = 0;
-			var index = 0;
-			var currentSample = 0;
-
-			while (dataSize > 0)
-			{
-				var chunk = Chunk.Read(s);
-				for (var n = 0; n < chunk.CompressedSize; n++)
-				{
-					var b = s.ReadUInt8();
-
-					var t = DecodeSample(b, ref index, ref currentSample);
-					output[offset++] = (byte)t;
-					output[offset++] = (byte)(t >> 8);
-
-					if (offset < outputSize)
-					{
-						/* possible that only half of the final byte is used! */
-						t = DecodeSample((byte)(b >> 4), ref index, ref currentSample);
-						output[offset++] = (byte)t;
-						output[offset++] = (byte)(t >> 8);
-					}
-				}
-
-				dataSize -= 8 + chunk.CompressedSize;
-			}
-
-			return output;
-		}
-	}
-}

OpenRA.Game/FileFormats/Blast.cs

@@ -1,281 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- *
- * This file is based on the blast routines (version 1.1 by Mark Adler)
- * included in zlib/contrib
- */
-#endregion
-
-using System;
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	public static class Blast
-	{
-		public static readonly int MAXBITS = 13; // maximum code length
-		public static readonly int MAXWIN = 4096; // maximum window size
-
-		static byte[] litlen = new byte[] {
-			11, 124, 8, 7, 28, 7, 188, 13, 76, 4,
-			10, 8, 12, 10, 12, 10, 8, 23, 8, 9,
-			7, 6, 7, 8, 7, 6, 55, 8, 23, 24,
-			12, 11, 7, 9, 11, 12, 6, 7, 22, 5,
-			7, 24, 6, 11, 9, 6, 7, 22, 7, 11,
-			38, 7, 9, 8, 25, 11, 8, 11, 9, 12,
-			8, 12, 5, 38, 5, 38, 5, 11, 7, 5,
-			6, 21, 6, 10, 53, 8, 7, 24, 10, 27,
-			44, 253, 253, 253, 252, 252, 252, 13, 12, 45,
-			12, 45, 12, 61, 12, 45, 44, 173
-		};
-
-		// bit lengths of length codes 0..15
-		static byte[] lenlen = new byte[] { 2, 35, 36, 53, 38, 23 };
-
-		// bit lengths of distance codes 0..63
-		static byte[] distlen = new byte[] { 2, 20, 53, 230, 247, 151, 248 };
-
-		// base for length codes
-		static short[] lengthbase = new short[] {
-			3, 2, 4, 5, 6, 7, 8, 9, 10, 12,
-			16, 24, 40, 72, 136, 264
-		};
-
-		// extra bits for length codes
-		static byte[] extra = new byte[] {
-			0, 0, 0, 0, 0, 0, 0, 0, 1, 2,
-			3, 4, 5, 6, 7, 8
-		};
-
-		static Huffman litcode = new Huffman(litlen, litlen.Length, 256);
-		static Huffman lencode = new Huffman(lenlen, lenlen.Length, 16);
-		static Huffman distcode = new Huffman(distlen, distlen.Length, 64);
-
-		// Decode PKWare Compression Library stream.
-		public static byte[] Decompress(byte[] src)
-		{
-			var br = new BitReader(src);
-
-			// Are literals coded?
-			var coded = br.ReadBits(8);
-
-			if (coded < 0 || coded > 1)
-				throw new NotImplementedException("Invalid datastream");
-			var encodedLiterals = coded == 1;
-
-			// log2(dictionary size) - 6
-			var dict = br.ReadBits(8);
-			if (dict < 4 || dict > 6)
-				throw new InvalidDataException("Invalid dictionary size");
-
-			// output state
-			ushort next = 0; // index of next write location in out[]
-			var first = true; // true to check distances (for first 4K)
-			var outBuffer = new byte[MAXWIN]; // output buffer and sliding window
-			var ms = new MemoryStream();
-
-			// decode literals and length/distance pairs
-			do
-			{
-				// length/distance pair
-				if (br.ReadBits(1) == 1)
-				{
-					// Length
-					var symbol = Decode(lencode, br);
-					var len = lengthbase[symbol] + br.ReadBits(extra[symbol]);
-
-					// Magic number for "done"
-					if (len == 519)
-					{
-						for (var i = 0; i < next; i++)
-							ms.WriteByte(outBuffer[i]);
-						break;
-					}
-
-					// Distance
-					symbol = len == 2 ? 2 : dict;
-					var dist = Decode(distcode, br) << symbol;
-					dist += br.ReadBits(symbol);
-					dist++;
-
-					if (first && dist > next)
-						throw new InvalidDataException("Attempt to jump before data");
-
-					// copy length bytes from distance bytes back
-					do
-					{
-						var dest = next;
-						var source = dest - dist;
-
-						var copy = MAXWIN;
-						if (next < dist)
-						{
-							source += copy;
-							copy = dist;
-						}
-
-						copy -= next;
-						if (copy > len)
-							copy = len;
-
-						len -= copy;
-						next += (ushort)copy;
-
-						// copy with old-fashioned memcpy semantics
-						// in case of overlapping ranges. this is NOT
-						// the same as Array.Copy()
-						while (copy-- > 0)
-							outBuffer[dest++] = outBuffer[source++];
-
-						// Flush window to outstream
-						if (next == MAXWIN)
-						{
-							for (var i = 0; i < next; i++)
-								ms.WriteByte(outBuffer[i]);
-							next = 0;
-							first = false;
-						}
-					} while (len != 0);
-				}
-				else
-				{
-					// literal value
-					var symbol = encodedLiterals ? Decode(litcode, br) : br.ReadBits(8);
-					outBuffer[next++] = (byte)symbol;
-					if (next == MAXWIN)
-					{
-						for (var i = 0; i < next; i++)
-							ms.WriteByte(outBuffer[i]);
-						next = 0;
-						first = false;
-					}
-				}
-			} while (true);
-
-			return ms.ToArray();
-		}
-
-		// Decode a code using huffman table h.
-		static int Decode(Huffman h, BitReader br)
-		{
-			var code = 0; // len bits being decoded
-			var first = 0; // first code of length len
-			var index = 0; // index of first code of length len in symbol table
-			short next = 1;
-			while (true)
-			{
-				code |= br.ReadBits(1) ^ 1; // invert code
-				int count = h.Count[next++];
-				if (code < first + count)
-					return h.Symbol[index + (code - first)];
-
-				index += count;
-				first += count;
-				first <<= 1;
-				code <<= 1;
-			}
-		}
-	}
-
-	class BitReader
-	{
-		readonly byte[] src;
-		int offset = 0;
-		int bitBuffer = 0;
-		int bitCount = 0;
-
-		public BitReader(byte[] src)
-		{
-			this.src = src;
-		}
-
-		public int ReadBits(int count)
-		{
-			var ret = 0;
-			var filled = 0;
-			while (filled < count)
-			{
-				if (bitCount == 0)
-				{
-					bitBuffer = src[offset++];
-					bitCount = 8;
-				}
-
-				ret |= (bitBuffer & 1) << filled;
-				bitBuffer >>= 1;
-				bitCount--;
-				filled++;
-			}
-
-			return ret;
-		}
-	}
-
-	/*
-	 * Given a list of repeated code lengths rep[0..n-1], where each byte is a
-	 * count (high four bits + 1) and a code length (low four bits), generate the
-	 * list of code lengths.  This compaction reduces the size of the object code.
-	 * Then given the list of code lengths length[0..n-1] representing a canonical
-	 * Huffman code for n symbols, construct the tables required to decode those
-	 * codes.  Those tables are the number of codes of each length, and the symbols
-	 * sorted by length, retaining their original order within each length.
-	 */
-	class Huffman
-	{
-		public short[] Count; // number of symbols of each length
-		public short[] Symbol; // canonically ordered symbols
-
-		public Huffman(byte[] rep, int n, short symbolCount)
-		{
-			var length = new short[256]; // code lengths
-			var s = 0; // current symbol
-
-			// convert compact repeat counts into symbol bit length list
-			foreach (var code in rep)
-			{
-				var num = (code >> 4) + 1; // Number of codes (top four bits plus 1)
-				var len = (byte)(code & 15); // Code length (low four bits)
-				do
-					length[s++] = len;
-				while (--num > 0);
-			}
-
-			n = s;
-
-			// count number of codes of each length
-			Count = new short[Blast.MAXBITS + 1];
-			for (var i = 0; i < n; i++)
-				Count[length[i]]++;
-
-			// no codes!
-			if (Count[0] == n)
-				return;
-
-			// check for an over-subscribed or incomplete set of lengths
-			var left = 1; // one possible code of zero length
-			for (var len = 1; len <= Blast.MAXBITS; len++)
-			{
-				left <<= 1;	// one more bit, double codes left
-				left -= Count[len];	// deduct count from possible codes
-				if (left < 0)
-					throw new InvalidDataException("over subscribed code set");
-			}
-
-			// generate offsets into symbol table for each length for sorting
-			var offs = new short[Blast.MAXBITS + 1];
-			for (var len = 1; len < Blast.MAXBITS; len++)
-				offs[len + 1] = (short)(offs[len] + Count[len]);
-
-			// put symbols in table sorted by length, by symbol order within each length
-			Symbol = new short[symbolCount];
-			for (short i = 0; i < n; i++)
-				if (length[i] != 0)
-					Symbol[offs[length[i]]++] = i;
-		}
-	}
-}

OpenRA.Game/FileFormats/Format2.cs

@@ -1,33 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-namespace OpenRA.FileFormats
-{
-	public static class Format2
-	{
-		public static void DecodeInto(byte[] src, byte[] dest, int destIndex)
-		{
-			var r = new FastByteReader(src);
-
-			while (!r.Done())
-			{
-				var cmd = r.ReadByte();
-				if (cmd == 0)
-				{
-					var count = r.ReadByte();
-					while (count-- > 0)
-						dest[destIndex++] = 0;
-				}
-				else
-					dest[destIndex++] = cmd;
-			}
-		}
-	}
-}

OpenRA.Game/FileFormats/Format40.cs

@@ -1,78 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-namespace OpenRA.FileFormats
-{
-	public static class Format40
-	{
-		public static int DecodeInto(byte[] src, byte[] dest, int srcOffset)
-		{
-			var ctx = new FastByteReader(src, srcOffset);
-			var destIndex = 0;
-
-			while (true)
-			{
-				var i = ctx.ReadByte();
-				if ((i & 0x80) == 0)
-				{
-					var count = i & 0x7F;
-					if (count == 0)
-					{
-						// case 6
-						count = ctx.ReadByte();
-						var value = ctx.ReadByte();
-						for (var end = destIndex + count; destIndex < end; destIndex++)
-							dest[destIndex] ^= value;
-					}
-					else
-					{
-						// case 5
-						for (var end = destIndex + count; destIndex < end; destIndex++)
-							dest[destIndex] ^= ctx.ReadByte();
-					}
-				}
-				else
-				{
-					var count = i & 0x7F;
-					if (count == 0)
-					{
-						count = ctx.ReadWord();
-						if (count == 0)
-							return destIndex;
-
-						if ((count & 0x8000) == 0)
-						{
-							// case 2
-							destIndex += count & 0x7FFF;
-						}
-						else if ((count & 0x4000) == 0)
-						{
-							// case 3
-							for (var end = destIndex + (count & 0x3FFF); destIndex < end; destIndex++)
-								dest[destIndex] ^= ctx.ReadByte();
-						}
-						else
-						{
-							// case 4
-							var value = ctx.ReadByte();
-							for (var end = destIndex + (count & 0x3FFF); destIndex < end; destIndex++)
-								dest[destIndex] ^= value;
-						}
-					}
-					else
-					{
-						// case 1
-						destIndex += count;
-					}
-				}
-			}
-		}
-	}
-}

OpenRA.Game/FileFormats/Format80.cs

@@ -1,206 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	class FastByteReader
-	{
-		readonly byte[] src;
-		int offset;
-
-		public FastByteReader(byte[] src, int offset = 0)
-		{
-			this.src = src;
-			this.offset = offset;
-		}
-
-		public bool Done() { return offset >= src.Length; }
-		public byte ReadByte() { return src[offset++]; }
-		public int ReadWord()
-		{
-			var x = ReadByte();
-			return x | (ReadByte() << 8);
-		}
-
-		public void CopyTo(byte[] dest, int offset, int count)
-		{
-			Array.Copy(src, this.offset, dest, offset, count);
-			this.offset += count;
-		}
-
-		public int Remaining() { return src.Length - offset; }
-	}
-
-	public static class Format80
-	{
-		static void ReplicatePrevious(byte[] dest, int destIndex, int srcIndex, int count)
-		{
-			if (srcIndex > destIndex)
-				throw new NotImplementedException("srcIndex > destIndex {0} {1}".F(srcIndex, destIndex));
-
-			if (destIndex - srcIndex == 1)
-			{
-				for (var i = 0; i < count; i++)
-					dest[destIndex + i] = dest[destIndex - 1];
-			}
-			else
-			{
-				for (var i = 0; i < count; i++)
-					dest[destIndex + i] = dest[srcIndex + i];
-			}
-		}
-
-		public static int DecodeInto(byte[] src, byte[] dest, int srcOffset = 0, bool reverse = false)
-		{
-			var ctx = new FastByteReader(src, srcOffset);
-			var destIndex = 0;
-			while (true)
-			{
-				var i = ctx.ReadByte();
-				if ((i & 0x80) == 0)
-				{
-					// case 2
-					var secondByte = ctx.ReadByte();
-					var count = ((i & 0x70) >> 4) + 3;
-					var rpos = ((i & 0xf) << 8) + secondByte;
-
-					if (destIndex + count > dest.Length)
-						return destIndex;
-
-					ReplicatePrevious(dest, destIndex, destIndex - rpos, count);
-					destIndex += count;
-				}
-				else if ((i & 0x40) == 0)
-				{
-					// case 1
-					var count = i & 0x3F;
-					if (count == 0)
-						return destIndex;
-
-					ctx.CopyTo(dest, destIndex, count);
-					destIndex += count;
-				}
-				else
-				{
-					var count3 = i & 0x3F;
-					if (count3 == 0x3E)
-					{
-						// case 4
-						var count = ctx.ReadWord();
-						var color = ctx.ReadByte();
-
-						for (var end = destIndex + count; destIndex < end; destIndex++)
-							dest[destIndex] = color;
-					}
-					else if (count3 == 0x3F)
-					{
-						// case 5
-						var count = ctx.ReadWord();
-						var srcIndex = reverse ? destIndex - ctx.ReadWord() : ctx.ReadWord();
-						if (srcIndex >= destIndex)
-							throw new NotImplementedException("srcIndex >= destIndex {0} {1}".F(srcIndex, destIndex));
-
-						for (var end = destIndex + count; destIndex < end; destIndex++)
-							dest[destIndex] = dest[srcIndex++];
-					}
-					else
-					{
-						// case 3
-						var count = count3 + 3;
-						var srcIndex = reverse ? destIndex - ctx.ReadWord() : ctx.ReadWord();
-						if (srcIndex >= destIndex)
-							throw new NotImplementedException("srcIndex >= destIndex {0} {1}".F(srcIndex, destIndex));
-
-						for (var end = destIndex + count; destIndex < end; destIndex++)
-							dest[destIndex] = dest[srcIndex++];
-					}
-				}
-			}
-		}
-
-		static int CountSame(byte[] src, int offset, int maxCount)
-		{
-			maxCount = Math.Min(src.Length - offset, maxCount);
-			if (maxCount <= 0)
-				return 0;
-
-			var first = src[offset++];
-			var count = 1;
-
-			while (count < maxCount && src[offset++] == first)
-				count++;
-
-			return count;
-		}
-
-		static void WriteCopyBlocks(byte[] src, int offset, int count, MemoryStream output)
-		{
-			while (count > 0)
-			{
-				var writeNow = Math.Min(count, 0x3F);
-				output.WriteByte((byte)(0x80 | writeNow));
-				output.Write(src, offset, writeNow);
-
-				count -= writeNow;
-				offset += writeNow;
-			}
-		}
-
-		// Quick and dirty Format80 encoder version 2
-		// Uses raw copy and RLE compression
-		public static byte[] Encode(byte[] src)
-		{
-			using (var ms = new MemoryStream())
-			{
-				var offset = 0;
-				var left = src.Length;
-				var blockStart = 0;
-
-				while (offset < left)
-				{
-					var repeatCount = CountSame(src, offset, 0xFFFF);
-					if (repeatCount >= 4)
-					{
-						// Write what we haven't written up to now
-						WriteCopyBlocks(src, blockStart, offset - blockStart, ms);
-
-						// Command 4: Repeat byte n times
-						ms.WriteByte(0xFE);
-
-						// Low byte
-						ms.WriteByte((byte)(repeatCount & 0xFF));
-
-						// High byte
-						ms.WriteByte((byte)(repeatCount >> 8));
-
-						// Value to repeat
-						ms.WriteByte(src[offset]);
-
-						offset += repeatCount;
-						blockStart = offset;
-					}
-					else
-						offset++;
-				}
-
-				// Write what we haven't written up to now
-				WriteCopyBlocks(src, blockStart, offset - blockStart, ms);
-
-				// Write terminator
-				ms.WriteByte(0x80);
-
-				return ms.ToArray();
-			}
-		}
-	}
-}

OpenRA.Game/FileFormats/HvaReader.cs

@@ -1,55 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-
-#endregion
-
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	public class HvaReader
-	{
-		public readonly uint FrameCount;
-		public readonly uint LimbCount;
-		public readonly float[] Transforms;
-
-		public HvaReader(Stream s)
-		{
-			// Index swaps for transposing a matrix
-			var ids = new byte[] { 0, 4, 8, 12, 1, 5, 9, 13, 2, 6, 10, 14 };
-
-			s.Seek(16, SeekOrigin.Begin);
-			FrameCount = s.ReadUInt32();
-			LimbCount = s.ReadUInt32();
-
-			// Skip limb names
-			s.Seek(16 * LimbCount, SeekOrigin.Current);
-			Transforms = new float[16 * FrameCount * LimbCount];
-			for (var j = 0; j < FrameCount; j++)
-				for (var i = 0; i < LimbCount; i++)
-				{
-					// Convert to column-major matrices and add the final matrix row
-					var c = 16 * (LimbCount * j + i);
-					Transforms[c + 3] = 0;
-					Transforms[c + 7] = 0;
-					Transforms[c + 11] = 0;
-					Transforms[c + 15] = 1;
-
-					for (var k = 0; k < 12; k++)
-						Transforms[c + ids[k]] = s.ReadFloat();
-				}
-		}
-
-		public static HvaReader Load(string filename)
-		{
-			using (var s = File.OpenRead(filename))
-				return new HvaReader(s);
-		}
-	}
-}

OpenRA.Game/FileFormats/IdxReader.cs

@@ -1,44 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using System.IO;
-using OpenRA.FileSystem;
-
-namespace OpenRA.FileFormats
-{
-	public class IdxReader
-	{
-		public readonly int SoundCount;
-		public List<IdxEntry> Entries;
-
-		public IdxReader(Stream s)
-		{
-			s.Seek(0, SeekOrigin.Begin);
-
-			var id = s.ReadASCII(4);
-
-			if (id != "GABA")
-				throw new InvalidDataException("Unable to load Idx file, did not find magic id, found {0} instead".F(id));
-
-			var two = s.ReadInt32();
-
-			if (two != 2)
-				throw new InvalidDataException("Unable to load Idx file, did not find magic number 2, found {0} instead".F(two));
-
-			SoundCount = s.ReadInt32();
-
-			Entries = new List<IdxEntry>();
-
-			for (var i = 0; i < SoundCount; i++)
-				Entries.Add(new IdxEntry(s));
-		}
-	}
-}

OpenRA.Game/FileFormats/ImaAdpcmLoader.cs

@@ -1,99 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	struct ImaAdpcmChunk
-	{
-		public int CompressedSize;
-		public int OutputSize;
-
-		public static ImaAdpcmChunk Read(Stream s)
-		{
-			ImaAdpcmChunk c;
-			c.CompressedSize = s.ReadUInt16();
-			c.OutputSize = s.ReadUInt16();
-			if (s.ReadUInt32() != 0xdeaf)
-				throw new InvalidDataException("Chunk header is bogus");
-			return c;
-		}
-	}
-
-	public static class ImaAdpcmLoader
-	{
-		static readonly int[] IndexAdjust = { -1, -1, -1, -1, 2, 4, 6, 8 };
-		static readonly int[] StepTable =
-		{
-			7, 8, 9, 10, 11, 12, 13, 14, 16,
-			17, 19, 21, 23, 25, 28, 31, 34, 37,
-			41, 45, 50, 55, 60, 66, 73, 80, 88,
-			97, 107, 118, 130, 143, 157, 173, 190, 209,
-			230, 253, 279, 307, 337, 371, 408, 449, 494,
-			544, 598, 658, 724, 796, 876, 963, 1060, 1166,
-			1282, 1411, 1552, 1707, 1878, 2066, 2272, 2499, 2749,
-			3024, 3327, 3660, 4026, 4428, 4871, 5358, 5894, 6484,
-			7132, 7845, 8630, 9493, 10442, 11487, 12635, 13899, 15289,
-			16818, 18500, 20350, 22385, 24623, 27086, 29794, 32767
-		};
-
-		static short DecodeImaAdpcmSample(byte b, ref int index, ref int current)
-		{
-			var sb = (b & 8) != 0;
-			b &= 7;
-
-			var delta = (StepTable[index] * b) / 4 + StepTable[index] / 8;
-			if (sb) delta = -delta;
-
-			current += delta;
-			if (current > short.MaxValue) current = short.MaxValue;
-			if (current < short.MinValue) current = short.MinValue;
-
-			index += IndexAdjust[b];
-			if (index < 0) index = 0;
-			if (index > 88) index = 88;
-
-			return (short)current;
-		}
-
-		public static byte[] LoadImaAdpcmSound(byte[] raw, ref int index)
-		{
-			var currentSample = 0;
-			return LoadImaAdpcmSound(raw, ref index, ref currentSample);
-		}
-
-		public static byte[] LoadImaAdpcmSound(byte[] raw, ref int index, ref int currentSample)
-		{
-			var s = new MemoryStream(raw);
-			var dataSize = raw.Length;
-			var outputSize = raw.Length * 4;
-
-			var output = new byte[outputSize];
-			var offset = 0;
-
-			while (dataSize-- > 0)
-			{
-				var b = s.ReadUInt8();
-
-				var t = DecodeImaAdpcmSample(b, ref index, ref currentSample);
-				output[offset++] = (byte)t;
-				output[offset++] = (byte)(t >> 8);
-
-				t = DecodeImaAdpcmSample((byte)(b >> 4), ref index, ref currentSample);
-				output[offset++] = (byte)t;
-				output[offset++] = (byte)(t >> 8);
-			}
-
-			return output;
-		}
-	}
-}

OpenRA.Game/FileFormats/Png.cs

@@ -0,0 +1,379 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Net;
+using System.Text;
+using ICSharpCode.SharpZipLib.Checksum;
+using ICSharpCode.SharpZipLib.Zip.Compression.Streams;
+using OpenRA.Graphics;
+using OpenRA.Primitives;
+
+namespace OpenRA.FileFormats
+{
+	public class Png
+	{
+		static readonly byte[] Signature = { 0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a };
+
+		public int Width { get; }
+		public int Height { get; }
+		public Color[] Palette { get; }
+		public byte[] Data { get; }
+		public SpriteFrameType Type { get; }
+		public Dictionary<string, string> EmbeddedData = new Dictionary<string, string>();
+
+		public int PixelStride => Type == SpriteFrameType.Indexed8 ? 1 : Type == SpriteFrameType.Rgb24 ? 3 : 4;
+
+		public Png(Stream s)
+		{
+			if (!Verify(s))
+				throw new InvalidDataException("PNG Signature is bogus");
+
+			s.Position += 8;
+			var headerParsed = false;
+			var data = new List<byte>();
+			Type = SpriteFrameType.Rgba32;
+
+			while (true)
+			{
+				var length = IPAddress.NetworkToHostOrder(s.ReadInt32());
+				var type = Encoding.UTF8.GetString(s.ReadBytes(4));
+				var content = s.ReadBytes(length);
+				/*var crc = */s.ReadInt32();
+
+				if (!headerParsed && type != "IHDR")
+					throw new InvalidDataException("Invalid PNG file - header does not appear first.");
+
+				using (var ms = new MemoryStream(content))
+				{
+					switch (type)
+					{
+						case "IHDR":
+						{
+							if (headerParsed)
+								throw new InvalidDataException("Invalid PNG file - duplicate header.");
+							Width = IPAddress.NetworkToHostOrder(ms.ReadInt32());
+							Height = IPAddress.NetworkToHostOrder(ms.ReadInt32());
+
+							var bitDepth = ms.ReadUInt8();
+							var colorType = (PngColorType)ms.ReadByte();
+							if (IsPaletted(bitDepth, colorType))
+								Type = SpriteFrameType.Indexed8;
+							else if (colorType == PngColorType.Color)
+								Type = SpriteFrameType.Rgb24;
+
+							Data = new byte[Width * Height * PixelStride];
+
+							var compression = ms.ReadByte();
+							/*var filter = */ms.ReadByte();
+							var interlace = ms.ReadByte();
+
+							if (compression != 0)
+								throw new InvalidDataException("Compression method not supported");
+
+							if (interlace != 0)
+								throw new InvalidDataException("Interlacing not supported");
+
+							headerParsed = true;
+
+							break;
+						}
+
+						case "PLTE":
+						{
+							Palette = new Color[256];
+							for (var i = 0; i < length / 3; i++)
+							{
+								var r = ms.ReadByte(); var g = ms.ReadByte(); var b = ms.ReadByte();
+								Palette[i] = Color.FromArgb(r, g, b);
+							}
+
+							break;
+						}
+
+						case "tRNS":
+						{
+							if (Palette == null)
+								throw new InvalidDataException("Non-Palette indexed PNG are not supported.");
+
+							for (var i = 0; i < length; i++)
+								Palette[i] = Color.FromArgb(ms.ReadByte(), Palette[i]);
+
+							break;
+						}
+
+						case "IDAT":
+						{
+							data.AddRange(content);
+
+							break;
+						}
+
+						case "tEXt":
+						{
+							var key = ms.ReadASCIIZ();
+							EmbeddedData.Add(key, ms.ReadASCII(length - key.Length - 1));
+
+							break;
+						}
+
+						case "IEND":
+						{
+							using (var ns = new MemoryStream(data.ToArray()))
+							{
+								using (var ds = new InflaterInputStream(ns))
+								{
+									var pxStride = PixelStride;
+									var rowStride = Width * pxStride;
+
+									var prevLine = new byte[rowStride];
+									for (var y = 0; y < Height; y++)
+									{
+										var filter = (PngFilter)ds.ReadByte();
+										var line = ds.ReadBytes(rowStride);
+
+										for (var i = 0; i < rowStride; i++)
+											line[i] = i < pxStride
+												? UnapplyFilter(filter, line[i], 0, prevLine[i], 0)
+												: UnapplyFilter(filter, line[i], line[i - pxStride], prevLine[i], prevLine[i - pxStride]);
+
+										Array.Copy(line, 0, Data, y * rowStride, rowStride);
+
+										prevLine = line;
+									}
+								}
+							}
+
+							if (Type == SpriteFrameType.Indexed8 && Palette == null)
+								throw new InvalidDataException("Non-Palette indexed PNG are not supported.");
+
+							return;
+						}
+					}
+				}
+			}
+		}
+
+		public Png(byte[] data, SpriteFrameType type, int width, int height, Color[] palette = null,
+			Dictionary<string, string> embeddedData = null)
+		{
+			var expectLength = width * height;
+			if (palette == null)
+				expectLength *= 4;
+
+			if (data.Length != expectLength)
+				throw new InvalidDataException("Input data does not match expected length");
+
+			Type = type;
+			Width = width;
+			Height = height;
+
+			switch (type)
+			{
+				case SpriteFrameType.Indexed8:
+				case SpriteFrameType.Rgba32:
+				case SpriteFrameType.Rgb24:
+				{
+					// Data is already in a compatible format
+					Data = data;
+					if (type == SpriteFrameType.Indexed8)
+						Palette = palette;
+
+					break;
+				}
+
+				case SpriteFrameType.Bgra32:
+				case SpriteFrameType.Bgr24:
+				{
+					// Convert to big endian
+					Data = new byte[data.Length];
+					var stride = PixelStride;
+					for (var i = 0; i < width * height; i++)
+					{
+						Data[stride * i] = data[stride * i + 2];
+						Data[stride * i + 1] = data[stride * i + 1];
+						Data[stride * i + 2] = data[stride * i + 0];
+
+						if (type == SpriteFrameType.Bgra32)
+							Data[stride * i + 3] = data[stride * i + 3];
+					}
+
+					break;
+				}
+
+				default:
+					throw new InvalidDataException($"Unhandled SpriteFrameType {type}");
+			}
+
+			if (embeddedData != null)
+				EmbeddedData = embeddedData;
+		}
+
+		public static bool Verify(Stream s)
+		{
+			var pos = s.Position;
+			var isPng = Signature.Aggregate(true, (current, t) => current && s.ReadUInt8() == t);
+			s.Position = pos;
+			return isPng;
+		}
+
+		static byte UnapplyFilter(PngFilter f, byte x, byte a, byte b, byte c)
+		{
+			switch (f)
+			{
+				case PngFilter.None: return x;
+				case PngFilter.Sub: return (byte)(x + a);
+				case PngFilter.Up: return (byte)(x + b);
+				case PngFilter.Average: return (byte)(x + (a + b) / 2);
+				case PngFilter.Paeth: return (byte)(x + Paeth(a, b, c));
+				default:
+					throw new InvalidOperationException("Unsupported Filter");
+			}
+		}
+
+		static byte Paeth(byte a, byte b, byte c)
+		{
+			var p = a + b - c;
+			var pa = Math.Abs(p - a);
+			var pb = Math.Abs(p - b);
+			var pc = Math.Abs(p - c);
+
+			return (pa <= pb && pa <= pc) ? a :
+				(pb <= pc) ? b : c;
+		}
+
+		[Flags]
+		enum PngColorType { Indexed = 1, Color = 2, Alpha = 4 }
+		enum PngFilter { None, Sub, Up, Average, Paeth }
+
+		static bool IsPaletted(byte bitDepth, PngColorType colorType)
+		{
+			if (bitDepth == 8 && colorType == (PngColorType.Indexed | PngColorType.Color))
+				return true;
+
+			if (bitDepth == 8 && colorType == (PngColorType.Color | PngColorType.Alpha))
+				return false;
+
+			if (bitDepth == 8 && colorType == PngColorType.Color)
+				return false;
+
+			throw new InvalidDataException("Unknown pixel format");
+		}
+
+		void WritePngChunk(Stream output, string type, Stream input)
+		{
+			input.Position = 0;
+
+			var typeBytes = Encoding.ASCII.GetBytes(type);
+			output.Write(IPAddress.HostToNetworkOrder((int)input.Length));
+			output.WriteArray(typeBytes);
+
+			var data = input.ReadAllBytes();
+			output.WriteArray(data);
+
+			var crc32 = new Crc32();
+			crc32.Update(typeBytes);
+			crc32.Update(data);
+			output.Write(IPAddress.NetworkToHostOrder((int)crc32.Value));
+		}
+
+		public byte[] Save()
+		{
+			using (var output = new MemoryStream())
+			{
+				output.WriteArray(Signature);
+				using (var header = new MemoryStream())
+				{
+					header.Write(IPAddress.HostToNetworkOrder(Width));
+					header.Write(IPAddress.HostToNetworkOrder(Height));
+					header.WriteByte(8); // Bit depth
+
+					var colorType = Type == SpriteFrameType.Indexed8 ? PngColorType.Indexed | PngColorType.Color :
+						Type == SpriteFrameType.Rgb24 ? PngColorType.Color : PngColorType.Color | PngColorType.Alpha;
+					header.WriteByte((byte)colorType);
+
+					header.WriteByte(0); // Compression
+					header.WriteByte(0); // Filter
+					header.WriteByte(0); // Interlacing
+
+					WritePngChunk(output, "IHDR", header);
+				}
+
+				var alphaPalette = false;
+				if (Palette != null)
+				{
+					using (var palette = new MemoryStream())
+					{
+						foreach (var c in Palette)
+						{
+							palette.WriteByte(c.R);
+							palette.WriteByte(c.G);
+							palette.WriteByte(c.B);
+							alphaPalette |= c.A > 0;
+						}
+
+						WritePngChunk(output, "PLTE", palette);
+					}
+				}
+
+				if (alphaPalette)
+				{
+					using (var alpha = new MemoryStream())
+					{
+						foreach (var c in Palette)
+							alpha.WriteByte(c.A);
+
+						WritePngChunk(output, "tRNS", alpha);
+					}
+				}
+
+				using (var data = new MemoryStream())
+				{
+					using (var compressed = new DeflaterOutputStream(data))
+					{
+						var rowStride = Width * PixelStride;
+						for (var y = 0; y < Height; y++)
+						{
+							// Write uncompressed scanlines for simplicity
+							compressed.WriteByte(0);
+							compressed.Write(Data, y * rowStride, rowStride);
+						}
+
+						compressed.Flush();
+						compressed.Finish();
+
+						WritePngChunk(output, "IDAT", data);
+					}
+				}
+
+				foreach (var kv in EmbeddedData)
+				{
+					using (var text = new MemoryStream())
+					{
+						text.WriteArray(Encoding.ASCII.GetBytes(kv.Key + (char)0 + kv.Value));
+						WritePngChunk(output, "tEXt", text);
+					}
+				}
+
+				WritePngChunk(output, "IEND", new MemoryStream());
+				return output.ToArray();
+			}
+		}
+
+		public void Save(string path)
+		{
+			File.WriteAllBytes(path, Save());
+		}
+	}
+}

OpenRA.Game/FileFormats/PngLoader.cs

@@ -1,193 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.Drawing;
-using System.Drawing.Imaging;
-using System.IO;
-using System.IO.Compression;
-using System.Net;
-using System.Runtime.InteropServices;
-using System.Text;
-
-namespace OpenRA.FileFormats
-{
-	public static class PngLoader
-	{
-		public static Bitmap Load(string filename)
-		{
-			using (var s = File.OpenRead(filename))
-				return Load(s);
-		}
-
-		public static Bitmap Load(Stream s)
-		{
-			using (var br = new BinaryReader(s))
-			{
-				var signature = new byte[] { 137, 80, 78, 71, 13, 10, 26, 10 };
-				foreach (var b in signature)
-					if (br.ReadByte() != b)
-						throw new InvalidDataException("PNG Signature is bogus");
-
-				Bitmap bitmap = null;
-				Color[] palette = null;
-				var data = new List<byte>();
-
-				for (;;)
-				{
-					var length = IPAddress.NetworkToHostOrder(br.ReadInt32());
-					var type = Encoding.UTF8.GetString(br.ReadBytes(4));
-					var content = br.ReadBytes(length);
-					/*var crc = */br.ReadInt32();
-
-					using (var ms = new MemoryStream(content))
-					using (var cr = new BinaryReader(ms))
-						switch (type)
-						{
-							case "IHDR":
-								{
-									var width = IPAddress.NetworkToHostOrder(cr.ReadInt32());
-									var height = IPAddress.NetworkToHostOrder(cr.ReadInt32());
-									var bitDepth = cr.ReadByte();
-									var colorType = (PngColorType)cr.ReadByte();
-									var compression = cr.ReadByte();
-									/*var filter = */cr.ReadByte();
-									var interlace = cr.ReadByte();
-
-									if (compression != 0) throw new InvalidDataException("Compression method not supported");
-									if (interlace != 0) throw new InvalidDataException("Interlacing not supported");
-
-									bitmap = new Bitmap(width, height, MakePixelFormat(bitDepth, colorType));
-								}
-
-								break;
-
-							case "PLTE":
-								{
-									palette = new Color[256];
-									for (var i = 0; i < 256; i++)
-									{
-										var r = cr.ReadByte(); var g = cr.ReadByte(); var b = cr.ReadByte();
-										palette[i] = Color.FromArgb(r, g, b);
-									}
-								}
-
-								break;
-
-							case "tRNS":
-								{
-									if (palette == null)
-										throw new InvalidDataException("Non-Palette indexed PNG are not supported.");
-
-									for (var i = 0; i < length; i++)
-										palette[i] = Color.FromArgb(cr.ReadByte(), palette[i]);
-								}
-
-								break;
-
-							case "IDAT":
-								{
-									data.AddRange(content);
-								}
-
-								break;
-
-							case "IEND":
-								{
-									if (bitmap == null)
-										throw new InvalidDataException("Image header not found.");
-
-									var bits = bitmap.LockBits(bitmap.Bounds(),
-										ImageLockMode.WriteOnly, PixelFormat.Format8bppIndexed);
-
-									using (var ns = new MemoryStream(data.ToArray()))
-									{
-										// 'zlib' flags bytes; confuses the DeflateStream.
-										/*var flags = (byte)*/ns.ReadByte();
-										/*var moreFlags = (byte)*/ns.ReadByte();
-
-										using (var ds = new DeflateStream(ns, CompressionMode.Decompress))
-										using (var dr = new BinaryReader(ds))
-										{
-											var prevLine = new byte[bitmap.Width];	// all zero
-											for (var y = 0; y < bitmap.Height; y++)
-											{
-												var filter = (PngFilter)dr.ReadByte();
-												var line = dr.ReadBytes(bitmap.Width);
-
-												for (var i = 0; i < bitmap.Width; i++)
-													line[i] = i > 0
-														? UnapplyFilter(filter, line[i], line[i - 1], prevLine[i], prevLine[i - 1])
-														: UnapplyFilter(filter, line[i], 0, prevLine[i], 0);
-
-												Marshal.Copy(line, 0, new IntPtr(bits.Scan0.ToInt64() + y * bits.Stride), line.Length);
-												prevLine = line;
-											}
-										}
-									}
-
-									bitmap.UnlockBits(bits);
-
-									if (palette == null)
-										throw new InvalidDataException("Non-Palette indexed PNG are not supported.");
-
-									using (var temp = new Bitmap(1, 1, PixelFormat.Format8bppIndexed))
-									{
-										var cp = temp.Palette;
-										for (var i = 0; i < 256; i++)
-											cp.Entries[i] = palette[i];		// finalize the palette.
-										bitmap.Palette = cp;
-										return bitmap;
-									}
-								}
-						}
-				}
-			}
-		}
-
-		static byte UnapplyFilter(PngFilter f, byte x, byte a, byte b, byte c)
-		{
-			switch (f)
-			{
-				case PngFilter.None: return x;
-				case PngFilter.Sub: return (byte)(x + a);
-				case PngFilter.Up: return (byte)(x + b);
-				case PngFilter.Average: return (byte)(x + (a + b) / 2);
-				case PngFilter.Paeth: return (byte)(x + Paeth(a, b, c));
-				default:
-					throw new InvalidOperationException("Unsupported Filter");
-			}
-		}
-
-		static byte Paeth(byte a, byte b, byte c)
-		{
-			var p = a + b - c;
-			var pa = Math.Abs(p - a);
-			var pb = Math.Abs(p - b);
-			var pc = Math.Abs(p - c);
-
-			return (pa <= pb && pa <= pc) ? a :
-				(pb <= pc) ? b : c;
-		}
-
-		[Flags]
-		enum PngColorType { Indexed = 1, Color = 2, Alpha = 4 }
-		enum PngFilter { None, Sub, Up, Average, Paeth }
-
-		static PixelFormat MakePixelFormat(byte bitDepth, PngColorType colorType)
-		{
-			if (bitDepth == 8 && colorType == (PngColorType.Indexed | PngColorType.Color))
-				return PixelFormat.Format8bppIndexed;
-
-			throw new InvalidDataException("Unknown pixelformat");
-		}
-	}
-}

OpenRA.Game/FileFormats/ReplayMetadata.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -27,7 +28,7 @@ namespace OpenRA.FileFormats
 		public ReplayMetadata(GameInformation info)
 		{
 			if (info == null)
-				throw new ArgumentNullException("info");
+				throw new ArgumentNullException(nameof(info));
 
 			GameInfo = info;
 		}
@@ -43,7 +44,7 @@ namespace OpenRA.FileFormats
 			// Read version
 			var version = fs.ReadInt32();
 			if (version != MetaVersion)
-				throw new NotSupportedException("Metadata version {0} is not supported".F(version));
+				throw new NotSupportedException($"Metadata version {version} is not supported");
 
 			// Read game info (max 100K limit as a safeguard against corrupted files)
 			var data = fs.ReadString(Encoding.UTF8, 1024 * 100);
@@ -78,41 +79,27 @@ namespace OpenRA.FileFormats
 
 		public static ReplayMetadata Read(string path)
 		{
-			using (var fs = new FileStream(path, FileMode.Open))
-				return Read(fs, path);
-		}
-
-		static ReplayMetadata Read(FileStream fs, string path)
-		{
-			if (!fs.CanSeek)
-				return null;
-
-			if (fs.Length < 20)
-				return null;
-
 			try
 			{
-				fs.Seek(-(4 + 4), SeekOrigin.End);
-				var dataLength = fs.ReadInt32();
-				if (fs.ReadInt32() == MetaEndMarker)
+				using (var fs = new FileStream(path, FileMode.Open))
 				{
-					// go back by (end marker + length storage + data + version + start marker) bytes
-					fs.Seek(-(4 + 4 + dataLength + 4 + 4), SeekOrigin.Current);
-					try
+					if (!fs.CanSeek)
+						return null;
+
+					if (fs.Length < 20)
+						return null;
+
+					fs.Seek(-(4 + 4), SeekOrigin.End);
+					var dataLength = fs.ReadInt32();
+					if (fs.ReadInt32() == MetaEndMarker)
 					{
+						// Go back by (end marker + length storage + data + version + start marker) bytes
+						fs.Seek(-(4 + 4 + dataLength + 4 + 4), SeekOrigin.Current);
 						return new ReplayMetadata(fs, path);
 					}
-					catch (InvalidOperationException ex)
-					{
-						Log.Write("debug", ex.ToString());
-					}
-					catch (NotSupportedException ex)
-					{
-						Log.Write("debug", ex.ToString());
-					}
 				}
 			}
-			catch (IOException ex)
+			catch (Exception ex)
 			{
 				Log.Write("debug", ex.ToString());
 			}

OpenRA.Game/FileFormats/VqaReader.cs

@@ -1,532 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	public class VqaReader
-	{
-		public readonly ushort Frames;
-		public readonly byte Framerate;
-		public readonly ushort Width;
-		public readonly ushort Height;
-
-		Stream stream;
-		int currentFrame;
-		ushort numColors;
-		ushort blockWidth;
-		ushort blockHeight;
-		byte chunkBufferParts;
-		int2 blocks;
-		uint[] offsets;
-		uint[] palette;
-		uint videoFlags; // if 0x10 is set the video is a 16 bit hq video (ts and later)
-		int sampleRate;
-		int sampleBits;
-		int audioChannels;
-
-		// Stores a list of subpixels, referenced by the VPTZ chunk
-		byte[] cbf;
-		byte[] cbp;
-		byte[] cbfBuffer;
-
-		// Buffer for loading file subchunks, the maximum chunk size of a file is not defined
-		// and the header definition for the size of the biggest chunks (color data) isn't accurate.
-		// But 256k is large enough for all TS videos(< 200k).
-		byte[] fileBuffer = new byte[256000];
-		int maxCbfzSize = 256000;
-		int vtprSize = 0;
-		int currentChunkBuffer = 0;
-		int chunkBufferOffset = 0;
-
-		// Top half contains block info, bottom half contains references to cbf array
-		byte[] origData;
-
-		// Final frame output
-		uint[,] frameData;
-		byte[] audioData;		// audio for this frame: 22050Hz 16bit mono pcm, uncompressed.
-		bool hasAudio;
-
-		public byte[] AudioData { get { return audioData; } }
-		public int CurrentFrame { get { return currentFrame; } }
-		public int SampleRate { get { return sampleRate; } }
-		public int SampleBits { get { return sampleBits; } }
-		public int AudioChannels { get { return audioChannels; } }
-		public bool HasAudio { get { return hasAudio; } }
-
-		public VqaReader(Stream stream)
-		{
-			this.stream = stream;
-
-			// Decode FORM chunk
-			if (stream.ReadASCII(4) != "FORM")
-				throw new InvalidDataException("Invalid vqa (invalid FORM section)");
-			/*var length = */stream.ReadUInt32();
-
-			if (stream.ReadASCII(8) != "WVQAVQHD")
-				throw new InvalidDataException("Invalid vqa (not WVQAVQHD)");
-			/*var length2 = */stream.ReadUInt32();
-
-			/*var version = */stream.ReadUInt16();
-			videoFlags = stream.ReadUInt16();
-			Frames = stream.ReadUInt16();
-			Width = stream.ReadUInt16();
-			Height = stream.ReadUInt16();
-
-			blockWidth = stream.ReadUInt8();
-			blockHeight = stream.ReadUInt8();
-			Framerate = stream.ReadUInt8();
-			chunkBufferParts = stream.ReadUInt8();
-			blocks = new int2(Width / blockWidth, Height / blockHeight);
-
-			numColors = stream.ReadUInt16();
-			/*var maxBlocks = */stream.ReadUInt16();
-			/*var unknown1 = */stream.ReadUInt16();
-			/*var unknown2 = */stream.ReadUInt32();
-
-			// Audio
-			sampleRate = stream.ReadUInt16();
-			audioChannels = stream.ReadByte();
-			sampleBits = stream.ReadByte();
-
-			/*var unknown3 =*/stream.ReadUInt32();
-			/*var unknown4 =*/stream.ReadUInt16();
-			/*maxCbfzSize =*/stream.ReadUInt32(); // Unreliable
-
-			/*var unknown5 =*/stream.ReadUInt32();
-
-			var frameSize = Exts.NextPowerOf2(Math.Max(Width, Height));
-
-			if (IsHqVqa)
-			{
-				cbfBuffer = new byte[maxCbfzSize];
-				cbf = new byte[maxCbfzSize * 3];
-				origData = new byte[maxCbfzSize];
-			}
-			else
-			{
-				cbfBuffer = new byte[Width * Height];
-				cbf = new byte[Width * Height];
-				cbp = new byte[Width * Height];
-				origData = new byte[2 * blocks.X * blocks.Y];
-			}
-
-			palette = new uint[numColors];
-			frameData = new uint[frameSize, frameSize];
-			var type = stream.ReadASCII(4);
-			while (type != "FINF")
-			{
-				// Sub type is a file tag
-				if (type[3] == 'F')
-				{
-					var jmp = int2.Swap(stream.ReadUInt32());
-					stream.Seek(jmp, SeekOrigin.Current);
-					type = stream.ReadASCII(4);
-				}
-				else
-					throw new NotSupportedException("Vqa uses unknown Subtype: {0}".F(type));
-			}
-
-			/*var length = */stream.ReadUInt16();
-			/*var unknown4 = */stream.ReadUInt16();
-
-			// Frame offsets
-			offsets = new uint[Frames];
-			for (var i = 0; i < Frames; i++)
-			{
-				offsets[i] = stream.ReadUInt32();
-				if (offsets[i] > 0x40000000)
-					offsets[i] -= 0x40000000;
-				offsets[i] <<= 1;
-			}
-
-			CollectAudioData();
-
-			Reset();
-		}
-
-		public void Reset()
-		{
-			currentFrame = chunkBufferOffset = currentChunkBuffer = 0;
-			LoadFrame();
-		}
-
-		void CollectAudioData()
-		{
-			var audio1 = new MemoryStream(); // left channel / mono
-			var audio2 = new MemoryStream(); // right channel
-			var adpcmIndex = 0;
-			var compressed = false;
-			for (var i = 0; i < Frames; i++)
-			{
-				stream.Seek(offsets[i], SeekOrigin.Begin);
-				var end = (i < Frames - 1) ? offsets[i + 1] : stream.Length;
-
-				while (stream.Position < end)
-				{
-					var type = stream.ReadASCII(4);
-					if (type == "SN2J")
-					{
-						var jmp = int2.Swap(stream.ReadUInt32());
-						stream.Seek(jmp, SeekOrigin.Current);
-						type = stream.ReadASCII(4);
-					}
-
-					var length = int2.Swap(stream.ReadUInt32());
-
-					switch (type)
-					{
-						case "SND0":
-						case "SND2":
-							if (audioChannels == 0)
-								throw new NotSupportedException();
-							else if (audioChannels == 1)
-							{
-								var rawAudio = stream.ReadBytes((int)length);
-								audio1.Write(rawAudio);
-							}
-							else
-							{
-								var rawAudio = stream.ReadBytes((int)length / 2);
-								audio1.Write(rawAudio);
-								rawAudio = stream.ReadBytes((int)length / 2);
-								audio2.Write(rawAudio);
-								if (length % 2 != 0)
-									stream.ReadBytes(2);
-							}
-
-							compressed = type == "SND2";
-							break;
-						default:
-							if (length + stream.Position > stream.Length)
-								throw new NotSupportedException("Vqa uses unknown Subtype: {0}".F(type));
-							stream.ReadBytes((int)length);
-							break;
-					}
-
-					// Chunks are aligned on even bytes; advance by a byte if the next one is null
-					if (stream.Peek() == 0) stream.ReadByte();
-				}
-			}
-
-			if (audioChannels == 1)
-				audioData = compressed ? AudLoader.LoadSound(audio1.ToArray(), ref adpcmIndex) : audio1.ToArray();
-			else
-			{
-				byte[] leftData, rightData;
-				if (!compressed)
-				{
-					leftData = audio1.ToArray();
-					rightData = audio2.ToArray();
-				}
-				else
-				{
-					adpcmIndex = 0;
-					leftData = AudLoader.LoadSound(audio1.ToArray(), ref adpcmIndex);
-					adpcmIndex = 0;
-					rightData = AudLoader.LoadSound(audio2.ToArray(), ref adpcmIndex);
-				}
-
-				audioData = new byte[rightData.Length + leftData.Length];
-				var rightIndex = 0;
-				var leftIndex = 0;
-				for (var i = 0; i < audioData.Length;)
-				{
-					audioData[i++] = leftData[leftIndex++];
-					audioData[i++] = leftData[leftIndex++];
-					audioData[i++] = rightData[rightIndex++];
-					audioData[i++] = rightData[rightIndex++];
-				}
-			}
-
-			hasAudio = audioData.Length > 0;
-		}
-
-		public void AdvanceFrame()
-		{
-			currentFrame++;
-			LoadFrame();
-		}
-
-		void LoadFrame()
-		{
-			if (currentFrame >= Frames)
-				return;
-
-			// Seek to the start of the frame
-			stream.Seek(offsets[currentFrame], SeekOrigin.Begin);
-			var end = (currentFrame < Frames - 1) ? offsets[currentFrame + 1] : stream.Length;
-
-			while (stream.Position < end)
-			{
-				var type = stream.ReadASCII(4);
-				var length = 0U;
-				if (type == "SN2J")
-				{
-					var jmp = int2.Swap(stream.ReadUInt32());
-					stream.Seek(jmp, SeekOrigin.Current);
-					type = stream.ReadASCII(4);
-					if (type == "SND2")
-					{
-						length = int2.Swap(stream.ReadUInt32());
-						stream.Seek(length, SeekOrigin.Current);
-						type = stream.ReadASCII(4);
-					}
-					else
-						throw new NotSupportedException();
-				}
-
-				length = int2.Swap(stream.ReadUInt32());
-
-				switch (type)
-				{
-					case "VQFR":
-						DecodeVQFR(stream);
-						break;
-					case "\0VQF":
-						stream.ReadByte();
-						DecodeVQFR(stream);
-						break;
-					case "VQFL":
-						DecodeVQFR(stream, "VQFL");
-						break;
-					default:
-						// Don't parse sound here.
-						stream.ReadBytes((int)length);
-						break;
-				}
-
-				// Chunks are aligned on even bytes; advance by a byte if the next one is null
-				if (stream.Peek() == 0) stream.ReadByte();
-			}
-		}
-
-		// VQA Frame
-		public void DecodeVQFR(Stream s, string parentType = "VQFR")
-		{
-			while (true)
-			{
-				// Chunks are aligned on even bytes; may be padded with a single null
-				if (s.Peek() == 0) s.ReadByte();
-				var type = s.ReadASCII(4);
-				var subchunkLength = (int)int2.Swap(s.ReadUInt32());
-
-				switch (type)
-				{
-					// Full frame-modifier
-					case "CBFZ":
-						var decodeMode = s.Peek() == 0;
-						s.ReadBytes(fileBuffer, 0, subchunkLength);
-						Array.Clear(cbf, 0, cbf.Length);
-						Array.Clear(cbfBuffer, 0, cbfBuffer.Length);
-						var decodeCount = 0;
-						decodeCount = Format80.DecodeInto(fileBuffer, cbfBuffer, decodeMode ? 1 : 0, decodeMode);
-						if ((videoFlags & 0x10) == 16)
-						{
-							var p = 0;
-							for (var i = 0; i < decodeCount; i += 2)
-							{
-								var packed = cbfBuffer[i + 1] << 8 | cbfBuffer[i];
-								/* 15      bit      0
-								   0rrrrrgg gggbbbbb
-								   HI byte  LO byte*/
-								cbf[p++] = (byte)((packed & 0x7C00) >> 7);
-								cbf[p++] = (byte)((packed & 0x3E0) >> 2);
-								cbf[p++] = (byte)((packed & 0x1f) << 3);
-							}
-						}
-						else
-						{
-							cbf = cbfBuffer;
-						}
-
-						if (parentType == "VQFL")
-							return;
-						break;
-					case "CBF0":
-						cbf = s.ReadBytes(subchunkLength);
-						break;
-
-					// frame-modifier chunk
-					case "CBP0":
-					case "CBPZ":
-						// Partial buffer is full; dump and recreate
-						if (currentChunkBuffer == chunkBufferParts)
-						{
-							if (type == "CBP0")
-								cbf = (byte[])cbp.Clone();
-							else
-								Format80.DecodeInto(cbp, cbf);
-
-							chunkBufferOffset = currentChunkBuffer = 0;
-						}
-
-						var bytes = s.ReadBytes(subchunkLength);
-						bytes.CopyTo(cbp, chunkBufferOffset);
-						chunkBufferOffset += subchunkLength;
-						currentChunkBuffer++;
-						break;
-
-					// Palette
-					case "CPL0":
-						for (var i = 0; i < numColors; i++)
-						{
-							var r = (byte)(s.ReadUInt8() << 2);
-							var g = (byte)(s.ReadUInt8() << 2);
-							var b = (byte)(s.ReadUInt8() << 2);
-							palette[i] = (uint)((255 << 24) | (r << 16) | (g << 8) | b);
-						}
-
-						break;
-
-					// Frame data
-					case "VPTZ":
-						Format80.DecodeInto(s.ReadBytes(subchunkLength), origData);
-
-						// This is the last subchunk
-						return;
-					case "VPRZ":
-						Array.Clear(origData, 0, origData.Length);
-						s.ReadBytes(fileBuffer, 0, subchunkLength);
-						if (fileBuffer[0] != 0)
-							vtprSize = Format80.DecodeInto(fileBuffer, origData);
-						else
-							Format80.DecodeInto(fileBuffer, origData, 1, true);
-						return;
-					case "VPTR":
-						Array.Clear(origData, 0, origData.Length);
-						s.ReadBytes(origData, 0, subchunkLength);
-						vtprSize = subchunkLength;
-						return;
-					default:
-						throw new InvalidDataException("Unknown sub-chunk {0}".F(type));
-				}
-			}
-		}
-
-		int cachedFrame = -1;
-
-		void DecodeFrameData()
-		{
-			cachedFrame = currentFrame;
-			if (IsHqVqa)
-			{
-				/* The VP?? chunks of the video file contains an array of instructions for
-				 * how the blocks of the finished frame will be filled with color data blocks
-				 * contained in the CBF? chunks.
-				 */
-				var p = 0;
-				for (var y = 0; y < blocks.Y;)
-				{
-					for (var x = 0; x < blocks.X;)
-					{
-						if (y >= blocks.Y)
-							break;
-
-						// The first 3 bits of the short determine the type of instruction with the rest being one or two parameters.
-						var val = (int)origData[p++];
-						val |= origData[p++] << 8;
-						var para_A = val & 0x1fff;
-						var para_B1 = val & 0xFF;
-						var para_B2 = (((val / 256) & 0x1f) + 1) * 2;
-						switch (val >> 13)
-						{
-							case 0:
-								x += para_A;
-								break;
-							case 1:
-								WriteBlock(para_B1, para_B2, ref x, ref y);
-								break;
-							case 2:
-								WriteBlock(para_B1, 1, ref x, ref y);
-								for (var i = 0; i < para_B2; i++)
-									WriteBlock(origData[p++], 1, ref x, ref y);
-								break;
-							case 3:
-								WriteBlock(para_A, 1, ref x, ref y);
-								break;
-							case 5:
-								WriteBlock(para_A, origData[p++], ref x, ref y);
-								break;
-							default:
-								throw new NotSupportedException();
-						}
-					}
-
-					y++;
-				}
-
-				if (p != vtprSize)
-					throw new IndexOutOfRangeException();
-			}
-			else
-			{
-				for (var y = 0; y < blocks.Y; y++)
-				{
-					for (var x = 0; x < blocks.X; x++)
-					{
-						var px = origData[x + y * blocks.X];
-						var mod = origData[x + (y + blocks.Y) * blocks.X];
-						for (var j = 0; j < blockHeight; j++)
-						{
-							for (var i = 0; i < blockWidth; i++)
-							{
-								var cbfi = (mod * 256 + px) * 8 + j * blockWidth + i;
-								var color = (mod == 0x0f) ? px : cbf[cbfi];
-								frameData[y * blockHeight + j, x * blockWidth + i] = palette[color];
-							}
-						}
-					}
-				}
-			}
-		}
-
-		public uint[,] FrameData
-		{
-			get
-			{
-				if (cachedFrame != currentFrame)
-					DecodeFrameData();
-
-				return frameData;
-			}
-		}
-
-		bool IsHqVqa { get { return (videoFlags & 0x10) == 16; } }
-
-		void WriteBlock(int blockNumber, int count, ref int x, ref int y)
-		{
-			for (var i = 0; i < count; i++)
-			{
-				var frameX = x * blockWidth;
-				var frameY = y * blockHeight;
-				var offset = blockNumber * blockHeight * blockWidth * 3;
-				for (var by = 0; by < blockHeight; by++)
-					for (var bx = 0; bx < blockWidth; bx++)
-					{
-						var p = (bx + by * blockWidth) * 3;
-
-						frameData[frameY + by, frameX + bx] = (uint)(0xFF << 24 | cbf[offset + p] << 16 | cbf[offset + p + 1] << 8 | cbf[offset + p + 2]);
-					}
-
-				x++;
-				if (x >= blocks.X)
-				{
-					x = 0;
-					y++;
-					if (y >= blocks.Y && i != count - 1)
-						throw new IndexOutOfRangeException();
-				}
-			}
-		}
-	}
-}

OpenRA.Game/FileFormats/WavLoader.cs

@@ -1,180 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	public class WavLoader
-	{
-		public readonly int FileSize;
-		public readonly string Format;
-
-		public readonly int FmtChunkSize;
-		public readonly int AudioFormat;
-		public readonly int Channels;
-		public readonly int SampleRate;
-		public readonly int ByteRate;
-		public readonly int BlockAlign;
-		public readonly int BitsPerSample;
-
-		public readonly int UncompressedSize;
-		public readonly int DataSize;
-		public readonly byte[] RawOutput;
-
-		public enum WaveType { Pcm = 0x1, ImaAdpcm = 0x11 }
-		public static WaveType Type { get; private set; }
-
-		public WavLoader(Stream s)
-		{
-			while (s.Position < s.Length)
-			{
-				if ((s.Position & 1) == 1)
-					s.ReadByte(); // Alignment
-
-				var type = s.ReadASCII(4);
-				switch (type)
-				{
-					case "RIFF":
-						FileSize = s.ReadInt32();
-						Format = s.ReadASCII(4);
-						if (Format != "WAVE")
-							throw new NotSupportedException("Not a canonical WAVE file.");
-						break;
-					case "fmt ":
-						FmtChunkSize = s.ReadInt32();
-						AudioFormat = s.ReadInt16();
-						Type = (WaveType)AudioFormat;
-						if (Type != WaveType.Pcm && Type != WaveType.ImaAdpcm)
-							throw new NotSupportedException("Compression type is not supported.");
-						Channels = s.ReadInt16();
-						SampleRate = s.ReadInt32();
-						ByteRate = s.ReadInt32();
-						BlockAlign = s.ReadInt16();
-						BitsPerSample = s.ReadInt16();
-
-						s.ReadBytes(FmtChunkSize - 16);
-						break;
-					case "fact":
-						{
-							var chunkSize = s.ReadInt32();
-							UncompressedSize = s.ReadInt32();
-							s.ReadBytes(chunkSize - 4);
-						}
-
-						break;
-					case "data":
-						DataSize = s.ReadInt32();
-						RawOutput = s.ReadBytes(DataSize);
-						break;
-					default:
-						// Ignore unknown chunks
-						{
-							var chunkSize = s.ReadInt32();
-							s.ReadBytes(chunkSize);
-						}
-
-						break;
-				}
-			}
-
-			if (Type == WaveType.ImaAdpcm)
-			{
-				RawOutput = DecodeImaAdpcmData();
-				BitsPerSample = 16;
-			}
-		}
-
-		public static float WaveLength(Stream s)
-		{
-			s.Position = 12;
-			var fmt = s.ReadASCII(4);
-
-			if (fmt != "fmt ")
-				return 0;
-
-			s.Position = 22;
-			var channels = s.ReadInt16();
-			var sampleRate = s.ReadInt32();
-
-			s.Position = 34;
-			var bitsPerSample = s.ReadInt16();
-			var length = s.Length * 8;
-
-			return length / (channels * sampleRate * bitsPerSample);
-		}
-
-		public byte[] DecodeImaAdpcmData()
-		{
-			var s = new MemoryStream(RawOutput);
-
-			var numBlocks = DataSize / BlockAlign;
-			var blockDataSize = BlockAlign - (Channels * 4);
-			var outputSize = UncompressedSize * Channels * 2;
-
-			var outOffset = 0;
-			var output = new byte[outputSize];
-
-			var predictor = new int[Channels];
-			var index = new int[Channels];
-
-			// Decode each block of IMA ADPCM data in RawOutput
-			for (var block = 0; block < numBlocks; block++)
-			{
-				// Each block starts with a initial state per-channel
-				for (var c = 0; c < Channels; c++)
-				{
-					predictor[c] = s.ReadInt16();
-					index[c] = s.ReadUInt8();
-					/* unknown/reserved */ s.ReadUInt8();
-
-					// Output first sample from input
-					output[outOffset++] = (byte)predictor[c];
-					output[outOffset++] = (byte)(predictor[c] >> 8);
-
-					if (outOffset >= outputSize)
-						return output;
-				}
-
-				// Decode and output remaining data in this block
-				var blockOffset = 0;
-				while (blockOffset < blockDataSize)
-				{
-					for (var c = 0; c < Channels; c++)
-					{
-						// Decode 4 bytes (to 16 bytes of output) per channel
-						var chunk = s.ReadBytes(4);
-						var decoded = ImaAdpcmLoader.LoadImaAdpcmSound(chunk, ref index[c], ref predictor[c]);
-
-						// Interleave output, one sample per channel
-						var outOffsetChannel = outOffset + (2 * c);
-						for (var i = 0; i < decoded.Length; i += 2)
-						{
-							var outOffsetSample = outOffsetChannel + i;
-							if (outOffsetSample >= outputSize)
-								return output;
-
-							output[outOffsetSample] = decoded[i];
-							output[outOffsetSample + 1] = decoded[i + 1];
-							outOffsetChannel += 2 * (Channels - 1);
-						}
-
-						blockOffset += 4;
-					}
-
-					outOffset += 16 * Channels;
-				}
-			}
-
-			return output;
-		}
-	}
-}

OpenRA.Game/FileFormats/XccGlobalDatabase.cs

@@ -1,44 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using System.IO;
-
-namespace OpenRA.FileFormats
-{
-	public class XccGlobalDatabase
-	{
-		public readonly string[] Entries;
-		public XccGlobalDatabase(Stream s)
-		{
-			var entries = new List<string>();
-			var reader = new BinaryReader(s);
-			while (reader.PeekChar() > -1)
-			{
-				var count = reader.ReadInt32();
-				for (var i = 0; i < count; i++)
-				{
-					var chars = new List<char>();
-					char c;
-
-					// Read filename
-					while ((c = reader.ReadChar()) != 0)
-						chars.Add(c);
-					entries.Add(new string(chars.ToArray()));
-
-					// Skip comment
-					while ((c = reader.ReadChar()) != 0) { }
-				}
-			}
-
-			Entries = entries.ToArray();
-		}
-	}
-}

OpenRA.Game/FileFormats/XccLocalDatabase.cs

@@ -1,67 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Text;
-
-namespace OpenRA.FileFormats
-{
-	public class XccLocalDatabase
-	{
-		public readonly string[] Entries;
-		public XccLocalDatabase(Stream s)
-		{
-			// Skip unnecessary header data
-			s.Seek(48, SeekOrigin.Begin);
-			var reader = new BinaryReader(s);
-			var count = reader.ReadInt32();
-			Entries = new string[count];
-			for (var i = 0; i < count; i++)
-			{
-				var chars = new List<char>();
-				char c;
-				while ((c = reader.ReadChar()) != 0)
-					chars.Add(c);
-
-				Entries[i] = new string(chars.ToArray());
-			}
-		}
-
-		public XccLocalDatabase(IEnumerable<string> filenames)
-		{
-			Entries = filenames.ToArray();
-		}
-
-		public byte[] Data()
-		{
-			var data = new MemoryStream();
-			using (var writer = new BinaryWriter(data))
-			{
-				writer.Write(Encoding.ASCII.GetBytes("XCC by Olaf van der Spek"));
-				writer.Write(new byte[] { 0x1A, 0x04, 0x17, 0x27, 0x10, 0x19, 0x80, 0x00 });
-
-				writer.Write((int)(Entries.Aggregate(Entries.Length, (a, b) => a + b.Length) + 52)); // Size
-				writer.Write((int)0); // Type
-				writer.Write((int)0); // Version
-				writer.Write((int)0); // Game/Format (0 == TD)
-				writer.Write((int)Entries.Length); // Entries
-				foreach (var e in Entries)
-				{
-					writer.Write(Encoding.ASCII.GetBytes(e));
-					writer.Write((byte)0);
-				}
-			}
-
-			return data.ToArray();
-		}
-	}
-}

OpenRA.Game/FileSystem/BagFile.cs

@@ -1,187 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.IO;
-using System.Linq;
-using System.Text;
-using OpenRA.FileFormats;
-using OpenRA.Primitives;
-
-namespace OpenRA.FileSystem
-{
-	public sealed class BagFile : IFolder
-	{
-		static readonly uint[] Nothing = { };
-
-		readonly string bagFilename;
-		readonly Stream s;
-		readonly int bagFilePriority;
-		readonly Dictionary<uint, IdxEntry> index;
-
-		public BagFile(string filename, int priority)
-		{
-			bagFilename = filename;
-			bagFilePriority = priority;
-
-			// A bag file is always accompanied with an .idx counterpart
-			// For example: audio.bag requires the audio.idx file
-			var indexFilename = Path.ChangeExtension(filename, ".idx");
-
-			// Build the index and dispose the stream, it is no longer needed after this
-			List<IdxEntry> entries;
-			using (var indexStream = GlobalFileSystem.Open(indexFilename))
-				entries = new IdxReader(indexStream).Entries;
-
-			index = entries.ToDictionaryWithConflictLog(x => x.Hash,
-				"{0} (bag format)".F(filename),
-				null, x => "(offs={0}, len={1})".F(x.Offset, x.Length));
-
-			s = GlobalFileSystem.Open(filename);
-		}
-
-		public int Priority { get { return 1000 + bagFilePriority; } }
-		public string Name { get { return bagFilename; } }
-
-		public Stream GetContent(uint hash)
-		{
-			IdxEntry entry;
-			if (!index.TryGetValue(hash, out entry))
-				return null;
-
-			s.Seek(entry.Offset, SeekOrigin.Begin);
-
-			var waveHeaderMemoryStream = new MemoryStream();
-
-			var channels = (entry.Flags & 1) > 0 ? 2 : 1;
-
-			if ((entry.Flags & 2) > 0)
-			{
-				// PCM
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("RIFF"));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(entry.Length + 36));
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("WAVE"));
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("fmt "));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(16));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)WavLoader.WaveType.Pcm));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)channels));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(entry.SampleRate));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(2 * channels * entry.SampleRate));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)(2 * channels)));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)16));
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("data"));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(entry.Length));
-			}
-
-			if ((entry.Flags & 8) > 0)
-			{
-				// IMA ADPCM
-				var samplesPerChunk = (2 * (entry.ChunkSize - 4)) + 1;
-				var bytesPerSec = (int)Math.Floor(((double)(2 * entry.ChunkSize) / samplesPerChunk) * ((double)entry.SampleRate / 2));
-				var chunkSize = entry.ChunkSize > entry.Length ? entry.Length : entry.ChunkSize;
-
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("RIFF"));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(entry.Length + 52));
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("WAVE"));
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("fmt "));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(20));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)WavLoader.WaveType.ImaAdpcm));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)channels));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(entry.SampleRate));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(bytesPerSec));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)chunkSize));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)4));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)2));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes((short)samplesPerChunk));
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("fact"));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(4));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(4 * entry.Length));
-				waveHeaderMemoryStream.Write(Encoding.ASCII.GetBytes("data"));
-				waveHeaderMemoryStream.Write(BitConverter.GetBytes(entry.Length));
-			}
-
-			waveHeaderMemoryStream.Seek(0, SeekOrigin.Begin);
-
-			// Construct a merged stream
-			var mergedStream = new MergedStream(waveHeaderMemoryStream, s);
-			mergedStream.SetLength(waveHeaderMemoryStream.Length + entry.Length);
-
-			return mergedStream;
-		}
-
-		uint? FindMatchingHash(string filename)
-		{
-			var hash = IdxEntry.HashFilename(filename, PackageHashType.CRC32);
-			if (index.ContainsKey(hash))
-				return hash;
-
-			// Maybe we were given a raw hash?
-			uint raw;
-			if (!uint.TryParse(filename, NumberStyles.AllowHexSpecifier, CultureInfo.InvariantCulture, out raw))
-				return null;
-
-			if ("{0:X}".F(raw) == filename && index.ContainsKey(raw))
-				return raw;
-
-			return null;
-		}
-
-		public Stream GetContent(string filename)
-		{
-			var hash = FindMatchingHash(filename);
-			return hash.HasValue ? GetContent(hash.Value) : null;
-		}
-
-		public bool Exists(string filename)
-		{
-			return FindMatchingHash(filename).HasValue;
-		}
-
-		public IEnumerable<uint> ClassicHashes()
-		{
-			return Nothing;
-		}
-
-		public IEnumerable<uint> CrcHashes()
-		{
-			return index.Keys;
-		}
-
-		public IEnumerable<string> AllFileNames()
-		{
-			var lookup = new Dictionary<uint, string>();
-			if (GlobalFileSystem.Exists("global mix database.dat"))
-			{
-				var db = new XccGlobalDatabase(GlobalFileSystem.Open("global mix database.dat"));
-				foreach (var e in db.Entries)
-				{
-					var hash = IdxEntry.HashFilename(e, PackageHashType.CRC32);
-					if (!lookup.ContainsKey(hash))
-						lookup.Add(hash, e);
-				}
-			}
-
-			return index.Keys.Select(k => lookup.ContainsKey(k) ? lookup[k] : "{0:X}".F(k));
-		}
-
-		public void Write(Dictionary<string, byte[]> contents)
-		{
-			GlobalFileSystem.Unmount(this);
-			throw new NotImplementedException("Updating bag files unsupported");
-		}
-
-		public void Dispose()
-		{
-			s.Dispose();
-		}
-	}
-}

OpenRA.Game/FileSystem/BigFile.cs

@@ -1,124 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-
-namespace OpenRA.FileSystem
-{
-	public sealed class BigFile : IFolder
-	{
-		public string Name { get; private set; }
-		public int Priority { get; private set; }
-		readonly Dictionary<string, Entry> entries = new Dictionary<string, Entry>();
-		readonly Stream s;
-
-		public BigFile(string filename, int priority)
-		{
-			Name = filename;
-			Priority = priority;
-
-			s = GlobalFileSystem.Open(filename);
-			try
-			{
-				if (s.ReadASCII(4) != "BIGF")
-					throw new InvalidDataException("Header is not BIGF");
-
-				// Total archive size.
-				s.ReadUInt32();
-
-				var entryCount = s.ReadUInt32();
-				if (BitConverter.IsLittleEndian)
-					entryCount = int2.Swap(entryCount);
-
-				// First entry offset? This is apparently bogus for EA's .big files
-				// and we don't have to try seeking there since the entries typically start next in EA's .big files.
-				s.ReadUInt32();
-
-				for (var i = 0; i < entryCount; i++)
-				{
-					var entry = new Entry(s);
-					entries.Add(entry.Path, entry);
-				}
-			}
-			catch
-			{
-				Dispose();
-				throw;
-			}
-		}
-
-		class Entry
-		{
-			readonly Stream s;
-			readonly uint offset;
-			readonly uint size;
-			public readonly string Path;
-
-			public Entry(Stream s)
-			{
-				this.s = s;
-
-				offset = s.ReadUInt32();
-				size = s.ReadUInt32();
-				if (BitConverter.IsLittleEndian)
-				{
-					offset = int2.Swap(offset);
-					size = int2.Swap(size);
-				}
-
-				Path = s.ReadASCIIZ();
-			}
-
-			public Stream GetData()
-			{
-				s.Position = offset;
-				return new MemoryStream(s.ReadBytes((int)size));
-			}
-		}
-
-		public Stream GetContent(string filename)
-		{
-			return entries[filename].GetData();
-		}
-
-		public bool Exists(string filename)
-		{
-			return entries.ContainsKey(filename);
-		}
-
-		public IEnumerable<uint> ClassicHashes()
-		{
-			return entries.Keys.Select(filename => PackageEntry.HashFilename(filename, PackageHashType.Classic));
-		}
-
-		public IEnumerable<uint> CrcHashes()
-		{
-			return Enumerable.Empty<uint>();
-		}
-
-		public IEnumerable<string> AllFileNames()
-		{
-			return entries.Keys;
-		}
-
-		public void Write(Dictionary<string, byte[]> contents)
-		{
-			throw new NotImplementedException();
-		}
-
-		public void Dispose()
-		{
-			s.Dispose();
-		}
-	}
-}

OpenRA.Game/FileSystem/D2kSoundResources.cs

@@ -1,107 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-
-namespace OpenRA.FileSystem
-{
-	public sealed class D2kSoundResources : IFolder
-	{
-		readonly Stream s;
-
-		readonly string filename;
-		readonly List<string> filenames;
-		readonly int priority;
-
-		readonly Dictionary<uint, PackageEntry> index = new Dictionary<uint, PackageEntry>();
-
-		public D2kSoundResources(string filename, int priority)
-		{
-			this.filename = filename;
-			this.priority = priority;
-
-			s = GlobalFileSystem.Open(filename);
-			try
-			{
-				filenames = new List<string>();
-
-				var headerLength = s.ReadUInt32();
-				while (s.Position < headerLength + 4)
-				{
-					var name = s.ReadASCIIZ();
-					var offset = s.ReadUInt32();
-					var length = s.ReadUInt32();
-
-					var hash = PackageEntry.HashFilename(name, PackageHashType.Classic);
-					if (!index.ContainsKey(hash))
-						index.Add(hash, new PackageEntry(hash, offset, length));
-
-					filenames.Add(name);
-				}
-			}
-			catch
-			{
-				Dispose();
-				throw;
-			}
-		}
-
-		public Stream GetContent(uint hash)
-		{
-			PackageEntry e;
-			if (!index.TryGetValue(hash, out e))
-				return null;
-
-			s.Seek(e.Offset, SeekOrigin.Begin);
-			return new MemoryStream(s.ReadBytes((int)e.Length));
-		}
-
-		public Stream GetContent(string filename)
-		{
-			return GetContent(PackageEntry.HashFilename(filename, PackageHashType.Classic));
-		}
-
-		public bool Exists(string filename)
-		{
-			return index.ContainsKey(PackageEntry.HashFilename(filename, PackageHashType.Classic));
-		}
-
-		public IEnumerable<string> AllFileNames()
-		{
-			return filenames;
-		}
-
-		public string Name { get { return filename; } }
-
-		public int Priority { get { return 1000 + priority; } }
-
-		public IEnumerable<uint> ClassicHashes()
-		{
-			return index.Keys;
-		}
-
-		public IEnumerable<uint> CrcHashes()
-		{
-			yield break;
-		}
-
-		public void Write(Dictionary<string, byte[]> contents)
-		{
-			throw new NotImplementedException("Cannot save Dune 2000 Sound Resources.");
-		}
-
-		public void Dispose()
-		{
-			s.Dispose();
-		}
-	}
-}

OpenRA.Game/FileSystem/FileSystem.cs

@@ -0,0 +1,330 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using OpenRA.Primitives;
+
+namespace OpenRA.FileSystem
+{
+	public interface IReadOnlyFileSystem
+	{
+		Stream Open(string filename);
+		bool TryGetPackageContaining(string path, out IReadOnlyPackage package, out string filename);
+		bool TryOpen(string filename, out Stream s);
+		bool Exists(string filename);
+		bool IsExternalModFile(string filename);
+	}
+
+	public class FileSystem : IReadOnlyFileSystem
+	{
+		public IEnumerable<IReadOnlyPackage> MountedPackages => mountedPackages.Keys;
+		readonly Dictionary<IReadOnlyPackage, int> mountedPackages = new Dictionary<IReadOnlyPackage, int>();
+		readonly Dictionary<string, IReadOnlyPackage> explicitMounts = new Dictionary<string, IReadOnlyPackage>();
+		readonly string modID;
+
+		// Mod packages that should not be disposed
+		readonly List<IReadOnlyPackage> modPackages = new List<IReadOnlyPackage>();
+		readonly IReadOnlyDictionary<string, Manifest> installedMods;
+		readonly IPackageLoader[] packageLoaders;
+
+		Cache<string, List<IReadOnlyPackage>> fileIndex = new Cache<string, List<IReadOnlyPackage>>(_ => new List<IReadOnlyPackage>());
+
+		public FileSystem(string modID, IReadOnlyDictionary<string, Manifest> installedMods, IPackageLoader[] packageLoaders)
+		{
+			this.modID = modID;
+			this.installedMods = installedMods;
+			this.packageLoaders = packageLoaders
+				.Append(new ZipFileLoader())
+				.ToArray();
+		}
+
+		public bool TryParsePackage(Stream stream, string filename, out IReadOnlyPackage package)
+		{
+			package = null;
+			foreach (var packageLoader in packageLoaders)
+				if (packageLoader.TryParsePackage(stream, filename, this, out package))
+					return true;
+
+			return false;
+		}
+
+		public IReadOnlyPackage OpenPackage(string filename)
+		{
+			// Raw directories are the easiest and one of the most common cases, so try these first
+			var resolvedPath = Platform.ResolvePath(filename);
+			if (!resolvedPath.Contains('|') && Directory.Exists(resolvedPath))
+				return new Folder(resolvedPath);
+
+			// Children of another package require special handling
+			if (TryGetPackageContaining(filename, out var parent, out var subPath))
+				return parent.OpenPackage(subPath, this);
+
+			// Try and open it normally
+			var stream = Open(filename);
+			if (TryParsePackage(stream, filename, out var package))
+				return package;
+
+			// No package loaders took ownership of the stream, so clean it up
+			stream.Dispose();
+
+			return null;
+		}
+
+		public void Mount(string name, string explicitName = null)
+		{
+			var optional = name.StartsWith("~", StringComparison.Ordinal);
+			if (optional)
+				name = name.Substring(1);
+
+			try
+			{
+				IReadOnlyPackage package;
+				if (name.StartsWith("$", StringComparison.Ordinal))
+				{
+					name = name.Substring(1);
+
+					if (!installedMods.TryGetValue(name, out var mod))
+						throw new InvalidOperationException($"Could not load mod '{name}'. Available mods: {installedMods.Keys.JoinWith(", ")}");
+
+					package = mod.Package;
+					modPackages.Add(package);
+				}
+				else
+				{
+					package = OpenPackage(name);
+					if (package == null)
+						throw new InvalidOperationException($"Could not open package '{name}', file not found or its format is not supported.");
+				}
+
+				Mount(package, explicitName);
+			}
+			catch
+			{
+				if (!optional)
+					throw;
+			}
+		}
+
+		public void Mount(IReadOnlyPackage package, string explicitName = null)
+		{
+			if (mountedPackages.TryGetValue(package, out var mountCount))
+			{
+				// Package is already mounted
+				// Increment the mount count and bump up the file loading priority
+				mountedPackages[package] = mountCount + 1;
+				foreach (var filename in package.Contents)
+				{
+					fileIndex[filename].Remove(package);
+					fileIndex[filename].Add(package);
+				}
+			}
+			else
+			{
+				// Mounting the package for the first time
+				mountedPackages.Add(package, 1);
+
+				if (explicitName != null)
+					explicitMounts.Add(explicitName, package);
+
+				foreach (var filename in package.Contents)
+					fileIndex[filename].Add(package);
+			}
+		}
+
+		public bool Unmount(IReadOnlyPackage package)
+		{
+			if (!mountedPackages.TryGetValue(package, out var mountCount))
+				return false;
+
+			if (--mountCount <= 0)
+			{
+				foreach (var packagesForFile in fileIndex.Values)
+					packagesForFile.RemoveAll(p => p == package);
+
+				mountedPackages.Remove(package);
+				var explicitKeys = explicitMounts.Where(kv => kv.Value == package)
+					.Select(kv => kv.Key)
+					.ToList();
+
+				foreach (var key in explicitKeys)
+					explicitMounts.Remove(key);
+
+				// Mod packages aren't owned by us, so we shouldn't dispose them
+				if (modPackages.Contains(package))
+					modPackages.Remove(package);
+				else
+					package.Dispose();
+			}
+			else
+				mountedPackages[package] = mountCount;
+
+			return true;
+		}
+
+		public void UnmountAll()
+		{
+			foreach (var package in mountedPackages.Keys)
+				if (!modPackages.Contains(package))
+					package.Dispose();
+
+			mountedPackages.Clear();
+			explicitMounts.Clear();
+			modPackages.Clear();
+
+			fileIndex = new Cache<string, List<IReadOnlyPackage>>(_ => new List<IReadOnlyPackage>());
+		}
+
+		public void LoadFromManifest(Manifest manifest)
+		{
+			UnmountAll();
+			foreach (var kv in manifest.Packages)
+				Mount(kv.Key, kv.Value);
+		}
+
+		Stream GetFromCache(string filename)
+		{
+			var package = fileIndex[filename]
+				.LastOrDefault(x => x.Contains(filename));
+
+			return package?.GetStream(filename);
+		}
+
+		public Stream Open(string filename)
+		{
+			if (!TryOpen(filename, out var s))
+				throw new FileNotFoundException($"File not found: {filename}", filename);
+
+			return s;
+		}
+
+		public bool TryGetPackageContaining(string path, out IReadOnlyPackage package, out string filename)
+		{
+			var explicitSplit = path.IndexOf('|');
+			if (explicitSplit > 0 && explicitMounts.TryGetValue(path.Substring(0, explicitSplit), out package))
+			{
+				filename = path.Substring(explicitSplit + 1);
+				return true;
+			}
+
+			package = fileIndex[path].LastOrDefault(x => x.Contains(path));
+			filename = path;
+
+			return package != null;
+		}
+
+		public bool TryOpen(string filename, out Stream s)
+		{
+			var explicitSplit = filename.IndexOf('|');
+			if (explicitSplit > 0)
+			{
+				if (explicitMounts.TryGetValue(filename.Substring(0, explicitSplit), out var explicitPackage))
+				{
+					s = explicitPackage.GetStream(filename.Substring(explicitSplit + 1));
+					if (s != null)
+						return true;
+				}
+			}
+
+			s = GetFromCache(filename);
+			if (s != null)
+				return true;
+
+			// The file should be in an explicit package (but we couldn't find it)
+			// Thus don't try to find it using the filename (which contains the invalid '|' char)
+			// This can be removed once the TODO below is resolved
+			if (explicitSplit > 0)
+				return false;
+
+			// Ask each package individually
+			// TODO: This fallback can be removed once the filesystem cleanups are complete
+			var package = mountedPackages.Keys.LastOrDefault(x => x.Contains(filename));
+			if (package != null)
+			{
+				s = package.GetStream(filename);
+				return s != null;
+			}
+
+			s = null;
+			return false;
+		}
+
+		public bool Exists(string filename)
+		{
+			var explicitSplit = filename.IndexOf('|');
+			if (explicitSplit > 0)
+				if (explicitMounts.TryGetValue(filename.Substring(0, explicitSplit), out var explicitPackage))
+					if (explicitPackage.Contains(filename.Substring(explicitSplit + 1)))
+						return true;
+
+			return fileIndex.ContainsKey(filename);
+		}
+
+		/// <summary>
+		/// Returns true if the given filename references an external mod via an explicit mount
+		/// </summary>
+		public bool IsExternalModFile(string filename)
+		{
+			var explicitSplit = filename.IndexOf('|');
+			if (explicitSplit < 0)
+				return false;
+
+			if (!explicitMounts.TryGetValue(filename.Substring(0, explicitSplit), out var explicitPackage))
+				return false;
+
+			if (installedMods[modID].Package == explicitPackage)
+				return false;
+
+			return modPackages.Contains(explicitPackage);
+		}
+
+		/// <summary>
+		/// Resolves a filesystem for an assembly, accounting for explicit and mod mounts.
+		/// Assemblies must exist in the native OS file system (not inside an OpenRA-defined package).
+		/// </summary>
+		public static string ResolveAssemblyPath(string path, Manifest manifest, InstalledMods installedMods)
+		{
+			var explicitSplit = path.IndexOf('|');
+			if (explicitSplit > 0 && !path.StartsWith("^"))
+			{
+				var parent = path.Substring(0, explicitSplit);
+				var filename = path.Substring(explicitSplit + 1);
+
+				var parentPath = manifest.Packages.FirstOrDefault(kv => kv.Value == parent).Key;
+				if (parentPath == null)
+					return null;
+
+				if (parentPath.StartsWith("$", StringComparison.Ordinal))
+				{
+					if (!installedMods.TryGetValue(parentPath.Substring(1), out var mod))
+						return null;
+
+					if (!(mod.Package is Folder))
+						return null;
+
+					path = Path.Combine(mod.Package.Name, filename);
+				}
+				else
+					path = Path.Combine(parentPath, filename);
+			}
+
+			var resolvedPath = Platform.ResolvePath(path);
+			return File.Exists(resolvedPath) ? resolvedPath : null;
+		}
+
+		public string GetPrefix(IReadOnlyPackage package)
+		{
+			return explicitMounts.ContainsValue(package) ? explicitMounts.First(f => f.Value == package).Key : null;
+		}
+	}
+}

OpenRA.Game/FileSystem/Folder.cs

@@ -1,82 +1,106 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
+using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 
 namespace OpenRA.FileSystem
 {
-	public sealed class Folder : IFolder
+	public sealed class Folder : IReadWritePackage
 	{
 		readonly string path;
-		readonly int priority;
 
-		// Create a new folder package
-		public Folder(string path, int priority, Dictionary<string, byte[]> contents)
+		public Folder(string path)
 		{
 			this.path = path;
-			this.priority = priority;
-			if (Directory.Exists(path))
-				Directory.Delete(path, true);
-
-			Write(contents);
-		}
-
-		public Folder(string path, int priority)
-		{
-			this.path = path;
-			this.priority = priority;
 			if (!Directory.Exists(path))
 				Directory.CreateDirectory(path);
 		}
 
-		public Stream GetContent(string filename)
+		public string Name => path;
+
+		public IEnumerable<string> Contents
+		{
+			get
+			{
+				// Order may vary on different file systems and it matters for hashing.
+				return Directory.GetFiles(path, "*", SearchOption.TopDirectoryOnly)
+					.Concat(Directory.GetDirectories(path))
+					.Select(Path.GetFileName)
+					.OrderBy(f => f);
+			}
+		}
+
+		public Stream GetStream(string filename)
 		{
 			try { return File.OpenRead(Path.Combine(path, filename)); }
 			catch { return null; }
 		}
 
-		public IEnumerable<uint> ClassicHashes()
+		public bool Contains(string filename)
 		{
-			foreach (var filename in Directory.GetFiles(path, "*", SearchOption.TopDirectoryOnly))
-				yield return PackageEntry.HashFilename(Path.GetFileName(filename), PackageHashType.Classic);
+			var combined = Path.Combine(path, filename);
+			return combined.StartsWith(path, StringComparison.Ordinal) && File.Exists(combined);
 		}
 
-		public IEnumerable<uint> CrcHashes()
+		public IReadOnlyPackage OpenPackage(string filename, FileSystem context)
 		{
-			yield break;
+			var resolvedPath = Platform.ResolvePath(Path.Combine(Name, filename));
+			if (Directory.Exists(resolvedPath))
+				return new Folder(resolvedPath);
+
+			// Zip files loaded from Folders (and *only* from Folders) can be read-write
+			if (ZipFileLoader.TryParseReadWritePackage(resolvedPath, out var readWritePackage))
+				return readWritePackage;
+
+			// Other package types can be loaded normally
+			var s = GetStream(filename);
+			if (s == null)
+				return null;
+
+			if (context.TryParsePackage(s, filename, out var package))
+				return package;
+
+			s.Dispose();
+			return null;
 		}
 
-		public IEnumerable<string> AllFileNames()
+		public void Update(string filename, byte[] contents)
 		{
-			foreach (var filename in Directory.GetFiles(path, "*", SearchOption.TopDirectoryOnly))
-				yield return Path.GetFileName(filename);
+			// HACK: ZipFiles can't be loaded as read-write from a stream, so we are
+			// forced to bypass the parent package and load them with their full path
+			// in FileSystem.OpenPackage.  Their internal name therefore contains the
+			// full parent path too.  We need to be careful to not add a second path
+			// prefix to these hacked packages.
+			var filePath = filename.StartsWith(path) ? filename : Path.Combine(path, filename);
+
+			Directory.CreateDirectory(Path.GetDirectoryName(filePath));
+			using (var s = File.Create(filePath))
+				s.Write(contents, 0, contents.Length);
 		}
 
-		public bool Exists(string filename)
+		public void Delete(string filename)
 		{
-			return File.Exists(Path.Combine(path, filename));
-		}
-
-		public int Priority { get { return priority; } }
-		public string Name { get { return path; } }
-
-		public void Write(Dictionary<string, byte[]> contents)
-		{
-			if (!Directory.Exists(path))
-				Directory.CreateDirectory(path);
-
-			foreach (var file in contents)
-				using (var dataStream = File.Create(Path.Combine(path, file.Key)))
-				using (var writer = new BinaryWriter(dataStream))
-					writer.Write(file.Value);
+			// HACK: ZipFiles can't be loaded as read-write from a stream, so we are
+			// forced to bypass the parent package and load them with their full path
+			// in FileSystem.OpenPackage.  Their internal name therefore contains the
+			// full parent path too.  We need to be careful to not add a second path
+			// prefix to these hacked packages.
+			var filePath = filename.StartsWith(path) ? filename : Path.Combine(path, filename);
+			if (Directory.Exists(filePath))
+				Directory.Delete(filePath, true);
+			else if (File.Exists(filePath))
+				File.Delete(filePath);
 		}
 
 		public void Dispose() { }

OpenRA.Game/FileSystem/GlobalFileSystem.cs

@@ -1,273 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Reflection;
-using OpenRA.Primitives;
-
-namespace OpenRA.FileSystem
-{
-	public interface IFolder : IDisposable
-	{
-		Stream GetContent(string filename);
-		bool Exists(string filename);
-		IEnumerable<uint> ClassicHashes();
-		IEnumerable<uint> CrcHashes();
-		IEnumerable<string> AllFileNames();
-		void Write(Dictionary<string, byte[]> contents);
-		int Priority { get; }
-		string Name { get; }
-	}
-
-	public static class GlobalFileSystem
-	{
-		public static List<IFolder> MountedFolders = new List<IFolder>();
-		static Cache<uint, List<IFolder>> classicHashIndex = new Cache<uint, List<IFolder>>(_ => new List<IFolder>());
-		static Cache<uint, List<IFolder>> crcHashIndex = new Cache<uint, List<IFolder>>(_ => new List<IFolder>());
-
-		public static List<string> FolderPaths = new List<string>();
-
-		static void MountInner(IFolder folder)
-		{
-			MountedFolders.Add(folder);
-
-			foreach (var hash in folder.ClassicHashes())
-			{
-				var l = classicHashIndex[hash];
-				if (!l.Contains(folder))
-					l.Add(folder);
-			}
-
-			foreach (var hash in folder.CrcHashes())
-			{
-				var l = crcHashIndex[hash];
-				if (!l.Contains(folder))
-					l.Add(folder);
-			}
-		}
-
-		static int order = 0;
-
-		public static IFolder CreatePackage(string filename, int order, Dictionary<string, byte[]> content)
-		{
-			if (filename.EndsWith(".mix", StringComparison.InvariantCultureIgnoreCase))
-				return new MixFile(filename, order, content);
-			if (filename.EndsWith(".zip", StringComparison.InvariantCultureIgnoreCase))
-				return new ZipFile(filename, order, content);
-			if (filename.EndsWith(".oramap", StringComparison.InvariantCultureIgnoreCase))
-				return new ZipFile(filename, order, content);
-			if (filename.EndsWith(".RS", StringComparison.InvariantCultureIgnoreCase))
-				throw new NotImplementedException("The creation of .RS archives is unimplemented");
-			if (filename.EndsWith(".Z", StringComparison.InvariantCultureIgnoreCase))
-				throw new NotImplementedException("The creation of .Z archives is unimplemented");
-			if (filename.EndsWith(".PAK", StringComparison.InvariantCultureIgnoreCase))
-				throw new NotImplementedException("The creation of .PAK archives is unimplemented");
-			if (filename.EndsWith(".big", StringComparison.InvariantCultureIgnoreCase))
-				throw new NotImplementedException("The creation of .big archives is unimplemented");
-			if (filename.EndsWith(".cab", StringComparison.InvariantCultureIgnoreCase))
-				throw new NotImplementedException("The creation of .cab archives is unimplemented");
-
-			return new Folder(filename, order, content);
-		}
-
-		public static IFolder OpenPackage(string filename, string annotation, int order)
-		{
-			if (filename.EndsWith(".mix", StringComparison.InvariantCultureIgnoreCase))
-			{
-				var type = string.IsNullOrEmpty(annotation)
-					? PackageHashType.Classic
-					: FieldLoader.GetValue<PackageHashType>("(value)", annotation);
-
-				return new MixFile(filename, type, order);
-			}
-
-			if (filename.EndsWith(".zip", StringComparison.InvariantCultureIgnoreCase))
-				return new ZipFile(filename, order);
-			if (filename.EndsWith(".oramap", StringComparison.InvariantCultureIgnoreCase))
-				return new ZipFile(filename, order);
-			if (filename.EndsWith(".RS", StringComparison.InvariantCultureIgnoreCase))
-				return new D2kSoundResources(filename, order);
-			if (filename.EndsWith(".Z", StringComparison.InvariantCultureIgnoreCase))
-				return new InstallShieldPackage(filename, order);
-			if (filename.EndsWith(".PAK", StringComparison.InvariantCultureIgnoreCase))
-				return new PakFile(filename, order);
-			if (filename.EndsWith(".big", StringComparison.InvariantCultureIgnoreCase))
-				return new BigFile(filename, order);
-			if (filename.EndsWith(".bag", StringComparison.InvariantCultureIgnoreCase))
-				return new BagFile(filename, order);
-			if (filename.EndsWith(".hdr", StringComparison.InvariantCultureIgnoreCase))
-				return new InstallShieldCABExtractor(filename, order);
-
-			return new Folder(filename, order);
-		}
-
-		public static void Mount(string name, string annotation = null)
-		{
-			var optional = name.StartsWith("~");
-			if (optional)
-				name = name.Substring(1);
-
-			name = Platform.ResolvePath(name);
-
-			FolderPaths.Add(name);
-			Action a = () => MountInner(OpenPackage(name, annotation, order++));
-
-			if (optional)
-				try { a(); }
-				catch { }
-			else
-				a();
-		}
-
-		public static void UnmountAll()
-		{
-			foreach (var folder in MountedFolders)
-				folder.Dispose();
-
-			MountedFolders.Clear();
-			FolderPaths.Clear();
-			classicHashIndex = new Cache<uint, List<IFolder>>(_ => new List<IFolder>());
-			crcHashIndex = new Cache<uint, List<IFolder>>(_ => new List<IFolder>());
-		}
-
-		public static bool Unmount(IFolder mount)
-		{
-			if (MountedFolders.Contains(mount))
-				mount.Dispose();
-
-			return MountedFolders.RemoveAll(f => f == mount) > 0;
-		}
-
-		public static void Mount(IFolder mount)
-		{
-			if (!MountedFolders.Contains(mount)) MountedFolders.Add(mount);
-		}
-
-		public static void LoadFromManifest(Manifest manifest)
-		{
-			UnmountAll();
-			foreach (var dir in manifest.Folders)
-				Mount(dir);
-
-			foreach (var pkg in manifest.Packages)
-				Mount(pkg.Key, pkg.Value);
-		}
-
-		static Stream GetFromCache(PackageHashType type, string filename)
-		{
-			var index = type == PackageHashType.CRC32 ? crcHashIndex : classicHashIndex;
-			var folder = index[PackageEntry.HashFilename(filename, type)]
-				.Where(x => x.Exists(filename))
-				.MinByOrDefault(x => x.Priority);
-
-			if (folder != null)
-				return folder.GetContent(filename);
-
-			return null;
-		}
-
-		public static Stream Open(string filename)
-		{
-			Stream s;
-			if (!TryOpen(filename, out s))
-				throw new FileNotFoundException("File not found: {0}".F(filename), filename);
-
-			return s;
-		}
-
-		public static bool TryOpen(string name, out Stream s)
-		{
-			var filename = name;
-			var foldername = string.Empty;
-
-			// Used for faction specific packages; rule out false positive on Windows C:\ drive notation
-			var explicitFolder = name.Contains(':') && !Directory.Exists(Path.GetDirectoryName(name));
-			if (explicitFolder)
-			{
-				var divide = name.Split(':');
-				foldername = divide.First();
-				filename = divide.Last();
-			}
-
-			// Check the cache for a quick lookup if the folder name is unknown
-			// TODO: This disables caching for explicit folder requests
-			if (filename.IndexOfAny(new char[] { '/', '\\' }) == -1 && !explicitFolder)
-			{
-				s = GetFromCache(PackageHashType.Classic, filename);
-				if (s != null)
-					return true;
-
-				s = GetFromCache(PackageHashType.CRC32, filename);
-				if (s != null)
-					return true;
-			}
-
-			// Ask each package individually
-			IFolder folder;
-			if (explicitFolder && !string.IsNullOrEmpty(foldername))
-				folder = MountedFolders.Where(x => x.Name == foldername).MaxByOrDefault(x => x.Priority);
-			else
-				folder = MountedFolders.Where(x => x.Exists(filename)).MaxByOrDefault(x => x.Priority);
-
-			if (folder != null)
-			{
-				s = folder.GetContent(filename);
-				return true;
-			}
-
-			s = null;
-			return false;
-		}
-
-		public static bool Exists(string name)
-		{
-			var explicitFolder = name.Contains(':') && !Directory.Exists(Path.GetDirectoryName(name));
-			if (explicitFolder)
-			{
-				var divide = name.Split(':');
-				var foldername = divide.First();
-				var filename = divide.Last();
-				return MountedFolders.Where(n => n.Name == foldername).Any(f => f.Exists(filename));
-			}
-			else
-				return MountedFolders.Any(f => f.Exists(name));
-		}
-
-		static Dictionary<string, Assembly> assemblyCache = new Dictionary<string, Assembly>();
-
-		public static Assembly ResolveAssembly(object sender, ResolveEventArgs e)
-		{
-			foreach (var assembly in AppDomain.CurrentDomain.GetAssemblies())
-				if (assembly.FullName == e.Name)
-					return assembly;
-
-			var frags = e.Name.Split(',');
-			var filename = frags[0] + ".dll";
-
-			Assembly a;
-			if (assemblyCache.TryGetValue(filename, out a))
-				return a;
-
-			if (Exists(filename))
-				using (var s = Open(filename))
-				{
-					var buf = s.ReadBytes((int)s.Length);
-					a = Assembly.Load(buf);
-					assemblyCache.Add(filename, a);
-					return a;
-				}
-
-			return null;
-		}
-	}
-}

OpenRA.Game/FileSystem/IPackage.cs

@@ -0,0 +1,42 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+
+namespace OpenRA.FileSystem
+{
+	public interface IPackageLoader
+	{
+		/// <summary>
+		/// Attempt to parse a stream as this type of package.
+		/// If successful, the loader is expected to take ownership of `s` and dispose it once done.
+		/// If unsuccessful, the loader is expected to return the stream position to where it started.
+		/// </summary>
+		bool TryParsePackage(Stream s, string filename, FileSystem context, out IReadOnlyPackage package);
+	}
+
+	public interface IReadOnlyPackage : IDisposable
+	{
+		string Name { get; }
+		IEnumerable<string> Contents { get; }
+		Stream GetStream(string filename);
+		bool Contains(string filename);
+		IReadOnlyPackage OpenPackage(string filename, FileSystem context);
+	}
+
+	public interface IReadWritePackage : IReadOnlyPackage
+	{
+		void Update(string filename, byte[] contents);
+		void Delete(string filename);
+	}
+}

OpenRA.Game/FileSystem/IdxEntry.cs

@@ -1,94 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using System.IO;
-
-namespace OpenRA.FileSystem
-{
-	public class IdxEntry
-	{
-		public const string DefaultExtension = "wav";
-
-		public readonly uint Hash;
-		public readonly string Name;
-		public readonly string Extension;
-		public readonly uint Offset;
-		public readonly uint Length;
-		public readonly uint SampleRate;
-		public readonly uint Flags;
-		public readonly uint ChunkSize;
-
-		public IdxEntry(uint hash, uint offset, uint length, uint sampleRate, uint flags, uint chuckSize)
-		{
-			Hash = hash;
-			Offset = offset;
-			Length = length;
-			SampleRate = sampleRate;
-			Flags = flags;
-			ChunkSize = chuckSize;
-		}
-
-		public IdxEntry(Stream s)
-		{
-			var asciiname = s.ReadASCII(16);
-
-			var pos = asciiname.IndexOf('\0');
-			if (pos != 0)
-				asciiname = asciiname.Substring(0, pos);
-
-			Name = asciiname;
-			Extension = DefaultExtension;
-			Offset = s.ReadUInt32();
-			Length = s.ReadUInt32();
-			SampleRate = s.ReadUInt32();
-			Flags = s.ReadUInt32();
-			ChunkSize = s.ReadUInt32();
-			Hash = HashFilename(string.Concat(Name, ".", Extension), PackageHashType.CRC32);
-		}
-
-		public void Write(BinaryWriter w)
-		{
-			w.Write(Name.PadRight(16, '\0'));
-			w.Write(Offset);
-			w.Write(Length);
-			w.Write(SampleRate);
-			w.Write(Flags);
-			w.Write(ChunkSize);
-		}
-
-		public override string ToString()
-		{
-			string filename;
-			if (names.TryGetValue(Hash, out filename))
-				return "{0} - offset 0x{1:x8} - length 0x{2:x8}".F(filename, Offset, Length);
-			else
-				return "0x{0:x8} - offset 0x{1:x8} - length 0x{2:x8}".F(Hash, Offset, Length);
-		}
-
-		public static uint HashFilename(string name, PackageHashType type)
-		{
-			return PackageEntry.HashFilename(name, type);
-		}
-
-		static Dictionary<uint, string> names = new Dictionary<uint, string>();
-
-		public static void AddStandardName(string s)
-		{
-			// RA1 and TD
-			var hash = HashFilename(s, PackageHashType.Classic);
-			names.Add(hash, s);
-
-			// TS
-			var crcHash = HashFilename(s, PackageHashType.CRC32);
-			names.Add(crcHash, s);
-		}
-	}
-}

OpenRA.Game/FileSystem/InstallShieldCABExtractor.cs

@@ -1,526 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Text.RegularExpressions;
-using ICSharpCode.SharpZipLib.Zip.Compression;
-using ICSharpCode.SharpZipLib.Zip.Compression.Streams;
-
-namespace OpenRA.FileSystem
-{
-	public class InstallShieldCABExtractor : IDisposable, IFolder
-	{
-		const uint FileSplit = 0x1;
-		const uint FileObfuscated = 0x2;
-		const uint FileCompressed = 0x4;
-		const uint FileInvalid = 0x8;
-
-		const uint LinkPrev = 0x1;
-		const uint LinkNext = 0x2;
-		const uint MaxFileGroupCount = 71;
-
-#region Nested Structs
-
-		struct FileGroup
-		{
-			public readonly string Name;
-			public readonly uint FirstFile;
-			public readonly uint LastFile;
-
-			public FileGroup(Stream reader, long offset)
-			{
-				var nameOffset = reader.ReadUInt32();
-				/*   unknown  */ reader.ReadBytes(18);
-				FirstFile = reader.ReadUInt32();
-				LastFile = reader.ReadUInt32();
-
-				reader.Seek(offset + (long)nameOffset, SeekOrigin.Begin);
-				Name = reader.ReadASCIIZ();
-			}
-		}
-
-		struct VolumeHeader
-		{
-			public readonly uint DataOffset;
-			public readonly uint DataOffsetHigh;
-			public readonly uint FirstFileIndex;
-			public readonly uint LastFileIndex;
-
-			public readonly uint FirstFileOffset;
-			public readonly uint FirstFileOffsetHigh;
-			public readonly uint FirstFileSizeExpanded;
-			public readonly uint FirstFileSizeExpandedHigh;
-
-			public readonly uint FirstFileSizeCompressed;
-			public readonly uint FirstFileSizeCompressedHigh;
-			public readonly uint LastFileOffset;
-			public readonly uint LastFileOffsetHigh;
-
-			public readonly uint LastFileSizeExpanded;
-			public readonly uint LastFileSizeExpandedHigh;
-			public readonly uint LastFileSizeCompressed;
-			public readonly uint LastFileSizeCompressedHigh;
-
-			public VolumeHeader(Stream reader)
-			{
-				DataOffset = reader.ReadUInt32();
-				DataOffsetHigh = reader.ReadUInt32();
-
-				FirstFileIndex = reader.ReadUInt32();
-				LastFileIndex = reader.ReadUInt32();
-				FirstFileOffset = reader.ReadUInt32();
-				FirstFileOffsetHigh = reader.ReadUInt32();
-
-				FirstFileSizeExpanded = reader.ReadUInt32();
-				FirstFileSizeExpandedHigh = reader.ReadUInt32();
-				FirstFileSizeCompressed = reader.ReadUInt32();
-				FirstFileSizeCompressedHigh = reader.ReadUInt32();
-
-				LastFileOffset = reader.ReadUInt32();
-				LastFileOffsetHigh = reader.ReadUInt32();
-				LastFileSizeExpanded = reader.ReadUInt32();
-				LastFileSizeExpandedHigh = reader.ReadUInt32();
-
-				LastFileSizeCompressed = reader.ReadUInt32();
-				LastFileSizeCompressedHigh = reader.ReadUInt32();
-			}
-		}
-
-		struct CommonHeader
-		{
-			public const long Size = 16;
-			public readonly uint Version;
-			public readonly uint VolumeInfo;
-			public readonly long CabDescriptorOffset;
-			public readonly uint CabDescriptorSize;
-
-			public CommonHeader(Stream reader)
-			{
-				Version = reader.ReadUInt32();
-				VolumeInfo = reader.ReadUInt32();
-				CabDescriptorOffset = (long)reader.ReadUInt32();
-				CabDescriptorSize = reader.ReadUInt32();
-			}
-		}
-
-		struct CabDescriptor
-		{
-			public readonly long FileTableOffset;
-			public readonly uint FileTableSize;
-			public readonly uint FileTableSize2;
-			public readonly uint DirectoryCount;
-
-			public readonly uint FileCount;
-			public readonly long FileTableOffset2;
-
-			public CabDescriptor(Stream reader, CommonHeader commonHeader)
-			{
-				reader.Seek(commonHeader.CabDescriptorOffset + 12, SeekOrigin.Begin);
-				FileTableOffset = (long)reader.ReadUInt32();
-				/*    unknown  */ reader.ReadUInt32();
-				FileTableSize = reader.ReadUInt32();
-
-				FileTableSize2 = reader.ReadUInt32();
-				DirectoryCount = reader.ReadUInt32();
-				/*   unknown  */ reader.ReadBytes(8);
-				FileCount = reader.ReadUInt32();
-
-				FileTableOffset2 = (long)reader.ReadUInt32();
-			}
-		}
-
-		struct FileDescriptor
-		{
-			public readonly ushort	Flags;
-			public readonly uint	ExpandedSize;
-			public readonly uint	CompressedSize;
-			public readonly uint	DataOffset;
-
-			public readonly byte[]	MD5;
-			public readonly uint	NameOffset;
-			public readonly ushort	DirectoryIndex;
-			public readonly uint	LinkToPrevious;
-
-			public readonly uint	LinkToNext;
-			public readonly byte	LinkFlags;
-			public readonly ushort	Volume;
-			public readonly string	Filename;
-
-			public FileDescriptor(Stream reader, long tableOffset)
-			{
-				Flags = reader.ReadUInt16();
-				ExpandedSize = reader.ReadUInt32();
-				/*    unknown   */ reader.ReadUInt32();
-				CompressedSize = reader.ReadUInt32();
-
-				/*  unknown */ reader.ReadUInt32();
-				DataOffset   = reader.ReadUInt32();
-				/*  unknown */ reader.ReadUInt32();
-				MD5          = reader.ReadBytes(16);
-
-				/*   unknown  */ reader.ReadBytes(16);
-				NameOffset     = reader.ReadUInt32();
-				DirectoryIndex = reader.ReadUInt16();
-				/*   unknown  */ reader.ReadBytes(12);
-				LinkToPrevious = reader.ReadUInt32();
-				LinkToNext = reader.ReadUInt32();
-
-				LinkFlags = reader.ReadBytes(1)[0];
-				Volume = reader.ReadUInt16();
-				var posSave = reader.Position;
-
-				reader.Seek(tableOffset + NameOffset, SeekOrigin.Begin);
-				Filename = reader.ReadASCIIZ();
-				reader.Seek(posSave, SeekOrigin.Begin);
-			}
-		}
-
-		class CabReader : IDisposable
-		{
-			readonly FileDescriptor fileDes;
-			public uint RemainingArchiveStream;
-			public uint RemainingFileStream;
-			readonly uint index;
-			readonly string commonName;
-			ushort volumeNumber;
-			Stream cabFile;
-
-			public CabReader(FileDescriptor fileDes, uint index, string commonName)
-			{
-				this.fileDes = fileDes;
-				this.index = index;
-				this.commonName = commonName;
-				volumeNumber = (ushort)((uint)fileDes.Volume - 1u);
-				RemainingArchiveStream = 0;
-				if ((fileDes.Flags & FileCompressed) > 0)
-					RemainingFileStream = fileDes.CompressedSize;
-				else
-					RemainingFileStream = fileDes.ExpandedSize;
-
-				cabFile = null;
-				NextFile();
-			}
-
-			public void CopyTo(Stream dest)
-			{
-				if ((fileDes.Flags & FileCompressed) != 0)
-				{
-					var inf = new Inflater(true);
-					var buffer = new byte[165535];
-					do
-					{
-						var bytesToExtract = cabFile.ReadUInt16();
-						RemainingArchiveStream -= 2u;
-						RemainingFileStream -= 2u;
-						inf.SetInput(GetBytes(bytesToExtract));
-						RemainingFileStream -= bytesToExtract;
-						while (!inf.IsNeedingInput)
-						{
-							var inflated = inf.Inflate(buffer);
-							dest.Write(buffer, 0, inflated);
-						}
-
-						inf.Reset();
-					}
-					while (RemainingFileStream > 0);
-				}
-				else
-				{
-					do
-					{
-						RemainingFileStream -= RemainingArchiveStream;
-						dest.Write(GetBytes(RemainingArchiveStream), 0, (int)RemainingArchiveStream);
-					}
-					while (RemainingFileStream > 0);
-				}
-			}
-
-			public byte[] GetBytes(uint count)
-			{
-				if (count < RemainingArchiveStream)
-				{
-					RemainingArchiveStream -= count;
-					return cabFile.ReadBytes((int)count);
-				}
-				else
-				{
-					var outArray = new byte[count];
-					var read = cabFile.Read(outArray, 0, (int)RemainingArchiveStream);
-					if (RemainingFileStream > RemainingArchiveStream)
-					{
-						NextFile();
-						RemainingArchiveStream -= (uint)cabFile.Read(outArray, read, (int)count - read);
-					}
-
-					return outArray;
-				}
-			}
-
-			public void Dispose()
-			{
-				cabFile.Dispose();
-			}
-
-			public void NextFile()
-			{
-				if (cabFile != null)
-					cabFile.Dispose();
-
-				++volumeNumber;
-				cabFile = GlobalFileSystem.Open("{0}{1}.cab".F(commonName, volumeNumber));
-				if (cabFile.ReadUInt32() != 0x28635349)
-					throw new InvalidDataException("Not an Installshield CAB package");
-
-				uint fileOffset;
-				if ((fileDes.Flags & FileSplit) != 0)
-				{
-					cabFile.Seek(CommonHeader.Size, SeekOrigin.Current);
-					var head = new VolumeHeader(cabFile);
-					if (index == head.LastFileIndex)
-					{
-						if ((fileDes.Flags & FileCompressed) != 0)
-							RemainingArchiveStream = head.LastFileSizeCompressed;
-						else
-							RemainingArchiveStream = head.LastFileSizeExpanded;
-
-						fileOffset = head.LastFileOffset;
-					}
-					else if (index == head.FirstFileIndex)
-					{
-						if ((fileDes.Flags & FileCompressed) != 0)
-							RemainingArchiveStream = head.FirstFileSizeCompressed;
-						else
-							RemainingArchiveStream = head.FirstFileSizeExpanded;
-
-						fileOffset = head.FirstFileOffset;
-					}
-					else
-						throw new Exception("Cannot Resolve Remaining Stream");
-				}
-				else
-				{
-					if ((fileDes.Flags & FileCompressed) != 0)
-						RemainingArchiveStream = fileDes.CompressedSize;
-					else
-						RemainingArchiveStream = fileDes.ExpandedSize;
-
-					fileOffset = fileDes.DataOffset;
-				}
-
-				cabFile.Seek(fileOffset, SeekOrigin.Begin);
-			}
-		}
-#endregion
-
-		readonly Stream hdrFile;
-		readonly CommonHeader commonHeader;
-		readonly CabDescriptor cabDescriptor;
-		readonly List<uint> directoryTable;
-		readonly Dictionary<uint, string> directoryNames = new Dictionary<uint, string>();
-		readonly Dictionary<uint, FileDescriptor> fileDescriptors = new Dictionary<uint, FileDescriptor>();
-		readonly Dictionary<string, uint> fileLookup = new Dictionary<string, uint>();
-		int priority;
-		string commonName;
-		public int Priority { get { return priority; } }
-
-		public string Name { get { return commonName; } }
-
-		public InstallShieldCABExtractor(string hdrFilename, int priority = -1)
-		{
-			var fileGroups = new List<FileGroup>();
-			var fileGroupOffsets = new List<uint>();
-
-			this.priority = priority;
-			hdrFile = GlobalFileSystem.Open(hdrFilename);
-
-			// Strips archive number AND file extension
-			commonName = Regex.Replace(hdrFilename, @"\d*\.[^\.]*$", "");
-			var signature = hdrFile.ReadUInt32();
-
-			if (signature != 0x28635349)
-				throw new InvalidDataException("Not an Installshield CAB package");
-
-			commonHeader = new CommonHeader(hdrFile);
-			cabDescriptor = new CabDescriptor(hdrFile, commonHeader);
-			/*    unknown   */ hdrFile.ReadBytes(14);
-
-			for (var i = 0U; i < MaxFileGroupCount; ++i)
-				fileGroupOffsets.Add(hdrFile.ReadUInt32());
-
-			hdrFile.Seek(commonHeader.CabDescriptorOffset + cabDescriptor.FileTableOffset, SeekOrigin.Begin);
-			directoryTable = new List<uint>();
-
-			for (var i = 0U; i < cabDescriptor.DirectoryCount; ++i)
-				directoryTable.Add(hdrFile.ReadUInt32());
-
-			foreach (var offset in fileGroupOffsets)
-			{
-				var nextOffset = offset;
-				while (nextOffset != 0)
-				{
-					hdrFile.Seek((long)nextOffset + 4 + commonHeader.CabDescriptorOffset, SeekOrigin.Begin);
-					var descriptorOffset = hdrFile.ReadUInt32();
-					nextOffset = hdrFile.ReadUInt32();
-					hdrFile.Seek((long)descriptorOffset + commonHeader.CabDescriptorOffset, SeekOrigin.Begin);
-
-					fileGroups.Add(new FileGroup(hdrFile, commonHeader.CabDescriptorOffset));
-				}
-			}
-
-			hdrFile.Seek(commonHeader.CabDescriptorOffset + cabDescriptor.FileTableOffset + cabDescriptor.FileTableOffset2, SeekOrigin.Begin);
-			foreach (var fileGroup in fileGroups)
-			{
-				for (var index = fileGroup.FirstFile; index <= fileGroup.LastFile; ++index)
-				{
-					AddFileDescriptorToList(index);
-					var fileDescriptor = fileDescriptors[index];
-					var fullFilePath   = "{0}\\{1}\\{2}".F(fileGroup.Name, DirectoryName((uint)fileDescriptor.DirectoryIndex), fileDescriptor.Filename);
-					fileLookup.Add(fullFilePath, index);
-				}
-			}
-		}
-
-		public string DirectoryName(uint index)
-		{
-			if (directoryNames.ContainsKey(index))
-				return directoryNames[index];
-
-			hdrFile.Seek(commonHeader.CabDescriptorOffset +
-					cabDescriptor.FileTableOffset +
-					directoryTable[(int)index],
-					SeekOrigin.Begin);
-
-			var test = hdrFile.ReadASCIIZ();
-			return test;
-		}
-
-		public bool Exists(string filename)
-		{
-			return fileLookup.ContainsKey(filename);
-		}
-
-		public uint DirectoryCount()
-		{
-			return cabDescriptor.DirectoryCount;
-		}
-
-		public string FileName(uint index)
-		{
-			if (!fileDescriptors.ContainsKey(index))
-				AddFileDescriptorToList(index);
-
-			return fileDescriptors[index].Filename;
-		}
-
-		void AddFileDescriptorToList(uint index)
-		{
-			hdrFile.Seek(commonHeader.CabDescriptorOffset +
-					cabDescriptor.FileTableOffset +
-					cabDescriptor.FileTableOffset2 +
-					index * 0x57,
-					SeekOrigin.Begin);
-
-			var fd = new FileDescriptor(hdrFile,
-				commonHeader.CabDescriptorOffset + cabDescriptor.FileTableOffset);
-
-			fileDescriptors.Add(index, fd);
-		}
-
-		public uint FileCount()
-		{
-			return cabDescriptor.FileCount;
-		}
-
-		public void ExtractFile(uint index, string fileName)
-		{
-			using (var destfile = File.Open(fileName, FileMode.Create))
-				GetContentById(index, destfile);
-		}
-
-		public void Write(Dictionary<string, byte[]> input)
-		{
-			throw new NotImplementedException("Cannot Add Files To Cab");
-		}
-
-		public IEnumerable<uint> ClassicHashes()
-		{
-			return fileLookup.Keys.Select(k => PackageEntry.HashFilename(k, PackageHashType.Classic));
-		}
-
-		public Stream GetContentById(uint index)
-		{
-			var fileDes = fileDescriptors[index];
-			if ((fileDes.Flags & FileInvalid) != 0)
-				throw new Exception("File Invalid");
-
-			if ((fileDes.LinkFlags & LinkPrev) != 0)
-				return GetContentById(fileDes.LinkToPrevious);
-
-			if ((fileDes.Flags & FileObfuscated) != 0)
-				throw new NotImplementedException("Haven't implemented obfustcated files");
-
-			var output = new MemoryStream((int)fileDes.ExpandedSize);
-
-			using (var reader = new CabReader(fileDes, index, commonName))
-				reader.CopyTo(output);
-
-			if (output.Length != fileDes.ExpandedSize)
-				throw new Exception("Did not fully extract Expected = {0}, Got = {1}".F(fileDes.ExpandedSize, output.Length));
-
-			output.Position = 0;
-			return output;
-		}
-
-		public void GetContentById(uint index, Stream output)
-		{
-			var fileDes = fileDescriptors[index];
-			if ((fileDes.Flags & FileInvalid) != 0)
-				throw new Exception("File Invalid");
-
-			if ((fileDes.LinkFlags & LinkPrev) != 0)
-			{
-				GetContentById(fileDes.LinkToPrevious, output);
-				return;
-			}
-
-			if ((fileDes.Flags & FileObfuscated) != 0)
-				throw new NotImplementedException("Haven't implemented obfustcated files");
-
-			using (var reader = new CabReader(fileDes, index, commonName))
-				reader.CopyTo(output);
-
-			if (output.Length != fileDes.ExpandedSize)
-				throw new Exception("Did not fully extract Expected = {0}, Got = {1}".F(fileDes.ExpandedSize, output.Length));
-		}
-
-		public Stream GetContent(string fileName)
-		{
-			return GetContentById(fileLookup[fileName]);
-		}
-
-		public IEnumerable<uint> CrcHashes()
-		{
-			yield break;
-		}
-
-		public IEnumerable<string> AllFileNames()
-		{
-			return fileLookup.Keys;
-		}
-
-		public void Dispose()
-		{
-			hdrFile.Dispose();
-		}
-	}
-}

OpenRA.Game/FileSystem/InstallShieldPackage.cs

@@ -1,158 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-using OpenRA.FileFormats;
-
-namespace OpenRA.FileSystem
-{
-	public sealed class InstallShieldPackage : IFolder
-	{
-		readonly Dictionary<uint, PackageEntry> index = new Dictionary<uint, PackageEntry>();
-		readonly List<string> filenames;
-		readonly Stream s;
-		readonly long dataStart = 255;
-		readonly int priority;
-		readonly string filename;
-
-		public InstallShieldPackage(string filename, int priority)
-		{
-			this.filename = filename;
-			this.priority = priority;
-
-			filenames = new List<string>();
-
-			s = GlobalFileSystem.Open(filename);
-			try
-			{
-				// Parse package header
-				var reader = new BinaryReader(s);
-				var signature = reader.ReadUInt32();
-				if (signature != 0x8C655D13)
-					throw new InvalidDataException("Not an Installshield package");
-
-				reader.ReadBytes(8);
-				/*var FileCount = */reader.ReadUInt16();
-				reader.ReadBytes(4);
-				/*var ArchiveSize = */reader.ReadUInt32();
-				reader.ReadBytes(19);
-				var tocAddress = reader.ReadInt32();
-				reader.ReadBytes(4);
-				var dirCount = reader.ReadUInt16();
-
-				// Parse the directory list
-				s.Seek(tocAddress, SeekOrigin.Begin);
-				var tocReader = new BinaryReader(s);
-
-				var fileCountInDirs = new List<uint>();
-
-				// Parse directories
-				for (var i = 0; i < dirCount; i++)
-					fileCountInDirs.Add(ParseDirectory(tocReader));
-
-				// Parse files
-				foreach (var fileCount in fileCountInDirs)
-					for (var i = 0; i < fileCount; i++)
-						ParseFile(reader);
-			}
-			catch
-			{
-				Dispose();
-				throw;
-			}
-		}
-
-		static uint ParseDirectory(BinaryReader reader)
-		{
-			// Parse directory header
-			var fileCount = reader.ReadUInt16();
-			var chunkSize = reader.ReadUInt16();
-			var nameLength = reader.ReadUInt16();
-			reader.ReadChars(nameLength); // var DirName = new String(reader.ReadChars(NameLength));
-
-			// Skip to the end of the chunk
-			reader.ReadBytes(chunkSize - nameLength - 6);
-			return fileCount;
-		}
-
-		uint accumulatedData = 0;
-		void ParseFile(BinaryReader reader)
-		{
-			reader.ReadBytes(7);
-			var compressedSize = reader.ReadUInt32();
-			reader.ReadBytes(12);
-			var chunkSize = reader.ReadUInt16();
-			reader.ReadBytes(4);
-			var nameLength = reader.ReadByte();
-			var fileName = new string(reader.ReadChars(nameLength));
-
-			var hash = PackageEntry.HashFilename(fileName, PackageHashType.Classic);
-			if (!index.ContainsKey(hash))
-				index.Add(hash, new PackageEntry(hash, accumulatedData, compressedSize));
-			filenames.Add(fileName);
-			accumulatedData += compressedSize;
-
-			// Skip to the end of the chunk
-			reader.ReadBytes(chunkSize - nameLength - 30);
-		}
-
-		public Stream GetContent(uint hash)
-		{
-			PackageEntry e;
-			if (!index.TryGetValue(hash, out e))
-				return null;
-
-			s.Seek(dataStart + e.Offset, SeekOrigin.Begin);
-			var data = s.ReadBytes((int)e.Length);
-
-			return new MemoryStream(Blast.Decompress(data));
-		}
-
-		public Stream GetContent(string filename)
-		{
-			return GetContent(PackageEntry.HashFilename(filename, PackageHashType.Classic));
-		}
-
-		public IEnumerable<uint> ClassicHashes()
-		{
-			return index.Keys;
-		}
-
-		public IEnumerable<uint> CrcHashes()
-		{
-			yield break;
-		}
-
-		public IEnumerable<string> AllFileNames()
-		{
-			return filenames;
-		}
-
-		public bool Exists(string filename)
-		{
-			return index.ContainsKey(PackageEntry.HashFilename(filename, PackageHashType.Classic));
-		}
-
-		public int Priority { get { return 2000 + priority; } }
-		public string Name { get { return filename; } }
-
-		public void Write(Dictionary<string, byte[]> contents)
-		{
-			throw new NotImplementedException("Cannot save InstallShieldPackages.");
-		}
-
-		public void Dispose()
-		{
-			s.Dispose();
-		}
-	}
-}

OpenRA.Game/FileSystem/MixFile.cs

@@ -1,290 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.IO;
-using System.Linq;
-using OpenRA.FileFormats;
-
-namespace OpenRA.FileSystem
-{
-	public sealed class MixFile : IFolder
-	{
-		readonly Dictionary<uint, PackageEntry> index;
-		readonly long dataStart;
-		readonly Stream s;
-		readonly int priority;
-		readonly string filename;
-		readonly PackageHashType type;
-
-		// Save a mix to disk with the given contents
-		public MixFile(string filename, int priority, Dictionary<string, byte[]> contents)
-		{
-			this.filename = filename;
-			this.priority = priority;
-			this.type = PackageHashType.Classic;
-
-			if (File.Exists(filename))
-				File.Delete(filename);
-
-			s = File.Create(filename);
-			try
-			{
-				index = new Dictionary<uint, PackageEntry>();
-				contents.Add("local mix database.dat", new XccLocalDatabase(contents.Keys.Append("local mix database.dat")).Data());
-				Write(contents);
-			}
-			catch
-			{
-				Dispose();
-				throw;
-			}
-		}
-
-		public MixFile(string filename, PackageHashType type, int priority)
-		{
-			this.filename = filename;
-			this.priority = priority;
-			this.type = type;
-
-			s = GlobalFileSystem.Open(filename);
-			try
-			{
-				// Detect format type
-				var isCncMix = s.ReadUInt16() != 0;
-
-				// The C&C mix format doesn't contain any flags or encryption
-				var isEncrypted = false;
-				if (!isCncMix)
-					isEncrypted = (s.ReadUInt16() & 0x2) != 0;
-
-				List<PackageEntry> entries;
-				if (isEncrypted)
-				{
-					long unused;
-					entries = ParseHeader(DecryptHeader(s, 4, out dataStart), 0, out unused);
-				}
-				else
-					entries = ParseHeader(s, isCncMix ? 0 : 4, out dataStart);
-
-				index = entries.ToDictionaryWithConflictLog(x => x.Hash,
-					"{0} ({1} format, Encrypted: {2}, DataStart: {3})".F(filename, isCncMix ? "C&C" : "RA/TS/RA2", isEncrypted, dataStart),
-					null, x => "(offs={0}, len={1})".F(x.Offset, x.Length));
-			}
-			catch (Exception)
-			{
-				Dispose();
-				throw;
-			}
-		}
-
-		static List<PackageEntry> ParseHeader(Stream s, long offset, out long headerEnd)
-		{
-			s.Seek(offset, SeekOrigin.Begin);
-			var numFiles = s.ReadUInt16();
-			/*uint dataSize = */s.ReadUInt32();
-
-			var items = new List<PackageEntry>();
-			for (var i = 0; i < numFiles; i++)
-				items.Add(new PackageEntry(s));
-
-			headerEnd = offset + 6 + numFiles * PackageEntry.Size;
-			return items;
-		}
-
-		static MemoryStream DecryptHeader(Stream s, long offset, out long headerEnd)
-		{
-			s.Seek(offset, SeekOrigin.Begin);
-
-			// Decrypt blowfish key
-			var keyblock = s.ReadBytes(80);
-			var blowfishKey = new BlowfishKeyProvider().DecryptKey(keyblock);
-			var fish = new Blowfish(blowfishKey);
-
-			// Decrypt first block to work out the header length
-			var ms = Decrypt(ReadBlocks(s, offset + 80, 1), fish);
-			var numFiles = ms.ReadUInt16();
-
-			// Decrypt the full header - round bytes up to a full block
-			var blockCount = (13 + numFiles * PackageEntry.Size) / 8;
-			headerEnd = offset + 80 + blockCount * 8;
-
-			return Decrypt(ReadBlocks(s, offset + 80, blockCount), fish);
-		}
-
-		static MemoryStream Decrypt(uint[] h, Blowfish fish)
-		{
-			var decrypted = fish.Decrypt(h);
-
-			var ms = new MemoryStream();
-			var writer = new BinaryWriter(ms);
-			foreach (var t in decrypted)
-				writer.Write(t);
-			writer.Flush();
-
-			ms.Seek(0, SeekOrigin.Begin);
-			return ms;
-		}
-
-		static uint[] ReadBlocks(Stream s, long offset, int count)
-		{
-			if (offset < 0)
-				throw new ArgumentOutOfRangeException("offset", "Non-negative number required.");
-
-			if (count < 0)
-				throw new ArgumentOutOfRangeException("count", "Non-negative number required.");
-
-			if (offset + (count * 2) > s.Length)
-				throw new ArgumentException("Bytes to read {0} and offset {1} greater than stream length {2}.".F(count * 2, offset, s.Length));
-
-			s.Seek(offset, SeekOrigin.Begin);
-
-			// A block is a single encryption unit (represented as two 32-bit integers)
-			var ret = new uint[2 * count];
-			for (var i = 0; i < ret.Length; i++)
-				ret[i] = s.ReadUInt32();
-
-			return ret;
-		}
-
-		uint? FindMatchingHash(string filename)
-		{
-			var hash = PackageEntry.HashFilename(filename, type);
-			if (index.ContainsKey(hash))
-				return hash;
-
-			// Maybe we were given a raw hash?
-			uint raw;
-			if (!uint.TryParse(filename, NumberStyles.AllowHexSpecifier, CultureInfo.InvariantCulture, out raw))
-				return null;
-
-			if ("{0:X}".F(raw) == filename && index.ContainsKey(raw))
-				return raw;
-
-			return null;
-		}
-
-		public Stream GetContent(uint hash)
-		{
-			PackageEntry e;
-			if (!index.TryGetValue(hash, out e))
-				return null;
-
-			s.Seek(dataStart + e.Offset, SeekOrigin.Begin);
-			var data = s.ReadBytes((int)e.Length);
-			return new MemoryStream(data);
-		}
-
-		public Stream GetContent(string filename)
-		{
-			var hash = FindMatchingHash(filename);
-			return hash.HasValue ? GetContent(hash.Value) : null;
-		}
-
-		static readonly uint[] Nothing = { };
-		public IEnumerable<uint> ClassicHashes()
-		{
-			if (type == PackageHashType.Classic)
-				return index.Keys;
-
-			return Nothing;
-		}
-
-		public IEnumerable<uint> CrcHashes()
-		{
-			if (type == PackageHashType.CRC32)
-				return index.Keys;
-
-			return Nothing;
-		}
-
-		public IEnumerable<string> AllFileNames()
-		{
-			var lookup = new Dictionary<uint, string>();
-			if (Exists("local mix database.dat"))
-			{
-				var db = new XccLocalDatabase(GetContent("local mix database.dat"));
-				foreach (var e in db.Entries)
-				{
-					var hash = PackageEntry.HashFilename(e, type);
-					if (!lookup.ContainsKey(hash))
-						lookup.Add(hash, e);
-				}
-			}
-
-			if (GlobalFileSystem.Exists("global mix database.dat"))
-			{
-				var db = new XccGlobalDatabase(GlobalFileSystem.Open("global mix database.dat"));
-				foreach (var e in db.Entries)
-				{
-					var hash = PackageEntry.HashFilename(e, type);
-					if (!lookup.ContainsKey(hash))
-						lookup.Add(hash, e);
-				}
-			}
-
-			return index.Keys.Select(k => lookup.ContainsKey(k) ? lookup[k] : "{0:X}".F(k));
-		}
-
-		public bool Exists(string filename)
-		{
-			return FindMatchingHash(filename).HasValue;
-		}
-
-		public int Priority { get { return 1000 + priority; } }
-		public string Name { get { return filename; } }
-
-		public void Write(Dictionary<string, byte[]> contents)
-		{
-			// Cannot modify existing mixfile - rename existing file and
-			// create a new one with original content plus modifications
-			GlobalFileSystem.Unmount(this);
-
-			// TODO: Add existing data to the contents list
-			if (index.Count > 0)
-				throw new NotImplementedException("Updating mix files unfinished");
-
-			// Construct a list of entries for the file header
-			uint dataSize = 0;
-			var items = new List<PackageEntry>();
-			foreach (var kv in contents)
-			{
-				var length = (uint)kv.Value.Length;
-				var hash = PackageEntry.HashFilename(Path.GetFileName(kv.Key), type);
-				items.Add(new PackageEntry(hash, dataSize, length));
-				dataSize += length;
-			}
-
-			// Write the new file
-			s.Seek(0, SeekOrigin.Begin);
-			using (var writer = new BinaryWriter(s))
-			{
-				// Write file header
-				writer.Write((ushort)items.Count);
-				writer.Write(dataSize);
-				foreach (var item in items)
-					item.Write(writer);
-
-				writer.Flush();
-
-				// Copy file data
-				foreach (var file in contents)
-					s.Write(file.Value);
-			}
-		}
-
-		public void Dispose()
-		{
-			s.Dispose();
-		}
-	}
-}

OpenRA.Game/FileSystem/PackageEntry.cs

@@ -1,110 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Text;
-using OpenRA.FileFormats;
-
-namespace OpenRA.FileSystem
-{
-	public enum PackageHashType { Classic, CRC32 }
-
-	public class PackageEntry
-	{
-		public const int Size = 12;
-		public readonly uint Hash;
-		public readonly uint Offset;
-		public readonly uint Length;
-
-		public PackageEntry(uint hash, uint offset, uint length)
-		{
-			Hash = hash;
-			Offset = offset;
-			Length = length;
-		}
-
-		public PackageEntry(Stream s)
-		{
-			Hash = s.ReadUInt32();
-			Offset = s.ReadUInt32();
-			Length = s.ReadUInt32();
-		}
-
-		public void Write(BinaryWriter w)
-		{
-			w.Write(Hash);
-			w.Write(Offset);
-			w.Write(Length);
-		}
-
-		public override string ToString()
-		{
-			string filename;
-			if (names.TryGetValue(Hash, out filename))
-				return "{0} - offset 0x{1:x8} - length 0x{2:x8}".F(filename, Offset, Length);
-			else
-				return "0x{0:x8} - offset 0x{1:x8} - length 0x{2:x8}".F(Hash, Offset, Length);
-		}
-
-		public static uint HashFilename(string name, PackageHashType type)
-		{
-			switch (type)
-			{
-				case PackageHashType.Classic:
-					{
-						name = name.ToUpperInvariant();
-						if (name.Length % 4 != 0)
-							name = name.PadRight(name.Length + (4 - name.Length % 4), '\0');
-
-						using (var ms = new MemoryStream(Encoding.ASCII.GetBytes(name)))
-						{
-							var len = name.Length >> 2;
-							uint result = 0;
-
-							while (len-- != 0)
-								result = ((result << 1) | (result >> 31)) + ms.ReadUInt32();
-
-							return result;
-						}
-					}
-
-				case PackageHashType.CRC32:
-					{
-						name = name.ToUpperInvariant();
-						var l = name.Length;
-						var a = l >> 2;
-						if ((l & 3) != 0)
-						{
-							name += (char)(l - (a << 2));
-							var i = 3 - (l & 3);
-							while (i-- != 0)
-								name += name[a << 2];
-						}
-
-						return CRC32.Calculate(Encoding.ASCII.GetBytes(name));
-					}
-
-				default: throw new NotImplementedException("Unknown hash type `{0}`".F(type));
-			}
-		}
-
-		static Dictionary<uint, string> names = new Dictionary<uint, string>();
-
-		public static void AddStandardName(string s)
-		{
-			var hash = HashFilename(s, PackageHashType.Classic); // RA1 and TD
-			names.Add(hash, s);
-			var crcHash = HashFilename(s, PackageHashType.CRC32); // TS
-			names.Add(crcHash, s);
-		}
-	}
-}

OpenRA.Game/FileSystem/Pak.cs

@@ -1,109 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-
-namespace OpenRA.FileSystem
-{
-	struct Entry
-	{
-		public uint Offset;
-		public uint Length;
-		public string Filename;
-	}
-
-	public sealed class PakFile : IFolder
-	{
-		readonly string filename;
-		readonly int priority;
-		readonly Dictionary<string, Entry> index;
-		readonly Stream stream;
-
-		public PakFile(string filename, int priority)
-		{
-			this.filename = filename;
-			this.priority = priority;
-			index = new Dictionary<string, Entry>();
-
-			stream = GlobalFileSystem.Open(filename);
-			try
-			{
-				index = new Dictionary<string, Entry>();
-				var offset = stream.ReadUInt32();
-				while (offset != 0)
-				{
-					var file = stream.ReadASCIIZ();
-					var next = stream.ReadUInt32();
-					var length = (next == 0 ? (uint)stream.Length : next) - offset;
-
-					// Ignore duplicate files
-					if (index.ContainsKey(file))
-						continue;
-
-					index.Add(file, new Entry { Offset = offset, Length = length, Filename = file });
-					offset = next;
-				}
-			}
-			catch
-			{
-				Dispose();
-				throw;
-			}
-		}
-
-		public Stream GetContent(string filename)
-		{
-			Entry entry;
-			if (!index.TryGetValue(filename, out entry))
-				return null;
-
-			stream.Seek(entry.Offset, SeekOrigin.Begin);
-			var data = stream.ReadBytes((int)entry.Length);
-			return new MemoryStream(data);
-		}
-
-		public IEnumerable<uint> ClassicHashes()
-		{
-			foreach (var filename in index.Keys)
-				yield return PackageEntry.HashFilename(filename, PackageHashType.Classic);
-		}
-
-		public IEnumerable<uint> CrcHashes()
-		{
-			yield break;
-		}
-
-		public IEnumerable<string> AllFileNames()
-		{
-			foreach (var filename in index.Keys)
-				yield return filename;
-		}
-
-		public bool Exists(string filename)
-		{
-			return index.ContainsKey(filename);
-		}
-
-		public void Write(Dictionary<string, byte[]> contents)
-		{
-			throw new NotImplementedException("Cannot save Pak archives.");
-		}
-
-		public int Priority { get { return 1000 + priority; } }
-		public string Name { get { return filename; } }
-
-		public void Dispose()
-		{
-			stream.Dispose();
-		}
-	}
-}

OpenRA.Game/FileSystem/ZipFile.cs

@@ -1,134 +1,237 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Text;
+using System.Linq;
 using ICSharpCode.SharpZipLib.Zip;
-using SZipFile = ICSharpCode.SharpZipLib.Zip.ZipFile;
 
 namespace OpenRA.FileSystem
 {
-	public sealed class ZipFile : IFolder
+	public class ZipFileLoader : IPackageLoader
 	{
-		readonly string filename;
-		readonly int priority;
-		SZipFile pkg;
+		static readonly string[] Extensions = { ".zip", ".oramap" };
 
-		static ZipFile()
+		class ReadOnlyZipFile : IReadOnlyPackage
 		{
-			ZipConstants.DefaultCodePage = Encoding.Default.CodePage;
-		}
+			public string Name { get; protected set; }
+			protected ZipFile pkg;
 
-		public ZipFile(string filename, int priority)
-		{
-			this.filename = filename;
-			this.priority = priority;
-			try
+			// Dummy constructor for use with ReadWriteZipFile
+			protected ReadOnlyZipFile() { }
+
+			public ReadOnlyZipFile(Stream s, string filename)
 			{
-				// pull the file into memory, dont keep it open.
-				pkg = new SZipFile(new MemoryStream(File.ReadAllBytes(filename)));
+				Name = filename;
+				pkg = new ZipFile(s);
 			}
-			catch (ZipException e)
+
+			public Stream GetStream(string filename)
 			{
-				Log.Write("debug", "Couldn't load zip file: {0}", e.Message);
+				var entry = pkg.GetEntry(filename);
+				if (entry == null)
+					return null;
+
+				using (var z = pkg.GetInputStream(entry))
+				{
+					var ms = new MemoryStream((int)entry.Size);
+					z.CopyTo(ms);
+					ms.Seek(0, SeekOrigin.Begin);
+					return ms;
+				}
 			}
-		}
 
-		// Create a new zip with the specified contents
-		public ZipFile(string filename, int priority, Dictionary<string, byte[]> contents)
-		{
-			this.priority = priority;
-			this.filename = filename;
+			public IEnumerable<string> Contents
+			{
+				get
+				{
+					foreach (ZipEntry entry in pkg)
+						if (entry.IsFile)
+							yield return entry.Name;
+				}
+			}
 
-			if (File.Exists(filename))
-				File.Delete(filename);
+			public bool Contains(string filename)
+			{
+				return pkg.GetEntry(filename) != null;
+			}
 
-			pkg = SZipFile.Create(filename);
-			Write(contents);
-		}
+			public void Dispose()
+			{
+				pkg?.Close();
+			}
 
-		public Stream GetContent(string filename)
-		{
-			var entry = pkg.GetEntry(filename);
-			if (entry == null)
+			public IReadOnlyPackage OpenPackage(string filename, FileSystem context)
+			{
+				// Directories are stored with a trailing "/" in the index
+				var entry = pkg.GetEntry(filename) ?? pkg.GetEntry(filename + "/");
+				if (entry == null)
+					return null;
+
+				if (entry.IsDirectory)
+					return new ZipFolder(this, filename);
+
+				// Other package types can be loaded normally
+				var s = GetStream(filename);
+				if (s == null)
+					return null;
+
+				if (context.TryParsePackage(s, filename, out var package))
+					return package;
+
+				s.Dispose();
 				return null;
-
-			using (var z = pkg.GetInputStream(entry))
-			{
-				var ms = new MemoryStream();
-				z.CopyTo(ms);
-				ms.Seek(0, SeekOrigin.Begin);
-				return ms;
 			}
 		}
 
-		public IEnumerable<uint> ClassicHashes()
+		sealed class ReadWriteZipFile : ReadOnlyZipFile, IReadWritePackage
 		{
-			foreach (ZipEntry entry in pkg)
-				yield return PackageEntry.HashFilename(entry.Name, PackageHashType.Classic);
+			readonly MemoryStream pkgStream = new MemoryStream();
+
+			public ReadWriteZipFile(string filename, bool create = false)
+			{
+				// SharpZipLib breaks when asked to update archives loaded from outside streams or files
+				// We can work around this by creating a clean in-memory-only file, cutting all outside references
+				if (!create)
+				{
+					using (var copy = new MemoryStream(File.ReadAllBytes(filename)))
+					{
+						pkgStream.Capacity = (int)copy.Length;
+						copy.CopyTo(pkgStream);
+					}
+				}
+
+				pkgStream.Position = 0;
+				pkg = new ZipFile(pkgStream);
+				Name = filename;
+			}
+
+			void Commit()
+			{
+				var pos = pkgStream.Position;
+				pkgStream.Position = 0;
+				File.WriteAllBytes(Name, pkgStream.ReadBytes((int)pkgStream.Length));
+				pkgStream.Position = pos;
+			}
+
+			public void Update(string filename, byte[] contents)
+			{
+				pkg.BeginUpdate();
+				pkg.Add(new StaticStreamDataSource(new MemoryStream(contents)), filename);
+				pkg.CommitUpdate();
+				Commit();
+			}
+
+			public void Delete(string filename)
+			{
+				pkg.BeginUpdate();
+				pkg.Delete(filename);
+				pkg.CommitUpdate();
+				Commit();
+			}
 		}
 
-		public IEnumerable<uint> CrcHashes()
+		sealed class ZipFolder : IReadOnlyPackage
 		{
-			yield break;
+			public string Name => path;
+			public ReadOnlyZipFile Parent { get; }
+			readonly string path;
+
+			public ZipFolder(ReadOnlyZipFile parent, string path)
+			{
+				if (path.EndsWith("/", StringComparison.Ordinal))
+					path = path.Substring(0, path.Length - 1);
+
+				Parent = parent;
+				this.path = path;
+			}
+
+			public Stream GetStream(string filename)
+			{
+				// Zip files use '/' as a path separator
+				return Parent.GetStream(path + '/' + filename);
+			}
+
+			public IEnumerable<string> Contents
+			{
+				get
+				{
+					foreach (var entry in Parent.Contents)
+					{
+						if (entry.StartsWith(path, StringComparison.Ordinal) && entry != path)
+						{
+							var filename = entry.Substring(path.Length + 1);
+							var dirLevels = filename.Split('/').Count(c => !string.IsNullOrEmpty(c));
+							if (dirLevels == 1)
+								yield return filename;
+						}
+					}
+				}
+			}
+
+			public bool Contains(string filename)
+			{
+				return Parent.Contains(path + '/' + filename);
+			}
+
+			public IReadOnlyPackage OpenPackage(string filename, FileSystem context)
+			{
+				return Parent.OpenPackage(path + '/' + filename, context);
+			}
+
+			public void Dispose() { /* nothing to do */ }
 		}
 
-		public IEnumerable<string> AllFileNames()
+		class StaticStreamDataSource : IStaticDataSource
 		{
-			foreach (ZipEntry entry in pkg)
-				yield return entry.Name;
+			readonly Stream s;
+			public StaticStreamDataSource(Stream s)
+			{
+				this.s = s;
+			}
+
+			public Stream GetSource()
+			{
+				return s;
+			}
 		}
 
-		public bool Exists(string filename)
+		public bool TryParsePackage(Stream s, string filename, FileSystem context, out IReadOnlyPackage package)
 		{
-			return pkg.GetEntry(filename) != null;
+			if (!Extensions.Any(e => filename.EndsWith(e, StringComparison.InvariantCultureIgnoreCase)))
+			{
+				package = null;
+				return false;
+			}
+
+			package = new ReadOnlyZipFile(s, filename);
+			return true;
 		}
 
-		public int Priority { get { return 500 + priority; } }
-		public string Name { get { return filename; } }
-
-		public void Write(Dictionary<string, byte[]> contents)
+		public static bool TryParseReadWritePackage(string filename, out IReadWritePackage package)
 		{
-			// TODO: Clear existing content?
-			pkg.Close();
-			pkg = SZipFile.Create(filename);
-			pkg.BeginUpdate();
+			if (!Extensions.Any(e => filename.EndsWith(e, StringComparison.InvariantCultureIgnoreCase)))
+			{
+				package = null;
+				return false;
+			}
 
-			foreach (var kvp in contents)
-				pkg.Add(new StaticMemoryDataSource(kvp.Value), kvp.Key);
-
-			pkg.CommitUpdate();
-			pkg.Close();
-			pkg = new SZipFile(new MemoryStream(File.ReadAllBytes(filename)));
+			package = new ReadWriteZipFile(filename);
+			return true;
 		}
 
-		public void Dispose()
+		public static IReadWritePackage Create(string filename)
 		{
-			if (pkg != null)
-				pkg.Close();
-		}
-	}
-
-	class StaticMemoryDataSource : IStaticDataSource
-	{
-		byte[] data;
-		public StaticMemoryDataSource(byte[] data)
-		{
-			this.data = data;
-		}
-
-		public Stream GetSource()
-		{
-			return new MemoryStream(data);
+			return new ReadWriteZipFile(filename, true);
 		}
 	}
 }

OpenRA.Game/Fonts.cs

@@ -0,0 +1,37 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System.Collections.Generic;
+
+namespace OpenRA
+{
+	public class FontData
+	{
+		public readonly string Font;
+		public readonly int Size;
+		public readonly int Ascender;
+	}
+
+	public class Fonts : IGlobalModData
+	{
+		[FieldLoader.LoadUsing(nameof(LoadFonts))]
+		public readonly Dictionary<string, FontData> FontList;
+
+		static object LoadFonts(MiniYaml y)
+		{
+			var ret = new Dictionary<string, FontData>();
+			foreach (var node in y.Nodes)
+				ret.Add(node.Key, FieldLoader.Load<FontData>(node.Value));
+
+			return ret;
+		}
+	}
+}

OpenRA.Game/GameInformation.cs

@@ -1,18 +1,19 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using OpenRA.Graphics;
 using OpenRA.Network;
+using OpenRA.Primitives;
 
 namespace OpenRA
 {
@@ -23,21 +24,24 @@ namespace OpenRA
 
 		public string MapUid;
 		public string MapTitle;
+		public int FinalGameTick;
 
+		/// <summary>Game start timestamp (when the recoding started).</summary>
 		public DateTime StartTimeUtc;
 
-		// Game end timestamp (when the recoding stopped).
+		/// <summary>Game end timestamp (when the recoding stopped).</summary>
 		public DateTime EndTimeUtc;
 
-		// Gets the game's duration, from the time the game started until the
-		// replay recording stopped.
-		public TimeSpan Duration { get { return EndTimeUtc > StartTimeUtc ? EndTimeUtc - StartTimeUtc : TimeSpan.Zero; } }
-		public IList<Player> Players { get; private set; }
-		public MapPreview MapPreview { get { return Game.ModData.MapCache[MapUid]; } }
-		public IEnumerable<Player> HumanPlayers { get { return Players.Where(p => p.IsHuman); } }
-		public bool IsSinglePlayer { get { return HumanPlayers.Count() == 1; } }
+		/// <summary>Gets the game's duration, from the time the game started until the replay recording stopped.</summary>
+		public TimeSpan Duration => EndTimeUtc > StartTimeUtc ? EndTimeUtc - StartTimeUtc : TimeSpan.Zero;
 
-		Dictionary<OpenRA.Player, Player> playersByRuntime;
+		public IList<Player> Players { get; }
+		public HashSet<int> DisabledSpawnPoints = new HashSet<int>();
+		public MapPreview MapPreview => Game.ModData.MapCache[MapUid];
+		public IEnumerable<Player> HumanPlayers { get { return Players.Where(p => p.IsHuman); } }
+		public bool IsSinglePlayer => HumanPlayers.Count() == 1;
+
+		readonly Dictionary<OpenRA.Player, Player> playersByRuntime;
 
 		public GameInformation()
 		{
@@ -70,33 +74,34 @@ namespace OpenRA
 
 				return info;
 			}
-			catch (InvalidOperationException)
+			catch (YamlException)
 			{
-				Log.Write("debug", "GameInformation deserialized invalid MiniYaml:\n{0}".F(data));
+				Log.Write("debug", $"GameInformation deserialized invalid MiniYaml:\n{data}");
 				throw;
 			}
 		}
 
 		public string Serialize()
 		{
-			var nodes = new List<MiniYamlNode>();
-
-			nodes.Add(new MiniYamlNode("Root", FieldSaver.Save(this)));
+			var nodes = new List<MiniYamlNode>
+			{
+				new MiniYamlNode("Root", FieldSaver.Save(this))
+			};
 
 			for (var i = 0; i < Players.Count; i++)
-				nodes.Add(new MiniYamlNode("Player@{0}".F(i), FieldSaver.Save(Players[i])));
+				nodes.Add(new MiniYamlNode($"Player@{i}", FieldSaver.Save(Players[i])));
 
 			return nodes.WriteToString();
 		}
 
-		// Adds the player information at start-up.
+		/// <summary>Adds the player information at start-up.</summary>
 		public void AddPlayer(OpenRA.Player runtimePlayer, Session lobbyInfo)
 		{
 			if (runtimePlayer == null)
-				throw new ArgumentNullException("runtimePlayer");
+				throw new ArgumentNullException(nameof(runtimePlayer));
 
 			if (lobbyInfo == null)
-				throw new ArgumentNullException("lobbyInfo");
+				throw new ArgumentNullException(nameof(lobbyInfo));
 
 			// We don't care about spectators and map players
 			if (runtimePlayer.NonCombatant || !runtimePlayer.Playable)
@@ -115,61 +120,79 @@ namespace OpenRA
 				IsBot = runtimePlayer.IsBot,
 				FactionName = runtimePlayer.Faction.Name,
 				FactionId = runtimePlayer.Faction.InternalName,
+				DisplayFactionName = runtimePlayer.DisplayFaction.Name,
+				DisplayFactionId = runtimePlayer.DisplayFaction.InternalName,
 				Color = runtimePlayer.Color,
 				Team = client.Team,
+				Handicap = client.Handicap,
 				SpawnPoint = runtimePlayer.SpawnPoint,
-				IsRandomFaction = runtimePlayer.Faction.InternalName != client.Race,
-				IsRandomSpawnPoint = runtimePlayer.SpawnPoint != client.SpawnPoint
+				IsRandomFaction = runtimePlayer.Faction.InternalName != client.Faction,
+				IsRandomSpawnPoint = runtimePlayer.DisplaySpawnPoint == 0,
+				Fingerprint = client.Fingerprint
 			};
 
 			playersByRuntime.Add(runtimePlayer, player);
 			Players.Add(player);
 		}
 
-		// Gets the player information for the specified runtime player instance.
+		/// <summary>Gets the player information for the specified runtime player instance.</summary>
 		public Player GetPlayer(OpenRA.Player runtimePlayer)
 		{
-			Player player;
-
-			playersByRuntime.TryGetValue(runtimePlayer, out player);
+			playersByRuntime.TryGetValue(runtimePlayer, out var player);
 
 			return player;
 		}
 
 		public class Player
 		{
-			// Start-up information
+			#region Start-up information
+
 			public int ClientIndex;
 
-			// The player name, not guaranteed to be unique.
+			/// <summary>The player name, not guaranteed to be unique.</summary>
 			public string Name;
 			public bool IsHuman;
 			public bool IsBot;
 
-			// The faction name (aka Country)
+			/// <summary>The faction's display name.</summary>
 			public string FactionName;
 
-			// The faction id (aka Country, aka Race)
+			/// <summary>The faction ID, a.k.a. the faction's internal name.</summary>
 			public string FactionId;
-			public HSLColor Color;
+			public Color Color;
 
-			// The team id on start-up, or 0 if the player is not part of the team.
+			/// <summary>The faction (including Random, etc.) that was selected in the lobby.</summary>
+			public string DisplayFactionName;
+			public string DisplayFactionId;
+
+			/// <summary>The team ID on start-up, or 0 if the player is not part of a team.</summary>
 			public int Team;
 			public int SpawnPoint;
+			public int Handicap;
 
-			// True if the faction was chosen at random; otherwise, false
+			/// <summary>True if the faction was chosen at random; otherwise, false.</summary>
 			public bool IsRandomFaction;
 
-			// True if the spawn point was chosen at random; otherwise, false.</summary>
+			/// <summary>True if the spawn point was chosen at random; otherwise, false.</summary>
 			public bool IsRandomSpawnPoint;
 
-			// Information gathered at a later stage
+			/// <summary>Player authentication fingerprint for the OpenRA forum.</summary>
+			public string Fingerprint;
 
-			// The game outcome for this player
+			#endregion
+
+			#region
+
+			/// <summary>The game outcome for this player.</summary>
 			public WinState Outcome;
 
-			// The time when this player won or lost the game
+			/// <summary>The time when this player won or lost the game.</summary>
 			public DateTime OutcomeTimestampUtc;
+
+			/// <summary>The frame at which this player disconnected.</summary>
+			public int DisconnectFrame;
+
+			#endregion
 		}
 	}
 }

OpenRA.Game/GameRules/ActorInfo.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -21,90 +22,74 @@ namespace OpenRA
 	/// </summary>
 	public class ActorInfo
 	{
+		public const string AbstractActorPrefix = "^";
+		public const char TraitInstanceSeparator = '@';
+
 		/// <summary>
 		/// The actor name can be anything, but the sprites used in the Render*: traits default to this one.
 		/// If you add an ^ in front of the name, the engine will recognize this as a collection of traits
 		/// that can be inherited by others (using Inherits:) and not a real unit.
-		/// You can remove inherited traits by adding a - infront of them as in -TraitName: to inherit everything, but this trait.
+		/// You can remove inherited traits by adding a - in front of them as in -TraitName: to inherit everything, but this trait.
 		/// </summary>
 		public readonly string Name;
-		public readonly TypeDictionary Traits = new TypeDictionary();
-		List<ITraitInfo> constructOrderCache = null;
+		readonly TypeDictionary traits = new TypeDictionary();
+		List<TraitInfo> constructOrderCache = null;
 
-		public ActorInfo(string name, MiniYaml node, Dictionary<string, MiniYaml> allUnits)
+		public ActorInfo(ObjectCreator creator, string name, MiniYaml node)
 		{
 			try
 			{
-				var allParents = new HashSet<string>();
-				var abstractActorType = name.StartsWith("^");
-
-				// Guard against circular inheritance
-				allParents.Add(name);
-				var mergedNode = MergeWithParents(node, allUnits, allParents).ToDictionary();
-
 				Name = name;
 
-				foreach (var t in mergedNode)
+				foreach (var t in node.Nodes)
 				{
-					if (t.Key[0] == '-')
-						throw new YamlException("Bogus trait removal: " + t.Key);
-
-					if (t.Key != "Inherits" && !t.Key.StartsWith("Inherits@"))
-						try
-						{
-							Traits.Add(LoadTraitInfo(t.Key.Split('@')[0], t.Value));
-						}
-						catch (FieldLoader.MissingFieldsException e)
-						{
-							if (!abstractActorType)
-								throw new YamlException(e.Message);
-						}
+					try
+					{
+						// HACK: The linter does not want to crash when a trait doesn't exist but only print an error instead
+						// LoadTraitInfo will only return null to signal us to abort here if the linter is running
+						var trait = LoadTraitInfo(creator, t.Key, t.Value);
+						if (trait != null)
+							traits.Add(trait);
+					}
+					catch (FieldLoader.MissingFieldsException e)
+					{
+						throw new YamlException(e.Message);
+					}
 				}
+
+				traits.TrimExcess();
 			}
 			catch (YamlException e)
 			{
-				throw new YamlException("Actor type {0}: {1}".F(name, e.Message));
+				throw new YamlException($"Actor type {name}: {e.Message}");
 			}
 		}
 
-		static Dictionary<string, MiniYaml> GetParents(MiniYaml node, Dictionary<string, MiniYaml> allUnits)
+		public ActorInfo(string name, params TraitInfo[] traitInfos)
 		{
-			return node.Nodes.Where(n => n.Key == "Inherits" || n.Key.StartsWith("Inherits@"))
-				.ToDictionary(n => n.Value.Value, n =>
-			{
-				MiniYaml i;
-					if (!allUnits.TryGetValue(n.Value.Value, out i))
-						throw new YamlException(
-							"Bogus inheritance -- parent type {0} does not exist".F(n.Value.Value));
-
-				return i;
-			});
+			Name = name;
+			foreach (var t in traitInfos)
+				traits.Add(t);
+			traits.TrimExcess();
 		}
 
-		static MiniYaml MergeWithParents(MiniYaml node, Dictionary<string, MiniYaml> allUnits, HashSet<string> allParents)
-		{
-			var parents = GetParents(node, allUnits);
-
-			foreach (var kv in parents)
-			{
-				if (!allParents.Add(kv.Key))
-					throw new YamlException(
-						"Bogus inheritance -- duplicate inheritance of {0}.".F(kv.Key));
-
-				node = MiniYaml.MergeStrict(node, MergeWithParents(kv.Value, allUnits, allParents));
-			}
-
-			return node;
-		}
-
-		static ITraitInfo LoadTraitInfo(string traitName, MiniYaml my)
+		static TraitInfo LoadTraitInfo(ObjectCreator creator, string traitName, MiniYaml my)
 		{
 			if (!string.IsNullOrEmpty(my.Value))
-				throw new YamlException("Junk value `{0}` on trait node {1}"
-				.F(my.Value, traitName));
-			var info = Game.CreateObject<ITraitInfo>(traitName + "Info");
+				throw new YamlException($"Junk value `{my.Value}` on trait node {traitName}");
+
+			// HACK: The linter does not want to crash when a trait doesn't exist but only print an error instead
+			// ObjectCreator will only return null to signal us to abort here if the linter is running
+			var traitInstance = traitName.Split(TraitInstanceSeparator);
+			var info = creator.CreateObject<TraitInfo>(traitInstance[0] + "Info");
+			if (info == null)
+				return null;
+
 			try
 			{
+				if (traitInstance.Length > 1)
+					info.GetType().GetField(nameof(info.InstanceName)).SetValue(info, traitInstance[1]);
+
 				FieldLoader.Load(info, my);
 			}
 			catch (FieldLoader.MissingFieldsException e)
@@ -116,25 +101,34 @@ namespace OpenRA
 			return info;
 		}
 
-		public IEnumerable<ITraitInfo> TraitsInConstructOrder()
+		public IEnumerable<TraitInfo> TraitsInConstructOrder()
 		{
 			if (constructOrderCache != null)
 				return constructOrderCache;
 
-			var source = Traits.WithInterface<ITraitInfo>().Select(i => new
+			var source = traits.WithInterface<TraitInfo>().Select(i => new
 			{
 				Trait = i,
 				Type = i.GetType(),
-				Dependencies = PrerequisitesOf(i).ToList()
+				Dependencies = PrerequisitesOf(i).ToList(),
+				OptionalDependencies = OptionalPrerequisitesOf(i).ToList()
 			}).ToList();
 
-			var resolved = source.Where(s => !s.Dependencies.Any()).ToList();
+			var resolved = source.Where(s => s.Dependencies.Count == 0 && s.OptionalDependencies.Count == 0).ToList();
 			var unresolved = source.Except(resolved);
 
 			var testResolve = new Func<Type, Type, bool>((a, b) => a == b || a.IsAssignableFrom(b));
-			var more = unresolved.Where(u => u.Dependencies.All(d => resolved.Exists(r => testResolve(d, r.Type))));
 
-			// Re-evaluate the vars above until sorted
+			// This query detects which unresolved traits can be immediately resolved as all their direct dependencies are met.
+			var more = unresolved.Where(u =>
+				u.Dependencies.All(d => // To be resolvable, all dependencies must be satisfied according to the following conditions:
+					resolved.Exists(r => testResolve(d, r.Type)) && // There must exist a resolved trait that meets the dependency.
+					!unresolved.Any(u1 => testResolve(d, u1.Type))) && // All matching traits that meet this dependency must be resolved first.
+				u.OptionalDependencies.All(d => // To be resolvable, all optional dependencies must be satisfied according to the following condition:
+					!unresolved.Any(u1 => testResolve(d, u1.Type)))); // All matching traits that meet this optional dependencies must be resolved first.
+
+			// Continue resolving traits as long as possible.
+			// Each time we resolve some traits, this means dependencies for other traits may then be possible to satisfy in the next pass.
 			while (more.Any())
 				resolved.AddRange(more);
 
@@ -151,17 +145,19 @@ namespace OpenRA
 				foreach (var u in unresolved)
 				{
 					var deps = u.Dependencies.Where(d => !resolved.Exists(r => r.Type == d));
-					exceptionString += u.Type + ": { " + string.Join(", ", deps) + " }\r\n";
+					var optDeps = u.OptionalDependencies.Where(d => !resolved.Exists(r => r.Type == d));
+					var allDeps = string.Join(", ", deps.Select(o => o.ToString()).Concat(optDeps.Select(o => $"[{o}]")));
+					exceptionString += $"{u.Type}: {{ {allDeps} }}\r\n";
 				}
 
-				throw new Exception(exceptionString);
+				throw new YamlException(exceptionString);
 			}
 
 			constructOrderCache = resolved.Select(r => r.Trait).ToList();
 			return constructOrderCache;
 		}
 
-		static IEnumerable<Type> PrerequisitesOf(ITraitInfo info)
+		public static IEnumerable<Type> PrerequisitesOf(TraitInfo info)
 		{
 			return info
 				.GetType()
@@ -170,18 +166,27 @@ namespace OpenRA
 				.Select(t => t.GetGenericArguments()[0]);
 		}
 
-		public IEnumerable<Pair<string, Type>> GetInitKeys()
+		public static IEnumerable<Type> OptionalPrerequisitesOf(TraitInfo info)
 		{
-			var inits = Traits.WithInterface<ITraitInfo>().SelectMany(
-				t => t.GetType().GetInterfaces()
-					.Where(i => i.IsGenericType && i.GetGenericTypeDefinition() == typeof(UsesInit<>))
-					.Select(i => i.GetGenericArguments()[0])).ToList();
+			return info
+				.GetType()
+				.GetInterfaces()
+				.Where(t => t.IsGenericType && t.GetGenericTypeDefinition() == typeof(NotBefore<>))
+				.Select(t => t.GetGenericArguments()[0]);
+		}
 
-			inits.Add(typeof(OwnerInit));		/* not exposed by a trait; this is used by the Actor itself */
+		public bool HasTraitInfo<T>() where T : ITraitInfoInterface { return traits.Contains<T>(); }
+		public T TraitInfo<T>() where T : ITraitInfoInterface { return traits.Get<T>(); }
+		public T TraitInfoOrDefault<T>() where T : ITraitInfoInterface { return traits.GetOrDefault<T>(); }
+		public IEnumerable<T> TraitInfos<T>() where T : ITraitInfoInterface { return traits.WithInterface<T>(); }
 
-			return inits.Select(
-				i => Pair.New(
-					i.Name.Replace("Init", ""), i));
+		public BitSet<TargetableType> GetAllTargetTypes()
+		{
+			// PERF: Avoid LINQ.
+			var targetTypes = default(BitSet<TargetableType>);
+			foreach (var targetable in TraitInfos<ITargetableInfo>())
+				targetTypes = targetTypes.Union(targetable.GetTargetTypes());
+			return targetTypes;
 		}
 	}
 }

OpenRA.Game/GameRules/MusicInfo.cs

@@ -1,14 +1,14 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
-using OpenRA.FileFormats;
 using OpenRA.FileSystem;
 
 namespace OpenRA.GameRules
@@ -18,6 +18,7 @@ namespace OpenRA.GameRules
 		public readonly string Filename;
 		public readonly string Title;
 		public readonly bool Hidden;
+		public readonly float VolumeModifier = 1f;
 
 		public int Length { get; private set; } // seconds
 		public bool Exists { get; private set; }
@@ -30,34 +31,34 @@ namespace OpenRA.GameRules
 			if (nd.ContainsKey("Hidden"))
 				bool.TryParse(nd["Hidden"].Value, out Hidden);
 
+			if (nd.ContainsKey("VolumeModifier"))
+				VolumeModifier = FieldLoader.GetValue<float>("VolumeModifier", nd["VolumeModifier"].Value);
+
 			var ext = nd.ContainsKey("Extension") ? nd["Extension"].Value : "aud";
 			Filename = (nd.ContainsKey("Filename") ? nd["Filename"].Value : key) + "." + ext;
-
-			if (!GlobalFileSystem.Exists(Filename))
-				return;
-
-			Exists = true;
-			using (var s = GlobalFileSystem.Open(Filename))
-			{
-				if (Filename.ToLowerInvariant().EndsWith("wav"))
-					Length = (int)WavLoader.WaveLength(s);
-				else
-					Length = (int)AudLoader.SoundLength(s);
-			}
 		}
 
-		public void Reload()
+		public void Load(IReadOnlyFileSystem fileSystem)
 		{
-			if (!GlobalFileSystem.Exists(Filename))
+			if (!fileSystem.TryOpen(Filename, out var stream))
 				return;
 
-			Exists = true;
-			using (var s = GlobalFileSystem.Open(Filename))
+			try
 			{
-				if (Filename.ToLowerInvariant().EndsWith("wav"))
-					Length = (int)WavLoader.WaveLength(s);
-				else
-					Length = (int)AudLoader.SoundLength(s);
+				Exists = true;
+				foreach (var loader in Game.ModData.SoundLoaders)
+				{
+					if (loader.TryParseSound(stream, out var soundFormat))
+					{
+						Length = (int)soundFormat.LengthInSeconds;
+						soundFormat.Dispose();
+						break;
+					}
+				}
+			}
+			finally
+			{
+				stream.Dispose();
 			}
 		}
 	}

OpenRA.Game/GameRules/Ruleset.cs

@@ -1,48 +1,289 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading.Tasks;
+using OpenRA.FileSystem;
 using OpenRA.GameRules;
 using OpenRA.Graphics;
+using OpenRA.Traits;
 
 namespace OpenRA
 {
 	public class Ruleset
 	{
-		public readonly IReadOnlyDictionary<string, ActorInfo> Actors;
+		public readonly ActorInfoDictionary Actors;
 		public readonly IReadOnlyDictionary<string, WeaponInfo> Weapons;
 		public readonly IReadOnlyDictionary<string, SoundInfo> Voices;
 		public readonly IReadOnlyDictionary<string, SoundInfo> Notifications;
 		public readonly IReadOnlyDictionary<string, MusicInfo> Music;
-		public readonly IReadOnlyDictionary<string, TileSet> TileSets;
-		public readonly IReadOnlyDictionary<string, SequenceProvider> Sequences;
+		public readonly ITerrainInfo TerrainInfo;
+		public readonly SequenceProvider Sequences;
+		public readonly IReadOnlyDictionary<string, MiniYamlNode> ModelSequences;
 
 		public Ruleset(
-			IDictionary<string, ActorInfo> actors,
-			IDictionary<string, WeaponInfo> weapons,
-			IDictionary<string, SoundInfo> voices,
-			IDictionary<string, SoundInfo> notifications,
-			IDictionary<string, MusicInfo> music,
-			IDictionary<string, TileSet> tileSets,
-			IDictionary<string, SequenceProvider> sequences)
+			IReadOnlyDictionary<string, ActorInfo> actors,
+			IReadOnlyDictionary<string, WeaponInfo> weapons,
+			IReadOnlyDictionary<string, SoundInfo> voices,
+			IReadOnlyDictionary<string, SoundInfo> notifications,
+			IReadOnlyDictionary<string, MusicInfo> music,
+			ITerrainInfo terrainInfo,
+			SequenceProvider sequences,
+			IReadOnlyDictionary<string, MiniYamlNode> modelSequences)
 		{
-			Actors = new ReadOnlyDictionary<string, ActorInfo>(actors);
-			Weapons = new ReadOnlyDictionary<string, WeaponInfo>(weapons);
-			Voices = new ReadOnlyDictionary<string, SoundInfo>(voices);
-			Notifications = new ReadOnlyDictionary<string, SoundInfo>(notifications);
-			Music = new ReadOnlyDictionary<string, MusicInfo>(music);
-			TileSets = new ReadOnlyDictionary<string, TileSet>(tileSets);
-			Sequences = new ReadOnlyDictionary<string, SequenceProvider>(sequences);
+			Actors = new ActorInfoDictionary(actors);
+			Weapons = weapons;
+			Voices = voices;
+			Notifications = notifications;
+			Music = music;
+			TerrainInfo = terrainInfo;
+			Sequences = sequences;
+			ModelSequences = modelSequences;
+
+			foreach (var a in Actors.Values)
+			{
+				foreach (var t in a.TraitInfos<IRulesetLoaded>())
+				{
+					try
+					{
+						t.RulesetLoaded(this, a);
+					}
+					catch (YamlException e)
+					{
+						throw new YamlException($"Actor type {a.Name}: {e.Message}");
+					}
+				}
+			}
+
+			foreach (var weapon in Weapons)
+			{
+				if (weapon.Value.Projectile is IRulesetLoaded<WeaponInfo> projectileLoaded)
+				{
+					try
+					{
+						projectileLoaded.RulesetLoaded(this, weapon.Value);
+					}
+					catch (YamlException e)
+					{
+						throw new YamlException($"Projectile type {weapon.Key}: {e.Message}");
+					}
+				}
+
+				foreach (var warhead in weapon.Value.Warheads)
+				{
+					if (warhead is IRulesetLoaded<WeaponInfo> cacher)
+					{
+						try
+						{
+							cacher.RulesetLoaded(this, weapon.Value);
+						}
+						catch (YamlException e)
+						{
+							throw new YamlException($"Weapon type {weapon.Key}: {e.Message}");
+						}
+					}
+				}
+			}
 		}
 
 		public IEnumerable<KeyValuePair<string, MusicInfo>> InstalledMusic { get { return Music.Where(m => m.Value.Exists); } }
+
+		static IReadOnlyDictionary<string, T> MergeOrDefault<T>(string name,
+			IReadOnlyFileSystem fileSystem,
+			IEnumerable<string> files,
+			MiniYaml additional,
+			IReadOnlyDictionary<string, T> defaults,
+			Func<MiniYamlNode, T> makeObject,
+			Func<MiniYamlNode, bool> filterNode = null)
+		{
+			if (additional == null && defaults != null)
+				return defaults;
+
+			IEnumerable<MiniYamlNode> yamlNodes = MiniYaml.Load(fileSystem, files, additional);
+
+			// Optionally, the caller can filter out elements from the loaded set of nodes. Default behavior is unfiltered.
+			if (filterNode != null)
+				yamlNodes = yamlNodes.Where(k => !filterNode(k));
+
+			return yamlNodes.ToDictionaryWithConflictLog(k => k.Key.ToLowerInvariant(), makeObject, "LoadFromManifest<" + name + ">");
+		}
+
+		public static Ruleset LoadDefaults(ModData modData)
+		{
+			var m = modData.Manifest;
+			var fs = modData.DefaultFileSystem;
+
+			Ruleset ruleset = null;
+			Action f = () =>
+			{
+				var actors = MergeOrDefault("Manifest,Rules", fs, m.Rules, null, null,
+					k => new ActorInfo(modData.ObjectCreator, k.Key.ToLowerInvariant(), k.Value),
+					filterNode: n => n.Key.StartsWith(ActorInfo.AbstractActorPrefix, StringComparison.Ordinal));
+
+				var weapons = MergeOrDefault("Manifest,Weapons", fs, m.Weapons, null, null,
+					k => new WeaponInfo(k.Value));
+
+				var voices = MergeOrDefault("Manifest,Voices", fs, m.Voices, null, null,
+					k => new SoundInfo(k.Value));
+
+				var notifications = MergeOrDefault("Manifest,Notifications", fs, m.Notifications, null, null,
+					k => new SoundInfo(k.Value));
+
+				var music = MergeOrDefault("Manifest,Music", fs, m.Music, null, null,
+					k => new MusicInfo(k.Key, k.Value));
+
+				var modelSequences = MergeOrDefault("Manifest,ModelSequences", fs, m.ModelSequences, null, null,
+					k => k);
+
+				// The default ruleset does not include a preferred tileset or sequence set
+				ruleset = new Ruleset(actors, weapons, voices, notifications, music, null, null, modelSequences);
+			};
+
+			if (modData.IsOnMainThread)
+			{
+				modData.HandleLoadingProgress();
+
+				var loader = new Task(f);
+				loader.Start();
+
+				// Animate the loadscreen while we wait
+				while (!loader.Wait(40))
+					modData.HandleLoadingProgress();
+			}
+			else
+				f();
+
+			return ruleset;
+		}
+
+		public static Ruleset LoadDefaultsForTileSet(ModData modData, string tileSet)
+		{
+			var dr = modData.DefaultRules;
+			var terrainInfo = modData.DefaultTerrainInfo[tileSet];
+			var sequences = modData.DefaultSequences[tileSet];
+
+			return new Ruleset(dr.Actors, dr.Weapons, dr.Voices, dr.Notifications, dr.Music, terrainInfo, sequences, dr.ModelSequences);
+		}
+
+		public static Ruleset Load(ModData modData, IReadOnlyFileSystem fileSystem, string tileSet,
+			MiniYaml mapRules, MiniYaml mapWeapons, MiniYaml mapVoices, MiniYaml mapNotifications,
+			MiniYaml mapMusic, MiniYaml mapSequences, MiniYaml mapModelSequences)
+		{
+			var m = modData.Manifest;
+			var dr = modData.DefaultRules;
+
+			Ruleset ruleset = null;
+			Action f = () =>
+			{
+				var actors = MergeOrDefault("Rules", fileSystem, m.Rules, mapRules, dr.Actors,
+					k => new ActorInfo(modData.ObjectCreator, k.Key.ToLowerInvariant(), k.Value),
+					filterNode: n => n.Key.StartsWith(ActorInfo.AbstractActorPrefix, StringComparison.Ordinal));
+
+				var weapons = MergeOrDefault("Weapons", fileSystem, m.Weapons, mapWeapons, dr.Weapons,
+					k => new WeaponInfo(k.Value));
+
+				var voices = MergeOrDefault("Voices", fileSystem, m.Voices, mapVoices, dr.Voices,
+					k => new SoundInfo(k.Value));
+
+				var notifications = MergeOrDefault("Notifications", fileSystem, m.Notifications, mapNotifications, dr.Notifications,
+					k => new SoundInfo(k.Value));
+
+				var music = MergeOrDefault("Music", fileSystem, m.Music, mapMusic, dr.Music,
+					k => new MusicInfo(k.Key, k.Value));
+
+				// TODO: Add support for merging custom terrain modifications
+				var terrainInfo = modData.DefaultTerrainInfo[tileSet];
+
+				// TODO: Top-level dictionary should be moved into the Ruleset instead of in its own object
+				var sequences = mapSequences == null ? modData.DefaultSequences[tileSet] :
+					new SequenceProvider(fileSystem, modData, tileSet, mapSequences);
+
+				var modelSequences = dr.ModelSequences;
+				if (mapModelSequences != null)
+					modelSequences = MergeOrDefault("ModelSequences", fileSystem, m.ModelSequences, mapModelSequences, dr.ModelSequences,
+						k => k);
+
+				ruleset = new Ruleset(actors, weapons, voices, notifications, music, terrainInfo, sequences, modelSequences);
+			};
+
+			if (modData.IsOnMainThread)
+			{
+				modData.HandleLoadingProgress();
+
+				var loader = new Task(f);
+				loader.Start();
+
+				// Animate the loadscreen while we wait
+				while (!loader.Wait(40))
+					modData.HandleLoadingProgress();
+			}
+			else
+				f();
+
+			return ruleset;
+		}
+
+		static bool AnyCustomYaml(MiniYaml yaml)
+		{
+			return yaml != null && (yaml.Value != null || yaml.Nodes.Count > 0);
+		}
+
+		static bool AnyFlaggedTraits(ModData modData, List<MiniYamlNode> actors)
+		{
+			foreach (var actorNode in actors)
+			{
+				foreach (var traitNode in actorNode.Value.Nodes)
+				{
+					try
+					{
+						var traitName = traitNode.Key.Split('@')[0];
+						var traitType = modData.ObjectCreator.FindType(traitName + "Info");
+						if (traitType != null && traitType.GetInterface(nameof(ILobbyCustomRulesIgnore)) == null)
+							return true;
+					}
+					catch (Exception ex)
+					{
+						Log.Write("debug", "Error in AnyFlaggedTraits\r\n" + ex.ToString());
+					}
+				}
+			}
+
+			return false;
+		}
+
+		public static bool DefinesUnsafeCustomRules(ModData modData, IReadOnlyFileSystem fileSystem,
+			MiniYaml mapRules, MiniYaml mapWeapons, MiniYaml mapVoices, MiniYaml mapNotifications, MiniYaml mapSequences)
+		{
+			// Maps that define any weapon, voice, notification, or sequence overrides are always flagged
+			if (AnyCustomYaml(mapWeapons) || AnyCustomYaml(mapVoices) || AnyCustomYaml(mapNotifications) || AnyCustomYaml(mapSequences))
+				return true;
+
+			// Any trait overrides that aren't explicitly whitelisted are flagged
+			if (mapRules != null)
+			{
+				if (AnyFlaggedTraits(modData, mapRules.Nodes))
+					return true;
+
+				if (mapRules.Value != null)
+				{
+					var mapFiles = FieldLoader.GetValue<string[]>("value", mapRules.Value);
+					foreach (var f in mapFiles)
+						if (AnyFlaggedTraits(modData, MiniYaml.FromStream(fileSystem.Open(f), f)))
+							return true;
+				}
+			}
+
+			return false;
+		}
 	}
 }

OpenRA.Game/GameRules/RulesetCache.cs

@@ -1,159 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using OpenRA.GameRules;
-using OpenRA.Graphics;
-using OpenRA.Support;
-
-namespace OpenRA
-{
-	public sealed class RulesetCache : IDisposable
-	{
-		static readonly List<MiniYamlNode> NoMapRules = new List<MiniYamlNode>();
-
-		readonly ModData modData;
-
-		readonly Dictionary<string, ActorInfo> actorCache = new Dictionary<string, ActorInfo>();
-		readonly Dictionary<string, WeaponInfo> weaponCache = new Dictionary<string, WeaponInfo>();
-		readonly Dictionary<string, SoundInfo> voiceCache = new Dictionary<string, SoundInfo>();
-		readonly Dictionary<string, SoundInfo> notificationCache = new Dictionary<string, SoundInfo>();
-		readonly Dictionary<string, MusicInfo> musicCache = new Dictionary<string, MusicInfo>();
-		readonly Dictionary<string, TileSet> tileSetCache = new Dictionary<string, TileSet>();
-		readonly Dictionary<string, SequenceCache> sequenceCaches = new Dictionary<string, SequenceCache>();
-
-		public event EventHandler LoadingProgress;
-		void RaiseProgress()
-		{
-			if (LoadingProgress != null)
-				LoadingProgress(this, new EventArgs());
-		}
-
-		public RulesetCache(ModData modData)
-		{
-			this.modData = modData;
-		}
-
-		/// <summary>
-		/// Cache and return the Ruleset for a given map.
-		/// If a map isn't specified then return the default mod Ruleset.
-		/// </summary>
-		public Ruleset Load(Map map = null)
-		{
-			var m = modData.Manifest;
-
-			Dictionary<string, ActorInfo> actors;
-			Dictionary<string, WeaponInfo> weapons;
-			Dictionary<string, SoundInfo> voices;
-			Dictionary<string, SoundInfo> notifications;
-			Dictionary<string, MusicInfo> music;
-			Dictionary<string, TileSet> tileSets;
-
-			using (new PerfTimer("Actors"))
-				actors = LoadYamlRules(actorCache, m.Rules,
-					map != null ? map.RuleDefinitions : NoMapRules,
-					(k, y) => new ActorInfo(k.Key.ToLowerInvariant(), k.Value, y));
-
-			using (new PerfTimer("Weapons"))
-				weapons = LoadYamlRules(weaponCache, m.Weapons,
-					map != null ? map.WeaponDefinitions : NoMapRules,
-					(k, _) => new WeaponInfo(k.Key.ToLowerInvariant(), k.Value));
-
-			using (new PerfTimer("Voices"))
-				voices = LoadYamlRules(voiceCache, m.Voices,
-					map != null ? map.VoiceDefinitions : NoMapRules,
-					(k, _) => new SoundInfo(k.Value));
-
-			using (new PerfTimer("Notifications"))
-				notifications = LoadYamlRules(notificationCache, m.Notifications,
-					map != null ? map.NotificationDefinitions : NoMapRules,
-					(k, _) => new SoundInfo(k.Value));
-
-			using (new PerfTimer("Music"))
-				music = LoadYamlRules(musicCache, m.Music,
-					NoMapRules,
-					(k, _) => new MusicInfo(k.Key, k.Value));
-
-			using (new PerfTimer("TileSets"))
-				tileSets = LoadTileSets(tileSetCache, sequenceCaches, m.TileSets);
-
-			var sequences = sequenceCaches.ToDictionary(kvp => kvp.Key, kvp => new SequenceProvider(kvp.Value, map));
-			return new Ruleset(actors, weapons, voices, notifications, music, tileSets, sequences);
-		}
-
-		Dictionary<string, T> LoadYamlRules<T>(
-			Dictionary<string, T> itemCache,
-			string[] files, List<MiniYamlNode> nodes,
-			Func<MiniYamlNode, Dictionary<string, MiniYaml>, T> f)
-		{
-			RaiseProgress();
-
-			var inputKey = string.Concat(string.Join("|", files), "|", nodes.WriteToString());
-
-			var mergedNodes = files
-				.Select(s => MiniYaml.FromFile(s))
-				.Aggregate(nodes, MiniYaml.MergeLiberal);
-
-			Func<MiniYamlNode, Dictionary<string, MiniYaml>, T> wrap = (wkv, wyy) =>
-			{
-				var key = inputKey + wkv.Value.ToLines(wkv.Key).JoinWith("|");
-				T t;
-				if (itemCache.TryGetValue(key, out t))
-					return t;
-
-				t = f(wkv, wyy);
-				itemCache.Add(key, t);
-
-				RaiseProgress();
-				return t;
-			};
-
-			var yy = mergedNodes.ToDictionary(x => x.Key, x => x.Value);
-			var itemSet = mergedNodes.ToDictionaryWithConflictLog(kv => kv.Key.ToLowerInvariant(), kv => wrap(kv, yy), "LoadYamlRules", null, null);
-
-			RaiseProgress();
-			return itemSet;
-		}
-
-		Dictionary<string, TileSet> LoadTileSets(Dictionary<string, TileSet> itemCache, Dictionary<string, SequenceCache> sequenceCaches, string[] files)
-		{
-			var items = new Dictionary<string, TileSet>();
-
-			foreach (var file in files)
-			{
-				TileSet t;
-				if (itemCache.TryGetValue(file, out t))
-					items.Add(t.Id, t);
-				else
-				{
-					t = new TileSet(modData, file);
-					itemCache.Add(file, t);
-
-					// every time we load a tile set, we create a sequence cache for it
-					var sc = new SequenceCache(modData, t);
-					sequenceCaches.Add(t.Id, sc);
-
-					items.Add(t.Id, t);
-				}
-			}
-
-			return items;
-		}
-
-		public void Dispose()
-		{
-			foreach (var cache in sequenceCaches.Values)
-				cache.Dispose();
-			sequenceCaches.Clear();
-		}
-	}
-}

OpenRA.Game/GameRules/SoundInfo.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -16,22 +17,14 @@ namespace OpenRA.GameRules
 {
 	public class SoundInfo
 	{
-		[FieldLoader.Ignore] public readonly Dictionary<string, string[]> Variants;
-		[FieldLoader.Ignore] public readonly Dictionary<string, string[]> Prefixes;
-		[FieldLoader.Ignore] public readonly Dictionary<string, string[]> Voices;
-		[FieldLoader.Ignore] public readonly Dictionary<string, string[]> Notifications;
+		public readonly Dictionary<string, string[]> Variants = new Dictionary<string, string[]>();
+		public readonly Dictionary<string, string[]> Prefixes = new Dictionary<string, string[]>();
+		public readonly Dictionary<string, string[]> Voices = new Dictionary<string, string[]>();
+		public readonly Dictionary<string, string[]> Notifications = new Dictionary<string, string[]>();
 		public readonly string DefaultVariant = ".aud";
 		public readonly string DefaultPrefix = "";
-		public readonly string[] DisableVariants = { };
-		public readonly string[] DisablePrefixes = { };
-
-		static Dictionary<string, string[]> Load(MiniYaml y, string name)
-		{
-			var nd = y.ToDictionary();
-			return nd.ContainsKey(name)
-				? nd[name].ToDictionary(my => FieldLoader.GetValue<string[]>("(value)", my.Value))
-				: new Dictionary<string, string[]>();
-		}
+		public readonly HashSet<string> DisableVariants = new HashSet<string>();
+		public readonly HashSet<string> DisablePrefixes = new HashSet<string>();
 
 		public readonly Lazy<Dictionary<string, SoundPool>> VoicePools;
 		public readonly Lazy<Dictionary<string, SoundPool>> NotificationsPools;
@@ -39,23 +32,49 @@ namespace OpenRA.GameRules
 		public SoundInfo(MiniYaml y)
 		{
 			FieldLoader.Load(this, y);
-			Variants = Load(y, "Variants");
-			Prefixes = Load(y, "Prefixes");
-			Voices = Load(y, "Voices");
-			Notifications = Load(y, "Notifications");
 
-			VoicePools = Exts.Lazy(() => Voices.ToDictionary(a => a.Key, a => new SoundPool(a.Value)));
-			NotificationsPools = Exts.Lazy(() => Notifications.ToDictionary(a => a.Key, a => new SoundPool(a.Value)));
+			VoicePools = Exts.Lazy(() => Voices.ToDictionary(a => a.Key, a => new SoundPool(1f, SoundPool.DefaultInterruptType, a.Value)));
+			NotificationsPools = Exts.Lazy(() => ParseSoundPool(y, "Notifications"));
+		}
+
+		static Dictionary<string, SoundPool> ParseSoundPool(MiniYaml y, string key)
+		{
+			var ret = new Dictionary<string, SoundPool>();
+			var classifiction = y.Nodes.First(x => x.Key == key);
+			foreach (var t in classifiction.Value.Nodes)
+			{
+				var volumeModifier = 1f;
+				var volumeModifierNode = t.Value.Nodes.FirstOrDefault(x => x.Key == nameof(SoundPool.VolumeModifier));
+				if (volumeModifierNode != null)
+					volumeModifier = FieldLoader.GetValue<float>(volumeModifierNode.Key, volumeModifierNode.Value.Value);
+
+				var interruptType = SoundPool.DefaultInterruptType;
+				var interruptTypeNode = t.Value.Nodes.FirstOrDefault(x => x.Key == nameof(SoundPool.InterruptType));
+				if (interruptTypeNode != null)
+					interruptType = FieldLoader.GetValue<SoundPool.InterruptType>(interruptTypeNode.Key, interruptTypeNode.Value.Value);
+
+				var names = FieldLoader.GetValue<string[]>(t.Key, t.Value.Value);
+				var sp = new SoundPool(volumeModifier, interruptType, names);
+				ret.Add(t.Key, sp);
+			}
+
+			return ret;
 		}
 	}
 
 	public class SoundPool
 	{
+		public enum InterruptType { DoNotPlay, Interrupt, Overlap }
+		public const InterruptType DefaultInterruptType = InterruptType.DoNotPlay;
+		public readonly float VolumeModifier;
+		public readonly InterruptType Type;
 		readonly string[] clips;
 		readonly List<string> liveclips = new List<string>();
 
-		public SoundPool(params string[] clips)
+		public SoundPool(float volumeModifier, InterruptType interruptType, params string[] clips)
 		{
+			VolumeModifier = volumeModifier;
+			Type = interruptType;
 			this.clips = clips;
 		}
 
@@ -64,8 +83,9 @@ namespace OpenRA.GameRules
 			if (liveclips.Count == 0)
 				liveclips.AddRange(clips);
 
+			// Avoid crashing if there's no clips at all
 			if (liveclips.Count == 0)
-				return null;		/* avoid crashing if there's no clips at all */
+				return null;
 
 			var i = Game.CosmeticRandom.Next(liveclips.Count);
 			var s = liveclips[i];

OpenRA.Game/GameRules/WeaponInfo.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -12,6 +13,7 @@ using System;
 using System.Collections.Generic;
 using System.Linq;
 using OpenRA.Effects;
+using OpenRA.Primitives;
 using OpenRA.Traits;
 
 namespace OpenRA.GameRules
@@ -21,65 +23,132 @@ namespace OpenRA.GameRules
 		public WeaponInfo Weapon;
 		public int[] DamageModifiers;
 		public int[] InaccuracyModifiers;
-		public int Facing;
+		public int[] RangeModifiers;
+		public WAngle Facing;
+		public Func<WAngle> CurrentMuzzleFacing;
 		public WPos Source;
+		public Func<WPos> CurrentSource;
 		public Actor SourceActor;
 		public WPos PassiveTarget;
 		public Target GuidedTarget;
 	}
 
-	public interface IProjectileInfo { IEffect Create(ProjectileArgs args); }
+	public class WarheadArgs
+	{
+		public WeaponInfo Weapon;
+		public int[] DamageModifiers = Array.Empty<int>();
+		public WPos? Source;
+		public WRot ImpactOrientation;
+		public WPos ImpactPosition;
+		public Actor SourceActor;
+		public Target WeaponTarget;
+
+		public WarheadArgs(ProjectileArgs args)
+		{
+			Weapon = args.Weapon;
+			DamageModifiers = args.DamageModifiers;
+			ImpactPosition = args.PassiveTarget;
+			Source = args.Source;
+			SourceActor = args.SourceActor;
+			WeaponTarget = args.GuidedTarget;
+		}
+
+		// For places that only want to update some of the fields (usually DamageModifiers)
+		public WarheadArgs(WarheadArgs args)
+		{
+			Weapon = args.Weapon;
+			DamageModifiers = args.DamageModifiers;
+			Source = args.Source;
+			SourceActor = args.SourceActor;
+			WeaponTarget = args.WeaponTarget;
+		}
+
+		// Default empty constructor for callers that want to initialize fields themselves
+		public WarheadArgs() { }
+	}
+
+	public interface IProjectile : IEffect { }
+	public interface IProjectileInfo { IProjectile Create(ProjectileArgs args); }
 
 	public sealed class WeaponInfo
 	{
 		[Desc("The maximum range the weapon can fire.")]
 		public readonly WDist Range = WDist.Zero;
 
-		[Desc("The sound played when the weapon is fired.")]
+		[Desc("First burst is aimed at this offset relative to target position.")]
+		public readonly WVec FirstBurstTargetOffset = WVec.Zero;
+
+		[Desc("Each burst after the first lands by this offset away from the previous burst.")]
+		public readonly WVec FollowingBurstTargetOffset = WVec.Zero;
+
+		[Desc("The sound played each time the weapon is fired.")]
 		public readonly string[] Report = null;
 
+		[Desc("Sound played only on first burst in a salvo.")]
+		public readonly string[] StartBurstReport = null;
+
+		[Desc("The sound played when the weapon is reloaded.")]
+		public readonly string[] AfterFireSound = null;
+
+		[Desc("Delay in ticks to play reloading sound.")]
+		public readonly int AfterFireSoundDelay = 0;
+
 		[Desc("Delay in ticks between reloading ammo magazines.")]
 		public readonly int ReloadDelay = 1;
 
 		[Desc("Number of shots in a single ammo magazine.")]
 		public readonly int Burst = 1;
 
-		public readonly bool Charges = false;
-
 		[Desc("What types of targets are affected.")]
-		public readonly string[] ValidTargets = { "Ground", "Water" };
+		public readonly BitSet<TargetableType> ValidTargets = new BitSet<TargetableType>("Ground", "Water");
 
 		[Desc("What types of targets are unaffected.", "Overrules ValidTargets.")]
-		public readonly string[] InvalidTargets = { };
+		public readonly BitSet<TargetableType> InvalidTargets;
 
-		[Desc("Delay in ticks between firing shots from the same ammo magazine.")]
-		public readonly int BurstDelay = 5;
+		static readonly BitSet<TargetableType> TargetTypeAir = new BitSet<TargetableType>("Air");
+
+		[Desc("If weapon is not directly targeting an actor and targeted position is above this altitude,",
+			"the weapon will ignore terrain target types and only check TargetTypeAir for validity.")]
+		public readonly WDist AirThreshold = new WDist(128);
+
+		[Desc("Delay in ticks between firing shots from the same ammo magazine. If one entry, it will be used for all bursts.",
+			"If multiple entries, their number needs to match Burst - 1.")]
+		public readonly int[] BurstDelays = { 5 };
 
 		[Desc("The minimum range the weapon can fire.")]
 		public readonly WDist MinRange = WDist.Zero;
 
-		[FieldLoader.LoadUsing("LoadProjectile")]
+		[Desc("Does this weapon aim at the target's center regardless of other targetable offsets?")]
+		public readonly bool TargetActorCenter = false;
+
+		[FieldLoader.LoadUsing(nameof(LoadProjectile))]
 		public readonly IProjectileInfo Projectile;
 
-		[FieldLoader.LoadUsing("LoadWarheads")]
+		[FieldLoader.LoadUsing(nameof(LoadWarheads))]
 		public readonly List<IWarhead> Warheads = new List<IWarhead>();
 
-		readonly HashSet<string> validTargetSet;
-		readonly HashSet<string> invalidTargetSet;
+		/// <summary>
+		/// This constructor is used solely for documentation generation!
+		/// </summary>
+		public WeaponInfo() { }
 
-		public WeaponInfo(string name, MiniYaml content)
+		public WeaponInfo(MiniYaml content)
 		{
+			// Resolve any weapon-level yaml inheritance or removals
+			// HACK: The "Defaults" sequence syntax prevents us from doing this generally during yaml parsing
+			content.Nodes = MiniYaml.Merge(new[] { content.Nodes });
 			FieldLoader.Load(this, content);
-			validTargetSet = new HashSet<string>(ValidTargets);
-			invalidTargetSet = new HashSet<string>(InvalidTargets);
 		}
 
 		static object LoadProjectile(MiniYaml yaml)
 		{
-			MiniYaml proj;
-			if (!yaml.ToDictionary().TryGetValue("Projectile", out proj))
+			if (!yaml.ToDictionary().TryGetValue("Projectile", out var proj))
 				return null;
+
 			var ret = Game.CreateObject<IProjectileInfo>(proj.Value + "Info");
+			if (ret == null)
+				return null;
+
 			FieldLoader.Load(ret, proj);
 			return ret;
 		}
@@ -90,6 +159,9 @@ namespace OpenRA.GameRules
 			foreach (var node in yaml.Nodes.Where(n => n.Key.StartsWith("Warhead")))
 			{
 				var ret = Game.CreateObject<IWarhead>(node.Value.Value + "Warhead");
+				if (ret == null)
+					continue;
+
 				FieldLoader.Load(ret, node.Value);
 				retList.Add(ret);
 			}
@@ -97,13 +169,13 @@ namespace OpenRA.GameRules
 			return retList;
 		}
 
-		public bool IsValidTarget(IEnumerable<string> targetTypes)
+		public bool IsValidTarget(BitSet<TargetableType> targetTypes)
 		{
-			return validTargetSet.Overlaps(targetTypes) && !invalidTargetSet.Overlaps(targetTypes);
+			return ValidTargets.Overlaps(targetTypes) && !InvalidTargets.Overlaps(targetTypes);
 		}
 
 		/// <summary>Checks if the weapon is valid against (can target) the target.</summary>
-		public bool IsValidAgainst(Target target, World world, Actor firedBy)
+		public bool IsValidAgainst(in Target target, World world, Actor firedBy)
 		{
 			if (target.Type == TargetType.Actor)
 				return IsValidAgainst(target.Actor, firedBy);
@@ -113,6 +185,10 @@ namespace OpenRA.GameRules
 
 			if (target.Type == TargetType.Terrain)
 			{
+				var dat = world.Map.DistanceAboveTerrain(target.CenterPosition);
+				if (dat > AirThreshold)
+					return IsValidTarget(TargetTypeAir);
+
 				var cell = world.Map.CellContaining(target.CenterPosition);
 				if (!world.Map.Contains(cell))
 					return false;
@@ -130,21 +206,23 @@ namespace OpenRA.GameRules
 		/// <summary>Checks if the weapon is valid against (can target) the actor.</summary>
 		public bool IsValidAgainst(Actor victim, Actor firedBy)
 		{
-			var targetable = victim.TraitOrDefault<ITargetable>();
-			if (targetable == null || !IsValidTarget(targetable.TargetTypes))
+			var targetTypes = victim.GetEnabledTargetTypes();
+
+			if (!IsValidTarget(targetTypes))
 				return false;
 
-			if (!Warheads.Any(w => w.IsValidAgainst(victim, firedBy)))
-				return false;
+			// PERF: Avoid LINQ.
+			foreach (var warhead in Warheads)
+				if (warhead.IsValidAgainst(victim, firedBy))
+					return true;
 
-			return true;
+			return false;
 		}
 
 		/// <summary>Checks if the weapon is valid against (can target) the frozen actor.</summary>
 		public bool IsValidAgainst(FrozenActor victim, Actor firedBy)
 		{
-			var targetable = victim.Info.Traits.GetOrDefault<ITargetableInfo>();
-			if (targetable == null || !IsValidTarget(targetable.GetTargetTypes()))
+			if (!IsValidTarget(victim.TargetTypes))
 				return false;
 
 			if (!Warheads.Any(w => w.IsValidAgainst(victim, firedBy)))
@@ -154,18 +232,37 @@ namespace OpenRA.GameRules
 		}
 
 		/// <summary>Applies all the weapon's warheads to the target.</summary>
-		public void Impact(Target target, Actor firedBy, IEnumerable<int> damageModifiers)
+		public void Impact(in Target target, WarheadArgs args)
 		{
+			var world = args.SourceActor.World;
 			foreach (var warhead in Warheads)
 			{
-				var wh = warhead; // force the closure to bind to the current warhead
-
-				Action a = () => wh.DoImpact(target, firedBy, damageModifiers);
-				if (wh.Delay > 0)
-					firedBy.World.AddFrameEndTask(w => w.Add(new DelayedAction(wh.Delay, a)));
+				if (warhead.Delay > 0)
+				{
+					// Lambdas can't use 'in' variables, so capture a copy for later
+					var delayedTarget = target;
+					world.AddFrameEndTask(w => w.Add(new DelayedImpact(warhead.Delay, warhead, delayedTarget, args)));
+				}
 				else
-					a();
+					warhead.DoImpact(target, args);
 			}
 		}
+
+		/// <summary>Applies all the weapon's warheads to the target. Only use for projectile-less, special-case impacts.</summary>
+		public void Impact(in Target target, Actor firedBy)
+		{
+			// The impact will happen immediately at target.CenterPosition.
+			var args = new WarheadArgs
+			{
+				Weapon = this,
+				SourceActor = firedBy,
+				WeaponTarget = target
+			};
+
+			if (firedBy.OccupiesSpace != null)
+				args.Source = firedBy.CenterPosition;
+
+			Impact(target, args);
+		}
 	}
 }

OpenRA.Game/GameSpeed.cs

@@ -0,0 +1,60 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System.Collections.Generic;
+using System.Linq;
+
+namespace OpenRA
+{
+	public class GameSpeed
+	{
+		[FieldLoader.Require]
+		public readonly string Name;
+
+		[FieldLoader.Require]
+		public readonly int Timestep;
+
+		[FieldLoader.Require]
+		public readonly int OrderLatency;
+	}
+
+	public class GameSpeeds : IGlobalModData
+	{
+		[FieldLoader.Require]
+		public readonly string DefaultSpeed;
+
+		[FieldLoader.LoadUsing(nameof(LoadSpeeds))]
+		public readonly Dictionary<string, GameSpeed> Speeds;
+
+		static object LoadSpeeds(MiniYaml y)
+		{
+			var ret = new Dictionary<string, GameSpeed>();
+			var speedsNode = y.Nodes.FirstOrDefault(n => n.Key == "Speeds");
+			if (speedsNode == null)
+				throw new YamlException("Error parsing GameSpeeds: Missing Speeds node!");
+
+			foreach (var node in speedsNode.Value.Nodes)
+			{
+				try
+				{
+					ret.Add(node.Key, FieldLoader.Load<GameSpeed>(node.Value));
+				}
+				catch (FieldLoader.MissingFieldsException e)
+				{
+					var label = e.Missing.Length > 1 ? "Required properties missing" : "Required property missing";
+					throw new YamlException($"Error parsing GameSpeed {node.Key}: {label}: {e.Missing.JoinWith(", ")}");
+				}
+			}
+
+			return ret;
+		}
+	}
+}

OpenRA.Game/Graphics/Animation.cs

@@ -1,74 +1,111 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
-using System.Collections.Generic;
 using System.Linq;
+using OpenRA.Primitives;
 using OpenRA.Support;
 
 namespace OpenRA.Graphics
 {
 	public class Animation
 	{
-		readonly int defaultTick = 40; // 25 fps == 40 ms
 		public ISpriteSequence CurrentSequence { get; private set; }
-		public bool IsDecoration = false;
-		public Func<bool> Paused;
-
-		readonly Func<int> facingFunc;
-
-		int frame = 0;
-		bool backwards = false;
-
-		string name;
-
-		bool tickAlways;
-
-		public string Name { get { return name; } }
+		public string Name { get; private set; }
+		public bool IsDecoration { get; set; }
 
 		readonly SequenceProvider sequenceProvider;
+		readonly Func<WAngle> facingFunc;
+		readonly Func<bool> paused;
+
+		int frame;
+		bool backwards;
+		bool tickAlways;
+		int timeUntilNextFrame;
+		Action tickFunc = () => { };
 
 		public Animation(World world, string name)
-			: this(world, name, () => 0) { }
+			: this(world, name, () => WAngle.Zero) { }
 
-		public Animation(World world, string name, Func<int> facingFunc)
-			: this(world.Map.SequenceProvider, name, facingFunc) { }
+		public Animation(World world, string name, Func<WAngle> facingFunc)
+			: this(world, name, facingFunc, null) { }
 
-		public Animation(SequenceProvider sequenceProvider, string name, Func<int> facingFunc)
+		public Animation(World world, string name, Func<bool> paused)
+			: this(world, name, () => WAngle.Zero, paused) { }
+
+		public Animation(World world, string name, Func<WAngle> facingFunc, Func<bool> paused)
 		{
-			this.sequenceProvider = sequenceProvider;
-			this.name = name.ToLowerInvariant();
-			this.tickFunc = () => { };
+			sequenceProvider = world.Map.Rules.Sequences;
+			Name = name.ToLowerInvariant();
 			this.facingFunc = facingFunc;
+			this.paused = paused;
 		}
 
-		public int CurrentFrame { get { return backwards ? CurrentSequence.Start + CurrentSequence.Length - frame - 1 : frame; } }
-		public Sprite Image { get { return CurrentSequence.GetSprite(CurrentFrame, facingFunc()); } }
+		public int CurrentFrame => backwards ? CurrentSequence.Length - frame - 1 : frame;
 
-		public IEnumerable<IRenderable> Render(WPos pos, WVec offset, int zOffset, PaletteReference palette, float scale)
+		public Sprite Image => CurrentSequence.GetSprite(CurrentFrame, facingFunc());
+
+		public IRenderable[] Render(WPos pos, in WVec offset, int zOffset, PaletteReference palette)
 		{
-			var imageRenderable = new SpriteRenderable(Image, pos, offset, CurrentSequence.ZOffset + zOffset, palette, scale, IsDecoration);
+			var tintModifiers = CurrentSequence.IgnoreWorldTint ? TintModifiers.IgnoreWorldTint : TintModifiers.None;
+			var alpha = CurrentSequence.GetAlpha(CurrentFrame);
+			var (image, rotation) = CurrentSequence.GetSpriteWithRotation(CurrentFrame, facingFunc());
+			var imageRenderable = new SpriteRenderable(image, pos, offset, CurrentSequence.ZOffset + zOffset, palette, CurrentSequence.Scale, alpha, float3.Ones, tintModifiers, IsDecoration,
+				rotation);
 
 			if (CurrentSequence.ShadowStart >= 0)
 			{
 				var shadow = CurrentSequence.GetShadow(CurrentFrame, facingFunc());
-				var shadowRenderable = new SpriteRenderable(shadow, pos, offset, CurrentSequence.ShadowZOffset + zOffset, palette, scale, true);
+				var shadowRenderable = new SpriteRenderable(shadow, pos, offset, CurrentSequence.ShadowZOffset + zOffset, palette, CurrentSequence.Scale, 1f, float3.Ones, tintModifiers,
+					true, rotation);
 				return new IRenderable[] { shadowRenderable, imageRenderable };
 			}
 
 			return new IRenderable[] { imageRenderable };
 		}
 
-		public IEnumerable<IRenderable> Render(WPos pos, PaletteReference palette)
+		public IRenderable[] RenderUI(WorldRenderer wr, int2 pos, in WVec offset, int zOffset, PaletteReference palette, float scale = 1f, float rotation = 0f)
 		{
-			return Render(pos, WVec.Zero, 0, palette, 1f);
+			scale *= CurrentSequence.Scale;
+			var screenOffset = (scale * wr.ScreenVectorComponents(offset)).XY.ToInt2();
+			var imagePos = pos + screenOffset - new int2((int)(scale * Image.Size.X / 2), (int)(scale * Image.Size.Y / 2));
+			var alpha = CurrentSequence.GetAlpha(CurrentFrame);
+			var imageRenderable = new UISpriteRenderable(Image, WPos.Zero + offset, imagePos, CurrentSequence.ZOffset + zOffset, palette, scale, alpha, rotation);
+
+			if (CurrentSequence.ShadowStart >= 0)
+			{
+				var shadow = CurrentSequence.GetShadow(CurrentFrame, facingFunc());
+				var shadowPos = pos - new int2((int)(scale * shadow.Size.X / 2), (int)(scale * shadow.Size.Y / 2));
+				var shadowRenderable = new UISpriteRenderable(shadow, WPos.Zero + offset, shadowPos, CurrentSequence.ShadowZOffset + zOffset, palette, scale, 1f, rotation);
+				return new IRenderable[] { shadowRenderable, imageRenderable };
+			}
+
+			return new IRenderable[] { imageRenderable };
+		}
+
+		public Rectangle ScreenBounds(WorldRenderer wr, WPos pos, in WVec offset)
+		{
+			var scale = CurrentSequence.Scale;
+			var xy = wr.ScreenPxPosition(pos) + wr.ScreenPxOffset(offset);
+			var cb = CurrentSequence.Bounds;
+			return Rectangle.FromLTRB(
+				xy.X + (int)(cb.Left * scale),
+				xy.Y + (int)(cb.Top * scale),
+				xy.X + (int)(cb.Right * scale),
+				xy.Y + (int)(cb.Bottom * scale));
+		}
+
+		public IRenderable[] Render(WPos pos, PaletteReference palette)
+		{
+			return Render(pos, WVec.Zero, 0, palette);
 		}
 
 		public void Play(string sequenceName)
@@ -76,12 +113,23 @@ namespace OpenRA.Graphics
 			PlayThen(sequenceName, null);
 		}
 
+		int CurrentSequenceTickOrDefault()
+		{
+			const int DefaultTick = 40; // 25 fps == 40 ms
+			return CurrentSequence?.Tick ?? DefaultTick;
+		}
+
+		void PlaySequence(string sequenceName)
+		{
+			CurrentSequence = GetSequence(sequenceName);
+			timeUntilNextFrame = CurrentSequenceTickOrDefault();
+		}
+
 		public void PlayRepeating(string sequenceName)
 		{
 			backwards = false;
 			tickAlways = false;
-			CurrentSequence = sequenceProvider.GetSequence(name, sequenceName);
-			timeUntilNextFrame = CurrentSequence != null ? CurrentSequence.Tick : defaultTick;
+			PlaySequence(sequenceName);
 
 			frame = 0;
 			tickFunc = () =>
@@ -97,9 +145,8 @@ namespace OpenRA.Graphics
 			if (!HasSequence(sequenceName))
 				return false;
 
-			CurrentSequence = sequenceProvider.GetSequence(name, sequenceName);
-			var tick = CurrentSequence != null ? CurrentSequence.Tick : defaultTick;
-			timeUntilNextFrame = Math.Min(tick, timeUntilNextFrame);
+			CurrentSequence = GetSequence(sequenceName);
+			timeUntilNextFrame = Math.Min(CurrentSequenceTickOrDefault(), timeUntilNextFrame);
 			frame %= CurrentSequence.Length;
 			return true;
 		}
@@ -108,8 +155,7 @@ namespace OpenRA.Graphics
 		{
 			backwards = false;
 			tickAlways = false;
-			CurrentSequence = sequenceProvider.GetSequence(name, sequenceName);
-			timeUntilNextFrame = CurrentSequence != null ? CurrentSequence.Tick : defaultTick;
+			PlaySequence(sequenceName);
 
 			frame = 0;
 			tickFunc = () =>
@@ -119,7 +165,7 @@ namespace OpenRA.Graphics
 				{
 					frame = CurrentSequence.Length - 1;
 					tickFunc = () => { };
-					if (after != null) after();
+					after?.Invoke();
 				}
 			};
 		}
@@ -134,8 +180,7 @@ namespace OpenRA.Graphics
 		{
 			backwards = false;
 			tickAlways = true;
-			CurrentSequence = sequenceProvider.GetSequence(name, sequenceName);
-			timeUntilNextFrame = CurrentSequence != null ? CurrentSequence.Tick : defaultTick;
+			PlaySequence(sequenceName);
 
 			frame = func();
 			tickFunc = () => frame = func();
@@ -144,8 +189,7 @@ namespace OpenRA.Graphics
 		public void PlayFetchDirection(string sequenceName, Func<int> direction)
 		{
 			tickAlways = false;
-			CurrentSequence = sequenceProvider.GetSequence(name, sequenceName);
-			timeUntilNextFrame = CurrentSequence != null ? CurrentSequence.Tick : defaultTick;
+			PlaySequence(sequenceName);
 
 			frame = 0;
 			tickFunc = () =>
@@ -159,17 +203,12 @@ namespace OpenRA.Graphics
 			};
 		}
 
-		int timeUntilNextFrame;
-		Action tickFunc;
-
 		public void Tick()
 		{
-			if (Paused == null || !Paused())
+			if (paused == null || !paused())
 				Tick(40); // tick one frame
 		}
 
-		public bool HasSequence(string seq) { return sequenceProvider.HasSequence(name, seq); }
-
 		public void Tick(int t)
 		{
 			if (tickAlways)
@@ -180,7 +219,7 @@ namespace OpenRA.Graphics
 				while (timeUntilNextFrame <= 0)
 				{
 					tickFunc();
-					timeUntilNextFrame += CurrentSequence != null ? CurrentSequence.Tick : defaultTick;
+					timeUntilNextFrame += CurrentSequenceTickOrDefault();
 				}
 			}
 		}
@@ -189,17 +228,19 @@ namespace OpenRA.Graphics
 		{
 			newImage = newImage.ToLowerInvariant();
 
-			if (name != newImage)
+			if (Name != newImage)
 			{
-				name = newImage.ToLowerInvariant();
+				Name = newImage;
 				if (!ReplaceAnim(CurrentSequence.Name))
 					ReplaceAnim(newAnimIfMissing);
 			}
 		}
 
+		public bool HasSequence(string seq) { return sequenceProvider.HasSequence(Name, seq); }
+
 		public ISpriteSequence GetSequence(string sequenceName)
 		{
-			return sequenceProvider.GetSequence(name, sequenceName);
+			return sequenceProvider.GetSequence(Name, sequenceName);
 		}
 
 		public string GetRandomExistingSequence(string[] sequences, MersenneTwister random)

OpenRA.Game/Graphics/AnimationWithOffset.cs

@@ -1,15 +1,16 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
-using System.Collections.Generic;
+using OpenRA.Primitives;
 
 namespace OpenRA.Graphics
 {
@@ -18,36 +19,42 @@ namespace OpenRA.Graphics
 		public readonly Animation Animation;
 		public readonly Func<WVec> OffsetFunc;
 		public readonly Func<bool> DisableFunc;
-		public readonly Func<bool> Paused;
 		public readonly Func<WPos, int> ZOffset;
 
 		public AnimationWithOffset(Animation a, Func<WVec> offset, Func<bool> disable)
-			: this(a, offset, disable, () => false, null) { }
+			: this(a, offset, disable, null) { }
 
 		public AnimationWithOffset(Animation a, Func<WVec> offset, Func<bool> disable, int zOffset)
-			: this(a, offset, disable, () => false, _ => zOffset) { }
+			: this(a, offset, disable, _ => zOffset) { }
 
-		public AnimationWithOffset(Animation a, Func<WVec> offset, Func<bool> disable, Func<bool> pause, Func<WPos, int> zOffset)
+		public AnimationWithOffset(Animation a, Func<WVec> offset, Func<bool> disable, Func<WPos, int> zOffset)
 		{
-			this.Animation = a;
-			this.Animation.Paused = pause;
-			this.OffsetFunc = offset;
-			this.DisableFunc = disable;
-			this.ZOffset = zOffset;
+			Animation = a;
+			OffsetFunc = offset;
+			DisableFunc = disable;
+			ZOffset = zOffset;
 		}
 
-		public IEnumerable<IRenderable> Render(Actor self, WorldRenderer wr, PaletteReference pal, float scale)
+		public IRenderable[] Render(Actor self, PaletteReference pal)
 		{
 			var center = self.CenterPosition;
-			var offset = OffsetFunc != null ? OffsetFunc() : WVec.Zero;
+			var offset = OffsetFunc?.Invoke() ?? WVec.Zero;
 
-			var z = (ZOffset != null) ? ZOffset(center + offset) : 0;
-			return Animation.Render(center, offset, z, pal, scale);
+			var z = ZOffset?.Invoke(center + offset) ?? 0;
+			return Animation.Render(center, offset, z, pal);
+		}
+
+		public Rectangle ScreenBounds(Actor self, WorldRenderer wr)
+		{
+			var center = self.CenterPosition;
+			var offset = OffsetFunc?.Invoke() ?? WVec.Zero;
+
+			return Animation.ScreenBounds(wr, center, offset);
 		}
 
 		public static implicit operator AnimationWithOffset(Animation a)
 		{
-			return new AnimationWithOffset(a, null, null, null, null);
+			return new AnimationWithOffset(a, null, null, null);
 		}
 	}
-}
+}

OpenRA.Game/Graphics/ChromeProvider.cs

@@ -1,126 +1,300 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
+using OpenRA.FileSystem;
+using OpenRA.Primitives;
 
 namespace OpenRA.Graphics
 {
+	[Flags]
+	public enum PanelSides
+	{
+		Left = 1,
+		Top = 2,
+		Right = 4,
+		Bottom = 8,
+		Center = 16,
+
+		Edges = Left | Top | Right | Bottom,
+		All = Edges | Center,
+	}
+
+	public static class PanelSidesExts
+	{
+		public static bool HasSide(this PanelSides self, PanelSides m)
+		{
+			// PERF: Enum.HasFlag is slower and requires allocations.
+			return (self & m) == m;
+		}
+	}
+
 	public static class ChromeProvider
 	{
-		struct Collection
+		public class Collection
 		{
-			public string Src;
-			public Dictionary<string, MappedImage> Regions;
+			public readonly string Image = null;
+			public readonly string Image2x = null;
+			public readonly string Image3x = null;
+
+			public readonly int[] PanelRegion = null;
+			public readonly PanelSides PanelSides = PanelSides.All;
+			public readonly Dictionary<string, Rectangle> Regions = new Dictionary<string, Rectangle>();
 		}
 
+		public static IReadOnlyDictionary<string, Collection> Collections => collections;
 		static Dictionary<string, Collection> collections;
-		static Dictionary<string, Sheet> cachedSheets;
+		static Dictionary<string, (Sheet Sheet, int Density)> cachedSheets;
 		static Dictionary<string, Dictionary<string, Sprite>> cachedSprites;
+		static Dictionary<string, Sprite[]> cachedPanelSprites;
+		static Dictionary<Collection, (Sheet Sheet, int)> cachedCollectionSheets;
 
-		public static void Initialize(IEnumerable<string> chromeFiles)
+		static IReadOnlyFileSystem fileSystem;
+		static float dpiScale = 1;
+
+		public static void Initialize(ModData modData)
 		{
 			Deinitialize();
 
-			collections = new Dictionary<string, Collection>();
-			cachedSheets = new Dictionary<string, Sheet>();
-			cachedSprites = new Dictionary<string, Dictionary<string, Sprite>>();
+			// Load higher resolution images if available on HiDPI displays
+			if (Game.Renderer != null)
+				dpiScale = Game.Renderer.WindowScale;
 
-			var chrome = chromeFiles.Select(s => MiniYaml.FromFile(s)).Aggregate(MiniYaml.MergeLiberal);
+			fileSystem = modData.DefaultFileSystem;
+			collections = new Dictionary<string, Collection>();
+			cachedSheets = new Dictionary<string, (Sheet, int)>();
+			cachedSprites = new Dictionary<string, Dictionary<string, Sprite>>();
+			cachedPanelSprites = new Dictionary<string, Sprite[]>();
+			cachedCollectionSheets = new Dictionary<Collection, (Sheet, int)>();
+
+			var chrome = MiniYaml.Merge(modData.Manifest.Chrome
+				.Select(s => MiniYaml.FromStream(fileSystem.Open(s), s)));
 
 			foreach (var c in chrome)
-				LoadCollection(c.Key, c.Value);
+				if (!c.Key.StartsWith("^", StringComparison.Ordinal))
+					LoadCollection(c.Key, c.Value);
 		}
 
 		public static void Deinitialize()
 		{
 			if (cachedSheets != null)
 				foreach (var sheet in cachedSheets.Values)
-					sheet.Dispose();
+					sheet.Sheet.Dispose();
 
 			collections = null;
 			cachedSheets = null;
 			cachedSprites = null;
-		}
-
-		public static void Save(string file)
-		{
-			var root = new List<MiniYamlNode>();
-			foreach (var kv in collections)
-				root.Add(new MiniYamlNode(kv.Key, SaveCollection(kv.Value)));
-
-			root.WriteToFile(file);
-		}
-
-		static MiniYaml SaveCollection(Collection collection)
-		{
-			var root = new List<MiniYamlNode>();
-			foreach (var kv in collection.Regions)
-				root.Add(new MiniYamlNode(kv.Key, kv.Value.Save(collection.Src)));
-
-			return new MiniYaml(collection.Src, root);
+			cachedPanelSprites = null;
+			cachedCollectionSheets = null;
 		}
 
 		static void LoadCollection(string name, MiniYaml yaml)
 		{
 			if (Game.ModData.LoadScreen != null)
 				Game.ModData.LoadScreen.Display();
-			var collection = new Collection()
-			{
-				Src = yaml.Value,
-				Regions = yaml.Nodes.ToDictionary(n => n.Key, n => new MappedImage(yaml.Value, n.Value))
-			};
 
-			collections.Add(name, collection);
+			collections.Add(name, FieldLoader.Load<Collection>(yaml));
+		}
+
+		static (Sheet Sheet, int Density) SheetForCollection(Collection c)
+		{
+			// Outer cache avoids recalculating image names
+			if (!cachedCollectionSheets.TryGetValue(c, out (Sheet, int) sheetDensity))
+			{
+				var image = c.Image;
+				var density = 1;
+				if (dpiScale > 2 && !string.IsNullOrEmpty(c.Image3x))
+				{
+					image = c.Image3x;
+					density = 3;
+				}
+				else if (dpiScale > 1 && !string.IsNullOrEmpty(c.Image2x))
+				{
+					image = c.Image2x;
+					density = 2;
+				}
+
+				// Inner cache makes sure we share sheets between collections
+				if (!cachedSheets.TryGetValue(image, out sheetDensity))
+				{
+					Sheet sheet;
+					using (var stream = fileSystem.Open(image))
+						sheet = new Sheet(SheetType.BGRA, stream);
+
+					sheet.GetTexture().ScaleFilter = TextureScaleFilter.Linear;
+
+					sheetDensity = (sheet, density);
+					cachedSheets.Add(image, sheetDensity);
+				}
+
+				cachedCollectionSheets.Add(c, sheetDensity);
+			}
+
+			return sheetDensity;
 		}
 
 		public static Sprite GetImage(string collectionName, string imageName)
 		{
+			var image = TryGetImage(collectionName, imageName);
+			if (image == null)
+				throw new ArgumentException($"Sprite `{collectionName}/{imageName}` was not found.");
+
+			return image;
+		}
+
+		public static Sprite TryGetImage(string collectionName, string imageName)
+		{
+			if (string.IsNullOrEmpty(collectionName))
+				return null;
+
 			// Cached sprite
-			Dictionary<string, Sprite> cachedCollection;
-			Sprite sprite;
-			if (cachedSprites.TryGetValue(collectionName, out cachedCollection) && cachedCollection.TryGetValue(imageName, out sprite))
+			if (cachedSprites.TryGetValue(collectionName, out var cachedCollection) && cachedCollection.TryGetValue(imageName, out var sprite))
 				return sprite;
 
-			Collection collection;
-			if (!collections.TryGetValue(collectionName, out collection))
-			{
-				Log.Write("debug", "Could not find collection '{0}'", collectionName);
-				return null;
-			}
-
-			MappedImage mi;
-			if (!collection.Regions.TryGetValue(imageName, out mi))
+			if (!collections.TryGetValue(collectionName, out var collection))
 				return null;
 
-			// Cached sheet
-			Sheet sheet;
-			if (cachedSheets.ContainsKey(mi.Src))
-				sheet = cachedSheets[mi.Src];
-			else
-			{
-				sheet = new Sheet(mi.Src);
-				cachedSheets.Add(mi.Src, sheet);
-			}
+			if (!collection.Regions.TryGetValue(imageName, out var mi))
+				return null;
 
 			// Cache the sprite
+			var sheetDensity = SheetForCollection(collection);
 			if (cachedCollection == null)
 			{
 				cachedCollection = new Dictionary<string, Sprite>();
 				cachedSprites.Add(collectionName, cachedCollection);
 			}
 
-			var image = mi.GetImage(sheet);
+			var image = new Sprite(sheetDensity.Sheet, sheetDensity.Density * mi, TextureChannel.RGBA, 1f / sheetDensity.Density);
 			cachedCollection.Add(imageName, image);
 
 			return image;
 		}
+
+		public static Sprite[] GetPanelImages(string collectionName)
+		{
+			var panel = TryGetPanelImages(collectionName);
+			if (panel == null)
+				throw new ArgumentException($"Panel `{collectionName}` was not found.");
+
+			return panel;
+		}
+
+		public static Sprite[] TryGetPanelImages(string collectionName)
+		{
+			if (string.IsNullOrEmpty(collectionName))
+				return null;
+
+			// Cached sprite
+			if (cachedPanelSprites.TryGetValue(collectionName, out var cachedSprites))
+				return cachedSprites;
+
+			if (!collections.TryGetValue(collectionName, out var collection))
+				return null;
+
+			Sprite[] sprites;
+			if (collection.PanelRegion != null)
+			{
+				if (collection.PanelRegion.Length != 8)
+				{
+					Log.Write("debug", $"Collection '{collectionName}' does not define a valid PanelRegion");
+					return null;
+				}
+
+				// Cache the sprites
+				var sheetDensity = SheetForCollection(collection);
+				var pr = collection.PanelRegion;
+				var ps = collection.PanelSides;
+
+				var sides = new (PanelSides PanelSides, Rectangle Bounds)[]
+				{
+					(PanelSides.Top | PanelSides.Left, new Rectangle(pr[0], pr[1], pr[2], pr[3])),
+					(PanelSides.Top, new Rectangle(pr[0] + pr[2], pr[1], pr[4], pr[3])),
+					(PanelSides.Top | PanelSides.Right, new Rectangle(pr[0] + pr[2] + pr[4], pr[1], pr[6], pr[3])),
+					(PanelSides.Left, new Rectangle(pr[0], pr[1] + pr[3], pr[2], pr[5])),
+					(PanelSides.Center, new Rectangle(pr[0] + pr[2], pr[1] + pr[3], pr[4], pr[5])),
+					(PanelSides.Right, new Rectangle(pr[0] + pr[2] + pr[4], pr[1] + pr[3], pr[6], pr[5])),
+					(PanelSides.Bottom | PanelSides.Left, new Rectangle(pr[0], pr[1] + pr[3] + pr[5], pr[2], pr[7])),
+					(PanelSides.Bottom, new Rectangle(pr[0] + pr[2], pr[1] + pr[3] + pr[5], pr[4], pr[7])),
+					(PanelSides.Bottom | PanelSides.Right, new Rectangle(pr[0] + pr[2] + pr[4], pr[1] + pr[3] + pr[5], pr[6], pr[7]))
+				};
+
+				sprites = sides.Select(x => ps.HasSide(x.PanelSides) ? new Sprite(sheetDensity.Sheet, sheetDensity.Density * x.Bounds, TextureChannel.RGBA, 1f / sheetDensity.Density) : null)
+					.ToArray();
+			}
+			else
+			{
+				// PERF: We don't need to search for images if there are no definitions.
+				// PERF: It's more efficient to send an empty array rather than an array of 9 nulls.
+				if (!collection.Regions.Any())
+					return Array.Empty<Sprite>();
+
+				// Support manual definitions for unusual dialog layouts
+				sprites = new[]
+				{
+					TryGetImage(collectionName, "corner-tl"),
+					TryGetImage(collectionName, "border-t"),
+					TryGetImage(collectionName, "corner-tr"),
+					TryGetImage(collectionName, "border-l"),
+					TryGetImage(collectionName, "background"),
+					TryGetImage(collectionName, "border-r"),
+					TryGetImage(collectionName, "corner-bl"),
+					TryGetImage(collectionName, "border-b"),
+					TryGetImage(collectionName, "corner-br")
+				};
+			}
+
+			cachedPanelSprites.Add(collectionName, sprites);
+			return sprites;
+		}
+
+		public static Size GetMinimumPanelSize(string collectionName)
+		{
+			if (string.IsNullOrEmpty(collectionName))
+				return new Size(0, 0);
+
+			if (!collections.TryGetValue(collectionName, out var collection))
+			{
+				Log.Write("debug", "Could not find collection '{0}'", collectionName);
+				return new Size(0, 0);
+			}
+
+			if (collection.PanelRegion == null || collection.PanelRegion.Length != 8)
+			{
+				Log.Write("debug", "Collection '{0}' does not define a valid PanelRegion", collectionName);
+				return new Size(0, 0);
+			}
+
+			var pr = collection.PanelRegion;
+			return new Size(pr[2] + pr[6], pr[3] + pr[7]);
+		}
+
+		public static void SetDPIScale(float scale)
+		{
+			if (dpiScale == scale)
+				return;
+
+			dpiScale = scale;
+
+			// Clear the sprite caches so the new artwork can be loaded
+			// Sheets are not cleared: we assume that the extra memory overhead
+			// of having the same sheet in memory in multiple DPIs is better than
+			// the overhead of having to dispose and reload everything.
+			// Changing the DPI scale is rare, but if it does happen then there
+			// is a reasonable chance that it may happen again this session.
+			cachedSprites.Clear();
+			cachedPanelSprites.Clear();
+			cachedCollectionSheets.Clear();
+		}
 	}
 }

OpenRA.Game/Graphics/CursorManager.cs

@@ -0,0 +1,294 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using OpenRA.Primitives;
+
+namespace OpenRA.Graphics
+{
+	public sealed class CursorManager
+	{
+		class Cursor
+		{
+			public string Name;
+			public int2 PaddedSize;
+			public Rectangle Bounds;
+
+			public int Length;
+			public Sprite[] Sprites;
+			public IHardwareCursor[] Cursors;
+		}
+
+		readonly Dictionary<string, Cursor> cursors = new Dictionary<string, Cursor>();
+		readonly SheetBuilder sheetBuilder;
+		readonly GraphicSettings graphicSettings;
+
+		Cursor cursor;
+		bool isLocked = false;
+		int2 lockedPosition;
+		readonly bool hardwareCursorsDisabled = false;
+		bool hardwareCursorsDoubled = false;
+
+		public CursorManager(CursorProvider cursorProvider)
+		{
+			hardwareCursorsDisabled = Game.Settings.Graphics.DisableHardwareCursors;
+
+			graphicSettings = Game.Settings.Graphics;
+			sheetBuilder = new SheetBuilder(SheetType.BGRA);
+			foreach (var kv in cursorProvider.Cursors)
+			{
+				var frames = kv.Value.Frames;
+				var palette = !string.IsNullOrEmpty(kv.Value.Palette) ? cursorProvider.Palettes[kv.Value.Palette] : null;
+
+				var c = new Cursor
+				{
+					Name = kv.Key,
+					Bounds = Rectangle.FromLTRB(0, 0, 1, 1),
+
+					Length = 0,
+					Sprites = new Sprite[frames.Length],
+					Cursors = new IHardwareCursor[frames.Length]
+				};
+
+				// Hardware cursors have a number of odd platform-specific bugs/limitations.
+				// Reduce the number of edge cases by padding the individual frames such that:
+				// - the hotspot is inside the frame bounds (enforced by SDL)
+				// - all frames within a sequence have the same size (needed for macOS 10.15)
+				// - the frame size is a multiple of 8 (needed for Windows)
+				foreach (var f in frames)
+				{
+					// Hotspot is specified relative to the center of the frame
+					var hotspot = f.Offset.ToInt2() - kv.Value.Hotspot - new int2(f.Size) / 2;
+
+					// Resolve indexed data to real colours
+					var data = f.Data;
+					var type = f.Type;
+					if (type == SpriteFrameType.Indexed8)
+					{
+						data = ConvertIndexedToBgra(kv.Key, f, palette);
+						type = SpriteFrameType.Bgra32;
+					}
+
+					c.Sprites[c.Length++] = sheetBuilder.Add(data, type, f.Size, 0, hotspot);
+
+					// Bounds relative to the hotspot
+					c.Bounds = Rectangle.Union(c.Bounds, new Rectangle(hotspot, f.Size));
+				}
+
+				// Pad bottom-right edge to make the frame size a multiple of 8
+				c.PaddedSize = 8 * new int2((c.Bounds.Width + 7) / 8, (c.Bounds.Height + 7) / 8);
+
+				cursors.Add(kv.Key, c);
+			}
+
+			CreateOrUpdateHardwareCursors();
+
+			foreach (var s in sheetBuilder.AllSheets)
+				s.ReleaseBuffer();
+
+			Update();
+		}
+
+		void CreateOrUpdateHardwareCursors()
+		{
+			if (hardwareCursorsDisabled)
+				return;
+
+			// Dispose any existing cursors to avoid leaking native resources
+			ClearHardwareCursors();
+
+			foreach (var kv in cursors)
+			{
+				var template = kv.Value;
+				for (var i = 0; i < template.Sprites.Length; i++)
+				{
+					if (template.Cursors[i] != null)
+						template.Cursors[i].Dispose();
+
+					// Calculate the padding to position the frame within sequenceBounds
+					var paddingTL = -(template.Bounds.Location - template.Sprites[i].Offset.XY.ToInt2());
+					var paddingBR = template.PaddedSize - new int2(template.Sprites[i].Bounds.Size) - paddingTL;
+
+					var hardwareCursor = CreateHardwareCursor(kv.Key, template.Sprites[i], paddingTL, paddingBR, -template.Bounds.Location);
+					if (hardwareCursor != null)
+						template.Cursors[i] = hardwareCursor;
+					else
+					{
+						Log.Write("debug", $"Failed to initialize hardware cursor for {template.Name}.");
+						Console.WriteLine($"Failed to initialize hardware cursor for {template.Name}.");
+					}
+				}
+			}
+
+			hardwareCursorsDoubled = graphicSettings.CursorDouble;
+		}
+
+		public void SetCursor(string cursorName)
+		{
+			if ((cursorName == null && cursor == null) || (cursor != null && cursorName == cursor.Name))
+				return;
+
+			if (cursorName == null || !cursors.TryGetValue(cursorName, out cursor))
+				cursor = null;
+
+			Update();
+		}
+
+		int frame;
+		int ticks;
+
+		public void Tick()
+		{
+			if (hardwareCursorsDoubled != graphicSettings.CursorDouble)
+			{
+				CreateOrUpdateHardwareCursors();
+				Update();
+			}
+
+			if (cursor == null || cursor.Cursors.Length == 1)
+				return;
+
+			if (++ticks > 2)
+			{
+				ticks -= 2;
+				frame++;
+
+				Update();
+			}
+		}
+
+		void Update()
+		{
+			if (cursor != null && frame >= cursor.Cursors.Length)
+				frame %= cursor.Cursors.Length;
+
+			var hardwareCursor = cursor?.Cursors[frame];
+			if (hardwareCursor == null || isLocked)
+				Game.Renderer.Window.SetHardwareCursor(null);
+			else
+				Game.Renderer.Window.SetHardwareCursor(hardwareCursor);
+		}
+
+		public void Render(Renderer renderer)
+		{
+			// Cursor is hidden
+			if (cursor == null)
+				return;
+
+			// Hardware cursor is enabled
+			if (!isLocked && cursor.Cursors[frame % cursor.Length] != null)
+				return;
+
+			// Render cursor in software
+			var doubleCursor = graphicSettings.CursorDouble;
+			var cursorSprite = cursor.Sprites[frame % cursor.Length];
+			var cursorScale = doubleCursor ? 2 : 1;
+
+			// Cursor is rendered in native window coordinates
+			// Apply same scaling rules as hardware cursors
+			if (Game.Renderer.NativeWindowScale > 1.5f)
+				cursorScale *= 2;
+
+			var mousePos = isLocked ? lockedPosition : Viewport.LastMousePos;
+			renderer.RgbaSpriteRenderer.DrawSprite(cursorSprite,
+				mousePos,
+				cursorScale / Game.Renderer.WindowScale);
+		}
+
+		public void Lock()
+		{
+			lockedPosition = Viewport.LastMousePos;
+			Game.Renderer.Window.SetRelativeMouseMode(true);
+			isLocked = true;
+			Update();
+		}
+
+		public void Unlock()
+		{
+			Game.Renderer.Window.SetRelativeMouseMode(false);
+			isLocked = false;
+			Update();
+		}
+
+		public static byte[] ConvertIndexedToBgra(string name, ISpriteFrame frame, ImmutablePalette palette)
+		{
+			if (frame.Type != SpriteFrameType.Indexed8)
+				throw new ArgumentException("ConvertIndexedToBgra requires input frames to be indexed.", nameof(frame));
+
+			// All palettes must be explicitly referenced, even if they are embedded in the sprite.
+			if (palette == null)
+				throw new InvalidOperationException($"Cursor sequence `{name}` attempted to load an indexed sprite but does not define Palette");
+
+			var width = frame.Size.Width;
+			var height = frame.Size.Height;
+			var data = new byte[4 * width * height];
+			unsafe
+			{
+				// Cast the data to an int array so we can copy the src data directly
+				fixed (byte* bd = &data[0])
+				{
+					var rgba = (uint*)bd;
+					for (var j = 0; j < height; j++)
+						for (var i = 0; i < width; i++)
+							rgba[j * width + i] = palette[frame.Data[j * width + i]];
+				}
+			}
+
+			return data;
+		}
+
+		IHardwareCursor CreateHardwareCursor(string name, Sprite data, int2 paddingTL, int2 paddingBR, int2 hotspot)
+		{
+			var size = data.Bounds.Size;
+			var srcStride = data.Sheet.Size.Width;
+			var srcData = data.Sheet.GetData();
+			var newWidth = paddingTL.X + size.Width + paddingBR.X;
+			var newHeight = paddingTL.Y + size.Height + paddingBR.Y;
+			var rgbaData = new byte[4 * newWidth * newHeight];
+
+			for (var j = 0; j < size.Height; j++)
+			{
+				for (var i = 0; i < size.Width; i++)
+				{
+					var src = 4 * ((j + data.Bounds.Top) * srcStride + data.Bounds.Left + i);
+					var dest = 4 * ((j + paddingTL.Y) * newWidth + i + paddingTL.X);
+					Array.Copy(srcData, src, rgbaData, dest, 4);
+				}
+			}
+
+			return Game.Renderer.Window.CreateHardwareCursor(name, new Size(newWidth, newHeight), rgbaData, hotspot, graphicSettings.CursorDouble);
+		}
+
+		void ClearHardwareCursors()
+		{
+			foreach (var c in cursors.Values)
+			{
+				for (var i = 0; i < c.Cursors.Length; i++)
+				{
+					if (c.Cursors[i] != null)
+					{
+						c.Cursors[i].Dispose();
+						c.Cursors[i] = null;
+					}
+				}
+			}
+		}
+
+		public void Dispose()
+		{
+			ClearHardwareCursors();
+
+			cursors.Clear();
+			sheetBuilder.Dispose();
+		}
+	}
+}

OpenRA.Game/Graphics/CursorProvider.cs

@@ -1,19 +1,18 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
 using System.Collections.Generic;
-using System.Drawing;
 using System.Linq;
-using OpenRA.FileSystem;
-using OpenRA.Primitives;
+using OpenRA.Traits;
 
 namespace OpenRA.Graphics
 {
@@ -24,35 +23,32 @@ namespace OpenRA.Graphics
 
 		public CursorProvider(ModData modData)
 		{
-			var sequenceFiles = modData.Manifest.Cursors;
-			var sequences = new MiniYaml(null, sequenceFiles.Select(s => MiniYaml.FromFile(s)).Aggregate(MiniYaml.MergeLiberal));
-			var shadowIndex = new int[] { };
+			var fileSystem = modData.DefaultFileSystem;
+			var sequenceYaml = MiniYaml.Merge(modData.Manifest.Cursors.Select(
+				s => MiniYaml.FromStream(fileSystem.Open(s), s)));
 
-			var nodesDict = sequences.ToDictionary();
-			if (nodesDict.ContainsKey("ShadowIndex"))
-			{
-				Array.Resize(ref shadowIndex, shadowIndex.Length + 1);
-				Exts.TryParseIntegerInvariant(nodesDict["ShadowIndex"].Value,
-					out shadowIndex[shadowIndex.Length - 1]);
-			}
+			var nodesDict = new MiniYaml(null, sequenceYaml).ToDictionary();
 
-			var palettes = new Dictionary<string, ImmutablePalette>();
-			foreach (var p in nodesDict["Palettes"].Nodes)
-				palettes.Add(p.Key, new ImmutablePalette(GlobalFileSystem.Open(p.Value.Value), shadowIndex));
+			// Overwrite previous definitions if there are duplicates
+			var pals = new Dictionary<string, IProvidesCursorPaletteInfo>();
+			foreach (var p in modData.DefaultRules.Actors[SystemActors.World].TraitInfos<IProvidesCursorPaletteInfo>())
+				if (p.Palette != null)
+					pals[p.Palette] = p;
 
-			Palettes = palettes.AsReadOnly();
+			Palettes = nodesDict["Cursors"].Nodes.Select(n => n.Value.Value)
+				.Where(p => p != null)
+				.Distinct()
+				.ToDictionary(p => p, p => pals[p].ReadPalette(modData.DefaultFileSystem));
 
-			var frameCache = new FrameCache(modData.SpriteLoaders);
+			var frameCache = new FrameCache(fileSystem, modData.SpriteLoaders);
 			var cursors = new Dictionary<string, CursorSequence>();
 			foreach (var s in nodesDict["Cursors"].Nodes)
 				foreach (var sequence in s.Value.Nodes)
 					cursors.Add(sequence.Key, new CursorSequence(frameCache, sequence.Key, s.Key, s.Value.Value, sequence.Value));
 
-			Cursors = cursors.AsReadOnly();
+			Cursors = cursors;
 		}
 
-		public static bool CursorViewportZoomed { get { return Game.Settings.Graphics.CursorDouble && Game.Settings.Graphics.PixelDouble; } }
-
 		public bool HasCursorSequence(string cursor)
 		{
 			return Cursors.ContainsKey(cursor);
@@ -63,7 +59,7 @@ namespace OpenRA.Graphics
 			try { return Cursors[cursor]; }
 			catch (KeyNotFoundException)
 			{
-				throw new InvalidOperationException("Cursor does not have a sequence `{0}`".F(cursor));
+				throw new InvalidOperationException($"Cursor does not have a sequence `{cursor}`");
 			}
 		}
 	}

OpenRA.Game/Graphics/CursorSequence.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -30,8 +31,10 @@ namespace OpenRA.Graphics
 			Palette = palette;
 			Name = name;
 
+			Frames = cache[cursorSrc].Skip(Start).ToArray();
+
 			if ((d.ContainsKey("Length") && d["Length"].Value == "*") || (d.ContainsKey("End") && d["End"].Value == "*"))
-				Length = Frames.Length - Start;
+				Length = Frames.Length;
 			else if (d.ContainsKey("Length"))
 				Length = Exts.ParseIntegerInvariant(d["Length"].Value);
 			else if (d.ContainsKey("End"))
@@ -39,22 +42,17 @@ namespace OpenRA.Graphics
 			else
 				Length = 1;
 
-			Frames = cache[cursorSrc]
-				.Skip(Start)
-				.Take(Length)
-				.ToArray();
+			Frames = Frames.Take(Length).ToArray();
 
 			if (d.ContainsKey("X"))
 			{
-				int x;
-				Exts.TryParseIntegerInvariant(d["X"].Value, out x);
+				Exts.TryParseIntegerInvariant(d["X"].Value, out var x);
 				Hotspot = Hotspot.WithX(x);
 			}
 
 			if (d.ContainsKey("Y"))
 			{
-				int y;
-				Exts.TryParseIntegerInvariant(d["Y"].Value, out y);
+				Exts.TryParseIntegerInvariant(d["Y"].Value, out var y);
 				Hotspot = Hotspot.WithY(y);
 			}
 		}

OpenRA.Game/Graphics/HSLColor.cs

@@ -1,107 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Drawing;
-using OpenRA.Scripting;
-
-namespace OpenRA.Graphics
-{
-	public struct HSLColor : IScriptBindable
-	{
-		public readonly byte H;
-		public readonly byte S;
-		public readonly byte L;
-		public readonly Color RGB;
-
-		public static HSLColor FromHSV(float h, float s, float v)
-		{
-			var ll = 0.5f * (2 - s) * v;
-			var ss = (ll >= 1 || v <= 0) ? 0 : 0.5f * s * v / (ll <= 0.5f ? ll : 1 - ll);
-			return new HSLColor((byte)(255 * h), (byte)(255 * ss), (byte)(255 * ll));
-		}
-
-		public static HSLColor FromRGB(int r, int g, int b)
-		{
-			var c = Color.FromArgb(r, g, b);
-			var h = (byte)((c.GetHue() / 360.0f) * 255);
-			var s = (byte)(c.GetSaturation() * 255);
-			var l = (byte)(c.GetBrightness() * 255);
-			return new HSLColor(h, s, l);
-		}
-
-		public static Color RGBFromHSL(float h, float s, float l)
-		{
-			// Convert from HSL to RGB
-			var q = (l < 0.5f) ? l * (1 + s) : l + s - (l * s);
-			var p = 2 * l - q;
-
-			float[] trgb = { h + 1 / 3.0f, h, h - 1 / 3.0f };
-			float[] rgb = { 0, 0, 0 };
-
-			for (var k = 0; k < 3; k++)
-			{
-				while (trgb[k] < 0) trgb[k] += 1.0f;
-				while (trgb[k] > 1) trgb[k] -= 1.0f;
-			}
-
-			for (var k = 0; k < 3; k++)
-			{
-				if (trgb[k] < 1 / 6.0f)
-					rgb[k] = p + ((q - p) * 6 * trgb[k]);
-				else if (trgb[k] >= 1 / 6.0f && trgb[k] < 0.5)
-					rgb[k] = q;
-				else if (trgb[k] >= 0.5f && trgb[k] < 2.0f / 3)
-					rgb[k] = p + ((q - p) * 6 * (2.0f / 3 - trgb[k]));
-				else
-					rgb[k] = p;
-			}
-
-			return Color.FromArgb((int)(rgb[0] * 255), (int)(rgb[1] * 255), (int)(rgb[2] * 255));
-		}
-
-		public static bool operator ==(HSLColor me, HSLColor other)
-		{
-			return me.H == other.H && me.S == other.S && me.L == other.L;
-		}
-
-		public static bool operator !=(HSLColor me, HSLColor other) { return !(me == other); }
-
-		public HSLColor(byte h, byte s, byte l)
-		{
-			H = h;
-			S = s;
-			L = l;
-			RGB = RGBFromHSL(H / 255f, S / 255f, L / 255f);
-		}
-
-		public void ToHSV(out float h, out float s, out float v)
-		{
-			var ll = 2 * L / 255f;
-			var ss = S / 255f * ((ll <= 1) ? ll : 2 - ll);
-
-			h = H / 255f;
-			s = (2 * ss) / (ll + ss);
-			v = (ll + ss) / 2;
-		}
-
-		public override string ToString()
-		{
-			return "{0},{1},{2}".F(H, S, L);
-		}
-
-		public override int GetHashCode() { return H.GetHashCode() ^ S.GetHashCode() ^ L.GetHashCode(); }
-
-		public override bool Equals(object obj)
-		{
-			var o = obj as HSLColor?;
-			return o != null && o == this;
-		}
-	}
-}

OpenRA.Game/Graphics/HardwareCursor.cs

@@ -1,138 +0,0 @@
-#region Copyright & License Information
-/*
-* Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
-* This file is part of OpenRA, which is free software. It is made
-* available to you under the terms of the GNU General Public License
-* as published by the Free Software Foundation. For more information,
-* see COPYING.
-*/
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.Drawing;
-using System.Linq;
-using OpenRA.Graphics;
-using OpenRA.Primitives;
-
-namespace OpenRA.Graphics
-{
-	public class HardwareCursor : ICursor
-	{
-		readonly Dictionary<string, IHardwareCursor[]> hardwareCursors = new Dictionary<string, IHardwareCursor[]>();
-		readonly CursorProvider cursorProvider;
-		CursorSequence cursor;
-
-		public HardwareCursor(CursorProvider cursorProvider)
-		{
-			this.cursorProvider = cursorProvider;
-
-			foreach (var kv in cursorProvider.Cursors)
-			{
-				var palette = cursorProvider.Palettes[kv.Value.Palette];
-				var hc = kv.Value.Frames
-					.Select(f => CreateCursor(f, palette, kv.Key, kv.Value))
-					.ToArray();
-
-				hardwareCursors.Add(kv.Key, hc);
-			}
-
-			Update();
-		}
-
-		IHardwareCursor CreateCursor(ISpriteFrame f, ImmutablePalette palette, string name, CursorSequence sequence)
-		{
-			var hotspot = sequence.Hotspot - f.Offset.ToInt2() + new int2(f.Size) / 2;
-
-			// Expand the frame if required to include the hotspot
-			var frameWidth = f.Size.Width;
-			var dataWidth = f.Size.Width;
-			var dataX = 0;
-			if (hotspot.X < 0)
-			{
-				dataX = -hotspot.X;
-				dataWidth += dataX;
-				hotspot = hotspot.WithX(0);
-			}
-			else if (hotspot.X >= frameWidth)
-				dataWidth = hotspot.X + 1;
-
-			var frameHeight = f.Size.Height;
-			var dataHeight = f.Size.Height;
-			var dataY = 0;
-			if (hotspot.Y < 0)
-			{
-				dataY = -hotspot.Y;
-				dataHeight += dataY;
-				hotspot = hotspot.WithY(0);
-			}
-			else if (hotspot.Y >= frameHeight)
-				dataHeight = hotspot.Y + 1;
-
-			var data = new byte[4 * dataWidth * dataHeight];
-			for (var j = 0; j < frameHeight; j++)
-			{
-				for (var i = 0; i < frameWidth; i++)
-				{
-					var bytes = BitConverter.GetBytes(palette[f.Data[j * frameWidth + i]]);
-					var start = 4 * ((j + dataY) * dataWidth + dataX + i);
-					for (var k = 0; k < 4; k++)
-						data[start + k] = bytes[k];
-				}
-			}
-
-			return Game.Renderer.Device.CreateHardwareCursor(name, new Size(dataWidth, dataHeight), data, hotspot);
-		}
-
-		public void SetCursor(string cursorName)
-		{
-			if ((cursorName == null && cursor == null) || (cursor != null && cursorName == cursor.Name))
-				return;
-
-			if (cursorName == null || !cursorProvider.Cursors.TryGetValue(cursorName, out cursor))
-				cursor = null;
-
-			Update();
-		}
-
-		int frame;
-		int ticks;
-		public void Tick()
-		{
-			if (cursor == null || cursor.Length == 1)
-				return;
-
-			if (++ticks > 2)
-			{
-				ticks -= 2;
-				frame++;
-
-				Update();
-			}
-		}
-
-		void Update()
-		{
-			if (cursor == null)
-				Game.Renderer.Device.SetHardwareCursor(null);
-			else
-			{
-				if (frame >= cursor.Length)
-					frame = frame % cursor.Length;
-
-				Game.Renderer.Device.SetHardwareCursor(hardwareCursors[cursor.Name][frame]);
-			}
-		}
-
-		public void Render(Renderer renderer) { }
-
-		public void Dispose()
-		{
-			foreach (var cursors in hardwareCursors)
-				foreach (var cursor in cursors.Value)
-					cursor.Dispose();
-
-			hardwareCursors.Clear();
-		}
-	}
-}

OpenRA.Game/Graphics/HardwarePalette.cs

@@ -1,10 +1,11 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
@@ -16,76 +17,94 @@ namespace OpenRA.Graphics
 {
 	public sealed class HardwarePalette : IDisposable
 	{
-		public ITexture Texture { get; private set; }
+		public ITexture Texture { get; }
+		public ITexture ColorShifts { get; }
+
 		public int Height { get; private set; }
 		readonly Dictionary<string, ImmutablePalette> palettes = new Dictionary<string, ImmutablePalette>();
-		readonly Dictionary<string, MutablePalette> modifiablePalettes = new Dictionary<string, MutablePalette>();
-		readonly IReadOnlyDictionary<string, MutablePalette> readOnlyModifiablePalettes;
+		readonly Dictionary<string, MutablePalette> mutablePalettes = new Dictionary<string, MutablePalette>();
 		readonly Dictionary<string, int> indices = new Dictionary<string, int>();
-		byte[] buffer = new byte[0];
+		byte[] buffer = Array.Empty<byte>();
+		float[] colorShiftBuffer = Array.Empty<float>();
 
 		public HardwarePalette()
 		{
-			Texture = Game.Renderer.Device.CreateTexture();
-			readOnlyModifiablePalettes = modifiablePalettes.AsReadOnly();
+			Texture = Game.Renderer.Context.CreateTexture();
+			ColorShifts = Game.Renderer.Context.CreateTexture();
 		}
 
 		public bool Contains(string name)
 		{
-			return modifiablePalettes.ContainsKey(name) || palettes.ContainsKey(name);
+			return mutablePalettes.ContainsKey(name) || palettes.ContainsKey(name);
 		}
 
 		public IPalette GetPalette(string name)
 		{
-			MutablePalette mutable;
-			if (modifiablePalettes.TryGetValue(name, out mutable))
+			if (mutablePalettes.TryGetValue(name, out var mutable))
 				return mutable.AsReadOnly();
-			ImmutablePalette immutable;
-			if (palettes.TryGetValue(name, out immutable))
+			if (palettes.TryGetValue(name, out var immutable))
 				return immutable;
-			throw new InvalidOperationException("Palette `{0}` does not exist".F(name));
+			throw new InvalidOperationException($"Palette `{name}` does not exist");
 		}
 
 		public int GetPaletteIndex(string name)
 		{
-			int ret;
-			if (!indices.TryGetValue(name, out ret))
-				throw new InvalidOperationException("Palette `{0}` does not exist".F(name));
+			if (!indices.TryGetValue(name, out var ret))
+				throw new InvalidOperationException($"Palette `{name}` does not exist");
 			return ret;
 		}
 
 		public void AddPalette(string name, ImmutablePalette p, bool allowModifiers)
 		{
 			if (palettes.ContainsKey(name))
-				throw new InvalidOperationException("Palette {0} has already been defined".F(name));
+				throw new InvalidOperationException($"Palette {name} has already been defined");
 
-			int index = palettes.Count;
+			// PERF: the first row in the palette textures is reserved as a placeholder for non-indexed sprites
+			// that do not have a color-shift applied. This provides a quick shortcut to avoid querying the
+			// color-shift texture for every pixel only to find that most are not shifted.
+			var index = palettes.Count + 1;
 			indices.Add(name, index);
 			palettes.Add(name, p);
 
-			if (palettes.Count > Height)
+			if (index >= Height)
 			{
-				Height = Exts.NextPowerOf2(palettes.Count);
+				Height = Exts.NextPowerOf2(index + 1);
 				Array.Resize(ref buffer, Height * Palette.Size * 4);
+				Array.Resize(ref colorShiftBuffer, Height * 4);
 			}
 
 			if (allowModifiers)
-				modifiablePalettes.Add(name, new MutablePalette(p));
+				mutablePalettes.Add(name, new MutablePalette(p));
 			else
 				CopyPaletteToBuffer(index, p);
 		}
 
 		public void ReplacePalette(string name, IPalette p)
 		{
-			if (modifiablePalettes.ContainsKey(name))
-				CopyPaletteToBuffer(indices[name], modifiablePalettes[name] = new MutablePalette(p));
+			if (mutablePalettes.ContainsKey(name))
+				CopyPaletteToBuffer(indices[name], mutablePalettes[name] = new MutablePalette(p));
 			else if (palettes.ContainsKey(name))
 				CopyPaletteToBuffer(indices[name], palettes[name] = new ImmutablePalette(p));
 			else
-				throw new InvalidOperationException("Palette `{0}` does not exist".F(name));
+				throw new InvalidOperationException($"Palette `{name}` does not exist");
 			CopyBufferToTexture();
 		}
 
+		public void SetColorShift(string name, float hueOffset, float satOffset, float minHue, float maxHue)
+		{
+			var index = GetPaletteIndex(name);
+			colorShiftBuffer[4 * index + 0] = hueOffset;
+			colorShiftBuffer[4 * index + 1] = satOffset;
+			colorShiftBuffer[4 * index + 2] = minHue;
+			colorShiftBuffer[4 * index + 3] = maxHue;
+		}
+
+		public bool HasColorShift(string name)
+		{
+			var index = GetPaletteIndex(name);
+			return colorShiftBuffer[4 * index + 2] != 0 || colorShiftBuffer[4 * index + 3] != 0;
+		}
+
 		public void Initialize()
 		{
 			CopyModifiablePalettesToBuffer();
@@ -99,26 +118,27 @@ namespace OpenRA.Graphics
 
 		void CopyModifiablePalettesToBuffer()
 		{
-			foreach (var kvp in modifiablePalettes)
+			foreach (var kvp in mutablePalettes)
 				CopyPaletteToBuffer(indices[kvp.Key], kvp.Value);
 		}
 
 		void CopyBufferToTexture()
 		{
 			Texture.SetData(buffer, Palette.Size, Height);
+			ColorShifts.SetFloatData(colorShiftBuffer, 1, Height);
 		}
 
 		public void ApplyModifiers(IEnumerable<IPaletteModifier> paletteMods)
 		{
 			foreach (var mod in paletteMods)
-				mod.AdjustPalette(readOnlyModifiablePalettes);
+				mod.AdjustPalette(mutablePalettes);
 
 			// Update our texture with the changes.
 			CopyModifiablePalettesToBuffer();
 			CopyBufferToTexture();
 
 			// Reset modified palettes back to their original colors, ready for next time.
-			foreach (var kvp in modifiablePalettes)
+			foreach (var kvp in mutablePalettes)
 			{
 				var originalPalette = palettes[kvp.Key];
 				var modifiedPalette = kvp.Value;
@@ -129,6 +149,7 @@ namespace OpenRA.Graphics
 		public void Dispose()
 		{
 			Texture.Dispose();
+			ColorShifts.Dispose();
 		}
 	}
 }

OpenRA.Game/Graphics/IGraphicsDevice.cs

@@ -1,138 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Drawing;
-using OpenRA.Graphics;
-
-namespace OpenRA
-{
-	[AttributeUsage(AttributeTargets.Assembly)]
-	public sealed class RendererAttribute : Attribute
-	{
-		public readonly Type Type;
-
-		public RendererAttribute(Type graphicsDeviceType)
-		{
-			if (!typeof(IDeviceFactory).IsAssignableFrom(graphicsDeviceType))
-				throw new InvalidOperationException("Incorrect type in RendererAttribute");
-			Type = graphicsDeviceType;
-		}
-	}
-
-	public interface IDeviceFactory
-	{
-		IGraphicsDevice Create(Size size, WindowMode windowMode);
-	}
-
-	public interface IHardwareCursor : IDisposable { }
-
-	public enum BlendMode : byte
-	{
-		None,
-		Alpha,
-		Additive,
-		Subtractive,
-		Multiply,
-		Multiplicative,
-		DoubleMultiplicative
-	}
-
-	public interface IGraphicsDevice : IDisposable
-	{
-		IVertexBuffer<Vertex> CreateVertexBuffer(int length);
-		ITexture CreateTexture(Bitmap bitmap);
-		ITexture CreateTexture();
-		IFrameBuffer CreateFrameBuffer(Size s);
-		IShader CreateShader(string name);
-
-		Size WindowSize { get; }
-
-		void Clear();
-		void Present();
-		Bitmap TakeScreenshot();
-		void PumpInput(IInputHandler inputHandler);
-		string GetClipboardText();
-		void DrawPrimitives(PrimitiveType type, int firstVertex, int numVertices);
-
-		void SetLineWidth(float width);
-		void EnableScissor(int left, int top, int width, int height);
-		void DisableScissor();
-
-		void EnableDepthBuffer();
-		void DisableDepthBuffer();
-
-		void SetBlendMode(BlendMode mode);
-
-		void GrabWindowMouseFocus();
-		void ReleaseWindowMouseFocus();
-
-		IHardwareCursor CreateHardwareCursor(string name, Size size, byte[] data, int2 hotspot);
-		void SetHardwareCursor(IHardwareCursor cursor);
-	}
-
-	public interface IVertexBuffer<T> : IDisposable
-	{
-		void Bind();
-		void SetData(T[] vertices, int length);
-		void SetData(T[] vertices, int start, int length);
-		void SetData(IntPtr data, int start, int length);
-	}
-
-	public interface IShader
-	{
-		void SetVec(string name, float x);
-		void SetVec(string name, float x, float y);
-		void SetVec(string name, float[] vec, int length);
-		void SetTexture(string param, ITexture texture);
-		void SetMatrix(string param, float[] mtx);
-		void Render(Action a);
-	}
-
-	public enum TextureScaleFilter { Nearest, Linear }
-
-	public interface ITexture : IDisposable
-	{
-		void SetData(Bitmap bitmap);
-		void SetData(uint[,] colors);
-		void SetData(byte[] colors, int width, int height);
-		byte[] GetData();
-		Size Size { get; }
-		TextureScaleFilter ScaleFilter { get; set; }
-	}
-
-	public interface IFrameBuffer : IDisposable
-	{
-		void Bind();
-		void Unbind();
-		ITexture Texture { get; }
-	}
-
-	public enum PrimitiveType
-	{
-		PointList,
-		LineList,
-		TriangleList,
-		QuadList,
-	}
-
-	public struct Range<T>
-	{
-		public readonly T Start, End;
-		public Range(T start, T end) { Start = start; End = end; }
-	}
-
-	public enum WindowMode
-	{
-		Windowed,
-		Fullscreen,
-		PseudoFullscreen,
-	}
-}

OpenRA.Game/Graphics/LineRenderer.cs

@@ -1,174 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Collections.Generic;
-using System.Drawing;
-
-namespace OpenRA.Graphics
-{
-	public class LineRenderer : Renderer.IBatchRenderer
-	{
-		static readonly float2 Offset = new float2(0.5f, 0.5f);
-
-		readonly Renderer renderer;
-		readonly IShader shader;
-		readonly Action renderAction;
-
-		readonly Vertex[] vertices;
-		int nv = 0;
-
-		float lineWidth = 1f;
-
-		public LineRenderer(Renderer renderer, IShader shader)
-		{
-			this.renderer = renderer;
-			this.shader = shader;
-			vertices = new Vertex[renderer.TempBufferSize];
-			renderAction = () =>
-			{
-				renderer.SetLineWidth(LineWidth);
-				renderer.DrawBatch(vertices, nv, PrimitiveType.LineList);
-			};
-		}
-
-		public float LineWidth
-		{
-			get
-			{
-				return lineWidth;
-			}
-
-			set
-			{
-				if (LineWidth != value)
-					Flush();
-
-				lineWidth = value;
-			}
-		}
-
-		public void Flush()
-		{
-			if (nv > 0)
-			{
-				renderer.Device.SetBlendMode(BlendMode.Alpha);
-				shader.Render(renderAction);
-				renderer.Device.SetBlendMode(BlendMode.None);
-
-				nv = 0;
-			}
-		}
-
-		public void DrawRect(float2 tl, float2 br, Color c)
-		{
-			var tr = new float2(br.X, tl.Y);
-			var bl = new float2(tl.X, br.Y);
-			DrawLine(tl, tr, c);
-			DrawLine(tl, bl, c);
-			DrawLine(tr, br, c);
-			DrawLine(bl, br, c);
-		}
-
-		public void DrawLine(float2 start, float2 end, Color color)
-		{
-			renderer.CurrentBatchRenderer = this;
-
-			if (nv + 2 > renderer.TempBufferSize)
-				Flush();
-
-			color = Util.PremultiplyAlpha(color);
-			var r = color.R / 255.0f;
-			var g = color.G / 255.0f;
-			var b = color.B / 255.0f;
-			var a = color.A / 255.0f;
-			vertices[nv++] = new Vertex(start + Offset, r, g, b, a);
-			vertices[nv++] = new Vertex(end + Offset, r, g, b, a);
-		}
-
-		public void DrawLine(float2 start, float2 end, Color startColor, Color endColor)
-		{
-			renderer.CurrentBatchRenderer = this;
-
-			if (nv + 2 > renderer.TempBufferSize)
-				Flush();
-
-			startColor = Util.PremultiplyAlpha(startColor);
-			var r = startColor.R / 255.0f;
-			var g = startColor.G / 255.0f;
-			var b = startColor.B / 255.0f;
-			var a = startColor.A / 255.0f;
-			vertices[nv++] = new Vertex(start + Offset, r, g, b, a);
-
-			endColor = Util.PremultiplyAlpha(endColor);
-			r = endColor.R / 255.0f;
-			g = endColor.G / 255.0f;
-			b = endColor.B / 255.0f;
-			a = endColor.A / 255.0f;
-			vertices[nv++] = new Vertex(end + Offset, r, g, b, a);
-		}
-
-		public void DrawLineStrip(IEnumerable<float2> points, Color color)
-		{
-			renderer.CurrentBatchRenderer = this;
-
-			color = Util.PremultiplyAlpha(color);
-			var r = color.R / 255.0f;
-			var g = color.G / 255.0f;
-			var b = color.B / 255.0f;
-			var a = color.A / 255.0f;
-
-			var first = true;
-			var prev = new Vertex();
-			foreach (var point in points)
-			{
-				if (first)
-				{
-					first = false;
-					prev = new Vertex(point + Offset, r, g, b, a);
-					continue;
-				}
-
-				if (nv + 2 > renderer.TempBufferSize)
-					Flush();
-
-				vertices[nv++] = prev;
-				prev = new Vertex(point + Offset, r, g, b, a);
-				vertices[nv++] = prev;
-			}
-		}
-
-		public void FillRect(RectangleF r, Color color)
-		{
-			for (var y = r.Top; y < r.Bottom; y++)
-				DrawLine(new float2(r.Left, y), new float2(r.Right, y), color);
-		}
-
-		public void FillEllipse(RectangleF r, Color color)
-		{
-			var a = (r.Right - r.Left) / 2;
-			var b = (r.Bottom - r.Top) / 2;
-			var xc = (r.Right + r.Left) / 2;
-			var yc = (r.Bottom + r.Top) / 2;
-			for (var y = r.Top; y <= r.Bottom; y++)
-			{
-				var dx = a * (float)Math.Sqrt(1 - (y - yc) * (y - yc) / b / b);
-				DrawLine(new float2(xc - dx, y), new float2(xc + dx, y), color);
-			}
-		}
-
-		public void SetViewportParams(Size screen, float zoom, int2 scroll)
-		{
-			shader.SetVec("Scroll", scroll.X, scroll.Y);
-			shader.SetVec("r1", zoom * 2f / screen.Width, -zoom * 2f / screen.Height);
-			shader.SetVec("r2", -1, 1);
-		}
-	}
-}

OpenRA.Game/Graphics/MappedImage.cs

@@ -1,43 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using System.Drawing;
-
-namespace OpenRA.Graphics
-{
-	class MappedImage
-	{
-		readonly Rectangle rect = Rectangle.Empty;
-		public readonly string Src;
-
-		public MappedImage(string defaultSrc, MiniYaml info)
-		{
-			FieldLoader.LoadField(this, "rect", info.Value);
-			FieldLoader.Load(this, info);
-			if (Src == null)
-				Src = defaultSrc;
-		}
-
-		public Sprite GetImage(Sheet s)
-		{
-			return new Sprite(s, rect, TextureChannel.Alpha);
-		}
-
-		public MiniYaml Save(string defaultSrc)
-		{
-			var root = new List<MiniYamlNode>();
-			if (defaultSrc != Src)
-				root.Add(new MiniYamlNode("Src", Src));
-
-			return new MiniYaml(FieldSaver.FormatValue(this, this.GetType().GetField("rect")), root);
-		}
-	}
-}

OpenRA.Game/Graphics/Minimap.cs

@@ -1,148 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
- * This file is part of OpenRA, which is free software. It is made
- * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
- */
-#endregion
-
-using System;
-using System.Drawing;
-using System.Drawing.Imaging;
-using System.Linq;
-using OpenRA.Traits;
-
-namespace OpenRA.Graphics
-{
-	public static class Minimap
-	{
-		public static Bitmap TerrainBitmap(TileSet tileset, Map map, bool actualSize = false)
-		{
-			var isDiamond = map.TileShape == TileShape.Diamond;
-			var b = map.Bounds;
-
-			// Fudge the heightmap offset by adding as much extra as we need / can.
-			// This tries to correct for our incorrect assumption that MPos == PPos
-			var heightOffset = Math.Min(map.MaximumTerrainHeight, map.MapSize.Y - b.Bottom);
-			var width = b.Width;
-			var height = b.Height + heightOffset;
-
-			var bitmapWidth = width;
-			if (isDiamond)
-				bitmapWidth = 2 * bitmapWidth - 1;
-
-			if (!actualSize)
-				bitmapWidth = height = Exts.NextPowerOf2(Math.Max(bitmapWidth, height));
-
-			var terrain = new Bitmap(bitmapWidth, height);
-
-			var bitmapData = terrain.LockBits(terrain.Bounds(),
-				ImageLockMode.ReadWrite, PixelFormat.Format32bppArgb);
-
-			var mapTiles = map.MapTiles.Value;
-
-			unsafe
-			{
-				var colors = (int*)bitmapData.Scan0;
-				var stride = bitmapData.Stride / 4;
-				for (var y = 0; y < height; y++)
-				{
-					for (var x = 0; x < width; x++)
-					{
-						var uv = new MPos(x + b.Left, y + b.Top);
-						var type = tileset.GetTileInfo(mapTiles[uv]);
-						var leftColor = type != null ? type.LeftColor : Color.Black;
-
-						if (isDiamond)
-						{
-							// Odd rows are shifted right by 1px
-							var dx = uv.V & 1;
-							var rightColor = type != null ? type.RightColor : Color.Black;
-							if (x + dx > 0)
-								colors[y * stride + 2 * x + dx - 1] = leftColor.ToArgb();
-
-							if (2 * x + dx < stride)
-								colors[y * stride + 2 * x + dx] = rightColor.ToArgb();
-						}
-						else
-							colors[y * stride + x] = leftColor.ToArgb();
-					}
-				}
-			}
-
-			terrain.UnlockBits(bitmapData);
-			return terrain;
-		}
-
-		// Add the static resources defined in the map; if the map lives
-		// in a world use AddCustomTerrain instead
-		static Bitmap AddStaticResources(TileSet tileset, Map map, Ruleset resourceRules, Bitmap terrainBitmap)
-		{
-			var terrain = new Bitmap(terrainBitmap);
-			var isDiamond = map.TileShape == TileShape.Diamond;
-			var b = map.Bounds;
-
-			// Fudge the heightmap offset by adding as much extra as we need / can
-			// This tries to correct for our incorrect assumption that MPos == PPos
-			var heightOffset = Math.Min(map.MaximumTerrainHeight, map.MapSize.Y - b.Bottom);
-			var width = b.Width;
-			var height = b.Height + heightOffset;
-
-			var resources = resourceRules.Actors["world"].Traits.WithInterface<ResourceTypeInfo>()
-				.ToDictionary(r => r.ResourceType, r => r.TerrainType);
-
-			var bitmapData = terrain.LockBits(terrain.Bounds(),
-				ImageLockMode.ReadWrite, PixelFormat.Format32bppArgb);
-
-			unsafe
-			{
-				var colors = (int*)bitmapData.Scan0;
-				var stride = bitmapData.Stride / 4;
-				for (var y = 0; y < height; y++)
-				{
-					for (var x = 0; x < width; x++)
-					{
-						var uv = new MPos(x + b.Left, y + b.Top);
-						if (map.MapResources.Value[uv].Type == 0)
-							continue;
-
-						string res;
-						if (!resources.TryGetValue(map.MapResources.Value[uv].Type, out res))
-							continue;
-
-						var color = tileset[tileset.GetTerrainIndex(res)].Color.ToArgb();
-						if (isDiamond)
-						{
-							// Odd rows are shifted right by 1px
-							var dx = uv.V & 1;
-							if (x + dx > 0)
-								colors[y * stride + 2 * x + dx - 1] = color;
-
-							if (2 * x + dx < stride)
-								colors[y * stride + 2 * x + dx] = color;
-						}
-						else
-							colors[y * stride + x] = color;
-					}
-				}
-			}
-
-			terrain.UnlockBits(bitmapData);
-
-			return terrain;
-		}
-
-		public static Bitmap RenderMapPreview(TileSet tileset, Map map, bool actualSize)
-		{
-			return RenderMapPreview(tileset, map, map.Rules, actualSize);
-		}
-
-		public static Bitmap RenderMapPreview(TileSet tileset, Map map, Ruleset resourceRules, bool actualSize)
-		{
-			using (var terrain = TerrainBitmap(tileset, map, actualSize))
-				return AddStaticResources(tileset, map, resourceRules, terrain);
-		}
-	}
-}

OpenRA.Game/Graphics/Model.cs

@@ -0,0 +1,95 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using OpenRA.FileSystem;
+using OpenRA.Primitives;
+
+namespace OpenRA.Graphics
+{
+	public interface IModel
+	{
+		uint Frames { get; }
+		uint Sections { get; }
+
+		float[] TransformationMatrix(uint section, uint frame);
+		float[] Size { get; }
+		float[] Bounds(uint frame);
+		ModelRenderData RenderData(uint section);
+
+		/// <summary>Returns the smallest rectangle that covers all rotations of all frames in a model</summary>
+		Rectangle AggregateBounds { get; }
+	}
+
+	public readonly struct ModelRenderData
+	{
+		public readonly int Start;
+		public readonly int Count;
+		public readonly Sheet Sheet;
+
+		public ModelRenderData(int start, int count, Sheet sheet)
+		{
+			Start = start;
+			Count = count;
+			Sheet = sheet;
+		}
+	}
+
+	public interface IModelCache : IDisposable
+	{
+		IModel GetModel(string model);
+		IModel GetModelSequence(string model, string sequence);
+		bool HasModelSequence(string model, string sequence);
+		IVertexBuffer<Vertex> VertexBuffer { get; }
+	}
+
+	public interface IModelSequenceLoader
+	{
+		Action<string> OnMissingModelError { get; set; }
+		IModelCache CacheModels(IReadOnlyFileSystem fileSystem, ModData modData, IReadOnlyDictionary<string, MiniYamlNode> modelDefinitions);
+	}
+
+	public class PlaceholderModelSequenceLoader : IModelSequenceLoader
+	{
+		public Action<string> OnMissingModelError { get; set; }
+
+		class PlaceholderModelCache : IModelCache
+		{
+			public IVertexBuffer<Vertex> VertexBuffer => throw new NotImplementedException();
+
+			public void Dispose() { }
+
+			public IModel GetModel(string model)
+			{
+				throw new NotImplementedException();
+			}
+
+			public IModel GetModelSequence(string model, string sequence)
+			{
+				throw new NotImplementedException();
+			}
+
+			public bool HasModelSequence(string model, string sequence)
+			{
+				throw new NotImplementedException();
+			}
+		}
+
+		[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "IDE0060:Remove unused parameter", Justification = "Load game API")]
+		public PlaceholderModelSequenceLoader(ModData modData) { }
+
+		public IModelCache CacheModels(IReadOnlyFileSystem fileSystem, ModData modData, IReadOnlyDictionary<string, MiniYamlNode> modelDefinitions)
+		{
+			return new PlaceholderModelCache();
+		}
+	}
+}

OpenRA.Game/Graphics/ModelAnimation.cs

@@ -0,0 +1,51 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using OpenRA.Primitives;
+
+namespace OpenRA.Graphics
+{
+	public readonly struct ModelAnimation
+	{
+		public readonly IModel Model;
+		public readonly Func<WVec> OffsetFunc;
+		public readonly Func<WRot> RotationFunc;
+		public readonly Func<bool> DisableFunc;
+		public readonly Func<uint> FrameFunc;
+		public readonly bool ShowShadow;
+
+		public ModelAnimation(IModel model, Func<WVec> offset, Func<WRot> rotation, Func<bool> disable, Func<uint> frame, bool showshadow)
+		{
+			Model = model;
+			OffsetFunc = offset;
+			RotationFunc = rotation;
+			DisableFunc = disable;
+			FrameFunc = frame;
+			ShowShadow = showshadow;
+		}
+
+		public Rectangle ScreenBounds(WPos pos, WorldRenderer wr, float scale)
+		{
+			var r = Model.AggregateBounds;
+			var offset = OffsetFunc != null ? OffsetFunc() : WVec.Zero;
+			var xy = wr.ScreenPxPosition(pos) + wr.ScreenPxOffset(offset);
+
+			return Rectangle.FromLTRB(
+				xy.X + (int)(r.Left * scale),
+				xy.Y + (int)(r.Top * scale),
+				xy.X + (int)(r.Right * scale),
+				xy.Y + (int)(r.Bottom * scale));
+		}
+
+		public bool IsVisible => DisableFunc == null || !DisableFunc();
+	}
+}

OpenRA.Game/Graphics/ModelRenderer.cs

@@ -0,0 +1,377 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using OpenRA.Primitives;
+
+namespace OpenRA.Graphics
+{
+	public class ModelRenderProxy
+	{
+		public readonly Sprite Sprite;
+		public readonly Sprite ShadowSprite;
+		public readonly float ShadowDirection;
+		public readonly float3[] ProjectedShadowBounds;
+
+		public ModelRenderProxy(Sprite sprite, Sprite shadowSprite, float3[] projectedShadowBounds, float shadowDirection)
+		{
+			Sprite = sprite;
+			ShadowSprite = shadowSprite;
+			ProjectedShadowBounds = projectedShadowBounds;
+			ShadowDirection = shadowDirection;
+		}
+	}
+
+	public sealed class ModelRenderer : IDisposable
+	{
+		// Static constants
+		static readonly float[] ShadowDiffuse = new float[] { 0, 0, 0 };
+		static readonly float[] ShadowAmbient = new float[] { 1, 1, 1 };
+		static readonly float2 SpritePadding = new float2(2, 2);
+		static readonly float[] ZeroVector = new float[] { 0, 0, 0, 1 };
+		static readonly float[] ZVector = new float[] { 0, 0, 1, 1 };
+		static readonly float[] FlipMtx = Util.ScaleMatrix(1, -1, 1);
+		static readonly float[] ShadowScaleFlipMtx = Util.ScaleMatrix(2, -2, 2);
+		static readonly float[] GroundNormal = { 0, 0, 1, 1 };
+
+		readonly Renderer renderer;
+		readonly IShader shader;
+
+		readonly Dictionary<Sheet, IFrameBuffer> mappedBuffers = new Dictionary<Sheet, IFrameBuffer>();
+		readonly Stack<KeyValuePair<Sheet, IFrameBuffer>> unmappedBuffers = new Stack<KeyValuePair<Sheet, IFrameBuffer>>();
+		readonly List<(Sheet Sheet, Action Func)> doRender = new List<(Sheet, Action)>();
+
+		SheetBuilder sheetBuilderForFrame;
+		bool isInFrame;
+
+		public ModelRenderer(Renderer renderer, IShader shader)
+		{
+			this.renderer = renderer;
+			this.shader = shader;
+		}
+
+		public void SetPalette(ITexture palette)
+		{
+			shader.SetTexture("Palette", palette);
+		}
+
+		public void SetViewportParams()
+		{
+			var a = 2f / renderer.SheetSize;
+			var view = new[]
+			{
+				a, 0, 0, 0,
+				0, -a, 0, 0,
+				0, 0, -2 * a, 0,
+				-1, 1, 0, 1
+			};
+
+			shader.SetMatrix("View", view);
+		}
+
+		public ModelRenderProxy RenderAsync(
+			WorldRenderer wr, IEnumerable<ModelAnimation> models, in WRot camera, float scale,
+			in WRot groundOrientation, in WRot lightSource, float[] lightAmbientColor, float[] lightDiffuseColor,
+			PaletteReference color, PaletteReference normals, PaletteReference shadowPalette)
+		{
+			if (!isInFrame)
+				throw new InvalidOperationException("BeginFrame has not been called. You cannot render until a frame has been started.");
+
+			// Correct for inverted y-axis
+			var scaleTransform = Util.ScaleMatrix(scale, scale, scale);
+
+			// Correct for bogus light source definition
+			var lightYaw = Util.MakeFloatMatrix(new WRot(WAngle.Zero, WAngle.Zero, -lightSource.Yaw).AsMatrix());
+			var lightPitch = Util.MakeFloatMatrix(new WRot(WAngle.Zero, -lightSource.Pitch, WAngle.Zero).AsMatrix());
+			var ground = Util.MakeFloatMatrix(groundOrientation.AsMatrix());
+			var shadowTransform = Util.MatrixMultiply(Util.MatrixMultiply(lightPitch, lightYaw), Util.MatrixInverse(ground));
+
+			var groundNormal = Util.MatrixVectorMultiply(ground, GroundNormal);
+
+			var invShadowTransform = Util.MatrixInverse(shadowTransform);
+			var cameraTransform = Util.MakeFloatMatrix(camera.AsMatrix());
+			var invCameraTransform = Util.MatrixInverse(cameraTransform);
+			if (invCameraTransform == null)
+				throw new InvalidOperationException("Failed to invert the cameraTransform matrix during RenderAsync.");
+
+			// Sprite rectangle
+			var tl = new float2(float.MaxValue, float.MaxValue);
+			var br = new float2(float.MinValue, float.MinValue);
+
+			// Shadow sprite rectangle
+			var stl = new float2(float.MaxValue, float.MaxValue);
+			var sbr = new float2(float.MinValue, float.MinValue);
+
+			foreach (var m in models)
+			{
+				// Convert screen offset back to world coords
+				var offsetVec = Util.MatrixVectorMultiply(invCameraTransform, wr.ScreenVector(m.OffsetFunc()));
+				var offsetTransform = Util.TranslationMatrix(offsetVec[0], offsetVec[1], offsetVec[2]);
+
+				var worldTransform = Util.MakeFloatMatrix(m.RotationFunc().AsMatrix());
+				worldTransform = Util.MatrixMultiply(scaleTransform, worldTransform);
+				worldTransform = Util.MatrixMultiply(offsetTransform, worldTransform);
+
+				var bounds = m.Model.Bounds(m.FrameFunc());
+				var worldBounds = Util.MatrixAABBMultiply(worldTransform, bounds);
+				var screenBounds = Util.MatrixAABBMultiply(cameraTransform, worldBounds);
+				var shadowBounds = Util.MatrixAABBMultiply(shadowTransform, worldBounds);
+
+				// Aggregate bounds rects
+				tl = float2.Min(tl, new float2(screenBounds[0], screenBounds[1]));
+				br = float2.Max(br, new float2(screenBounds[3], screenBounds[4]));
+				stl = float2.Min(stl, new float2(shadowBounds[0], shadowBounds[1]));
+				sbr = float2.Max(sbr, new float2(shadowBounds[3], shadowBounds[4]));
+			}
+
+			// Inflate rects to ensure rendering is within bounds
+			tl -= SpritePadding;
+			br += SpritePadding;
+			stl -= SpritePadding;
+			sbr += SpritePadding;
+
+			// Corners of the shadow quad, in shadow-space
+			var corners = new float[][]
+			{
+				new[] { stl.X, stl.Y, 0, 1 },
+				new[] { sbr.X, sbr.Y, 0, 1 },
+				new[] { sbr.X, stl.Y, 0, 1 },
+				new[] { stl.X, sbr.Y, 0, 1 }
+			};
+
+			var shadowScreenTransform = Util.MatrixMultiply(cameraTransform, invShadowTransform);
+			var shadowGroundNormal = Util.MatrixVectorMultiply(shadowTransform, groundNormal);
+			var screenCorners = new float3[4];
+			for (var j = 0; j < 4; j++)
+			{
+				// Project to ground plane
+				corners[j][2] = -(corners[j][1] * shadowGroundNormal[1] / shadowGroundNormal[2] +
+								  corners[j][0] * shadowGroundNormal[0] / shadowGroundNormal[2]);
+
+				// Rotate to camera-space
+				corners[j] = Util.MatrixVectorMultiply(shadowScreenTransform, corners[j]);
+				screenCorners[j] = new float3(corners[j][0], corners[j][1], 0);
+			}
+
+			// Shadows are rendered at twice the resolution to reduce artifacts
+			CalculateSpriteGeometry(tl, br, 1, out var spriteSize, out var spriteOffset);
+			CalculateSpriteGeometry(stl, sbr, 2, out var shadowSpriteSize, out var shadowSpriteOffset);
+
+			if (sheetBuilderForFrame == null)
+				sheetBuilderForFrame = new SheetBuilder(SheetType.BGRA, AllocateSheet);
+
+			var sprite = sheetBuilderForFrame.Allocate(spriteSize, 0, spriteOffset);
+			var shadowSprite = sheetBuilderForFrame.Allocate(shadowSpriteSize, 0, shadowSpriteOffset);
+			var sb = sprite.Bounds;
+			var ssb = shadowSprite.Bounds;
+			var spriteCenter = new float2(sb.Left + sb.Width / 2, sb.Top + sb.Height / 2);
+			var shadowCenter = new float2(ssb.Left + ssb.Width / 2, ssb.Top + ssb.Height / 2);
+
+			var translateMtx = Util.TranslationMatrix(spriteCenter.X - spriteOffset.X, renderer.SheetSize - (spriteCenter.Y - spriteOffset.Y), 0);
+			var shadowTranslateMtx = Util.TranslationMatrix(shadowCenter.X - shadowSpriteOffset.X, renderer.SheetSize - (shadowCenter.Y - shadowSpriteOffset.Y), 0);
+			var correctionTransform = Util.MatrixMultiply(translateMtx, FlipMtx);
+			var shadowCorrectionTransform = Util.MatrixMultiply(shadowTranslateMtx, ShadowScaleFlipMtx);
+
+			doRender.Add((sprite.Sheet, () =>
+			{
+				foreach (var m in models)
+				{
+					// Convert screen offset to world offset
+					var offsetVec = Util.MatrixVectorMultiply(invCameraTransform, wr.ScreenVector(m.OffsetFunc()));
+					var offsetTransform = Util.TranslationMatrix(offsetVec[0], offsetVec[1], offsetVec[2]);
+
+					var rotations = Util.MakeFloatMatrix(m.RotationFunc().AsMatrix());
+					var worldTransform = Util.MatrixMultiply(scaleTransform, rotations);
+					worldTransform = Util.MatrixMultiply(offsetTransform, worldTransform);
+
+					var transform = Util.MatrixMultiply(cameraTransform, worldTransform);
+					transform = Util.MatrixMultiply(correctionTransform, transform);
+
+					var shadow = Util.MatrixMultiply(shadowTransform, worldTransform);
+					shadow = Util.MatrixMultiply(shadowCorrectionTransform, shadow);
+
+					var lightTransform = Util.MatrixMultiply(Util.MatrixInverse(rotations), invShadowTransform);
+
+					var frame = m.FrameFunc();
+					for (uint i = 0; i < m.Model.Sections; i++)
+					{
+						var rd = m.Model.RenderData(i);
+						var t = m.Model.TransformationMatrix(i, frame);
+						var it = Util.MatrixInverse(t);
+						if (it == null)
+							throw new InvalidOperationException($"Failed to invert the transformed matrix of frame {i} during RenderAsync.");
+
+						// Transform light vector from shadow -> world -> limb coords
+						var lightDirection = ExtractRotationVector(Util.MatrixMultiply(it, lightTransform));
+
+						Render(rd, wr.World.ModelCache, Util.MatrixMultiply(transform, t), lightDirection,
+							lightAmbientColor, lightDiffuseColor, color.TextureMidIndex, normals.TextureMidIndex);
+
+						// Disable shadow normals by forcing zero diffuse and identity ambient light
+						if (m.ShowShadow)
+							Render(rd, wr.World.ModelCache, Util.MatrixMultiply(shadow, t), lightDirection,
+								ShadowAmbient, ShadowDiffuse, shadowPalette.TextureMidIndex, normals.TextureMidIndex);
+					}
+				}
+			}));
+
+			var screenLightVector = Util.MatrixVectorMultiply(invShadowTransform, ZVector);
+			screenLightVector = Util.MatrixVectorMultiply(cameraTransform, screenLightVector);
+			return new ModelRenderProxy(sprite, shadowSprite, screenCorners, -screenLightVector[2] / screenLightVector[1]);
+		}
+
+		static void CalculateSpriteGeometry(float2 tl, float2 br, float scale, out Size size, out int2 offset)
+		{
+			var width = (int)(scale * (br.X - tl.X));
+			var height = (int)(scale * (br.Y - tl.Y));
+			offset = (0.5f * scale * (br + tl)).ToInt2();
+
+			// Width and height must be even to avoid rendering glitches
+			if ((width & 1) == 1)
+				width += 1;
+			if ((height & 1) == 1)
+				height += 1;
+
+			size = new Size(width, height);
+		}
+
+		static float[] ExtractRotationVector(float[] mtx)
+		{
+			var tVec = Util.MatrixVectorMultiply(mtx, ZVector);
+			var tOrigin = Util.MatrixVectorMultiply(mtx, ZeroVector);
+			tVec[0] -= tOrigin[0] * tVec[3] / tOrigin[3];
+			tVec[1] -= tOrigin[1] * tVec[3] / tOrigin[3];
+			tVec[2] -= tOrigin[2] * tVec[3] / tOrigin[3];
+
+			// Renormalize
+			var w = (float)Math.Sqrt(tVec[0] * tVec[0] + tVec[1] * tVec[1] + tVec[2] * tVec[2]);
+			tVec[0] /= w;
+			tVec[1] /= w;
+			tVec[2] /= w;
+			tVec[3] = 1f;
+
+			return tVec;
+		}
+
+		void Render(
+			ModelRenderData renderData,
+			IModelCache cache,
+			float[] t, float[] lightDirection,
+			float[] ambientLight, float[] diffuseLight,
+			float colorPaletteTextureMidIndex, float normalsPaletteTextureMidIndex)
+		{
+			shader.SetTexture("DiffuseTexture", renderData.Sheet.GetTexture());
+			shader.SetVec("PaletteRows", colorPaletteTextureMidIndex, normalsPaletteTextureMidIndex);
+			shader.SetMatrix("TransformMatrix", t);
+			shader.SetVec("LightDirection", lightDirection, 4);
+			shader.SetVec("AmbientLight", ambientLight, 3);
+			shader.SetVec("DiffuseLight", diffuseLight, 3);
+
+			shader.PrepareRender();
+			renderer.DrawBatch(cache.VertexBuffer, renderData.Start, renderData.Count, PrimitiveType.TriangleList);
+		}
+
+		public void BeginFrame()
+		{
+			if (isInFrame)
+				throw new InvalidOperationException("BeginFrame has already been called. A new frame cannot be started until EndFrame has been called.");
+
+			isInFrame = true;
+
+			foreach (var kv in mappedBuffers)
+				unmappedBuffers.Push(kv);
+			mappedBuffers.Clear();
+		}
+
+		IFrameBuffer EnableFrameBuffer(Sheet s)
+		{
+			var fbo = mappedBuffers[s];
+			Game.Renderer.Flush();
+			fbo.Bind();
+
+			Game.Renderer.Context.EnableDepthBuffer();
+			return fbo;
+		}
+
+		void DisableFrameBuffer(IFrameBuffer fbo)
+		{
+			Game.Renderer.Flush();
+			Game.Renderer.Context.DisableDepthBuffer();
+			fbo.Unbind();
+		}
+
+		public void EndFrame()
+		{
+			if (!isInFrame)
+				throw new InvalidOperationException("BeginFrame has not been called. There is no frame to end.");
+
+			isInFrame = false;
+			sheetBuilderForFrame = null;
+
+			if (doRender.Count == 0)
+				return;
+
+			Sheet currentSheet = null;
+			IFrameBuffer fbo = null;
+			foreach (var v in doRender)
+			{
+				// Change sheet
+				if (v.Sheet != currentSheet)
+				{
+					if (fbo != null)
+						DisableFrameBuffer(fbo);
+
+					currentSheet = v.Sheet;
+					fbo = EnableFrameBuffer(currentSheet);
+				}
+
+				v.Func();
+			}
+
+			if (fbo != null)
+				DisableFrameBuffer(fbo);
+
+			doRender.Clear();
+		}
+
+		public Sheet AllocateSheet()
+		{
+			// Reuse cached fbo
+			if (unmappedBuffers.Count > 0)
+			{
+				var kv = unmappedBuffers.Pop();
+				mappedBuffers.Add(kv.Key, kv.Value);
+				return kv.Key;
+			}
+
+			var size = new Size(renderer.SheetSize, renderer.SheetSize);
+			var framebuffer = renderer.Context.CreateFrameBuffer(size);
+			var sheet = new Sheet(SheetType.BGRA, framebuffer.Texture);
+			mappedBuffers.Add(sheet, framebuffer);
+
+			return sheet;
+		}
+
+		public void Dispose()
+		{
+			foreach (var kvp in mappedBuffers.Concat(unmappedBuffers))
+			{
+				kvp.Key.Dispose();
+				kvp.Value.Dispose();
+			}
+
+			mappedBuffers.Clear();
+			unmappedBuffers.Clear();
+		}
+	}
+}

OpenRA.Game/Graphics/Palette.cs

@@ -1,20 +1,18 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
 using System;
 using System.Collections.Generic;
-using System.Drawing;
-using System.Drawing.Imaging;
 using System.IO;
-using System.Reflection;
-using System.Runtime.InteropServices;
+using OpenRA.Primitives;
 
 namespace OpenRA.Graphics
 {
@@ -35,35 +33,6 @@ namespace OpenRA.Graphics
 			return Color.FromArgb((int)palette[index]);
 		}
 
-		public static ColorPalette AsSystemPalette(this IPalette palette)
-		{
-			ColorPalette pal;
-			using (var b = new Bitmap(1, 1, PixelFormat.Format8bppIndexed))
-				pal = b.Palette;
-
-			for (var i = 0; i < Size; i++)
-				pal.Entries[i] = palette.GetColor(i);
-
-			// hack around a mono bug -- the palette flags get set wrong.
-			if (Platform.CurrentPlatform != PlatformType.Windows)
-				typeof(ColorPalette).GetField("flags",
-					BindingFlags.Instance | BindingFlags.NonPublic).SetValue(pal, 1);
-
-			return pal;
-		}
-
-		public static Bitmap AsBitmap(this IPalette palette)
-		{
-			var b = new Bitmap(Size, 1, PixelFormat.Format32bppArgb);
-			var data = b.LockBits(new Rectangle(0, 0, b.Width, b.Height),
-								  ImageLockMode.WriteOnly, PixelFormat.Format32bppArgb);
-			var temp = new uint[Palette.Size];
-			palette.CopyToArray(temp, 0);
-			Marshal.Copy((int[])(object)temp, 0, data.Scan0, Size);
-			b.UnlockBits(data);
-			return b;
-		}
-
 		public static IPalette AsReadOnly(this IPalette palette)
 		{
 			if (palette is ImmutablePalette)
@@ -73,9 +42,10 @@ namespace OpenRA.Graphics
 
 		class ReadOnlyPalette : IPalette
 		{
-			IPalette palette;
+			readonly IPalette palette;
 			public ReadOnlyPalette(IPalette palette) { this.palette = palette; }
-			public uint this[int index] { get { return palette[index]; } }
+			public uint this[int index] => palette[index];
+
 			public void CopyToArray(Array destination, int destinationOffset)
 			{
 				palette.CopyToArray(destination, destinationOffset);
@@ -87,28 +57,25 @@ namespace OpenRA.Graphics
 	{
 		readonly uint[] colors = new uint[Palette.Size];
 
-		public uint this[int index]
-		{
-			get { return colors[index]; }
-		}
+		public uint this[int index] => colors[index];
 
 		public void CopyToArray(Array destination, int destinationOffset)
 		{
 			Buffer.BlockCopy(colors, 0, destination, destinationOffset * 4, Palette.Size * 4);
 		}
 
-		public ImmutablePalette(string filename, int[] remap)
+		public ImmutablePalette(string filename, int[] remapTransparent, int[] remap)
 		{
 			using (var s = File.OpenRead(filename))
-				LoadFromStream(s, remap);
+				LoadFromStream(s, remapTransparent, remap);
 		}
 
-		public ImmutablePalette(Stream s, int[] remapShadow)
+		public ImmutablePalette(Stream s, int[] remapTransparent, int[] remapShadow)
 		{
-			LoadFromStream(s, remapShadow);
+			LoadFromStream(s, remapTransparent, remapShadow);
 		}
 
-		void LoadFromStream(Stream s, int[] remapShadow)
+		void LoadFromStream(Stream s, int[] remapTransparent, int[] remapShadow)
 		{
 			using (var reader = new BinaryReader(s))
 				for (var i = 0; i < Palette.Size; i++)
@@ -116,10 +83,18 @@ namespace OpenRA.Graphics
 					var r = (byte)(reader.ReadByte() << 2);
 					var g = (byte)(reader.ReadByte() << 2);
 					var b = (byte)(reader.ReadByte() << 2);
+
+					// Replicate high bits into the (currently zero) low bits.
+					r |= (byte)(r >> 6);
+					g |= (byte)(g >> 6);
+					b |= (byte)(b >> 6);
+
 					colors[i] = (uint)((255 << 24) | (r << 16) | (g << 8) | b);
 				}
 
-			colors[0] = 0; // Convert black background to transparency.
+			foreach (var i in remapTransparent)
+				colors[i] = 0;
+
 			foreach (var i in remapShadow)
 				colors[i] = 140u << 24;
 		}
@@ -133,7 +108,7 @@ namespace OpenRA.Graphics
 
 		public ImmutablePalette(IPalette p)
 		{
-			for (int i = 0; i < Palette.Size; i++)
+			for (var i = 0; i < Palette.Size; i++)
 				colors[i] = p[i];
 		}
 
@@ -151,8 +126,8 @@ namespace OpenRA.Graphics
 
 		public uint this[int index]
 		{
-			get { return colors[index]; }
-			set { colors[index] = value; }
+			get => colors[index];
+			set => colors[index] = value;
 		}
 
 		public void CopyToArray(Array destination, int destinationOffset)

OpenRA.Game/Graphics/PaletteReference.cs

@@ -1,19 +1,14 @@
 #region Copyright & License Information
 /*
- * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
+ * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
  * This file is part of OpenRA, which is free software. It is made
  * available to you under the terms of the GNU General Public License
- * as published by the Free Software Foundation. For more information,
- * see COPYING.
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
  */
 #endregion
 
-using System;
-using System.Collections.Generic;
-using System.Drawing;
-using System.Linq;
-using OpenRA.Traits;
-
 namespace OpenRA.Graphics
 {
 	public sealed class PaletteReference
@@ -23,8 +18,8 @@ namespace OpenRA.Graphics
 
 		public readonly string Name;
 		public IPalette Palette { get; internal set; }
-		public float TextureIndex { get { return index / hardwarePalette.Height; } }
-		public float TextureMidIndex { get { return (index + 0.5f) / hardwarePalette.Height; } }
+		public float TextureIndex => index / hardwarePalette.Height;
+		public float TextureMidIndex => (index + 0.5f) / hardwarePalette.Height;
 
 		public PaletteReference(string name, int index, IPalette palette, HardwarePalette hardwarePalette)
 		{
@@ -33,5 +28,7 @@ namespace OpenRA.Graphics
 			this.index = index;
 			this.hardwarePalette = hardwarePalette;
 		}
+
+		public bool HasColorShift => hardwarePalette.HasColorShift(Name);
 	}
 }