pi-better-openai 0.1.11 → 0.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -23,12 +23,42 @@ pi install npm:pi-better-openai
23
23
  - Interactive settings picker via `/openai-settings`.
24
24
  - Footer customization for model, thinking, fast mode, usage, and token/cost context.
25
25
  - OpenAI image generation/editing through the `openai_image` tool and `/openai-image` command.
26
+ - Animated Codex custom pets rendered in the Better OpenAI footer.
26
27
  - Commands:
27
28
  - `/fast` toggles fast mode.
28
29
  - `/openai-image <prompt>` generates an image directly.
30
+ - `/pets [help|list|wake [slug]|tuck|select <slug>]` renders or manages custom pets from `${CODEX_HOME:-~/.codex}/pets`.
29
31
  - `/openai-usage` shows current OpenAI subscription usage.
30
32
  - `/openai-settings` opens settings, diagnostics, and config details.
31
33
 
34
+ ## Codex pets
35
+
36
+ Codex pets are an OpenAI Codex app feature, so the floating overlay and pet picker are still controlled by Codex (`Settings → Appearance → Pets` or `/pet`). This extension can also render compatible custom pet spritesheets directly in pi's Better OpenAI footer.
37
+
38
+ ```bash
39
+ /pets wake # render the selected pet, or the first ready pet
40
+ /pets wake <slug> # render a specific ready pet
41
+ /pets select <slug> # select a ready pet without changing visibility
42
+ /pets tuck # hide it
43
+ /pets list # list local custom pets and readiness diagnostics
44
+ ```
45
+
46
+ You can also enable **Footer pet** in `/openai-settings`, cycle installed pets with the **Pet** row, preview the selected pet in the footer, and tune placement (`inline-right` by default), idle, thinking/streaming, tool-execution, and any failed-tool animation states, plus random idle emotes and size.
47
+
48
+ To create a custom pet for the Codex app:
49
+
50
+ ```bash
51
+ $skill-installer hatch-pet
52
+ ```
53
+
54
+ Then reload Codex skills (`Cmd/Ctrl+K → Force Reload Skills`) and ask:
55
+
56
+ ```text
57
+ $hatch-pet create a new pet inspired by pi-better-openai
58
+ ```
59
+
60
+ Custom pets should end up in `${CODEX_HOME:-~/.codex}/pets/<pet-name>/` with `pet.json` and `spritesheet.webp`. Refresh custom pets in Codex settings and toggle the overlay with `/pet`.
61
+
32
62
  ## Screenshots
33
63
 
34
64
  <!-- Add screenshots here. -->