From b76e3a19f1eb0d7f4446175aa292e6f694c2b9f8 Mon Sep 17 00:00:00 2001 From: Asankilp Date: Mon, 2 Dec 2024 01:04:52 +0800 Subject: [PATCH] update license and readme --- LICENSE => LICENSE-MIT | 0 LICENSE-MULAN | 9 +++++++++ README.md | 5 ++++- README_EN.md | 12 +++++++++--- 4 files changed, 22 insertions(+), 4 deletions(-) rename LICENSE => LICENSE-MIT (100%) create mode 100644 LICENSE-MULAN diff --git a/LICENSE b/LICENSE-MIT similarity index 100% rename from LICENSE rename to LICENSE-MIT diff --git a/LICENSE-MULAN b/LICENSE-MULAN new file mode 100644 index 0000000..d4271fc --- /dev/null +++ b/LICENSE-MULAN @@ -0,0 +1,9 @@ +Copyright (c) 2024 EillesWan +nonebot-plugin-latex & other specified codes is licensed under Mulan PSL v2. +You can use this software according to the terms and conditions of the Mulan PSL v2. +You may obtain a copy of Mulan PSL v2 at: + http://license.coscl.org.cn/MulanPSL2 +THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, +EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, +MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. +See the Mulan PSL v2 for more details. diff --git a/README.md b/README.md index c5b2c92..6fc71de 100644 --- a/README.md +++ b/README.md @@ -174,10 +174,13 @@ _✨ 使用 OpenAI 标准格式 API 的聊天机器人插件 ✨_ | MARSHOAI_SINGLE_LATEX_PARSE | `bool` | `false` | 单行公式是否渲染(当消息富文本解析启用时可用)(如果单行也渲……只能说不好看) | ## ❤ 鸣谢&版权说明 +本项目使用了以下项目的代码: +- [nonebot-plugin-latex](https://github.com/EillesWan/nonebot-plugin-latex) "Marsho" logo 由 [@Asankilp](https://github.com/Asankilp) 绘制,基于 [CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/) 许可下提供。 -"nonebot-plugin-marshoai" 基于 [MIT](./LICENSE) 许可下提供。 +"nonebot-plugin-marshoai" 基于 [MIT](./LICENSE-MIT) 许可下提供。 +部分指定的代码基于 [Mulan PSL v2](./LICENSE-MULAN) 许可下提供。 ## 🕊️ TODO diff --git a/README_EN.md b/README_EN.md index 36bc528..30c8072 100644 --- a/README_EN.md +++ b/README_EN.md @@ -151,6 +151,7 @@ Add options in the `.env` file from the diagram below in nonebot2 project. | MARSHOAI_DEFAULT_NAME | `str` | `marsho` | Command to call Marsho | | MARSHOAI_ALIASES | `set[str]` | `set{"Marsho"}` | 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 | #### AI call @@ -175,15 +176,20 @@ Add options in the `.env` file from the diagram below in nonebot2 project. | MARSHOAI_ENABLE_NICKNAME_TIP | `bool` | `true` | When on, if user haven't set username, remind user to set | | MARSHOAI_ENABLE_PRAISES | `bool` | `true` | Turn on Praise list or not | | MARSHOAI_ENABLE_TOOLS | `bool` | `true` | Turn on Marsho Tools or not | -| MARSHOAI_LOAD_BUILTIN_TOOLS | `bool` | `true` | Loading the built-in tool pack or not | - +| MARSHOAI_LOAD_BUILTIN_TOOLS | `bool` | `true` | Loading the built-in toolkit or not | +| MARSHOAI_TOOLSET_DIR | `list` | `[]` | List of external toolset directory | +| MARSHOAI_ENABLE_RICHTEXT_PARSE | `bool` | `true` | Turn on auto parse rich text feature(including image, LaTeX equation) | +| MARSHOAI_SINGLE_LATEX_PARSE | `bool` | `false`| Render single-line equation or not | ## ❤ Thanks&Copyright +This project uses the following code from other projects: +-[nonebot-plugin-latex](https://github.com/EillesWan/nonebot-plugin-latex) "Marsho" logo contributed by [@Asankilp](https://github.com/Asankilp), licensed under [CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/) lisense. -"nonebot-plugin-marshoai" is licensed under [MIT](./LICENSE) license. +"nonebot-plugin-marshoai" is licensed under [MIT](./LICENSE-MIT) license. +Some of the code is licensed under [Mulan PSL v2](./LICENSE-MULAN) license. ## 🕊️ TODO