Files
RolemasterDB/AGENTS.md
2026-03-19 22:56:58 +01:00

2.4 KiB

Agent Guide

Also see the other related technical documentation in the docs folder.

Tools

These tool paths should be used instead of any entry in the PATH environment variable:

  • Python is installed in C:\Users\frank\AppData\Local\Programs\Python\Python314.
  • MiKTeX portable is installed in D:\Code\miktex-portable\texmfs\install\miktex\bin\x64.
  • Tesseract is installed in C:\Program Files\Sejda PDF Desktop\resources\vendor\tesseract-windows-x64.

Rules

  • Prefer extracting code to a shared helper to be reused instead of duplicating code. Always keep high maintainability standards.
  • Keep changes as small as possible, design solutions that achieve the goals with minimal churn.
  • Always place each newly created class into its own file. The file name must match the class name.
  • When asked to begin working on a task, create a detailed implementation plan first, present the plan to the user, and ask for approval before beginning with the actual implementation.
  • When an task is finished, perform a code review to evaluate if the change is clean and maintainable with high software engineering standards. Iterate on the code and repeat the review process until satisfied.
  • After the implementation is finished, verify all changed files, and run python D:\Code\crlf.py $file1 $file2 ... only for files you recognize, in order to normalize all line endings of all touched files to CRLF.
  • If there's documnentation present, always keep it updated.
  • At the end perform a git commit with a one-liner summary.

PowerShell

  • This is a Windows environment, WSL is not installed (i.e. sed is not available). You're running under PowerShell 7.5.5. Due to platform restrictions, file deletions are not possible. Replacing the entire file content via a context diff is a viable alternative.
  • PowerShell doesn't support bash-style heredocs. If complex scripts need to be executed, consider using python as a last resort. Run Python code using python -c with inline commands instead of python - <<'PY'.
  • Parallel PowerShell calls are flaky, stick to sequential reads and command execution.
  • Commands like rg and Get-Content are always allowed.

Dotnet CLI

  • Use $env:DOTNET_SKIP_FIRST_TIME_EXPERIENCE = '1'
  • Use $env:NUGET_PACKAGES = Join-Path $env:USERPROFILE '.nuget\packages'
  • If a build fails with 0 errors / 0 warnings, do not keep retrying the same build command, instead use --no-restore.