docs: 插件 README 簡化為指令、說明、程式碼片段

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
root
2026-10-14 02:52:00 +00:00
co-authored by Claude Sonnet 5.5
parent 9d0c0ba154
commit 00d84f4070
5 changed files with 261 additions and 208 deletions
+51 -39
View File
@@ -1,55 +1,67 @@
<p align="center"><img src="../../assets/icon.png" alt="jsc-companion" width="96"></p>
# jsc-companion
小說角色陪伴:人設注入、語氣、心情與好感、互動記憶、主動關心與待辦,並可用 ingest skill 解析小說建立角色。
目前版本:0.0.3
## 指令
| 指令 | 說明 |
| --- | --- |
| `/companion status` | 查看目前角色與狀態 |
| `/companion switch <角色>` | 切換角色 |
| `/companion off` | 關閉陪伴 |
| `/companion setup` | 設定 |
| `/companion todo` | 待辦:`todo add <內容> [due=YYYY-MM-DDTHH:MM]`、`todo done <編號>` |
| `/companion quiet [分鐘]` | 暫時安靜 |
| `ingest` skill | 解析單章小說(txt/md),逐一詢問合併、新建或略過後寫入角色資料;提供章節檔或要求建立角色時自動使用 |
### `/companion status`
查看目前角色與狀態。
```text
/companion status
/companion switch <角色>
```
### `/companion switch <角色>`
切換角色。
```text
/companion switch 小明
```
### `/companion setup`
進行設定。
```text
/companion setup
```
### `/companion todo add <內容> [due=YYYY-MM-DDTHH:MM]`
新增待辦,可指定到期時間。
```text
/companion todo add 買牛奶 due=2026-10-15T18:00
```
### `/companion todo done <編號>`
將待辦標為完成。
```text
/companion todo done 1
```
### `/companion quiet [分鐘]`
暫時安靜,不主動關心。
```text
/companion quiet 30
```
### `/companion off`
關閉陪伴。
```text
/companion off
```
### `ingest skill`
## 安裝
解析單章小說(txt/md),逐一詢問合併、新建或略過後寫入角色資料;提供章節檔或要求建立角色時自動使用。
```bash
claude plugin marketplace add https://gitea.jsc.idv.tw/jiantw83/jsc-marketplace.git
claude plugin install jsc-companion@jsc-marketplace
```text
幫我用 ingest 解析 chapter1.md,章節編號 1
```
## 更新
```bash
claude plugin marketplace update jsc-marketplace
claude plugin update jsc-companion@jsc-marketplace
```
更新後需重新啟動 Claude Code 才會生效。
## 移除
```bash
claude plugin uninstall jsc-companion@jsc-marketplace
```
## 授權
[MIT License](../../LICENSE)