2.5 KiB
Repository Guidelines
Project Structure & Module Organization
UnrealHyperTwist/ is the live application root. Treat UnrealHyperTwist/Source/UnrealHyperTwist/ as the primary first-party code surface and UnrealHyperTwist/Config/ plus Content/ as the active project shell. UnrealHyperTwist/Plugins/UnrealMCPChong/ is the only maintained in-repo plugin fork; the other plugin folders are external copies and should stay untouched unless a plugin task explicitly names them. docs/ contains working documentation, while docs/refs/ is reference-only and may contain sensitive ops material. mirrors/, zippedreposource/, and the archived content folders at repo root are custody/reference storage, not the default edit target.
Build, Test, and Development Commands
Open UnrealHyperTwist/UnrealHyperTwist.uproject or UnrealHyperTwist/UnrealHyperTwist.sln in Visual Studio 2022 / Unreal Engine 5.7 for normal work. Use git -C C:\HyperTwist status --short before and after changes. The bootstrap CI check is defined in .woodpecker/hypertwist-bootstrap.yml and validates the presence of the Unreal project, source module root, and docs tree.
Agent Instructions
When Visual Studio MCP tools are available, prefer semantic solution/project/document tools over raw filesystem grep for C# or Unreal symbol work. Default the working scope to UnrealHyperTwist/ and tracked repo docs before exploring mirrors or archived source material. Do not modify mirrors/, zippedreposource/, or docs/refs/ unless the task is explicitly about provenance, intake, or operations. If you encounter Rust content under mirrored dependencies, anchor analysis on the nearest Cargo.toml; do not fabricate Rust workspace files for this repo.
When the user says continue, interpret it as continue in logical sequence, not merely resume the nearest open task. If two options are paired and one logically widens or completes the lane needed by the other, do that sequence rather than picking an isolated substep out of order. The default continuation target is: scope the current packet, implement it, validate it, and keep going until the safe package is ready to land unless validation fails or a real decision is required.
When a task is safely complete, stage, commit, and push it without waiting for a separate reminder. Prefer landing the full aligned package after the widening/closure work is done, rather than committing intermediate fragments that leave the intended sequence half-finished.