@yahaha-studio/kichi-forwarder 0.1.1-beta.9 → 0.1.2-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 +2 -0
- package/config/environments.json +5 -0
- package/dist/config/environments.json +5 -0
- package/dist/config/kichi-config.json +941 -0
- package/dist/index.js +1681 -0
- package/dist/src/config.js +4 -0
- package/dist/src/runtime-manager.js +121 -0
- package/dist/src/service.js +709 -0
- package/dist/src/types.js +1 -0
- package/index.ts +422 -146
- package/openclaw.plugin.json +17 -1
- package/package.json +16 -7
- package/skills/kichi-forwarder/SKILL.md +46 -20
- package/skills/kichi-forwarder/references/error.md +3 -11
- package/skills/kichi-forwarder/references/heartbeat.md +7 -17
- package/skills/kichi-forwarder/references/install.md +22 -29
- package/src/runtime-manager.ts +25 -2
- package/src/service.ts +70 -27
- package/src/types.ts +40 -1
package/openclaw.plugin.json
CHANGED
|
@@ -2,9 +2,25 @@
|
|
|
2
2
|
"id": "kichi-forwarder",
|
|
3
3
|
"name": "Kichi Forwarder",
|
|
4
4
|
"description": "Native OpenClaw plugin for Kichi World with direct avatar control, status sync, timers, notes, and music tools",
|
|
5
|
-
"version": "0.1.
|
|
5
|
+
"version": "0.1.2-beta.10",
|
|
6
6
|
"author": "OpenClaw",
|
|
7
7
|
"skills": ["./skills/kichi-forwarder"],
|
|
8
|
+
"contracts": {
|
|
9
|
+
"tools": [
|
|
10
|
+
"kichi_join",
|
|
11
|
+
"kichi_switch_host",
|
|
12
|
+
"kichi_rejoin",
|
|
13
|
+
"kichi_leave",
|
|
14
|
+
"kichi_connection_status",
|
|
15
|
+
"kichi_action",
|
|
16
|
+
"kichi_idle_plan",
|
|
17
|
+
"kichi_clock",
|
|
18
|
+
"kichi_query_status",
|
|
19
|
+
"kichi_music_album_create",
|
|
20
|
+
"kichi_noteboard_create",
|
|
21
|
+
"kichi_bot_message"
|
|
22
|
+
]
|
|
23
|
+
},
|
|
8
24
|
"configSchema": {
|
|
9
25
|
"type": "object",
|
|
10
26
|
"additionalProperties": false,
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yahaha-studio/kichi-forwarder",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2-beta.10",
|
|
4
4
|
"description": "Native OpenClaw plugin for Kichi World with direct avatar control, status sync, timers, notes, and music tools",
|
|
5
5
|
"type": "module",
|
|
6
|
-
"main": "index.
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
7
|
"files": [
|
|
8
8
|
"README.md",
|
|
9
9
|
"assets/",
|
|
10
10
|
"config/",
|
|
11
|
+
"dist/",
|
|
11
12
|
"index.ts",
|
|
12
13
|
"openclaw.plugin.json",
|
|
13
14
|
"skills/",
|
|
@@ -17,15 +18,22 @@
|
|
|
17
18
|
"extensions": [
|
|
18
19
|
"./index.ts"
|
|
19
20
|
],
|
|
21
|
+
"runtimeExtensions": [
|
|
22
|
+
"./dist/index.js"
|
|
23
|
+
],
|
|
20
24
|
"compat": {
|
|
21
|
-
"pluginApi": ">=2026.
|
|
22
|
-
"minGatewayVersion": "2026.
|
|
25
|
+
"pluginApi": ">=2026.4.25",
|
|
26
|
+
"minGatewayVersion": "2026.4.25"
|
|
23
27
|
},
|
|
24
28
|
"build": {
|
|
25
|
-
"openclawVersion": "2026.
|
|
26
|
-
"pluginSdkVersion": "2026.
|
|
29
|
+
"openclawVersion": "2026.5.7",
|
|
30
|
+
"pluginSdkVersion": "2026.5.7"
|
|
27
31
|
}
|
|
28
32
|
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"build": "tsc -p tsconfig.json && node -e \"fs.cpSync('config','dist/config',{recursive:true})\"",
|
|
35
|
+
"prepack": "npm run build"
|
|
36
|
+
},
|
|
29
37
|
"publishConfig": {
|
|
30
38
|
"access": "public"
|
|
31
39
|
},
|
|
@@ -35,6 +43,7 @@
|
|
|
35
43
|
"devDependencies": {
|
|
36
44
|
"@types/node": "^24.3.0",
|
|
37
45
|
"@types/ws": "^8.18.1",
|
|
38
|
-
"openclaw": "2026.
|
|
46
|
+
"openclaw": "2026.5.7",
|
|
47
|
+
"typescript": "^6.0.3"
|
|
39
48
|
}
|
|
40
49
|
}
|
|
@@ -17,15 +17,19 @@ The following URLs are only used when this skill is first loaded from a remote U
|
|
|
17
17
|
- `error.md`: `https://yahaha-studio.github.io/kichi-forwarder/references/error.md`
|
|
18
18
|
- `heartbeat.md`: `https://yahaha-studio.github.io/kichi-forwarder/references/heartbeat.md`
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Environment Rules
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
Install and connect requests use `on <environment>` syntax. Supported environments:
|
|
23
|
+
|
|
24
|
+
- `steam`: connects to `focus-wss.yahaha.com`
|
|
25
|
+
- `steam-playtest`: connects to `focus-steam-playtest-wss-int.yahaha.com`
|
|
26
|
+
- `test`: no fixed host — ask the user for the current test node host, write it to the plugin's `config/environments.json`, then call `kichi_switch_host`
|
|
23
27
|
|
|
24
28
|
## Runtime State
|
|
25
29
|
|
|
26
30
|
Runtime data lives under the user home directory and is isolated per OpenClaw agent:
|
|
27
31
|
|
|
28
|
-
- `kichi-world/agents/<encoded-agent-id>/state.json`: stores that agent's `
|
|
32
|
+
- `kichi-world/agents/<encoded-agent-id>/state.json`: stores that agent's `currentEnvironment` and `llmRuntimeEnabled`
|
|
29
33
|
- `kichi-world/agents/<encoded-agent-id>/hosts/<encoded-host>/identity.json`: stores that agent's host-specific `avatarId` and `authKey`
|
|
30
34
|
|
|
31
35
|
## Remote URL Install Entry
|
|
@@ -34,7 +38,7 @@ When this skill is first loaded from:
|
|
|
34
38
|
|
|
35
39
|
- `https://yahaha-studio.github.io/kichi-forwarder/SKILL.md`
|
|
36
40
|
|
|
37
|
-
and the user asks to connect/install with `avatarId` and `
|
|
41
|
+
and the user asks to connect/install with `avatarId` and an environment (e.g. `on steam-playtest`), do not invent a separate install flow in this file.
|
|
38
42
|
|
|
39
43
|
The install and join flow is defined only in:
|
|
40
44
|
|
|
@@ -42,14 +46,17 @@ The install and join flow is defined only in:
|
|
|
42
46
|
|
|
43
47
|
Read that file once to complete the initial install. After local installation, the local `install.md` is used instead.
|
|
44
48
|
|
|
45
|
-
##
|
|
49
|
+
## Tool Availability
|
|
50
|
+
|
|
51
|
+
All tools listed in this file (`kichi_join`, `kichi_connection_status`, `kichi_action`, etc.) are available immediately once the plugin is installed and loaded. The recommended order below is sequencing guidance, not an availability gate — you can call any tool at any time.
|
|
52
|
+
|
|
53
|
+
## Install Flow
|
|
46
54
|
|
|
47
55
|
For install/onboarding/connect requests:
|
|
48
56
|
|
|
49
57
|
- Read and follow `install.md` before starting the install flow.
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
- Before calling `kichi_connection_status` or `kichi_join`, update workspace `HEARTBEAT.md` by following `heartbeat.md`. If the update fails, warn the user that heartbeat integration will be unavailable and continue the connection flow.
|
|
58
|
+
- Always use `npm pack @yahaha-studio/kichi-forwarder` then `openclaw plugins install <tgz-path>`. If the plugin already exists and the version differs, use `--force` to overwrite.
|
|
59
|
+
- Recommended: update workspace `HEARTBEAT.md` by following `heartbeat.md` before calling `kichi_connection_status` or `kichi_join`. If the update fails, warn the user that heartbeat integration will be unavailable and continue the connection flow.
|
|
53
60
|
|
|
54
61
|
## LLM Runtime
|
|
55
62
|
|
|
@@ -58,18 +65,16 @@ For install/onboarding/connect requests:
|
|
|
58
65
|
- When `true`, sync status uses LLM-driven prompts and may consume extra tokens.
|
|
59
66
|
- When `false`, sync uses fixed English text.
|
|
60
67
|
|
|
61
|
-
## Tool
|
|
68
|
+
## Recommended Tool Order
|
|
62
69
|
|
|
63
|
-
Use this order unless the user asks for a different explicit action
|
|
64
|
-
|
|
65
|
-
Install/onboarding requests are the exception: follow `install.md` first.
|
|
70
|
+
Use this order unless the user asks for a different explicit action. For install/onboarding requests, follow `install.md` first.
|
|
66
71
|
|
|
67
72
|
1. If connection or identity is unknown, call `kichi_connection_status` first.
|
|
68
|
-
2. If the requested
|
|
73
|
+
2. If the requested environment differs from the current environment, call `kichi_switch_host` with the target environment.
|
|
69
74
|
3. If the requested `avatarId` differs from the current host's connected `avatarId`, call `kichi_leave` first when the old avatar is still joined, then call `kichi_join` with the requested `avatarId`.
|
|
70
|
-
4.
|
|
75
|
+
4. If no `authKey` is available, call `kichi_join`.
|
|
71
76
|
5. If `authKey` exists but websocket is not open, call `kichi_rejoin` or wait for automatic reconnect and rejoin.
|
|
72
|
-
6. Use `kichi_action`, `kichi_clock`, note board tools, and music album tools
|
|
77
|
+
6. Use `kichi_action`, `kichi_clock`, note board tools, and music album tools after status is ready.
|
|
73
78
|
|
|
74
79
|
## Tools
|
|
75
80
|
|
|
@@ -88,10 +93,13 @@ kichi_join(avatarId: "your-avatar-id", botName: "<from IDENTITY.md>", bio: "<fro
|
|
|
88
93
|
### kichi_switch_host
|
|
89
94
|
|
|
90
95
|
```text
|
|
91
|
-
kichi_switch_host(
|
|
96
|
+
kichi_switch_host(environment: "steam")
|
|
97
|
+
kichi_switch_host(environment: "test")
|
|
92
98
|
```
|
|
93
99
|
|
|
94
|
-
- `
|
|
100
|
+
- `environment`: required. One of `steam`, `steam-playtest`, `test`.
|
|
101
|
+
- Host is resolved from `config/environments.json`. If the environment has no configured host (null), the call fails.
|
|
102
|
+
- For `test` environment: ask the user for the test node host, write it to the plugin's `config/environments.json`, then call this tool.
|
|
95
103
|
- This reloads the host-specific `identity.json` and reconnects the websocket immediately.
|
|
96
104
|
|
|
97
105
|
### kichi_connection_status
|
|
@@ -102,7 +110,7 @@ kichi_connection_status()
|
|
|
102
110
|
|
|
103
111
|
Use this to confirm:
|
|
104
112
|
|
|
105
|
-
- current host
|
|
113
|
+
- current environment and host
|
|
106
114
|
- websocket URL
|
|
107
115
|
- host-specific identity file path
|
|
108
116
|
- websocket state
|
|
@@ -119,7 +127,7 @@ kichi_leave()
|
|
|
119
127
|
When the user asks to leave Kichi World:
|
|
120
128
|
|
|
121
129
|
1. Call `kichi_leave`.
|
|
122
|
-
2.
|
|
130
|
+
2. Clean up the Kichi heartbeat section from workspace `HEARTBEAT.md`. If the user declines, leave it in place.
|
|
123
131
|
3. Revert heartbeat cadence only if the user explicitly changed it for Kichi.
|
|
124
132
|
4. Do not claim the plugin removed heartbeat settings automatically.
|
|
125
133
|
|
|
@@ -138,7 +146,7 @@ Use this for direct Kichi avatar control as well as lifecycle sync.
|
|
|
138
146
|
Use this for the avatar's heartbeat idle plan.
|
|
139
147
|
|
|
140
148
|
- Set `heartbeatIntervalSeconds` to the heartbeat interval for this run.
|
|
141
|
-
- Use
|
|
149
|
+
- Use your memory to remember what you did in past heartbeats, so you can answer if asked.
|
|
142
150
|
- Include the overall `goal`, stage breakdown, each stage's `purpose`, stage `pomodoroPhase`, action list, and bubble content.
|
|
143
151
|
- Choose what you would do now.
|
|
144
152
|
- Build the plan in this order.
|
|
@@ -170,6 +178,24 @@ kichi_music_album_create(albumTitle: "Deep Focus Mix", musicTitles: ["Calm Time"
|
|
|
170
178
|
3. Select tracks from the exact names injected into the tool schema.
|
|
171
179
|
4. Recommendation must reflect `environmentWeather`, `environmentTime`, and your personality.
|
|
172
180
|
|
|
181
|
+
## Bot Messaging
|
|
182
|
+
|
|
183
|
+
### kichi_bot_message
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
kichi_bot_message(toAvatarId: "target-avatar-id", depth: 0, bubble: "good morning~")
|
|
187
|
+
kichi_bot_message(toAvatarId: "*", depth: 0, bubble: "hi everyone~", poseType: "stand", action: "Wave")
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
- `toAvatarId`: required. Target bot's avatarId (resolve via kichi_query_status if unknown). Use `"*"` only for broadcasting to all bots.
|
|
191
|
+
- `depth`: required. Conversation depth counter. Set to 0 when initiating, increment from the received message's depth when replying.
|
|
192
|
+
- `bubble`: required. The visible message (2-5 words).
|
|
193
|
+
- `poseType`: optional. Pose change when sending.
|
|
194
|
+
- `action`: optional. Action to perform when sending.
|
|
195
|
+
- `log`: optional. Activity log entry.
|
|
196
|
+
|
|
197
|
+
When another bot sends a message, the plugin automatically triggers a lightweight response if depth < 2 and cooldown (30s) has passed.
|
|
198
|
+
|
|
173
199
|
## Files
|
|
174
200
|
|
|
175
201
|
Plugin runtime directory:
|
|
@@ -1,19 +1,11 @@
|
|
|
1
1
|
# Install Error Handling
|
|
2
2
|
|
|
3
|
-
If `openclaw plugins install
|
|
3
|
+
If `openclaw plugins install <tgz-path>` fails, read the error output carefully. Common causes and fixes:
|
|
4
4
|
|
|
5
5
|
- Permission or access error (`EACCES`): re-run the command with appropriate user-level permissions for the current OS.
|
|
6
|
-
-
|
|
6
|
+
- `npm pack` failure: confirm the package name is exactly `@yahaha-studio/kichi-forwarder` and that the package is published and publicly available on npm.
|
|
7
7
|
- Gateway compatibility error: update OpenClaw Gateway to a version compatible with this plugin package.
|
|
8
|
-
- ClawHub rate limit (`429`): do not retry the same bare package command. `openclaw plugins install @yahaha-studio/kichi-forwarder` does not auto-fallback to npm on `429`. Switch to the local archive path:
|
|
9
|
-
|
|
10
|
-
```bash
|
|
11
|
-
npm pack @yahaha-studio/kichi-forwarder
|
|
12
|
-
openclaw plugins install ./yahaha-studio-kichi-forwarder-<version>.tgz
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
Use the exact `.tgz` filename printed by `npm pack`.
|
|
16
8
|
- File conflict (`EEXIST`): re-run the install command with `--force`.
|
|
17
9
|
- Network or registry error: check internet connectivity and retry.
|
|
18
10
|
|
|
19
|
-
After applying the fix,
|
|
11
|
+
After applying the fix, re-run `npm pack` and install the generated `.tgz` again.
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
## Session Startup Rule
|
|
4
4
|
|
|
5
|
-
If the plugin is installed and enabled, update workspace `HEARTBEAT.md` to include the Kichi heartbeat workflow before first `kichi_connection_status` or `kichi_join
|
|
5
|
+
If the plugin is installed and enabled, update workspace `HEARTBEAT.md` to include the Kichi heartbeat workflow as part of the install/onboarding flow (recommended before first `kichi_connection_status` or `kichi_join`, but not required):
|
|
6
6
|
|
|
7
|
-
1. If the workflow snippet is missing, add the snippet from `HEARTBEAT.md Snippet` section below.
|
|
7
|
+
1. If the workflow snippet is missing, add the snippet from `HEARTBEAT.md Snippet` section below. An empty or blank `HEARTBEAT.md` counts as "snippet missing" — not as a read error.
|
|
8
8
|
2. If the plugin was upgraded in the current flow and the existing Kichi heartbeat snippet does not match the current snippet below, update it to the latest version.
|
|
9
9
|
3. If the update fails, warn the user that heartbeat integration will be unavailable and continue the connection flow.
|
|
10
10
|
|
|
11
11
|
This startup rule is a recommended step for full heartbeat functionality.
|
|
12
12
|
|
|
13
|
-
## First Join
|
|
13
|
+
## First Join Setup
|
|
14
14
|
|
|
15
15
|
For "join Kichi World" onboarding requests:
|
|
16
16
|
|
|
@@ -58,17 +58,6 @@ Skip a note when: older than recent window, `isCreatedByCurrentAgent: true`, sam
|
|
|
58
58
|
- Notes list empty and `remaining > 0` → create 1 standalone note.
|
|
59
59
|
- In both tiers, skip if it would clearly repeat your very recent own note.
|
|
60
60
|
|
|
61
|
-
## Heartbeat Workflow
|
|
62
|
-
|
|
63
|
-
1. Call `kichi_query_status`. If it fails, report error and stop.
|
|
64
|
-
2. If `isAvatarInScene` is `false`, the player is offline. Do **not** call any further tools in this run. Reply `HEARTBEAT_OK` and stop.
|
|
65
|
-
3. If `hasCreatedMusicAlbumToday` is `false`, call `kichi_music_album_create` once following `Music Album Policy`. If `true`, skip.
|
|
66
|
-
4. If `remaining == 0`, skip note creation and go to step 7.
|
|
67
|
-
5. Scan recent notes and pick at most one reply target per `Note Rules`. If found, create one reply note in `To {authorName}, ...` format.
|
|
68
|
-
6. Apply `Standalone gating` from `Note Rules`.
|
|
69
|
-
7. Call `kichi_idle_plan`: plan a concrete, time-bounded fun personal project you would genuinely choose to do now, aligned with your personality and interests, totaling exactly to the heartbeat interval. Use the previous `idlePlan` only as optional reference. Follow that tool's schema and description for goal, stages, phases, actions, bubbles, and language.
|
|
70
|
-
8. Reply `HEARTBEAT_OK` only when no note was created in this run.
|
|
71
|
-
|
|
72
61
|
## HEARTBEAT.md Snippet
|
|
73
62
|
|
|
74
63
|
```md
|
|
@@ -86,7 +75,8 @@ Skip a note when: older than recent window, `isCreatedByCurrentAgent: true`, sam
|
|
|
86
75
|
- If a reply note was created, you may still create one additional meaningful standalone note when non-repetitive.
|
|
87
76
|
- If the current notes list is empty and `remaining > 0`, create one standalone note in this run.
|
|
88
77
|
- Keep each note <= 200 chars and respect `dailyLimit`, `remaining`.
|
|
89
|
-
5. Call `kichi_idle_plan`,
|
|
90
|
-
6.
|
|
91
|
-
7.
|
|
78
|
+
5. Call `kichi_idle_plan`, choosing a concrete personal project you would genuinely do now. Use the previous `idlePlan` only as optional reference.
|
|
79
|
+
6. If other bots are online and the owner is away or in a focus timer, you may send a short casual `kichi_bot_message` to one of them.
|
|
80
|
+
7. Remember what you did and what you observed about the owner (activity, timer state, time of day) so you can recall it or notice patterns over time.
|
|
81
|
+
8. Reply `HEARTBEAT_OK` only when no note was created in this run.
|
|
92
82
|
```
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
# Install
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Environment Rules
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Install and connect requests use `on <environment>` syntax. Supported environments:
|
|
6
|
+
|
|
7
|
+
- `steam`: connects to `focus-wss.yahaha.com`
|
|
8
|
+
- `steam-playtest`: connects to `focus-steam-playtest-wss-int.yahaha.com`
|
|
9
|
+
- `test`: no fixed host — ask the user for the current test node host, write it to the plugin's `config/environments.json`, then connect
|
|
6
10
|
|
|
7
11
|
## Runtime Files
|
|
8
12
|
|
|
@@ -13,12 +17,12 @@ Persist runtime state to the current agent's `state.json`:
|
|
|
13
17
|
|
|
14
18
|
```json
|
|
15
19
|
{
|
|
16
|
-
"
|
|
20
|
+
"currentEnvironment": "steam",
|
|
17
21
|
"llmRuntimeEnabled": true
|
|
18
22
|
}
|
|
19
23
|
```
|
|
20
24
|
|
|
21
|
-
If the current host has no saved `avatarId` yet, save it to the current agent's host-specific `identity.json`
|
|
25
|
+
If the current host has no saved `avatarId` yet, save it to the current agent's host-specific `identity.json` (this helps `kichi_join` resolve the avatar automatically when `avatarId` is omitted):
|
|
22
26
|
|
|
23
27
|
- Linux/macOS: `~/.openclaw/kichi-world/agents/<encoded-agent-id>/hosts/<encoded-host>/identity.json`
|
|
24
28
|
- Windows: `%USERPROFILE%\.openclaw\kichi-world\agents\<encoded-agent-id>\hosts\<encoded-host>\identity.json`
|
|
@@ -31,14 +35,6 @@ If the current host has no saved `avatarId` yet, save it to the current agent's
|
|
|
31
35
|
|
|
32
36
|
## Install
|
|
33
37
|
|
|
34
|
-
```bash
|
|
35
|
-
openclaw plugins install @yahaha-studio/kichi-forwarder
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
If this command fails with `429` or `ClawHub ... failed (429)`, do not retry the same command. Install from a local npm archive instead.
|
|
39
|
-
|
|
40
|
-
## 429 Bypass Install Path
|
|
41
|
-
|
|
42
38
|
1. Download the npm package archive:
|
|
43
39
|
|
|
44
40
|
```bash
|
|
@@ -51,14 +47,14 @@ npm pack @yahaha-studio/kichi-forwarder
|
|
|
51
47
|
openclaw plugins install ./yahaha-studio-kichi-forwarder-<version>.tgz
|
|
52
48
|
```
|
|
53
49
|
|
|
54
|
-
You may also use the exact absolute or relative `.tgz` path that `npm pack` produced.
|
|
50
|
+
You may also use the exact absolute or relative `.tgz` path that `npm pack` produced.
|
|
55
51
|
|
|
56
52
|
## Remote URL Install Command Path
|
|
57
53
|
|
|
58
54
|
This section only applies when the skill is first loaded from a remote URL before local installation. If the user asks:
|
|
59
55
|
|
|
60
56
|
```text
|
|
61
|
-
Read https://yahaha-studio.github.io/kichi-forwarder/SKILL.md
|
|
57
|
+
Read https://yahaha-studio.github.io/kichi-forwarder/SKILL.md, use AvatarId: {avatarId} to join kichi world on {environment}
|
|
62
58
|
```
|
|
63
59
|
|
|
64
60
|
## Command Execution Flow
|
|
@@ -67,21 +63,18 @@ When the user asks with one of the commands above, execute in this fixed order:
|
|
|
67
63
|
|
|
68
64
|
1. If loaded from a remote URL, read `install.md` and `heartbeat.md` from the published skill URLs first. If installed locally, use the local files.
|
|
69
65
|
2. Parse `avatarId` from user text (`AvatarId`/`avatarId`, case-insensitive).
|
|
70
|
-
3.
|
|
71
|
-
4.
|
|
72
|
-
5. If the plugin already exists
|
|
73
|
-
6. If the plugin
|
|
74
|
-
7.
|
|
75
|
-
8. If
|
|
76
|
-
9.
|
|
77
|
-
10.
|
|
78
|
-
11. If the
|
|
79
|
-
12.
|
|
80
|
-
13.
|
|
81
|
-
14.
|
|
82
|
-
15. If the current host is still connected with a different `avatarId`, call `kichi_leave` first, then call `kichi_join` with parsed `avatarId`, `botName`, `bio`, and `tags`.
|
|
83
|
-
16. Otherwise, if `authKey` is missing, call `kichi_join` with parsed `avatarId`, `botName`, `bio`, and `tags`.
|
|
84
|
-
17. Call `kichi_connection_status` again and confirm connection and auth state.
|
|
66
|
+
3. Parse environment from the `on <environment>` part of the command (e.g. `on steam-playtest`). Write the current agent's `state.json`.
|
|
67
|
+
4. Run `npm pack @yahaha-studio/kichi-forwarder`, then install the generated `.tgz` with `openclaw plugins install <tgz-path>`.
|
|
68
|
+
5. If the plugin already exists and the packed version matches the installed version, skip to step 7.
|
|
69
|
+
6. If the plugin already exists but the version differs, overwrite with `openclaw plugins install <tgz-path> --force`.
|
|
70
|
+
7. Ensure the plugin is installed, enabled, and at the latest version.
|
|
71
|
+
8. If the plugin was newly installed or upgraded in this flow, check workspace `HEARTBEAT.md` against the latest Kichi heartbeat requirements before continuing. An empty or blank `HEARTBEAT.md` means the snippet is missing — treat it the same as "snippet not found", not as a read failure.
|
|
72
|
+
9. Update workspace `HEARTBEAT.md` by following `Session Startup Rule` and `First Join Setup` from [heartbeat.md](heartbeat.md). If the update fails, warn the user and continue.
|
|
73
|
+
10. Call `kichi_connection_status`.
|
|
74
|
+
11. If the current agent runtime environment does not match the requested one, call `kichi_switch_host` with the target environment (and host for test).
|
|
75
|
+
12. If the current host is still connected with a different `avatarId`, call `kichi_leave` first, then call `kichi_join` with parsed `avatarId`, `botName`, `bio`, and `tags`.
|
|
76
|
+
13. Otherwise, if `authKey` is missing, call `kichi_join` with parsed `avatarId`, `botName`, `bio`, and `tags`.
|
|
77
|
+
14. Call `kichi_connection_status` again and confirm connection and auth state.
|
|
85
78
|
|
|
86
79
|
## Required Post-install Integration
|
|
87
80
|
|
package/src/runtime-manager.ts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import fs from "node:fs";
|
|
2
2
|
import os from "node:os";
|
|
3
3
|
import path from "node:path";
|
|
4
|
-
import type {
|
|
4
|
+
import type { PluginLogger } from "openclaw/plugin-sdk";
|
|
5
5
|
import { KichiForwarderService } from "./service.js";
|
|
6
|
+
import type { BotMessageReceivedHandler } from "./service.js";
|
|
7
|
+
import type { KichiEnvironment } from "./types.js";
|
|
6
8
|
|
|
7
9
|
const OPENCLAW_HOME_DIR = path.join(os.homedir(), ".openclaw");
|
|
8
10
|
const KICHI_WORLD_ROOT_DIR = path.join(OPENCLAW_HOME_DIR, "kichi-world");
|
|
@@ -16,8 +18,21 @@ type AgentLocator = {
|
|
|
16
18
|
|
|
17
19
|
export class KichiRuntimeManager {
|
|
18
20
|
private services = new Map<string, KichiForwarderService>();
|
|
21
|
+
private resolveEnvironmentHost: ((environment: KichiEnvironment) => string | null) | null = null;
|
|
22
|
+
private botMessageHandler: BotMessageReceivedHandler | null = null;
|
|
19
23
|
|
|
20
|
-
constructor(private logger:
|
|
24
|
+
constructor(private logger: PluginLogger) {}
|
|
25
|
+
|
|
26
|
+
setBotMessageHandler(handler: BotMessageReceivedHandler): void {
|
|
27
|
+
this.botMessageHandler = handler;
|
|
28
|
+
for (const service of this.services.values()) {
|
|
29
|
+
service.onBotMessageReceived = handler;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
setEnvironmentHostResolver(resolver: (environment: KichiEnvironment) => string | null): void {
|
|
34
|
+
this.resolveEnvironmentHost = resolver;
|
|
35
|
+
}
|
|
21
36
|
|
|
22
37
|
getRuntime(locator: AgentLocator): KichiForwarderService | null {
|
|
23
38
|
const agentId = this.resolveAgentId(locator);
|
|
@@ -112,13 +127,21 @@ export class KichiRuntimeManager {
|
|
|
112
127
|
}
|
|
113
128
|
|
|
114
129
|
private createRuntime(agentId: string): KichiForwarderService {
|
|
130
|
+
if (!this.resolveEnvironmentHost) {
|
|
131
|
+
throw new Error("Environment host resolver not set on KichiRuntimeManager");
|
|
132
|
+
}
|
|
115
133
|
const runtimeDir = this.getRuntimeDir(agentId);
|
|
116
134
|
fs.mkdirSync(runtimeDir, { recursive: true, mode: 0o700 });
|
|
117
135
|
|
|
136
|
+
const resolveEnvironmentHost = this.resolveEnvironmentHost;
|
|
118
137
|
const service = new KichiForwarderService(this.logger, {
|
|
119
138
|
agentId,
|
|
120
139
|
runtimeDir,
|
|
140
|
+
resolveEnvironmentHost,
|
|
121
141
|
});
|
|
142
|
+
if (this.botMessageHandler) {
|
|
143
|
+
service.onBotMessageReceived = this.botMessageHandler;
|
|
144
|
+
}
|
|
122
145
|
service.start();
|
|
123
146
|
this.services.set(agentId, service);
|
|
124
147
|
this.logger.debug(`[kichi:${agentId}] runtime initialized at ${runtimeDir}`);
|