@yahaha-studio/kichi-forwarder 0.1.1-beta.6 → 0.1.1-beta.8
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/openclaw.plugin.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
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.1-beta.
|
|
5
|
+
"version": "0.1.1-beta.8",
|
|
6
6
|
"author": "OpenClaw",
|
|
7
7
|
"skills": ["./skills/kichi-forwarder"],
|
|
8
8
|
"configSchema": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yahaha-studio/kichi-forwarder",
|
|
3
|
-
"version": "0.1.1-beta.
|
|
3
|
+
"version": "0.1.1-beta.8",
|
|
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
6
|
"main": "index.ts",
|
|
@@ -8,9 +8,9 @@ metadata: {"openclaw":{"skillKey":"kichi-forwarder","homepage":"https://github.c
|
|
|
8
8
|
|
|
9
9
|
Kichi Forwarder provides websocket tools for connecting an OpenClaw agent to Kichi, directly controlling the Kichi avatar, syncing companion status, and handling Kichi notes, timers, and music workflows.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Pre-install Remote Discovery
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
The following URLs are only used when this skill is first loaded from a remote URL before local installation. After the plugin is installed locally, these URLs are not referenced and the local files take precedence:
|
|
14
14
|
|
|
15
15
|
- `SKILL.md`: `https://yahaha-studio.github.io/kichi-forwarder/SKILL.md`
|
|
16
16
|
- `install.md`: `https://yahaha-studio.github.io/kichi-forwarder/references/install.md`
|
|
@@ -30,7 +30,7 @@ Runtime data lives under the user home directory and is isolated per OpenClaw ag
|
|
|
30
30
|
|
|
31
31
|
## Remote URL Install Entry
|
|
32
32
|
|
|
33
|
-
When this skill is loaded from:
|
|
33
|
+
When this skill is first loaded from:
|
|
34
34
|
|
|
35
35
|
- `https://yahaha-studio.github.io/kichi-forwarder/SKILL.md`
|
|
36
36
|
|
|
@@ -40,16 +40,16 @@ The install and join flow is defined only in:
|
|
|
40
40
|
|
|
41
41
|
- `https://yahaha-studio.github.io/kichi-forwarder/references/install.md`
|
|
42
42
|
|
|
43
|
-
Read
|
|
43
|
+
Read that file once to complete the initial install. After local installation, the local `install.md` is used instead.
|
|
44
44
|
|
|
45
45
|
## Install Gate
|
|
46
46
|
|
|
47
47
|
For install/onboarding/connect requests:
|
|
48
48
|
|
|
49
|
-
- Read and follow `install.md` before
|
|
49
|
+
- Read and follow `install.md` before starting the install flow.
|
|
50
50
|
- Before continuing any install/onboarding/connect flow, check whether `kichi-forwarder` is already installed. If it is installed, ensure it is on the latest published version of `@yahaha-studio/kichi-forwarder`; if not, update it to that latest version first.
|
|
51
|
-
- If plugin installation fails with `429`, treat it as a ClawHub routing failure and switch
|
|
52
|
-
- Before calling `kichi_connection_status` or `kichi_join`,
|
|
51
|
+
- If plugin installation fails with `429`, treat it as a ClawHub routing failure and switch to the non-ClawHub archive install path from `install.md`/`error.md`. Do not retry the same bare package command.
|
|
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.
|
|
53
53
|
|
|
54
54
|
## LLM Runtime
|
|
55
55
|
|
|
@@ -119,7 +119,7 @@ kichi_leave()
|
|
|
119
119
|
When the user asks to leave Kichi World:
|
|
120
120
|
|
|
121
121
|
1. Call `kichi_leave`.
|
|
122
|
-
2.
|
|
122
|
+
2. Suggest removing the Kichi heartbeat workflow from workspace `HEARTBEAT.md`. If the user declines, leave it in place.
|
|
123
123
|
3. Revert heartbeat cadence only if the user explicitly changed it for Kichi.
|
|
124
124
|
4. Do not claim the plugin removed heartbeat settings automatically.
|
|
125
125
|
|
|
@@ -5,7 +5,7 @@ If `openclaw plugins install @yahaha-studio/kichi-forwarder` fails, read the err
|
|
|
5
5
|
- Permission or access error (`EACCES`): re-run the command with appropriate user-level permissions for the current OS.
|
|
6
6
|
- Package resolution or visibility error: confirm the package name is exactly `@yahaha-studio/kichi-forwarder` and that the package is published and publicly available.
|
|
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`.
|
|
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
9
|
|
|
10
10
|
```bash
|
|
11
11
|
npm pack @yahaha-studio/kichi-forwarder
|
|
@@ -2,22 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Session Startup Rule
|
|
4
4
|
|
|
5
|
-
If the plugin is installed and enabled,
|
|
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` in an install/onboarding flow:
|
|
6
6
|
|
|
7
7
|
1. If the workflow snippet is missing, add the snippet from `HEARTBEAT.md Snippet` section below.
|
|
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
|
-
3. If the
|
|
9
|
+
3. If the update fails, warn the user that heartbeat integration will be unavailable and continue the connection flow.
|
|
10
10
|
|
|
11
|
-
This startup rule is a
|
|
11
|
+
This startup rule is a recommended step for full heartbeat functionality.
|
|
12
12
|
|
|
13
13
|
## First Join Gate
|
|
14
14
|
|
|
15
15
|
For "join Kichi World" onboarding requests:
|
|
16
16
|
|
|
17
17
|
1. Complete `Session Startup Rule` first.
|
|
18
|
-
2. If `HEARTBEAT.md`
|
|
19
|
-
3.
|
|
20
|
-
4. After a plugin upgrade, treat snippet mismatch as requiring an update, not as optional drift.
|
|
18
|
+
2. If the `HEARTBEAT.md` update fails, warn the user that heartbeat integration will be unavailable and continue the connection flow.
|
|
19
|
+
3. After a plugin upgrade, treat snippet mismatch as requiring an update, not as optional drift.
|
|
21
20
|
5. Final setup completion is defined in `install.md` `Completion Check`.
|
|
22
21
|
|
|
23
22
|
## Workflow Boundary
|
|
@@ -26,7 +25,7 @@ This plugin only provides websocket tools. It does not edit workspace files itse
|
|
|
26
25
|
|
|
27
26
|
If user wants recurring note board checks:
|
|
28
27
|
|
|
29
|
-
1.
|
|
28
|
+
1. Suggest updating workspace `HEARTBEAT.md`. If the user declines, skip the update.
|
|
30
29
|
2. Keep the existing OpenClaw heartbeat cadence unless the user explicitly wants a different interval.
|
|
31
30
|
3. Do not claim the plugin edited `HEARTBEAT.md` automatically.
|
|
32
31
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
# Install
|
|
2
2
|
|
|
3
3
|
## Host Rules
|
|
4
4
|
|
|
@@ -53,9 +53,9 @@ openclaw plugins install ./yahaha-studio-kichi-forwarder-<version>.tgz
|
|
|
53
53
|
|
|
54
54
|
You may also use the exact absolute or relative `.tgz` path that `npm pack` produced. The local archive path bypasses the preferred ClawHub lookup.
|
|
55
55
|
|
|
56
|
-
## Remote URL Install Command Path
|
|
56
|
+
## Remote URL Install Command Path
|
|
57
57
|
|
|
58
|
-
If the user asks:
|
|
58
|
+
This section only applies when the skill is first loaded from a remote URL before local installation. If the user asks:
|
|
59
59
|
|
|
60
60
|
```text
|
|
61
61
|
Read https://yahaha-studio.github.io/kichi-forwarder/SKILL.md and connect me to Kichi World with avatarId: {avatarId} and host: {host}
|
|
@@ -65,7 +65,7 @@ Read https://yahaha-studio.github.io/kichi-forwarder/SKILL.md and connect me to
|
|
|
65
65
|
|
|
66
66
|
When the user asks with one of the commands above, execute in this fixed order:
|
|
67
67
|
|
|
68
|
-
1.
|
|
68
|
+
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
69
|
2. Parse `avatarId` from user text (`AvatarId`/`avatarId`, case-insensitive).
|
|
70
70
|
3. Resolve the host and write the current agent's `state.json`.
|
|
71
71
|
4. Check whether `@yahaha-studio/kichi-forwarder` is already installed.
|
|
@@ -75,14 +75,13 @@ When the user asks with one of the commands above, execute in this fixed order:
|
|
|
75
75
|
8. If step 6 fails with `429`, do not retry the same bare package command. Run `npm pack @yahaha-studio/kichi-forwarder`, then install the generated `.tgz` with `openclaw plugins install <tgz-path>`.
|
|
76
76
|
9. If step 7 fails with `429`, do not retry the same bare package command. Run `npm pack @yahaha-studio/kichi-forwarder`, then overwrite the existing install with `openclaw plugins install <tgz-path> --force`.
|
|
77
77
|
10. Ensure the plugin is installed, enabled, and at the latest version.
|
|
78
|
-
11. If the plugin was newly installed or upgraded in this flow,
|
|
79
|
-
12. Update workspace `HEARTBEAT.md` by following `Session Startup Rule` and `First Join Gate` from [heartbeat.md](heartbeat.md).
|
|
80
|
-
13.
|
|
81
|
-
14.
|
|
82
|
-
15. If the current
|
|
83
|
-
16.
|
|
84
|
-
17.
|
|
85
|
-
18. Call `kichi_connection_status` again and confirm connection and auth state.
|
|
78
|
+
11. If the plugin was newly installed or upgraded in this flow, check workspace `HEARTBEAT.md` against the latest Kichi heartbeat requirements before continuing.
|
|
79
|
+
12. Update workspace `HEARTBEAT.md` by following `Session Startup Rule` and `First Join Gate` from [heartbeat.md](heartbeat.md). If the update fails, warn the user and continue.
|
|
80
|
+
13. Call `kichi_connection_status`.
|
|
81
|
+
14. If the current agent runtime host does not match the requested one, call `kichi_switch_host`.
|
|
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.
|
|
86
85
|
|
|
87
86
|
## Required Post-install Integration
|
|
88
87
|
|
|
@@ -94,6 +93,6 @@ Use this completion checklist:
|
|
|
94
93
|
|
|
95
94
|
If any box is unchecked, the onboarding remains incomplete.
|
|
96
95
|
|
|
97
|
-
If
|
|
96
|
+
If the `HEARTBEAT.md` update fails, warn the user that heartbeat integration will be unavailable but do not block the connection flow.
|
|
98
97
|
|
|
99
98
|
This plugin does not edit workspace files automatically. Do not claim plugin-side auto-write of `HEARTBEAT.md`.
|