Skip to content

Commit 64a8c14

Browse files
readme: mention plugins.bat in the install + plugins sections
1 parent b567805 commit 64a8c14

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,14 @@ Gabriel has a drop-in plugin system. Create a folder under `plugins/<name>/` wit
263263

264264
Official plugins live at **[HoppouAI/ProjectGabriel-Plugins](https://github.com/HoppouAI/ProjectGabriel-Plugins)**. The author guide is in [plugins/README.md](plugins/README.md).
265265

266+
### Installing plugins
267+
268+
Run **`plugins.bat`** for an interactive TUI that pulls the latest plugin
269+
list from the official repo, shows what's already installed, and one
270+
keypress installs a plugin folder plus runs `bin\uv.exe pip install` for
271+
any dependencies it needs. Press `L` inside the TUI to install from a
272+
local folder or `G` to point it at a fork instead.
273+
266274
---
267275

268276
## Project Structure
@@ -271,6 +279,7 @@ Official plugins live at **[HoppouAI/ProjectGabriel-Plugins](https://github.com/
271279
main.py Entry point
272280
supervisor.py Auto-restart on crash
273281
configurator.py Interactive setup wizard
282+
plugin_installer.py Interactive plugin installer (TUI)
274283
src/
275284
audio.py Audio I/O, effects, music/SFX
276285
vrchat.py VRChat OSC client (movement, chatbox, voice)

plugins/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,17 @@ This folder is mostly gitignored so personal plugins stay local. The
88
ships with `enabled: false` so a fresh checkout doesn't load it. flip
99
that to `true` if you want to see it in action.
1010

11-
## Quick start
11+
## Installing prebuilt plugins
12+
13+
Run `plugins.bat` from the project root to open the plugin installer.
14+
It pulls the latest list from
15+
[HoppouAI/ProjectGabriel-Plugins](https://github.com/HoppouAI/ProjectGabriel-Plugins),
16+
shows what's available + already installed, and one keypress installs the
17+
folder plus runs `bin\uv.exe pip install` for any python deps the
18+
plugin needs. Press `L` inside the TUI to install from a local folder
19+
instead, or `G` to point it at a fork.
20+
21+
## Quick start (writing your own)
1222

1323
1. Make a folder: `plugins/my_thing/`
1424
2. Add `plugins/my_thing/plugin.yml`:

0 commit comments

Comments
 (0)