chore(README.md): updated for more instructions

This commit is contained in:
Neko Ayaka
2026-04-22 13:54:02 +08:00
parent 8603d8cd7a
commit 36ee517e1e
2 changed files with 33 additions and 0 deletions
@@ -71,3 +71,19 @@ Important:
- Scenario entrypoints should point at `index.ts` when the workflow is organized as a section folder.
- Keep this package focused on Electron capture flows for docs screenshots.
- Paths in these `pnpm -F` examples are resolved from the filtered package working directory.
## Electron Profile Note (Plugin Discovery)
When running scenarios through `@proj-airi/vishot-runner-electron`, the built Electron app can use a different `userData` profile than `dev:tamagotchi`.
- `dev:tamagotchi` plugin root commonly resolves to:
- `~/Library/Application Support/@proj-airi/stage-tamagotchi/plugins/v1`
- Vishot/Electron capture runs can resolve plugin root to:
- `~/Library/Application Support/Electron/plugins/v1`
If the chess plugin appears in dev but not in Vishot (`Discovered 0` or `Plugin manifest not found`), link the plugin `dist` directory into the Electron profile plugins root too:
```bash
mkdir -p "$HOME/Library/Application Support/Electron/plugins/v1"
ln -sfn "/absolute/path/to/airi-plugin-game-chess/dist" "$HOME/Library/Application Support/Electron/plugins/v1/airi-plugin-game-chess"
```
+17
View File
@@ -44,6 +44,23 @@ pnpm -F @proj-airi/scenarios-stage-tamagotchi-browser capture
In this environment, the raw capture command worked end-to-end after running outside the sandbox because `tsx` pipe creation was denied inside the sandbox (`listen EPERM` on the temporary `tsx` IPC pipe).
## Electron Profile Note (Plugin Host Root)
`vishot-runner-electron` launches the built Electron app entrypoint. In local development this can resolve `app.getPath('userData')` to the `Electron` profile directory, which means plugin discovery happens under:
- `~/Library/Application Support/Electron/plugins/v1`
This may differ from `dev:tamagotchi`, which often uses:
- `~/Library/Application Support/@proj-airi/stage-tamagotchi/plugins/v1`
If plugin-host devtools shows `Discovered 0`, `Plugin manifest not found`, or module registration errors during Vishot scenarios, mirror your plugin symlink into the Electron profile plugins directory:
```bash
mkdir -p "$HOME/Library/Application Support/Electron/plugins/v1"
ln -sfn "/absolute/path/to/airi-plugin-game-chess/dist" "$HOME/Library/Application Support/Electron/plugins/v1/airi-plugin-game-chess"
```
## Additional Examples
To verify the controls-island hearing button specifically: