pleb/plugin-helper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refine agents instructions

Browse Source
This commit is contained in:
pleb
2026-07-01 22:41:54 -07:00
parent dbc4c7e0b4
commit f160e4b349
1 changed files with 0 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
-21
View File
@@ -5,23 +5,11 @@ Guidance for coding agents working in this repo.
## Project Shape ## Project Shape
- This repo manages Beat Saber plugins for BSManager instances. - This repo manages Beat Saber plugins for BSManager instances.
- Default instance roots are:
- `~/Windows/Users/pleb/BSManager/BSInstances`
- `~/.local/share/BSManager/BSInstances`
- A local BSManager source checkout may be available at
`~/src/Zagrios/bs-manager`. Use it as a read-only reference when
investigating launch behavior, inherited Steam arguments, instance layout, or
Proton environment details unless the user explicitly asks for BSManager code
changes.
- Keep plugin source checkouts under `~/src/<owner>/<repo>` when a - Keep plugin source checkouts under `~/src/<owner>/<repo>` when a
locked or registry plugin has a GitHub source repo. Prefer checking out the locked or registry plugin has a GitHub source repo. Prefer checking out the
upstream author/repo first, with `origin` pointing at upstream. If the user has upstream author/repo first, with `origin` pointing at upstream. If the user has
an existing personal fork checkout, preserve it as a remote named `github` an existing personal fork checkout, preserve it as a remote named `github`
and set/add `origin` to the upstream repo instead of replacing local work. and set/add `origin` to the upstream repo instead of replacing local work.
- Prefer repo-local state for planned installs unless the task explicitly
targets the user's live default state. Use `--state-dir .state` for the local
Linux install and `--state-dir .state-windows` for the mounted Windows install
when both roots contain the same instance name.
## Workflow Rules ## Workflow Rules
@@ -30,12 +18,6 @@ Guidance for coding agents working in this repo.
`.venv/bin/python` for helper commands and tests when it exists. `.venv/bin/python` for helper commands and tests when it exists.
- For human-style inspection, prefer the menu with repo-local state: - For human-style inspection, prefer the menu with repo-local state:
`PYTHONPATH=src .venv/bin/python -m plugin_helper --state-dir .state menu`. `PYTHONPATH=src .venv/bin/python -m plugin_helper --state-dir .state menu`.
- When targeting the local Linux BSManager install, pass
`--instances-root ~/.local/share/BSManager/BSInstances` and normally
`--state-dir .state`.
- When targeting the mounted Windows BSManager install, pass
`--instances-root ~/Windows/Users/pleb/BSManager/BSInstances` and
normally `--state-dir .state-windows`.
- Use the helper commands instead of manually copying plugin files into an - Use the helper commands instead of manually copying plugin files into an
instance. instance.
- When adding, updating, building, or investigating a GitHub-hosted plugin, - When adding, updating, building, or investigating a GitHub-hosted plugin,
@@ -45,9 +27,6 @@ Guidance for coding agents working in this repo.
- Treat BSIPA as a bootstrap phase: - Treat BSIPA as a bootstrap phase:
- `bootstrap` installs the locked BSIPA archive and records generated files. - `bootstrap` installs the locked BSIPA archive and records generated files.
- ordinary plugin plans should depend on healthy bootstrap state. - ordinary plugin plans should depend on healthy bootstrap state.
- Be careful with duplicate instance names across Windows and local roots. Use
the menu or pass `--instances-root` explicitly when targeting one install, and
keep install/bootstrap state separate per target root.
- After completing repo changes, suggest a concise commit message in the final - After completing repo changes, suggest a concise commit message in the final
response unless the user already asked you to commit. response unless the user already asked you to commit.