Updated agents file.
This commit is contained in:
30
AGENTS.md
30
AGENTS.md
@@ -5,7 +5,7 @@ Agent guidance for this repository (`Soul Droid Chat`).
|
|||||||
## Quick Start for New Agents
|
## Quick Start for New Agents
|
||||||
|
|
||||||
1. Read `game/script.rpy`, `game/screens.rpy`, and `game/llm_ren.py` to understand flow and LLM integration.
|
1. Read `game/script.rpy`, `game/screens.rpy`, and `game/llm_ren.py` to understand flow and LLM integration.
|
||||||
2. Run `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" lint` before making changes.
|
2. Run `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" lint` before making changes.
|
||||||
3. Make small, focused edits that preserve Ren'Py ids and the `EMOTION:<value>` response contract.
|
3. Make small, focused edits that preserve Ren'Py ids and the `EMOTION:<value>` response contract.
|
||||||
4. Validate with `compile` and `test` (`test <testcase_or_suite_name>` for a single case while iterating).
|
4. Validate with `compile` and `test` (`test <testcase_or_suite_name>` for a single case while iterating).
|
||||||
5. Avoid committing generated artifacts/logs (`*.rpyc`, `game/cache/`, `log.txt`, `errors.txt`, `traceback.txt`) or secrets.
|
5. Avoid committing generated artifacts/logs (`*.rpyc`, `game/cache/`, `log.txt`, `errors.txt`, `traceback.txt`) or secrets.
|
||||||
@@ -29,42 +29,42 @@ Agent guidance for this repository (`Soul Droid Chat`).
|
|||||||
|
|
||||||
## Tooling and Environment
|
## Tooling and Environment
|
||||||
|
|
||||||
- Expected Ren'Py launcher script: `/home/micost/renpy-8.5.2-sdk/renpy.sh`.
|
- Expected Ren'Py launcher script in PATH: `renpy.sh`.
|
||||||
- CLI usage pattern:
|
- CLI usage pattern:
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "<repo-path>" <command> [args]`
|
- `"renpy.sh" "<repo-path>" <command> [args]`
|
||||||
- Python in environment is available (`python3`), but gameplay validation should use Ren'Py commands.
|
- Python in environment is available (`python3`), but gameplay validation should use Ren'Py commands.
|
||||||
|
|
||||||
## Build, Lint, and Test Commands
|
## Build, Lint, and Test Commands
|
||||||
|
|
||||||
Run all commands from repository root:
|
Run all commands from repository root:
|
||||||
`/home/micost/Documentos/Renpy Projects/Soul Droid Chat`
|
`/home/$USER/Documentos/Renpy Projects/Soul Droid Chat`
|
||||||
|
|
||||||
### Quick checks (most common)
|
### Quick checks (most common)
|
||||||
|
|
||||||
- Lint project:
|
- Lint project:
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" lint`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" lint`
|
||||||
- Run game locally:
|
- Run game locally:
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" run`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" run`
|
||||||
- Compile scripts/python cache:
|
- Compile scripts/python cache:
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" compile`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" compile`
|
||||||
|
|
||||||
### Test execution (Ren'Py test runner)
|
### Test execution (Ren'Py test runner)
|
||||||
|
|
||||||
- Run default/global test suite:
|
- Run default/global test suite:
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" test`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test`
|
||||||
- Run a single test suite or testcase (important):
|
- Run a single test suite or testcase (important):
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" test <testcase_or_suite_name>`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test <testcase_or_suite_name>`
|
||||||
- Show detailed test report:
|
- Show detailed test report:
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" test --report-detailed`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test --report-detailed`
|
||||||
- Run all testcases even if disabled:
|
- Run all testcases even if disabled:
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" test --enable-all`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test --enable-all`
|
||||||
|
|
||||||
### Distribution/build packaging
|
### Distribution/build packaging
|
||||||
|
|
||||||
- Create distributions (launcher command):
|
- Create distributions (launcher command):
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" distribute`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" distribute`
|
||||||
- Android build exists as a Ren'Py command (if SDK/keystore configured):
|
- Android build exists as a Ren'Py command (if SDK/keystore configured):
|
||||||
- `"/home/micost/renpy-8.5.2-sdk/renpy.sh" "/home/micost/Documentos/Renpy Projects/Soul Droid Chat" android_build`
|
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" android_build`
|
||||||
|
|
||||||
## Suggested Validation Sequence for Agents
|
## Suggested Validation Sequence for Agents
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ If a command fails, include the failing command and key error excerpt in your re
|
|||||||
- Keep style declarations grouped and readable (existing file order is a good template).
|
- Keep style declarations grouped and readable (existing file order is a good template).
|
||||||
- For dialogue flow, keep Python blocks short; move reusable logic to `*_ren.py`.
|
- For dialogue flow, keep Python blocks short; move reusable logic to `*_ren.py`.
|
||||||
- Use explicit keyword args when clarity helps (`prompt =`, `fadeout`, `fadein`).
|
- Use explicit keyword args when clarity helps (`prompt =`, `fadeout`, `fadein`).
|
||||||
- Do not rename core ids required by Ren'Py (`"window"`, `"what"`, `"who"`, `"input"`).
|
- Do not rename core ids required by Ren'Py (`_("window")`, `_("what")`, `_("who")`, `_("input")`).
|
||||||
|
|
||||||
### Python conventions (`*_ren.py` and embedded `init python`)
|
### Python conventions (`*_ren.py` and embedded `init python`)
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ If a command fails, include the failing command and key error excerpt in your re
|
|||||||
### UI/screens changes
|
### UI/screens changes
|
||||||
|
|
||||||
- Reuse existing `gui.*` variables and style helpers where possible.
|
- Reuse existing `gui.*` variables and style helpers where possible.
|
||||||
- Keep mobile/small variant handling (`renpy.variant("small")`) intact.
|
- Keep mobile/small variant handling (`renpy.variant(_("small"))`) intact.
|
||||||
- Prefer extending existing screens over introducing parallel duplicate screens.
|
- Prefer extending existing screens over introducing parallel duplicate screens.
|
||||||
- For settings UI, follow patterns already used in `preferences` screen.
|
- For settings UI, follow patterns already used in `preferences` screen.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user