onebots

English

简体中文

English

简体中文

Appearance

Satori Protocol ​

Satori is a modern, unified robot protocol standard designed for cross-platform robot applications.

Protocol Introduction ​

Satori protocol provides:

  • Unified message format
  • Standardized API interface
  • Event-driven architecture
  • Multi-platform support
  • Extensible design

Standard Reference ​

Installation ​

Server-Side ​

bash
npm install @onebots/protocol-satori-v1

Client-Side ​

bash
npm install @imhelper/satori-v1

Configuration ​

Configure Satori protocol in config.yaml:

yaml
# Global default configuration
general:
  satori.v1:
    use_http: true
    use_ws: true
    token: ''

# Account configuration
wechat.my_mp:
  satori.v1:
    use_http: true
    use_ws: true
    token: 'your_token'

Communication Methods ​

HTTP API ​

URL Format: http://localhost:6727/{platform}/{account_id}/satori/v1/{action}

WebSocket ​

URL Format: ws://localhost:6727/{platform}/{account_id}/satori/v1

Client SDK Usage ​

typescript
import { ImHelper } from 'imhelper';
import { SatoriV1Adapter } from '@imhelper/satori-v1';

const client = new ImHelper();

// Register Satori protocol adapter
client.registerAdapter('satori.v1', SatoriV1Adapter);

// Connect to onebots server
await client.connect({
  platform: 'wechat',
  account_id: 'my_mp',
  protocol: 'satori.v1',
  endpoint: 'ws://localhost:6727/wechat/my_mp/satori/v1/ws',
  token: 'your_token',
});