aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.gitmodules4
-rw-r--r--README.rst37
-rw-r--r--docs/source/index.rst5
-rw-r--r--site/package-lock.json26
-rw-r--r--site/package.json2
-rw-r--r--site/yarn.lock14
6 files changed, 45 insertions, 43 deletions
diff --git a/.gitmodules b/.gitmodules
index 7fd6566..1897f8d 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -3,6 +3,6 @@
url = https://github.com/HydroRoll-Team/HydroRollCore
branch = main
[submodule "TRPGNivis"]
- path = TRPGNivis
+ path = TRPGNivisSDK
url = https://github.com/HydroRoll-Team/TRPGNivis
- branch = main \ No newline at end of file
+ branch = main
diff --git a/README.rst b/README.rst
index fb1e904..b744bd4 100644
--- a/README.rst
+++ b/README.rst
@@ -1,16 +1,10 @@
-|official site| |community| |ruff| |python_v| |crates_v| |release_img| |docs_status|
+|official site| |community| |ruff| |python_v| |crates_v| |release_img| |docs_status| |CodeQL|
-.. image:: https://images.repography.com/39938419/HydroRoll-Team/HydroRoll/structure/ZbjPFFiNYq0UR3cTqEwQHLzqWSn3SeO30n9Nk3SwmVU/P3iLPoavAOE9FSLe1r5_jJObx8LljYhDBCDfkumyDY0_table.svg
- :alt: Structure
- :target: https://github.com/HydroRoll-Team/HydroRoll
- :width: 60
- :align: right
+跨平台、多模态、高度自定义的骰系开发框架 |Structure2|
+==================================
.. start-index
-跨平台、多模态、高度自定义的骰系开发框架
-========================================
-
欢迎来到 *HydroRoll* [水系]，一个依据科学架构并由多模态模型赋能，使用 *Rust* 与 *Python* 编写的高性能、跨平台骰系开发框架。
🌏 此框架主要用于解决 **“如何更好的为冷门规则书做适配”** 与 **“如何更好的实现人机交互”** 两个问题。如果你是世界主、规则书作者、人工智能（自然语言处理方向）爱好者，那么水系或许是你的不二之选。
@@ -24,7 +18,7 @@
- 👍 跨平台，对接 *onebot* 协议、 *kook* 平台、 *dingtalk* 软件、 *telegram*、 *discord*、 *minecraft*...与自研 *IM* 平台。
- 🧩 兼容的插件设计，可编写 *lua*、 *python*、 *javascript* 脚本，为附加功能赋能， *Blockly* 傻瓜式在线可视化编写水系脚本插件。
- 🎲 *Meta* 级别的掷骰表达式解析库，可自定义任何解析规则，或可用于一条指令执行多个操作~>学习 `oneroll <https://github.com/HydroRoll-Team/DiceParser>`_。
-- 🤖 内嵌 *AI* 工具——水系模型工作流，*webui* 管理各个单一任务模型的输入输出与嵌套关系，低成本实现媲美大模型的多任务功能。
+- 🤖 内嵌 *AI* 工具——水系模型工作流， *webui* 管理各个单一任务模型的输入输出与嵌套关系，低成本实现媲美大模型的多任务功能。
- 🎢 渐进式学习框架，从编写简单的 *nivis reply* 脚本，到编写满足小需求的 *lua*、 *python* 脚本，再到成为世界主编写自己的规则包模块，甚至训练水系模型，层层递进，轻松学习。
- 🔓 更多特性等你发掘！
@@ -37,16 +31,16 @@
.. code:: shell
- pip install hydro_roll
- # pip install hydro_roll[all] 安装所有组件
- # pip install hydro_roll[basemodel] 安装基础模型
- # pip install hydro_roll[dev] 安装开发包
+ pip install hydro-roll
+ # pip install hydro-roll[all] 安装所有组件
+ # pip install hydro-roll[basemodel] 安装基础模型
+ # pip install hydro-roll[dev] 安装开发包
接着使用 ``atien`` 命令搭建机器人模板并运行。
.. code:: shell
- atien new -b coc_example "HydroRollBot"
+ atien new -b coc-example "HydroRollBot"
cd HydroRollBot
atien run
@@ -62,11 +56,11 @@
pip install iamai
iamai new "HydroRollDevBot"
- iamai install hydro_roll --dist HydroRollDevBot
+ iamai install hydro-roll --dist HydroRollDevBot
# cd HydroRollDevBot
- # iamai install hydro_roll
+ # iamai install hydro-roll
-接着你需要自行修改 *config.toml* 中的相关适配器与 *hydro_roll* 插件的配置。
+接着你需要自行修改 *config.toml* 中的相关适配器与 *hydro-roll* 插件的配置。
最后你可能需要一个启动锚点—— ``main.py``。
@@ -132,6 +126,9 @@
.. |Structure| image:: https://images.repography.com/39938419/HydroRoll-Team/HydroRoll/structure/ZbjPFFiNYq0UR3cTqEwQHLzqWSn3SeO30n9Nk3SwmVU/-8GQ3jezs4jjRVX5ZbACiuiSwmPbkzEdEQAyP2ednF0_table.svg
:target: https://github.com/HydroRoll-Team/HydroRoll
:alt: Structure
+ :align: right
+.. |Structure2| image:: https://images.repography.com/39938419/HydroRoll-Team/HydroRoll/structure/ZbjPFFiNYq0UR3cTqEwQHLzqWSn3SeO30n9Nk3SwmVU/P3iLPoavAOE9FSLe1r5_jJObx8LljYhDBCDfkumyDY0_table.svg
+ :width: 60
.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Ruff
@@ -157,4 +154,6 @@
.. |license icon| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FHydroRoll-Team%2FHydroRoll.svg?type=shield&issueType=license
:target: https://app.fossa.com/projects/git%2Bgithub.com%2FHydroRoll-Team%2FHydroRoll?ref=badge_shield&issueType=license
.. |FOSSA Status| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FHydroRoll-Team%2FHydroRoll.svg?type=large&issueType=license
- :target: https://app.fossa.com/projects/git%2Bgithub.com%2FHydroRoll-Team%2FHydroRoll?ref=badge_large&issueType=license \ No newline at end of file
+ :target: https://app.fossa.com/projects/git%2Bgithub.com%2FHydroRoll-Team%2FHydroRoll?ref=badge_large&issueType=license
+.. |CodeQL| image:: https://github.com/HydroRoll-Team/HydroRoll/actions/workflows/github-code-scanning/codeql/badge.svg
+ :target: https://github.com/HydroRoll-Team/HydroRoll/actions/workflows/github-code-scanning/codeql
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 88f3f4b..3c4827b 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,5 +1,8 @@
.. hide-toc: true
+跨平台、多模态、高度自定义的骰系开发框架
+=======================================
+
.. include:: ../../README.rst
:start-after: start-index
:end-before: end-index
@@ -39,4 +42,4 @@
:hidden:
:caption: 开放 API 手册
- 参考 <api/index.rst> \ No newline at end of file
+ 参考 <api/index.rst>
diff --git a/site/package-lock.json b/site/package-lock.json
index 99f7824..7069588 100644
--- a/site/package-lock.json
+++ b/site/package-lock.json
@@ -30,7 +30,7 @@
"sass": "^1.60.0",
"typescript": "^5.0.0",
"unplugin-fonts": "^1.0.3",
- "vite": "^4.5.2",
+ "vite": "^4.5.3",
"vite-plugin-vuetify": "^1.0.0",
"vue-tsc": "^1.2.0"
}
@@ -3814,9 +3814,9 @@
"dev": true
},
"node_modules/follow-redirects": {
- "version": "1.15.5",
- "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.5.tgz",
- "integrity": "sha512-vSFWUON1B+yAw1VN4xMfxgn5fTUiaOzAJCKBwIIgT/+7CuGy9+r+5gITvP62j3RmaD5Ph65UaERdOSRGUzZtgw==",
+ "version": "1.15.6",
+ "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
+ "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==",
"funding": [
{
"type": "individual",
@@ -6777,9 +6777,9 @@
}
},
"node_modules/vite": {
- "version": "4.5.2",
- "resolved": "https://registry.npmjs.org/vite/-/vite-4.5.2.tgz",
- "integrity": "sha512-tBCZBNSBbHQkaGyhGCDUGqeo2ph8Fstyp6FMSvTtsXeZSPpSMGlviAOav2hxVTqFcx8Hj/twtWKsMJXNY0xI8w==",
+ "version": "4.5.3",
+ "resolved": "https://registry.npmjs.org/vite/-/vite-4.5.3.tgz",
+ "integrity": "sha512-kQL23kMeX92v3ph7IauVkXkikdDRsYMGTVl5KY2E9OY4ONLvkHf04MDTbnfo6NKxZiDLWzVpP5oTa8hQD8U3dg==",
"devOptional": true,
"dependencies": {
"esbuild": "^0.18.10",
@@ -9965,9 +9965,9 @@
"dev": true
},
"follow-redirects": {
- "version": "1.15.5",
- "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.5.tgz",
- "integrity": "sha512-vSFWUON1B+yAw1VN4xMfxgn5fTUiaOzAJCKBwIIgT/+7CuGy9+r+5gITvP62j3RmaD5Ph65UaERdOSRGUzZtgw=="
+ "version": "1.15.6",
+ "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
+ "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA=="
},
"for-in": {
"version": "1.0.2",
@@ -12052,9 +12052,9 @@
}
},
"vite": {
- "version": "4.5.2",
- "resolved": "https://registry.npmjs.org/vite/-/vite-4.5.2.tgz",
- "integrity": "sha512-tBCZBNSBbHQkaGyhGCDUGqeo2ph8Fstyp6FMSvTtsXeZSPpSMGlviAOav2hxVTqFcx8Hj/twtWKsMJXNY0xI8w==",
+ "version": "4.5.3",
+ "resolved": "https://registry.npmjs.org/vite/-/vite-4.5.3.tgz",
+ "integrity": "sha512-kQL23kMeX92v3ph7IauVkXkikdDRsYMGTVl5KY2E9OY4ONLvkHf04MDTbnfo6NKxZiDLWzVpP5oTa8hQD8U3dg==",
"devOptional": true,
"requires": {
"esbuild": "^0.18.10",
diff --git a/site/package.json b/site/package.json
index 49917d0..852e7d9 100644
--- a/site/package.json
+++ b/site/package.json
@@ -31,7 +31,7 @@
"sass": "^1.60.0",
"typescript": "^5.0.0",
"unplugin-fonts": "^1.0.3",
- "vite": "^4.5.2",
+ "vite": "^4.5.3",
"vite-plugin-vuetify": "^1.0.0",
"vue-tsc": "^1.2.0"
}
diff --git a/site/yarn.lock b/site/yarn.lock
index 30964e5..0164cf9 100644
--- a/site/yarn.lock
+++ b/site/yarn.lock
@@ -2314,9 +2314,9 @@ flatted@^3.2.9:
integrity sha512-36yxDn5H7OFZQla0/jFJmbIKTdZAQHngCedGxiMmpNfEZM0sdEeT+WczLQrjK6D7o2aiyLYDnkw0R3JK0Qv1RQ==
follow-redirects@^1.15.0:
- version "1.15.5"
- resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.5.tgz#54d4d6d062c0fa7d9d17feb008461550e3ba8020"
- integrity sha512-vSFWUON1B+yAw1VN4xMfxgn5fTUiaOzAJCKBwIIgT/+7CuGy9+r+5gITvP62j3RmaD5Ph65UaERdOSRGUzZtgw==
+ version "1.15.6"
+ resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.6.tgz#7f815c0cda4249c74ff09e95ef97c23b5fd0399b"
+ integrity sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==
for-in@^1.0.2:
version "1.0.2"
@@ -4107,10 +4107,10 @@ vite-plugin-vuetify@^1.0.0:
debug "^4.3.3"
upath "^2.0.1"
-vite@^4.5.2:
- version "4.5.2"
- resolved "https://registry.yarnpkg.com/vite/-/vite-4.5.2.tgz#d6ea8610e099851dad8c7371599969e0f8b97e82"
- integrity sha512-tBCZBNSBbHQkaGyhGCDUGqeo2ph8Fstyp6FMSvTtsXeZSPpSMGlviAOav2hxVTqFcx8Hj/twtWKsMJXNY0xI8w==
+vite@^4.5.3:
+ version "4.5.3"
+ resolved "https://registry.yarnpkg.com/vite/-/vite-4.5.3.tgz#d88a4529ea58bae97294c7e2e6f0eab39a50fb1a"
+ integrity sha512-kQL23kMeX92v3ph7IauVkXkikdDRsYMGTVl5KY2E9OY4ONLvkHf04MDTbnfo6NKxZiDLWzVpP5oTa8hQD8U3dg==
dependencies:
esbuild "^0.18.10"
postcss "^8.4.27"
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2026-01-20 20:54:51 +0000