Merge branch 'dev' into no-arh-or-debug-map-portrait-reload

Author: SnipUndercover

.azure-pipelines/prebuild.ps1

@@ -1,7 +1,20 @@
 # Make the Everest version match the build number.
 $BuildNumber = [string]([int]$env:BUILD_BUILDID + [int]$env:BUILD_BUILDIDOFFSET)
 $EverestPath = [io.path]::combine($env:BUILD_SOURCESDIRECTORY, 'Celeste.Mod.mm', 'Mod', 'Everest', 'Everest.cs')
-(Get-Content $EverestPath) -replace '(?<=public readonly static string VersionString = ")[^"]*', "1.$BuildNumber.0-azure-$(($env:BUILD_SOURCEVERSION).Substring(0, 5))" | Set-Content $EverestPath
+# Get the branch name from Azure Pipelines
+if ($env:SYSTEM_PULLREQUEST_PULLREQUESTID -ne $null) {
+  # Build triggered by a PR
+  $BranchName = "pr$env:SYSTEM_PULLREQUEST_PULLREQUESTNUMBER"
+} else {
+  # Build triggered by a regular push
+  $BranchName = $env:BUILD_SOURCEBRANCHNAME
+}
+# Compose the version string with branch info
+$SourceVersionShort = $env:BUILD_SOURCEVERSION.Substring(0, 5)
+$VersionString = "1.$BuildNumber.0-azure-$SourceVersionShort-$BranchName"
+
+# Set Version String
+(Get-Content $EverestPath) -replace '(?<=public readonly static string VersionString = ")[^"]*', $VersionString | Set-Content $EverestPath
 
 # Currently unstable/in development
 $HelperPath = [io.path]::combine($env:BUILD_SOURCESDIRECTORY, 'Celeste.Mod.mm', 'Mod', 'Helpers', 'EverestVersion.cs')

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/tas-check/1-get-build-url.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+# Waits for Azure to be finished building, and writes the download link to /tmp/everest-pr-tas-check/download-link.txt.
+# Parameter: commit SHA
+
+set -xeo pipefail
+
+get_build_id() {
+	curl 'https://dev.azure.com/EverestAPI/Everest/_apis/build/builds?definitions=3&statusFilter=completed' \
+		| jq -r ".value | map(select(.sourceVersion == \"${1}\")) | .[].id"
+}
+
+BUILD_ID=`get_build_id "$1"`
+while [ "${BUILD_ID}" == "" ]; do
+	sleep 60
+	BUILD_ID=`get_build_id "$1"`
+done
+
+mkdir -p /tmp/everest-pr-tas-check
+echo -n "https://dev.azure.com/EverestAPI/Everest/_apis/build/builds/${BUILD_ID}/artifacts?artifactName=main&api-version=5.0&%24format=zip" > /tmp/everest-pr-tas-check/download-link.txt

.github/tas-check/2-1-install.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+# Installs Everest from the branch to test, CelesteTAS and the mod that is going to be TASed.
+# Parameters: URL of the TAS files, URL of the mod bundle
+
+set -xeo pipefail
+
+docker build \
+	--build-arg "MAIN_BUILD_URL=`cat /tmp/everest-pr-tas-check/download-link.txt`" \
+	--build-arg "TAS_FILES_URL=$1" \
+	--build-arg "BUNDLE_DOWNLOAD_URL=$2" \
+	-t celeste .

.github/tas-check/2-2-install-inner.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+# Installs Everest from the branch to test, CelesteTAS and the mod that is going to be TASed.
+# Run from within the Docker image, where Celeste is installed at /home/ubuntu/celeste.
+
+set -xeo pipefail
+
+# download Everest
+cd /home/ubuntu
+curl --fail -Lo everest.zip "${MAIN_BUILD_URL}"
+unzip everest.zip
+rm -v everest.zip
+
+# copy Everest files to Celeste install
+mv -fv main/* celeste/
+rm -rfv main
+
+# install Everest in headless mode
+cd celeste
+chmod -v u+x MiniInstaller-linux
+./MiniInstaller-linux headless
+
+# download TAS files
+cd ..
+curl --fail -Lo t.zip "${TAS_FILES_URL}"
+unzip t.zip
+rm -v t.zip
+
+# install CelesteTAS
+cd celeste/Mods
+curl --fail -Lo CelesteTAS.zip "https://github.com/EverestAPI/CelesteTAS-EverestInterop/releases/download/v3.45.1/CelesteTAS.zip"
+
+# install the mod that is going to be TASed, downloaded as a bundle zip containing the mod zip
+# and all of its dependencies (https://maddie480.ovh/celeste/bundle-download?id=${TAS_TO_RUN})
+if ! [ "${BUNDLE_DOWNLOAD_URL}" == "" ]; then
+    curl --fail -Lo t.zip "${BUNDLE_DOWNLOAD_URL}"
+    unzip t.zip
+    rm -v t.zip
+fi

.github/tas-check/3-run.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# Runs the requested TAS and checks the result.
+# Parameter: path of the TAS to run
+
+set -xeo pipefail
+
+docker run \
+	--volume "/tmp/everest-pr-tas-check:/home/ubuntu/tas" \
+	--rm \
+	--name celeste celeste \
+	--sync-check-file "/home/ubuntu/$1" \
+	--sync-check-result /home/ubuntu/tas/result.json
+
+[ "`jq -r '.entries[].status' /tmp/everest-pr-tas-check/result.json`" == "success" ]

.github/tas-check/Dockerfile

@@ -0,0 +1,5 @@
+FROM max480/everest:vanilla
+
+ARG MAIN_BUILD_URL TAS_FILES_URL BUNDLE_DOWNLOAD_URL
+COPY 2-2-install-inner.sh /tmp
+RUN /tmp/2-2-install-inner.sh && rm /tmp/2-2-install-inner.sh

.github/tas-check/run-locally.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+# Builds and runs the TAS locally, calling the same scripts as the pipeline in order to test them.
+# Requires Docker and jq.
+
+if [ "$1" == "" ] || [ "$2" == "" ]; then
+    echo "Usage: ./run-locally.sh [Celeste|StrawberryJam2021] [commit SHA]"
+    exit 1
+fi
+
+set -xeo pipefail
+
+case "$1" in
+    "Celeste")
+        TAS_URL="https://github.com/VampireFlower/CelesteTAS/archive/60b1680e61e43ec4681d7c9053d249491e0fe905.zip"
+        TAS_PATH="CelesteTAS-60b1680e61e43ec4681d7c9053d249491e0fe905/0 - 100%.tas"
+        ;;
+
+    "StrawberryJam2021")
+        TAS_URL="https://github.com/VampireFlower/StrawberryJamTAS/archive/c9c589a8ef225def5aca869cc1ed3eedf588ec14.zip"
+        TAS_PATH="StrawberryJamTAS-c9c589a8ef225def5aca869cc1ed3eedf588ec14/0-SJ All Levels.tas"
+        BUNDLE_DOWNLOAD="https://celestemodupdater.0x0a.de/pinned-mods/StrawberryJam2021-Bundle-134df0f4.zip"
+        ;;
+
+    *)
+        echo "Unknown TAS: $1"
+        exit 1
+esac
+
+cd "`dirname "$0"`"
+./1-get-build-url.sh "$2"
+./2-1-install.sh "${TAS_URL}" "${BUNDLE_DOWNLOAD}"
+./3-run.sh "${TAS_PATH}"

.github/workflows/tas-sync-check.yml

@@ -0,0 +1,38 @@
+name: TAS Sync Check
+
+on:
+  pull_request:
+    branches: [dev]
+
+jobs:
+  check:
+    strategy:
+      matrix:
+        tas:
+          - name: Celeste 100%
+            url: "https://github.com/VampireFlower/CelesteTAS/archive/60b1680e61e43ec4681d7c9053d249491e0fe905.zip"
+            path: "CelesteTAS-60b1680e61e43ec4681d7c9053d249491e0fe905/0 - 100%.tas"
+
+          - name: Strawberry Jam All Levels
+            url: "https://github.com/VampireFlower/StrawberryJamTAS/archive/c9c589a8ef225def5aca869cc1ed3eedf588ec14.zip"
+            path: "StrawberryJamTAS-c9c589a8ef225def5aca869cc1ed3eedf588ec14/0-SJ All Levels.tas"
+            bundle: "https://celestemodupdater.0x0a.de/pinned-mods/StrawberryJam2021-Bundle-134df0f4.zip"
+
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    name: ${{ matrix.tas.name }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Wait for Azure build on commit ${{ github.sha }}
+      run: cd .github/tas-check && ./1-get-build-url.sh "${{ github.sha }}"
+
+    - name: Install Everest and required mods
+      run: cd .github/tas-check && ./2-1-install.sh "${{ matrix.tas.url }}" "${{ matrix.tas.bundle }}"
+
+    - name: Run TAS at ${{ matrix.tas.path }}
+      run: cd .github/tas-check && ./3-run.sh "${{ matrix.tas.path }}"

Celeste.Mod.mm/Mod/Everest/Everest.Loader.cs

@@ -1,7 +1,8 @@
-using Celeste.Mod.Backdrops;
+using Celeste.Mod.Backdrops;
 using Celeste.Mod.Core;
 using Celeste.Mod.Entities;
 using Celeste.Mod.Helpers;
+using Celeste.Mod.Registry;
 using MAB.DotIgnore;
 using Microsoft.Xna.Framework;
 using Monocle;
@@ -208,6 +209,7 @@ internal static void LoadAuto() {
 
                 watch.Stop();
                 Logger.Verbose("loader", $"ALL MODS LOADED IN {watch.ElapsedMilliseconds}ms");
+                Logger.Info("loader", $"Loaded {Everest._Modules.Count} modules");
 
                 try {
                     Watcher = new FileSystemWatcher {
@@ -609,36 +611,68 @@ internal static void ProcessAssembly(EverestModuleMetadata meta, Assembly asm, T
 
                             patch_Level.EntityLoader loader = null;
 
-                            ConstructorInfo ctor;
+                            ConstructorInfo ctor = null;
                             MethodInfo gen;
 
                             gen = type.GetMethod(genName, new Type[] { typeof(Level), typeof(LevelData), typeof(Vector2), typeof(EntityData) });
                             if (gen != null && gen.IsStatic && gen.ReturnType.IsCompatible(typeof(Entity))) {
-                                loader = (level, levelData, offset, entityData) => (Entity) gen.Invoke(null, new object[] { level, levelData, offset, entityData });
+                                loader = (level, levelData, offset, entityData) => {
+                                    var entityId = ((patch_Level)level).CreateEntityId(levelData, entityData);
+                                    var entity = (patch_Entity) gen.Invoke(null, new object[] { level, levelData, offset, entityData });
+                                    if (entity != null) {
+                                        entity.SourceData = entityData;
+                                        entity.SourceId = entityId;
+                                    }
+                                    
+                                    return entity;
+                                };
                                 goto RegisterEntityLoader;
                             }
 
                             ctor = type.GetConstructor(new Type[] { typeof(EntityData), typeof(Vector2), typeof(EntityID) });
                             if (ctor != null) {
-                                loader = (level, levelData, offset, entityData) => (Entity) ctor.Invoke(new object[] { entityData, offset, new EntityID(levelData.Name, entityData.ID + (patch_Level._isLoadingTriggers ? 10000000 : 0)) });
+                                loader = (level, levelData, offset, entityData) => {
+                                    var entityId = ((patch_Level)level).CreateEntityId(levelData, entityData);
+                                    var entity = (patch_Entity) ctor.Invoke(new object[] { entityData, offset, entityId });
+                                    entity.SourceData = entityData;
+                                    entity.SourceId = entityId;
+                                    
+                                    return entity;
+                                };
                                 goto RegisterEntityLoader;
                             }
 
                             ctor = type.GetConstructor(new Type[] { typeof(EntityData), typeof(Vector2) });
                             if (ctor != null) {
-                                loader = (level, levelData, offset, entityData) => (Entity) ctor.Invoke(new object[] { entityData, offset });
+                                loader = (level, levelData, offset, entityData) => {
+                                    var entity = (patch_Entity)ctor.Invoke(new object[] { entityData, offset });
+                                    entity.SourceData = entityData;
+                                    entity.SourceId = ((patch_Level)level).CreateEntityId(levelData, entityData);
+                                    
+                                    return entity;
+                                };
                                 goto RegisterEntityLoader;
                             }
 
                             ctor = type.GetConstructor(new Type[] { typeof(Vector2) });
                             if (ctor != null) {
-                                loader = (level, levelData, offset, entityData) => (Entity) ctor.Invoke(new object[] { offset });
+                                loader = (level, levelData, offset, entityData) => {
+                                    var entity = (patch_Entity)ctor.Invoke(new object[] { offset });
+                                    entity.SourceData = entityData;
+                                    entity.SourceId = ((patch_Level)level).CreateEntityId(levelData, entityData);
+                                    return entity;
+                                };
                                 goto RegisterEntityLoader;
                             }
 
                             ctor = type.GetConstructor(Type.EmptyTypes);
                             if (ctor != null) {
-                                loader = (level, levelData, offset, entityData) => (Entity) ctor.Invoke(null);
+                                loader = (level, levelData, offset, entityData) => {
+                                    var entity = (patch_Entity)ctor.Invoke(null);
+                                    entity.SourceData = entityData;
+                                    entity.SourceId = ((patch_Level)level).CreateEntityId(levelData, entityData);
+                                    return entity;
+                                };
                                 goto RegisterEntityLoader;
                             }
 
@@ -647,6 +681,13 @@ internal static void ProcessAssembly(EverestModuleMetadata meta, Assembly asm, T
                                 Logger.Warn("core", $"Found custom entity without suitable constructor / {genName}(Level, LevelData, Vector2, EntityData): {id} ({type.FullName})");
                                 continue;
                             }
+
+                            // Immediately register the connection when we're calling the ctor,
+                            // since we know the return type upfront.
+                            if (ctor != null) {
+                                EntityRegistry.RegisterSidToTypeConnection(id, ctor.DeclaringType);
+                            }
+                            
                             patch_Level.EntityLoaders[id] = loader;
                         }
                     }