Pufferfish Openclaw Channel

Name: Pufferfish Openclaw Channel
Rating: 3.5 (1 reviews)
Author: misschengxi-crypto

By misschengxi-crypto 👁 39 views ▲ 0 votes

OpenClaw channel plugin for Pufferfish IM platform

GitHub

Install

npm install
npm

Configuration Example

{
  "channels": {
    "pufferfish": {
      "bots": {
        "my-bot-account": {
          "enabled": true,
          "botUid": "your-bot-uid",
          "privateKey": "-----BEGIN PRIVATE KEY-----\n<your-private-key>\n-----END PRIVATE KEY-----"
        }
      },
      "botProfilesByBotUid": {
        "your-bot-uid": {
          "systemPrompt": "你是一个中文助手。仅根据用户当前问题直接回答，不进行角色扮演，不主动寒暄，不要求用户先设定称呼或身份。",
          "skills": ["skillA", "skillB"]
        }
      }
    }
  }
}

README

# Pufferfish OpenClaw Channel Plugin

OpenClaw channel plugin for connecting bots to the Pufferfish IM platform.

## Features

- Registers `pufferfish` channel to OpenClaw
- Uses bot-side challenge flow (`/v1/ai-bot/connect`) to exchange runtime token
- Maintains WebSocket connection for inbound messages
- Sends text/image/file replies back to Pufferfish

## Requirements

- Node.js 18+
- OpenClaw CLI installed and available as `openclaw`

## Install

```bash
npm install
npm run build
openclaw plugins install . --link
```

Or use Makefile:

```bash
make install
make build
make install-plugin
```

## Configuration

Configure `channels.pufferfish` in `~/.openclaw/openclaw.json`:

```json
{
  "channels": {
    "pufferfish": {
      "bots": {
        "my-bot-account": {
          "enabled": true,
          "botUid": "your-bot-uid",
          "privateKey": "-----BEGIN PRIVATE KEY-----\n<your-private-key>\n-----END PRIVATE KEY-----"
        }
      },
      "botProfilesByBotUid": {
        "your-bot-uid": {
          "systemPrompt": "你是一个中文助手。仅根据用户当前问题直接回答，不进行角色扮演，不主动寒暄，不要求用户先设定称呼或身份。",
          "skills": ["skillA", "skillB"]
        }
      }
    }
  }
}
```

`apiUrl` is optional and defaults to production: `https://v1.88.vu`.
For test/staging, set `bots.<account>.apiUrl` explicitly (for example `https://v1.qqvu.org`).

`systemPrompt` is optional. If omitted or empty, the plugin now sends a neutral fallback prompt so the bot replies directly to user questions without role-play setup chatter.

You can also copy from the safe template:

```bash
cp openclaw.example.json ~/.openclaw/openclaw.json
```

## Security Notes

- `privateKey` is a secret credential. Keep it only in local runtime config.
- Never commit real private keys, tokens, or production credentials to Git.
- Do not place real secrets in examples, tests, or screenshots.

## Development

```bash
npm run dev
npm test
```

## Open Source Release (GitHub)

Create a public repository on GitHub first, then run:

```bash
git remote add github https://github.com/<org-or-user>/pufferfish-openclaw-channel.git
git push -u github main
```

If your default branch is not `main`, replace it with your branch name.

Recommended checks before first public push:

```bash
npm test
npm run build
git status --short
```

## License

MIT License. See `LICENSE`.

channels