Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
595 changes: 462 additions & 133 deletions README.fr.md

Large diffs are not rendered by default.

579 changes: 454 additions & 125 deletions README.id.md

Large diffs are not rendered by default.

542 changes: 435 additions & 107 deletions README.it.md

Large diffs are not rendered by default.

489 changes: 405 additions & 84 deletions README.ja.md

Large diffs are not rendered by default.

1,504 changes: 326 additions & 1,178 deletions README.md

Large diffs are not rendered by default.

603 changes: 462 additions & 141 deletions README.pt-br.md

Large diffs are not rendered by default.

611 changes: 466 additions & 145 deletions README.vi.md

Large diffs are not rendered by default.

410 changes: 368 additions & 42 deletions README.zh.md

Large diffs are not rendered by default.

Binary file added assets/hardware-banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/launcher-tui.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/launcher-webui.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions docs/channels/matrix/README.fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
> Retour au [README](../../../README.fr.md)

# Guide de configuration du canal Matrix

## 1. Exemple de configuration

Ajoutez ceci à `config.json` :

```json
{
"channels": {
"matrix": {
"enabled": true,
"homeserver": "https://matrix.org",
"user_id": "@your-bot:matrix.org",
"access_token": "YOUR_MATRIX_ACCESS_TOKEN",
"device_id": "",
"join_on_invite": true,
"allow_from": [],
"group_trigger": {
"mention_only": true
},
"placeholder": {
"enabled": true,
"text": "Thinking..."
},
"reasoning_channel_id": "",
"message_format": "richtext"
}
}
}
```

## 2. Référence des champs

| Champ | Type | Requis | Description |
|----------------------|----------|--------|-------------|
| enabled | bool | Oui | Activer ou désactiver le canal Matrix |
| homeserver | string | Oui | URL du homeserver Matrix (par exemple `https://matrix.org`) |
| user_id | string | Oui | ID utilisateur Matrix du bot (par exemple `@bot:matrix.org`) |
| access_token | string | Oui | Jeton d'accès du bot |
| device_id | string | Non | ID d'appareil Matrix optionnel |
| join_on_invite | bool | Non | Rejoindre automatiquement les salons invités |
| allow_from | []string | Non | Liste blanche d'utilisateurs (IDs Matrix) |
| group_trigger | object | Non | Stratégie de déclenchement de groupe (`mention_only` / `prefixes`) |
| placeholder | object | Non | Configuration du message de remplacement |
| reasoning_channel_id | string | Non | Canal cible pour la sortie de raisonnement |
| message_format | string | Non | Format de sortie : `"richtext"` (défaut) rend le markdown en HTML ; `"plain"` envoie du texte brut uniquement |

## 3. Fonctionnalités actuellement supportées

- Envoi/réception de messages texte avec rendu markdown (gras, italique, titres, blocs de code, etc.)
- Format de message configurable (`richtext` / `plain`)
- Téléchargement d'images/audio/vidéo/fichiers entrants (MediaStore en priorité, chemin local en secours)
- Normalisation de l'audio entrant dans le flux de transcription existant (`[audio: ...]`)
- Upload et envoi d'images/audio/vidéo/fichiers sortants
- Règles de déclenchement de groupe (y compris le mode mention uniquement)
- État de frappe (`m.typing`)
- Message de remplacement + remplacement de la réponse finale
- Rejoindre automatiquement les salons invités (peut être désactivé)

## 4. TODO

- Améliorations des métadonnées des médias riches (par exemple taille et miniatures des images/vidéos)
64 changes: 64 additions & 0 deletions docs/channels/matrix/README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
> [README](../../../README.ja.md) に戻る

# Matrix チャンネル設定ガイド

## 1. 設定例

`config.json` に以下を追加してください:

```json
{
"channels": {
"matrix": {
"enabled": true,
"homeserver": "https://matrix.org",
"user_id": "@your-bot:matrix.org",
"access_token": "YOUR_MATRIX_ACCESS_TOKEN",
"device_id": "",
"join_on_invite": true,
"allow_from": [],
"group_trigger": {
"mention_only": true
},
"placeholder": {
"enabled": true,
"text": "Thinking..."
},
"reasoning_channel_id": "",
"message_format": "richtext"
}
}
}
```

## 2. フィールドリファレンス

| フィールド | 型 | 必須 | 説明 |
|----------------------|----------|------|------|
| enabled | bool | はい | Matrix チャンネルの有効/無効 |
| homeserver | string | はい | Matrix ホームサーバー URL(例:`https://matrix.org`) |
| user_id | string | はい | ボットの Matrix ユーザー ID(例:`@bot:matrix.org`) |
| access_token | string | はい | ボットのアクセストークン |
| device_id | string | いいえ | オプションの Matrix デバイス ID |
| join_on_invite | bool | いいえ | 招待されたルームに自動参加 |
| allow_from | []string | いいえ | ユーザーホワイトリスト(Matrix ユーザー ID) |
| group_trigger | object | いいえ | グループトリガー戦略(`mention_only` / `prefixes`) |
| placeholder | object | いいえ | プレースホルダーメッセージ設定 |
| reasoning_channel_id | string | いいえ | 推論出力のターゲットチャンネル |
| message_format | string | いいえ | 出力形式:`"richtext"`(デフォルト)は markdown を HTML としてレンダリング;`"plain"` はプレーンテキストのみ送信 |

## 3. 現在サポートされている機能

- markdown レンダリング付きテキストメッセージ送受信(太字、斜体、見出し、コードブロックなど)
- 設定可能なメッセージ形式(`richtext` / `plain`)
- 受信画像/音声/動画/ファイルのダウンロード(MediaStore 優先、ローカルパスフォールバック)
- 受信音声の既存文字起こしフローへの正規化(`[audio: ...]`)
- 送信画像/音声/動画/ファイルのアップロードと送信
- グループトリガールール(メンションのみモードを含む)
- タイピング状態(`m.typing`)
- プレースホルダーメッセージ + 最終返信の置き換え
- 招待されたルームへの自動参加(無効化可能)

## 4. TODO

- リッチメディアメタデータの改善(例:画像/動画のサイズとサムネイル)
2 changes: 2 additions & 0 deletions docs/channels/matrix/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
> Back to [README](../../../README.md)

# Matrix Channel Configuration Guide

## 1. Example Configuration
Expand Down
64 changes: 64 additions & 0 deletions docs/channels/matrix/README.pt-br.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
> Voltar ao [README](../../../README.pt-br.md)

# Guia de Configuração do Canal Matrix

## 1. Exemplo de Configuração

Adicione isto ao `config.json`:

```json
{
"channels": {
"matrix": {
"enabled": true,
"homeserver": "https://matrix.org",
"user_id": "@your-bot:matrix.org",
"access_token": "YOUR_MATRIX_ACCESS_TOKEN",
"device_id": "",
"join_on_invite": true,
"allow_from": [],
"group_trigger": {
"mention_only": true
},
"placeholder": {
"enabled": true,
"text": "Thinking..."
},
"reasoning_channel_id": "",
"message_format": "richtext"
}
}
}
```

## 2. Referência de Campos

| Campo | Tipo | Obrigatório | Descrição |
|----------------------|----------|-------------|-----------|
| enabled | bool | Sim | Habilitar ou desabilitar o canal Matrix |
| homeserver | string | Sim | URL do homeserver Matrix (por exemplo `https://matrix.org`) |
| user_id | string | Sim | ID de usuário Matrix do bot (por exemplo `@bot:matrix.org`) |
| access_token | string | Sim | Token de acesso do bot |
| device_id | string | Não | ID de dispositivo Matrix opcional |
| join_on_invite | bool | Não | Entrar automaticamente em salas convidadas |
| allow_from | []string | Não | Lista branca de usuários (IDs Matrix) |
| group_trigger | object | Não | Estratégia de gatilho de grupo (`mention_only` / `prefixes`) |
| placeholder | object | Não | Configuração de mensagem de espaço reservado |
| reasoning_channel_id | string | Não | Canal alvo para saída de raciocínio |
| message_format | string | Não | Formato de saída: `"richtext"` (padrão) renderiza markdown como HTML; `"plain"` envia apenas texto simples |

## 3. Suporte Atual

- Envio/recebimento de mensagens de texto com renderização markdown (negrito, itálico, cabeçalhos, blocos de código, etc.)
- Formato de mensagem configurável (`richtext` / `plain`)
- Download de imagens/áudio/vídeo/arquivos recebidos (MediaStore primeiro, fallback para caminho local)
- Normalização de áudio recebido no fluxo de transcrição existente (`[audio: ...]`)
- Upload e envio de imagens/áudio/vídeo/arquivos de saída
- Regras de gatilho de grupo (incluindo modo somente menção)
- Estado de digitação (`m.typing`)
- Mensagem de espaço reservado + substituição de resposta final
- Entrada automática em salas convidadas (pode ser desabilitado)

## 4. TODO

- Melhorias nos metadados de mídia rica (por exemplo tamanho e miniaturas de imagens/vídeos)
64 changes: 64 additions & 0 deletions docs/channels/matrix/README.vi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
> Quay lại [README](../../../README.vi.md)

# Hướng dẫn Cấu hình Kênh Matrix

## 1. Cấu hình Mẫu

Thêm vào `config.json`:

```json
{
"channels": {
"matrix": {
"enabled": true,
"homeserver": "https://matrix.org",
"user_id": "@your-bot:matrix.org",
"access_token": "YOUR_MATRIX_ACCESS_TOKEN",
"device_id": "",
"join_on_invite": true,
"allow_from": [],
"group_trigger": {
"mention_only": true
},
"placeholder": {
"enabled": true,
"text": "Thinking..."
},
"reasoning_channel_id": "",
"message_format": "richtext"
}
}
}
```

## 2. Tham chiếu Trường

| Trường | Kiểu | Bắt buộc | Mô tả |
|----------------------|----------|----------|-------|
| enabled | bool | Có | Bật hoặc tắt kênh Matrix |
| homeserver | string | Có | URL homeserver Matrix (ví dụ `https://matrix.org`) |
| user_id | string | Có | ID người dùng Matrix của bot (ví dụ `@bot:matrix.org`) |
| access_token | string | Có | Token truy cập của bot |
| device_id | string | Không | ID thiết bị Matrix tùy chọn |
| join_on_invite | bool | Không | Tự động tham gia phòng được mời |
| allow_from | []string | Không | Danh sách trắng người dùng (ID Matrix) |
| group_trigger | object | Không | Chiến lược kích hoạt nhóm (`mention_only` / `prefixes`) |
| placeholder | object | Không | Cấu hình tin nhắn giữ chỗ |
| reasoning_channel_id | string | Không | Kênh đích cho đầu ra suy luận |
| message_format | string | Không | Định dạng đầu ra: `"richtext"` (mặc định) render markdown thành HTML; `"plain"` chỉ gửi văn bản thuần |

## 3. Tính năng Hiện tại

- Gửi/nhận tin nhắn văn bản với render markdown (đậm, nghiêng, tiêu đề, khối code, v.v.)
- Định dạng tin nhắn có thể cấu hình (`richtext` / `plain`)
- Tải xuống hình ảnh/âm thanh/video/tệp đến (MediaStore trước, fallback đường dẫn cục bộ)
- Chuẩn hóa âm thanh đến vào luồng phiên âm hiện có (`[audio: ...]`)
- Tải lên và gửi hình ảnh/âm thanh/video/tệp đi
- Quy tắc kích hoạt nhóm (bao gồm chế độ chỉ đề cập)
- Trạng thái đang gõ (`m.typing`)
- Tin nhắn giữ chỗ + thay thế phản hồi cuối cùng
- Tự động tham gia phòng được mời (có thể tắt)

## 4. TODO

- Cải thiện metadata phương tiện phong phú (ví dụ kích thước và hình thu nhỏ hình ảnh/video)
2 changes: 2 additions & 0 deletions docs/channels/matrix/README.zh.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
> 返回 [README](../../../README.zh.md)

# Matrix 通道配置指南

## 1. 配置示例
Expand Down
Loading
Loading