Skip to content

AGENT.md

Latest commit

 

History

History
64 lines (46 loc) · 2.63 KB

AGENT.md

File metadata and controls

64 lines (46 loc) · 2.63 KB

Agent Notes

Project Boundary

  • This repo is intentionally tool-first.
  • Keep only recovery scripts, repo-owned mod source, docs, and bundled tool archives in git.
  • Do not commit recovered game source, recovered Godot projects, exported resources, runtime logs, or unpacked tool directories.

Rebuild Flow

  • Main entrypoint: D:\Desktop\SlayTheSpire2Mobile\recover_sts2_godot.py
  • Re-export entrypoint: D:\Desktop\SlayTheSpire2Mobile\export_android_apk.py
  • Typical rebuild command:
cd D:\Desktop\SlayTheSpire2Mobile
python .\recover_sts2_godot.py --force
  • Typical re-export command after an existing recovery:
cd D:\Desktop\SlayTheSpire2Mobile
python .\export_android_apk.py
  • Default output: D:\Desktop\SlayTheSpire2Mobile\build\recovered_project
  • Tool archives are stored in tools\*.zip.
  • If tools\gdre or tools\godot451 are missing, the Python script will auto-extract them from the bundled zip files.

Source Of Truth

  • Recovery result authority is build\recovered_project\recovery_report.json.
  • Do not judge success from raw process exit codes alone.
  • Godot 4.5.1 Mono may exit with signal 11 on shutdown even when the project reached the main menu successfully.
  • Smoke success is log-based: main menu reached, deferred startup disabled, FMOD loaded, and repo mod loaded.

Mod Workflow

  • Repo-owned mod source lives in mods\ahahaha_menu.
  • The generated mod project inside build\recovered_project\_generated_mod_projects is disposable output.
  • Make long-term gameplay/UI/code changes in repo-owned mod files, not in build\recovered_project.
  • Current minimal validation effect: the main menu shows 啊哈哈哈哈哈哈哈.

Editing Rules

  • If you change bundled tool versions, update:
    • recover_sts2_godot.py
    • README.md
    • any paths/constants that point to tool zip names or extracted executables
  • Prefer changing the recovery script instead of editing recovered output by hand.
  • If a fix is required after every rebuild, encode it in recover_sts2_godot.py.

Git Hygiene

  • Before committing, check git status.
  • Local IDE directories like .idea may appear and should stay out of version control unless explicitly requested.
  • Generated directories such as build, recovered_*, and unpacked tools\gdre / tools\godot451 should remain untracked.

Known Limits

  • Android export is still blocked by missing FMOD and Spine Android .so binaries from the Windows game install.
  • This repo should not contain game-owned recovered source or assets.
  • Treat public release decisions carefully: the repo is still game-specific even if recovered source is excluded.