mirror of
https://github.com/soarqin/DSP_Mods.git
synced 2026-11-19 17:05:20 +08:00
chore: remove obsoleted docs
This commit is contained in:
1 parent
9f48923166
commit
7e7d91e5b2
4 files changed
-1821
No files matched your search
@@ -1,55 +0,0 @@
|
||||
# DSP 0.10.35.29131 Compatibility
|
||||
|
||||
## Scope and sources
|
||||
|
||||
The 2026-10-12 audit compares the supplied DSP **0.10.35.29104** backup with the installed **0.10.35.29131**, Steam build **25878145**. It covers the maintained mods in `DSP_Mods.sln`, including Dustbin's preloader. The retired LabOpt projects are excluded.
|
||||
|
||||
Method bodies and metadata come from the original `DSPGAME_Data/Managed/Assembly-CSharp.dll` in:
|
||||
|
||||
- Previous game: `D:/Steam/steamapps/content/app_13466540/depot_1366541`.
|
||||
- Current game: `D:/Steam/steamapps/common/Dyson Sphere Program`, located through Steam's registry entry and `steamapps/libraryfolders.vdf`.
|
||||
|
||||
Versions come from each installation's `Updates/Versions.txt` and the installed `appmanifest_1366540.acf`. `AssemblyFromGame/Assembly-CSharp.dll` is refreshed only for compilation.
|
||||
|
||||
## Findings and fixes
|
||||
|
||||
The native assembly has 67 changed method bodies, 11 added fields, 3 removed fields, and two replaced method signatures. No types are added or removed. Eight changed methods are directly targeted by maintained mod patches:
|
||||
|
||||
| Native methods | Change relevant to review | Result |
|
||||
| --- | --- | --- |
|
||||
| `BuildTool_Reform.ExecuteBrushAction` | Terrain previews cache their preparation position and soil cost; soil cost moves from a local to a field. | Expanded brush and build-range patches still match. Flatten/restore execution signatures and soil guards remain valid. |
|
||||
| `BuildTool_BlueprintPaste.DetermineReforms` | A terrain calculation now divides floating-point operands. | The blueprint soil-check patch still matches the intended comparison. |
|
||||
| `BuildTool_Upgrade.DeterminePreviews` | Downgrade cursor text is distinguished from upgrade text. | Cursor-size and build-range patches retain their targets. |
|
||||
| `MonitorComponent.InternalUpdate` | Cargo deletion scans a locked belt buffer and adds locals and exception handling. | The stack-count patch still targets the earlier cargo query and its `Cargo` local; branch targets remain valid. |
|
||||
| `PlayerAction_Rts.GameTick` | Manual order cancellation changes for mining/building commands. | Globe-view conflict checks and auto-construct postfix bindings remain valid. |
|
||||
| `ProductionExtraInfoCalculator.CalculateFactory`, `UIReferenceSpeedTip.AddEntryDataWithFactory` | Ray Receiver catalyst storage and active-catalyst identification are corrected. | Mining-speed and protected-vein patches still target the mining calculations. |
|
||||
| `UIBuildMenu._OnUpdate` | Native vegetation-planting buttons are hidden. | The modifier-key patch still matches the native input checks. |
|
||||
|
||||
The audit also reproduces an existing UXAssist defect on **both** game versions: the Ray Receiver buffer setting is ignored. Native `GameTick_Gamma` tests `keyFrame && useIon && catalystCount < 2`, while the mod searches for a floating-point conversion followed by `20f`. The pattern is absent, so the guarded transpiler returns the original method and the configured threshold never takes effect.
|
||||
|
||||
The fix replaces the integer constant in the current catalyst-count comparison with `ReceiverBufferCount`. Only that constant changes. Native key-frame and mode checks, catalyst consumption, proliferation, both input ports, photon output, and branch destinations are preserved. The missing-pattern fallback still returns the original instructions. Native input can take stacked cargo, so the setting is an intake threshold rather than a strict inventory cap.
|
||||
|
||||
The bilingual help text and README now show the native threshold as **2**. UXAssist's existing **1.6.2** unreleased changelog includes the fix; mod versions are unchanged.
|
||||
|
||||
A subsequent mining-speed regression check finds an existing type error in `Increase maximum power usage in Logistic Stations and Advanced Mining Machines`. A floating-point slider constant makes the injected conversion delegate return `Single`, but native `OnMaxMiningSpeedChange` stores that result in an `Int32` local and then in `MinerComponent.speed`. This invalid IL corrupts the actual speed, rather than only its displayed percentage. A check using the original handler and the pre-fix package DLL reproduces invalid integer values; the exact result of the invalid IL depends on the runtime.
|
||||
|
||||
The conversion now explicitly returns `Int32`, preserves native rounding, and retains 100%–300% in 10-percentage-point steps and 400%–1,000% in 100-percentage-point steps. Its transpiler matches the complete native calculation without depending on a fixed local slot and returns the original instructions when that calculation is absent. For miners whose speed has already been corrupted, adjust the slider after installing the fix; the previous intended setting cannot be recovered reliably from the corrupted value.
|
||||
|
||||
LiveStreamAssist's offline text generator also fails on both game versions because it asks the type-tree generator for the removed `CreationPartProtoSet`; the original DLL and asset script metadata contain `VehiclePartProtoSet`. Its extraction map now uses the current type while preserving the public `creationPart` dictionary group. Text and icons are regenerated from the current installation, including item 1211, technology 1509, recipe 162, signal 519, updated English guide text, and current localized vegetation names. The offline layers retain their existing behavior and make no WebSocket requests.
|
||||
|
||||
## Validation
|
||||
|
||||
- `dotnet build DSP_Mods.sln -c Release --no-restore`: zero warnings and zero errors.
|
||||
- 217 prefix/postfix target and parameter bindings pass, including Dustbin's injected fields.
|
||||
- 212 transpiler applications: 200 transformations and 12 unchanged results. No target-resolution, transpiler-execution, branch-label, or missing-operand errors occur. The 12 unchanged results also occur with the previous game DLL.
|
||||
- Dustbin's actual preloader injects the two expected Boolean fields into a temporary copy of the original game assembly; its mod checks pass against that copy.
|
||||
- The receiver regression check fails before the fix because configuration value 1 leaves the native threshold at 2. After the fix, 21 assertions pass on each game version, covering thresholds 1, 2, 7, and 20, below/equal/above boundaries, emitted comparison types, preservation of surrounding instructions, and missing-pattern fallback.
|
||||
- 55 existing behavior assertions pass, including terrain buffer bounds, soil guards, saved brush restoration, and composition of both `ExecuteBrushAction` transpilers in either order.
|
||||
- 75 mining-speed assertions pass. The check executes the original handler with the injected conversion against real game data types, replacing only the Unity text setter with a recording function. It verifies actual miner-speed assignments and displayed percentages, every slider position, rounding boundaries, reopening readback, native event/station guards, the unpatched path, and complete/partial missing-pattern fallbacks. This check covers the return/local type mismatch that the earlier structural transpiler checks did not detect.
|
||||
- LiveStreamAssist's text and icon generators succeed against the current original game files; the dictionary includes 175 items and 315 technologies. Repacking the JS bundle produces no source changes.
|
||||
- 42 JS client/query/text/overlay checks and the Python locale/format checks pass. The full JS suite also includes seven pre-existing dashboard failures: its `FakeQuery` omits `getClusterString`, which the unchanged dashboard calls. The same seven failures reproduce in an isolated copy of the files from `HEAD`. These tests use their own mocked text data, independent of the regenerated dictionary.
|
||||
- `git diff --check` passes.
|
||||
|
||||
The temporary audit harness and raw comparison outputs remain under the excluded `UXAssist/obj/game-update-29131/` directory. `MONOMOD_DMD_TYPE=cecil` is set only for the check process so the repository's older MonoMod delegate generator can run on the installed .NET runtime. No detours are installed into the game.
|
||||
|
||||
These checks do not verify Unity rendering, live input, or native detour installation. In-game testing remains necessary: exercise expanded foundation/Restore Terrain brushes, monitor stack counting, globe-view movement and auto-construct, protected-vein estimates, and Ray Receiver intake with the buffer feature enabled and disabled.
|
||||
@@ -1,65 +0,0 @@
|
||||
# DSP 0.10.35 Compatibility
|
||||
|
||||
## Scope and sources
|
||||
|
||||
This update adapts UXAssist and CheatEnabler from DSP **0.10.34.28529** to the locally installed **0.10.35.29057**, Steam build **25482430**.
|
||||
|
||||
The comparison uses the original `DSPGAME_Data/Managed/Assembly-CSharp.dll` from the supplied previous-version depot and the Steam installation located through the registry and `steamapps/libraryfolders.vdf`. Version history comes from each installation's `Updates/Versions.txt`. In-game terminology comes from the installed `Locale/Names`, `Locale/1033`, and `Locale/2052` tables.
|
||||
|
||||
The publicized, stripped assemblies in `AssemblyFromGame/` are refreshed for compilation only. They are not used to inspect native method bodies.
|
||||
|
||||
## Assembly changes
|
||||
|
||||
The Assembly-CSharp metadata and IL comparison finds:
|
||||
|
||||
- 69 added types and 9 removed types.
|
||||
- 784 added fields and 78 removed fields.
|
||||
- 663 added method signatures and 46 removed method signatures.
|
||||
- 475 changed bodies among methods whose signatures remain present.
|
||||
|
||||
These counts include compiler-generated members. New code includes `Blackbox*`, `CreativeTool*`, and vehicle-part infrastructure, as well as vegetation collection and terrain restoration. The presence of a type does not establish that its feature is exposed in the current game UI.
|
||||
|
||||
## Compatibility changes
|
||||
|
||||
| Area | Native change | Mod adaptation |
|
||||
| --- | --- | --- |
|
||||
| Terrain tools | `BuildTool_Reform.ReformAction` is removed. Brush input and range checks move to `ExecuteBrushAction`; execution splits into `DoFlattenExecute` and `DoRestoreExecute`. | Retarget UXAssist's range and brush-limit patches. Allocate sufficient preview buffers for 30 x 30 brushes before preparing either terrain operation. Clamp active brushes on disable and oversized saved brushes on restore when the feature is inactive. |
|
||||
| Terraform anyway | Foundation placement and Restore Terrain now have separate soil deductions. | Bypass the foundation-count check in `DoFlattenExecute`. Clamp positive soil costs to the available balance in both execution methods, while retaining negative costs that award soil. Leave native terrain restoration and foundation refunds intact. |
|
||||
| Globe-view actions | `EViewMode.Create` shifts subsequent enum values: Globe is now 4 and Starmap is 5. | Match and emit named enum values. Extend the movement/mining camera-conflict getter results rather than relying on local-variable positions. |
|
||||
| Ray Receiver inventory | Stored catalysts move from accumulated `catalystPoint`/`catalystIncPoint` values to `catalystCount`/`catalystInc`. `catalystPoint` becomes the active catalyst's remaining lifetime. | Apply the configured buffer limit to the stored item count without multiplying by 3,600. Planet initialization returns stored catalysts and their proliferation points, matching native item take-back semantics. |
|
||||
| Mineral exhaustion | `NotifyVeinExhausted` gains `hasMinerLostAllVeins` and honors the new alert preference. | Determine whether a miner loses its last vein before removing the vein. Pass that result to the notification; oil depletion passes false, as in the native implementation. |
|
||||
| Handcrafting counts | Native Shift-click shortcuts bypass the old increment/decrement path. | Replace the count-button handlers while enhanced count control is enabled. Preserve normal steps of 1, Ctrl steps of 10, Shift steps of 100, Alt steps of 1,000, and the 1–1,000 bounds. |
|
||||
| Soil-change tips | `Player.SetSandCount` now updates soil progression before notifying subscribers. | Suppress `UIGame.OnSandCountChanged` instead of returning early from the player setter. Native progression and other subscribers remain intact. |
|
||||
| Batch technology buyout | The technology UI changes local-variable layout and adds prerequisite checks to buyout visibility. | Replace the visibility expression with a semantic predicate for locked, non-hidden, non-obsolete technologies. Preserve the native metadata toggle, sandbox exclusion, and surrounding selected/researching state handling. |
|
||||
|
||||
Affected transpilers use guarded matching and return the original instructions if their required pattern is absent. The mods now target the new terrain API; this is not a dual-version compatibility layer for 0.10.34.
|
||||
|
||||
## Validation
|
||||
|
||||
Both projects build in Release with zero warnings and zero errors after refreshing the game references:
|
||||
|
||||
```powershell
|
||||
dotnet build UpdateGameDlls/UpdateGameDlls.csproj
|
||||
dotnet build UXAssist/UXAssist.csproj -c Release --no-restore
|
||||
dotnet build CheatEnabler/CheatEnabler.csproj -c Release --no-restore
|
||||
git diff --check
|
||||
```
|
||||
|
||||
An ignored standalone check harness in `obj/dsp-compat/` reads the original game DLL and uses the repository's HarmonyX/BepInEx dependencies without installing game detours. It checks:
|
||||
|
||||
- 116 prefix/postfix target and parameter bindings.
|
||||
- 187 transpiler applications: 183 transformations and 4 unchanged results that also occur with the previous DLL. No target, matcher, branch-label, or operand checks fail.
|
||||
- 55 behavior assertions covering handcrafting modifiers, brush bounds and buffer reuse, disabled-feature save restoration, soil shortages and gains, buyout visibility, UI-only soil-tip suppression, and missing-pattern fallbacks.
|
||||
- The two `ExecuteBrushAction` transpilers compose in either order; these assertions are included in the behavior count.
|
||||
|
||||
These automated checks do not verify native detour installation or Unity rendering/input behavior. The user also confirmed that testing passed. Mod versions and package manifests are not changed; the changelog entries remain unreleased.
|
||||
|
||||
## In-game smoke checks
|
||||
|
||||
Use a disposable copy of a save for destructive reset/refund and mineral-depletion checks.
|
||||
|
||||
1. Test foundation placement and Restore Terrain with brush sizes 1, 10, 11, and 30, including line drawing. Disable expanded brushes and reload a save made with a large brush.
|
||||
2. Enable Terraform anyway with insufficient foundations and soil. Check foundation placement, terrain restoration, blueprint foundations, and base-pit removal. Soil must stay nonnegative, and soil gains and native refunds must remain available.
|
||||
3. Feed a Ray Receiver proliferated catalysts, check the configured buffer limit, and verify stored catalyst refunds through planet initialization on the disposable save.
|
||||
4. Exercise the mineral-exhaustion alert modes, globe-view movement/mining, and normal/Ctrl/Shift/Alt handcrafting count changes.
|
||||
5. Check batch buyout with missing prerequisites and verify hidden, obsolete, and already-unlocked technologies remain excluded. Hide soil tips and confirm soil-related progression still advances.
|
||||
@@ -1,334 +0,0 @@
|
||||
# Phase 5 — Transpiler Robustness & Code Quality Gates
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Make Harmony transpilers easier to diagnose on game updates, consolidate mod-compatibility reflection behind a single helper API, and add build-level quality gates.
|
||||
|
||||
**Architecture:**
|
||||
- A small `TranspilerGuard` helper standardizes the `CodeMatcher.IsInvalid` fallback pattern so transpilers can return original instructions and log a warning instead of producing invalid IL.
|
||||
- A public `ModCompatHelper` in `UXAssist.Common.ModCompat` centralizes BepInEx plugin detection, external-type resolution, and member lookup; wrappers and DysonSphere reflection consumers migrate to it.
|
||||
- A root `.editorconfig`, stricter MSBuild warning settings, and a GitHub Actions build workflow provide guardrails without blocking the existing obsolete-warning surface.
|
||||
|
||||
**Tech Stack:** C# / .NET Framework 4.7.2 / BepInEx 5 / HarmonyLib / MSBuild / GitHub Actions
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Transpiler comments & fallback guards
|
||||
|
||||
**Files:**
|
||||
- Create: `UXAssist/Common/Patching/TranspilerGuard.cs`
|
||||
- Modify: all files listed in `docs/TranspilerAudit.md` (26 files, 115 transpilers)
|
||||
|
||||
- [ ] **Step 1.1: Create `TranspilerGuard`**
|
||||
|
||||
```csharp
|
||||
using System.Collections.Generic;
|
||||
using System.Reflection.Emit;
|
||||
using BepInEx.Logging;
|
||||
using HarmonyLib;
|
||||
|
||||
namespace UXAssist.Common.Patching;
|
||||
|
||||
public static class TranspilerGuard
|
||||
{
|
||||
public static IEnumerable<CodeInstruction> Finish(
|
||||
this CodeMatcher matcher,
|
||||
IEnumerable<CodeInstruction> originalInstructions,
|
||||
ManualLogSource logger,
|
||||
string transpilerName)
|
||||
{
|
||||
if (matcher.IsInvalid)
|
||||
{
|
||||
logger?.LogWarning($"Transpiler '{transpilerName}' failed to match; returning original instructions.");
|
||||
return originalInstructions;
|
||||
}
|
||||
return matcher.InstructionEnumeration();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 1.2: Add standardized header comments to every transpiler**
|
||||
|
||||
For each transpiler method, insert a comment block immediately above the method:
|
||||
|
||||
```csharp
|
||||
// Harmony transpiler target: <Full.TypeName>.<MethodName>(<signature>)
|
||||
// Purpose: <one-line description>
|
||||
// Fragile matches: <magic constants / local slots / field names>
|
||||
// Fallback: <returns original instructions via TranspilerGuard if matcher becomes invalid / or "None — patch will fail loudly if target method changes">
|
||||
```
|
||||
|
||||
Use the audit in `docs/TranspilerAudit.md` (produced by exploration) to fill Fragile matches.
|
||||
|
||||
- [ ] **Step 1.3: Add fallback guards where missing**
|
||||
|
||||
For transpilers that currently call `matcher.InstructionEnumeration()` without checking `IsInvalid`, change the last lines to:
|
||||
|
||||
```csharp
|
||||
return matcher.Finish(instructions, UXAssist.Logger, nameof(<TranspilerMethodName>));
|
||||
```
|
||||
|
||||
Preserve the return type `IEnumerable<CodeInstruction>`. Where a method already checks `matcher.IsInvalid`/`IsValid`, keep the existing logic and only add the comment.
|
||||
|
||||
- [ ] **Step 1.4: Build after comment/guard pass**
|
||||
|
||||
Run: `dotnet build DSP_Mods.sln -c Release`
|
||||
Expected: 0 errors, 0 new warnings.
|
||||
|
||||
---
|
||||
|
||||
## Task 2: Centralize mod-compatibility reflection
|
||||
|
||||
**Files:**
|
||||
- Create: `UXAssist/Common/ModCompat/ModCompatHelper.cs`
|
||||
- Create: `UXAssist/Common/Utils/DysonSphereReflection.cs`
|
||||
- Modify: `UXAssist/ModsCompat/AuxilaryfunctionWrapper.cs`
|
||||
- Modify: `UXAssist/ModsCompat/BlueprintTweaks.cs`
|
||||
- Modify: `UXAssist/ModsCompat/BulletTimeWrapper.cs`
|
||||
- Modify: `UXAssist/ModsCompat/CommonAPIWrapper.cs`
|
||||
- Modify: `UXAssist/ModsCompat/PlanetVeinUtilization.cs`
|
||||
- Modify: `UXAssist/Patches/DysonSpherePatch.cs`
|
||||
- Modify: `CheatEnabler/Functions/DysonSphere/ShellCompletionFunctions.cs`
|
||||
- Modify: `CheatEnabler/Functions/DysonSphere/FrameRemovalFunctions.cs`
|
||||
|
||||
- [ ] **Step 2.1: Create `ModCompatHelper`**
|
||||
|
||||
```csharp
|
||||
using System;
|
||||
using System.Reflection;
|
||||
using BepInEx;
|
||||
using BepInEx.Bootstrap;
|
||||
|
||||
namespace UXAssist.Common.ModCompat;
|
||||
|
||||
public static class ModCompatHelper
|
||||
{
|
||||
public static bool TryGetLoadedPluginInfo(string guid, out PluginInfo pluginInfo)
|
||||
=> Chainloader.PluginInfos.TryGetValue(guid, out pluginInfo) && pluginInfo != null;
|
||||
|
||||
public static bool TryGetPluginType(PluginInfo pluginInfo, string typeName, out Type type)
|
||||
{
|
||||
type = null;
|
||||
if (pluginInfo?.Instance == null) return false;
|
||||
try
|
||||
{
|
||||
type = pluginInfo.Instance.GetType().Assembly.GetType(typeName, throwOnError: false);
|
||||
}
|
||||
catch { /* ignored */ }
|
||||
return type != null;
|
||||
}
|
||||
|
||||
public static bool TryGetPluginType(string guid, string typeName, out Type type)
|
||||
{
|
||||
type = null;
|
||||
return TryGetLoadedPluginInfo(guid, out var pluginInfo) && TryGetPluginType(pluginInfo, typeName, out type);
|
||||
}
|
||||
|
||||
public static bool TryGetFieldValue<T>(Type type, string fieldName, object instance, out T value)
|
||||
{
|
||||
value = default;
|
||||
if (type == null) return false;
|
||||
var field = AccessTools.Field(type, fieldName);
|
||||
if (field == null) return false;
|
||||
try
|
||||
{
|
||||
var result = field.GetValue(instance);
|
||||
if (result is T t)
|
||||
{
|
||||
value = t;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
catch { /* ignored */ }
|
||||
return false;
|
||||
}
|
||||
|
||||
public static bool TryGetMethod(Type type, string methodName, out MethodInfo method)
|
||||
{
|
||||
method = null;
|
||||
if (type == null) return false;
|
||||
method = AccessTools.Method(type, methodName);
|
||||
return method != null;
|
||||
}
|
||||
|
||||
public static bool TryGetPropertySetter(Type type, string propertyName, out MethodInfo setter)
|
||||
{
|
||||
setter = null;
|
||||
if (type == null) return false;
|
||||
var property = AccessTools.Property(type, propertyName);
|
||||
if (property == null) return false;
|
||||
setter = property.GetSetMethod(nonPublic: true);
|
||||
return setter != null;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2.2: Refactor mod-compat wrappers to use `ModCompatHelper`**
|
||||
|
||||
Replace the duplicated `Chainloader.PluginInfos.TryGetValue` + `pluginInfo.Instance.GetType().Assembly.GetType(...)` + `AccessTools.Field/Method/PropertySetter` patterns with calls to `ModCompatHelper`. Keep the existing public static fields (e.g., `HasBulletTime`, `ShowStationInfo`) and init timing (`Start`/`Run`).
|
||||
|
||||
- [ ] **Step 2.3: Create `DysonSphereReflection`**
|
||||
|
||||
```csharp
|
||||
using System.Reflection;
|
||||
using HarmonyLib;
|
||||
|
||||
namespace UXAssist.Common.Utils;
|
||||
|
||||
public static class DysonSphereReflection
|
||||
{
|
||||
private static readonly FieldInfo TotalNodeSpField = AccessTools.Field(typeof(DysonSphereLayer), "totalNodeSP");
|
||||
private static readonly FieldInfo TotalFrameSpField = AccessTools.Field(typeof(DysonSphereLayer), "totalFrameSP");
|
||||
private static readonly FieldInfo TotalCpField = AccessTools.Field(typeof(DysonSphereLayer), "totalCP");
|
||||
|
||||
public static long? GetTotalNodeSP(DysonSphereLayer layer)
|
||||
=> layer != null && TotalNodeSpField != null ? (long?)TotalNodeSpField.GetValue(layer) : null;
|
||||
|
||||
public static long? GetTotalFrameSP(DysonSphereLayer layer)
|
||||
=> layer != null && TotalFrameSpField != null ? (long?)TotalFrameSpField.GetValue(layer) : null;
|
||||
|
||||
public static long? GetTotalCP(DysonSphereLayer layer)
|
||||
=> layer != null && TotalCpField != null ? (long?)TotalCpField.GetValue(layer) : null;
|
||||
|
||||
public static bool IsAvailable => TotalNodeSpField != null && TotalFrameSpField != null && TotalCpField != null;
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2.4: Migrate DysonSphere field consumers**
|
||||
|
||||
Update `UXAssist/Patches/DysonSpherePatch.cs`, `CheatEnabler/Functions/DysonSphere/ShellCompletionFunctions.cs`, and `CheatEnabler/Functions/DysonSphere/FrameRemovalFunctions.cs` to call `DysonSphereReflection` instead of resolving the fields locally. Remove duplicate `AccessTools.Field` declarations.
|
||||
|
||||
- [ ] **Step 2.5: Build after reflection refactor**
|
||||
|
||||
Run: `dotnet build DSP_Mods.sln -c Release`
|
||||
Expected: 0 errors, 0 new warnings.
|
||||
|
||||
---
|
||||
|
||||
## Task 3: Code quality gates
|
||||
|
||||
**Files:**
|
||||
- Create: `.editorconfig`
|
||||
- Modify: `Directory.Build.props`
|
||||
- Create: `.github/workflows/build.yml`
|
||||
|
||||
- [ ] **Step 3.1: Add root `.editorconfig`**
|
||||
|
||||
```ini
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
end_of_line = crlf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
[*.{cs,vb}]
|
||||
# Suggestion-only so existing code does not break the build
|
||||
dotnet_style_qualification_for_field = false:suggestion
|
||||
dotnet_style_qualification_for_property = false:suggestion
|
||||
dotnet_style_qualification_for_method = false:suggestion
|
||||
dotnet_style_qualification_for_event = false:suggestion
|
||||
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
|
||||
dotnet_style_readonly_field = true:suggestion
|
||||
csharp_style_var_for_built_in_types = true:suggestion
|
||||
csharp_style_var_when_type_is_apparent = true:suggestion
|
||||
csharp_style_var_elsewhere = true:suggestion
|
||||
csharp_style_expression_bodied_methods = when_on_single_line:suggestion
|
||||
csharp_style_expression_bodied_properties = true:suggestion
|
||||
csharp_prefer_simple_default_expression = true:suggestion
|
||||
csharp_style_pattern_local_over_anonymous_function = true:suggestion
|
||||
```
|
||||
|
||||
- [ ] **Step 3.2: Harden `Directory.Build.props`**
|
||||
|
||||
Add to the existing `<PropertyGroup>` (do not remove existing properties):
|
||||
|
||||
```xml
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
<NoWarn>0618</NoWarn>
|
||||
<Nullable>disable</Nullable>
|
||||
<AnalysisLevel>none</AnalysisLevel>
|
||||
<EnforceCodeStyleInBuild>false</EnforceCodeStyleInBuild>
|
||||
```
|
||||
|
||||
`NoWarn>0618` suppresses the expected `[Obsolete]` usage warnings from the old `Util` facade; any new warning class will fail the build.
|
||||
|
||||
- [ ] **Step 3.3: Add GitHub Actions build workflow**
|
||||
|
||||
Create `.github/workflows/build.yml`:
|
||||
|
||||
```yaml
|
||||
name: Build
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main, master, refactor/*]
|
||||
pull_request:
|
||||
branches: [main, master]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: '8.0.x'
|
||||
|
||||
- name: Restore
|
||||
run: dotnet restore DSP_Mods.sln
|
||||
|
||||
- name: Build Release
|
||||
run: dotnet build DSP_Mods.sln -c Release --no-restore
|
||||
|
||||
- name: Package mods
|
||||
run: dotnet build -t:ZipMod -c Release --no-restore
|
||||
```
|
||||
|
||||
- [ ] **Step 3.4: Verify quality gates**
|
||||
|
||||
Run:
|
||||
```bash
|
||||
dotnet clean DSP_Mods.sln
|
||||
dotnet build DSP_Mods.sln -c Release
|
||||
```
|
||||
Expected: 0 errors, 0 warnings.
|
||||
|
||||
Run:
|
||||
```bash
|
||||
dotnet build -t:ZipMod -c Release
|
||||
```
|
||||
Expected: All zips produced; no errors.
|
||||
|
||||
---
|
||||
|
||||
## Task 4: Documentation & checkpoint
|
||||
|
||||
**Files:**
|
||||
- Modify: `AGENTS.md`
|
||||
|
||||
- [ ] **Step 4.1: Update `AGENTS.md`**
|
||||
|
||||
Append a "Phase 5 — Transpiler Robustness & Code Quality Gates" subsection under the project overview describing:
|
||||
- `UXAssist.Common.Patching.TranspilerGuard`
|
||||
- `UXAssist.Common.ModCompat.ModCompatHelper`
|
||||
- `UXAssist.Common.Utils.DysonSphereReflection`
|
||||
- `.editorconfig`, `TreatWarningsAsErrors`, and the GitHub Actions build workflow.
|
||||
|
||||
- [ ] **Step 4.2: Tag checkpoint**
|
||||
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "refactor: phase 5 transpiler robustness, mod-compat helpers, and build quality gates"
|
||||
git tag refactor-phase5
|
||||
```
|
||||
|
||||
Expected: tag `refactor-phase5` exists on the new commit and build remains clean.
|
||||
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user