LiteyukiStudio/nonebot-plugin-marshoai
5
4
Fork 0
mirror of https://github.com/LiteyukiStudio/nonebot-plugin-marshoai.git synced 2025-08-01 07:09:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

✨ 更新安装文档，添加关于GitHub Models API的警告信息，并调整配置项说明

Browse Source
This commit is contained in:
Asankilp
2025-01-25 00:06:27 +08:00
parent c8e776d5ff
commit ef71514ce2
5 changed files with 94 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/start/install.md
View File

@ -49,7 +49,9 @@ Open the `pyproject.toml` file under nonebot2's root directory, Add to`[tool.non
- Create new [personal access token](https://github.com/settings/tokens/new)，**Don't need any permissions**.
- Copy the new token, add to the `.env` file's `marshoai_token` option.
:::warning
GitHub Models API comes with significant limitations and is therefore not recommended for use. For better alternatives, it's suggested to adjust the configuration `MARSHOAI_AZURE_ENDPOINT` to use other service providers' models instead.
:::
## 🎉 Usage
End `marsho` in order to get direction for use(If you configured the custom command, please use the configured one).
@ -105,7 +107,7 @@ Add options in the `.env` file from the diagram below in nonebot2 project.
| Option | Type | Default | Description |
| --------------------- | ---------- | ----------- | ----------------- |
| MARSHOAI_DEFAULT_NAME | `str` | `marsho` | Command to call Marsho |
| MARSHOAI_ALIASES | `set[str]` | `set{"Marsho"}` | Other name(Alias) to call Marsho |
| MARSHOAI_ALIASES | `set[str]` | `list["小棉"]` | Other name(Alias) to call Marsho |
| MARSHOAI_AT | `bool` | `false` | Call by @ or not |
| MARSHOAI_MAIN_COLOUR | `str` | `FFAAAA` | Theme color, used by some tools and features |
@ -125,6 +127,7 @@ Add options in the `.env` file from the diagram below in nonebot2 project.
| MARSHOAI_MAX_TOKENS | `int` | `null` | Max token number |
| MARSHOAI_ADDITIONAL_IMAGE_MODELS | `list` | `[]` | External image-support model list, such as `hunyuan-vision` |
| MARSHOAI_NICKNAME_LIMIT | `int` | `16` | Limit for nickname length |
| MARSHOAI_FIX_TOOLCALLS | `bool` | `true` | Fix tool calls or not |
#### Feature Switches