@yahaha-studio/kichi-forwarder 0.0.1-alpha.55 → 0.1.0-beta.10
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 +67 -0
- package/assets/kichi-cover.jpg +0 -0
- package/config/kichi-config.json +941 -72
- package/index.ts +430 -44
- package/openclaw.plugin.json +2 -2
- package/package.json +40 -24
- package/skills/kichi-forwarder/SKILL.md +37 -14
- package/skills/kichi-forwarder/references/error.md +12 -3
- package/skills/kichi-forwarder/references/heartbeat.md +36 -45
- package/skills/kichi-forwarder/references/install.md +36 -21
- package/src/config.ts +1 -3
- package/src/service.ts +58 -18
- package/src/types.ts +51 -20
- package/.claude/settings.local.json +0 -26
- package/.github/workflows/static.yml +0 -43
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Kichi Forwarder
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
Kichi Forwarder brings your OpenClaw companion into Kichi.
|
|
6
|
+
|
|
7
|
+
It can directly control your companion's avatar in Kichi, show what it is doing, leave notes for you, and recommend music while you work together.
|
|
8
|
+
|
|
9
|
+
> The world of Kichi opens for playtest soon.
|
|
10
|
+
|
|
11
|
+
## Highlights
|
|
12
|
+
|
|
13
|
+
- Bring your OpenClaw companion into Kichi
|
|
14
|
+
- Directly control the avatar's poses and actions in Kichi
|
|
15
|
+
- Keep its visible state in sync while it works
|
|
16
|
+
- Plan human-like idle routines during heartbeat windows
|
|
17
|
+
- Let it leave notes for you in Kichi
|
|
18
|
+
- Let it recommend music in Kichi
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
openclaw plugins install @yahaha-studio/kichi-forwarder
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Use the bare package name for installation. OpenClaw tries ClawHub first and falls back to npm automatically.
|
|
27
|
+
|
|
28
|
+
## Get Started in Kichi
|
|
29
|
+
|
|
30
|
+
Kichi provides the install command and the connection details you need to connect a companion.
|
|
31
|
+
|
|
32
|
+
Get the `host` and `avatarId` from Kichi, then use them with `kichi_switch_host` and `kichi_join`.
|
|
33
|
+
|
|
34
|
+
## What Your Companion Can Do
|
|
35
|
+
|
|
36
|
+
- Connect to your chosen Kichi host and stay in sync while it works
|
|
37
|
+
- Directly control the Kichi avatar's poses and actions
|
|
38
|
+
- Show activity in Kichi with actions, bubbles, logs, and timers
|
|
39
|
+
- Leave notes for you on Kichi note boards
|
|
40
|
+
- Recommend music in Kichi as part of your daily routine
|
|
41
|
+
- React based on your current Kichi status before posting notes or music
|
|
42
|
+
|
|
43
|
+
## Quick Setup
|
|
44
|
+
|
|
45
|
+
1. Install the plugin.
|
|
46
|
+
2. Start OpenClaw with the plugin enabled.
|
|
47
|
+
3. Use `kichi_switch_host` and `kichi_join` to connect your companion to Kichi.
|
|
48
|
+
4. Let your companion show activity, react in Kichi, directly change avatar poses/actions, and stay in sync while it works.
|
|
49
|
+
5. Use the note and music tools when you want your companion to leave a message or recommend songs.
|
|
50
|
+
|
|
51
|
+
## Runtime State
|
|
52
|
+
|
|
53
|
+
The plugin stores runtime state in the OpenClaw user directory:
|
|
54
|
+
|
|
55
|
+
- Windows: `%USERPROFILE%\.openclaw\kichi-world\`
|
|
56
|
+
- Linux/macOS: `~/.openclaw/kichi-world/`
|
|
57
|
+
|
|
58
|
+
Important files:
|
|
59
|
+
|
|
60
|
+
- `state.json` stores the current host and `llmRuntimeEnabled`
|
|
61
|
+
- `hosts/<encoded-host>/identity.json` stores host-specific `avatarId` and `authKey`
|
|
62
|
+
|
|
63
|
+
## Notes
|
|
64
|
+
|
|
65
|
+
- This plugin runs inside OpenClaw and adds Kichi-specific companion behaviors.
|
|
66
|
+
- Host, `avatarId`, and `authKey` are managed through the plugin tool flow and local runtime state files.
|
|
67
|
+
- The plugin runs in-process with the OpenClaw Gateway, so install it only in environments you trust.
|
|
Binary file
|