Skip to content

Commit

Permalink
refactor(examples): update file tree
Browse files Browse the repository at this point in the history
  • Loading branch information
HsiangNianian committed Jun 16, 2024
1 parent 5597a8a commit 525de52
Show file tree
Hide file tree
Showing 38 changed files with 614 additions and 1,457 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -182,3 +182,9 @@ docs/_build/

# Pyenv
.python-version

# examples
examples/config.toml
examples/HydroRoll/**
examples/plugins/**/*.py
examples/logs/**/*.log
6 changes: 3 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
path = hydro_roll_core
url = https://github.com/HydroRoll-Team/HydroRollCore
branch = main
[submodule "nivis_python"]
path = nivis_python
url = https://github.com/HydroRoll-Team/nivis-python
[submodule "TRPGNivis"]
path = TRPGNivis
url = https://github.com/HydroRoll-Team/TRPGNivis
branch = main
6 changes: 5 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,9 @@
"python.formatting.provider": "none",
"restructuredtext.preview.docutils.disabled": true,
"iis.configDir": "",
"restructuredtext.preview.name": "docutils"
"restructuredtext.preview.name": "docutils",
"Lua.diagnostics.globals": [
"setGroupConf",
"getGroupConf"
]
}
41 changes: 21 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
.. start-index
跨平台、多模态、高度自定义的骰系开发框架
==================================
========================================

欢迎来到 *HydroRoll* [水系],一个依据科学架构并由多模态模型赋能,使用 *Rust* 与 *Python* 编写的高性能、跨平台骰系开发框架。

Expand All @@ -31,7 +31,7 @@
.. end-index
安装与使用
-----
----------

在安装 **3.9+** 版本的 *Python* 之后,请先全局安装 *pdm* 依赖,接着全局安装 *hydro_roll* 包。

Expand All @@ -53,7 +53,7 @@
更多详细的使用方法请参考 `官方文档`_。

开发示例
----
--------

你可以选择从框架端开始开发水系骰子。

Expand Down Expand Up @@ -84,27 +84,28 @@
python main.py
知识问答
----
--------

“谁适合水系?”

- 世界主——规则书作者。水系基于通用规则包(规则书的 *Python* 实现)标准架构,可以为你一键生成规则书
的 *pdf* 版本与一个在线规则书浏览站点,同时允许你在规则包内自定义高优先级的骰系内建指令。一个规则
包,便是一个骰系。
- 插件爱好者——下游插件开发者。水系插件可用 *lua*、 *python*、 *javascript* 编写,同时,支持在线将其他骰
系的插件文件(如 *shiki* 的 *lua* 脚本,青果的 *python* 插件,海豹的 *js* 插件等)转换为水系对应语言的插
件脚本实现,另有使用 *Blockly* 搭建的可视化编程站点,轻松编写插件脚本。
- 机器学习爱好者。水系继承自多模态机器学习框架 *iamai*,能够同时训练与推理多个模型,试想你的骰子拥有
自己的独特人格...

- 渴望游玩冷门规则的 *kp* 与 *pl*。
~~~~~~~~~~~~~~~~~

- 世界主——规则书作者。水系基于通用规则包(规则书的 *Python* 实现)标准架构,可以为你一键生成规则书
的 *pdf* 版本与一个在线规则书浏览站点,同时允许你在规则包内自定义高优先级的骰系内建指令。一个规则
包,便是一个骰系。
- 插件爱好者——下游插件开发者。水系插件可用 *lua**python*、 *javascript* 编写,同时,支持在线将其他骰
系的插件文件(如 *shiki* 的 *lua* 脚本,青果的 *python* 插件,海豹的 *js* 插件等)转换为水系对应语言的插
件脚本实现,另有使用 *Blockly* 搭建的可视化编程站点,轻松编写插件脚本。
- 机器学习爱好者。水系继承自多模态机器学习框架 *iamai*,能够同时训练与推理多个模型,试想你的骰子拥有
自己的独特人格...
- 渴望游玩冷门规则的 *kp* 与 *pl*。

“水系是什么?水系不是什么?”
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

水系是一个骰系开发框架,允许你方便快捷的开发自己的骰系。抛开人工智能模块的水系的第一用户是世界主。
水系是一个骰系开发框架,允许你方便快捷的开发自己的骰系。抛开人工智能模块的水系的第一用户是世界主。

水系不是一个具体的骰系,但是水系有一个官方的规则书实现。在水系社区,骰系概念是被弱化的,一个加载了
独特的规则包的骰子,便是一个骰系(针对此规则包所对应的规则书而言)。
水系不是一个具体的骰系,但是水系有一个官方的规则书实现。在水系社区,骰系概念是被弱化的,一个加载了
独特的规则包的骰子,便是一个骰系(针对此规则包所对应的规则书而言)。

----

Expand Down Expand Up @@ -136,7 +137,7 @@
:alt: Ruff
.. |logo_icon| image:: https://cdn.jsdelivr.net/gh/HydroRoll-Team/HydroRoll@main/site/src/assets/image/logo.png
:target: https://hydroroll.team/
:align: right
:align: bottom
:alt: HydroRoll Logo
:height: 128
.. |docs| image:: https://img.shields.io/badge/DOCS%20AND%20BLOGS-000000.svg?logo=Vercel&labelColor=000&style=flat-square
Expand All @@ -150,7 +151,7 @@
.. |official site| image:: https://img.shields.io/badge/官网-2255aa.svg?logo=data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8CAgL/CgoK/woKCv8GBgb/BgYG/woKCv8KCgr/AgIC/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/BgYG/0ZGRv9MTEz/JiYm/ygoKP9MTEz/RkZG/wYGBv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9ycnL/Li4u/1xcXP9eXl7/Li4u/3Jycv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP88PDz/cnJy/05OTv9OTk7/UFBQ/05OTv9wcHD/Pj4+/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/Kioq/3Jycv9cXFz/TExM/05OTv9aWlr/cHBw/yoqKv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/Pj4+/zg4OP+AgID/Pj4+/2ZmZv9oaGj/PDw8/4CAgP86Ojr/Pj4+/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/ywsLP9iYmL/enp6/zIyMv90dHT/dHR0/zAwMP98fHz/YmJi/ywsLP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9SUlL/PDw8/3Jycv9CQkL/UlJS/1RUVP9CQkL/cnJy/zw8PP9SUlL/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/VFRU/yIiIv9aWlr/PDw8/zw8PP8+Pj7/PDw8/1hYWP8iIiL/VFRU/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/zQ0NP9CQkL/ZmZm/yIiIv9WVlb/WFhY/yIiIv9mZmb/QkJC/zY2Nv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9QUFD/BgYG/0RERP9KSkr/JCQk/yYmJv9KSkr/RERE/wgICP9QUFD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/CgoK/wICAv8KCgr/CgoK/wYGBv8GBgb/CgoK/woKCv8CAgL/CgoK/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==&labelColor=gray&logoWidth=20&logoColor=white&style=flat-square
:target: https://hydroroll.team/
.. |crates_v| image:: https://img.shields.io/crates/v/hydro_roll?logo=rust&color=red
:target: https://crates.io/crates/hydro_roll)
:target: https://crates.io/crates/hydro_roll
.. |release_img| image:: https://github.com/HydroRoll-Team/HydroRoll/actions/workflows/release.yml/badge.svg
:target: https://github.com/HydroRoll-Team/HydroRoll/actions/workflows/release.yml
.. |license icon| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FHydroRoll-Team%2FHydroRoll.svg?type=shield&issueType=license
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
SOURCEDIR = source
BUILDDIR = _build
SPHINXINTL ?= sphinx-intl
lang ?= zh_CN
Expand Down
109 changes: 109 additions & 0 deletions docs/source/community/code-of-conduct.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
贡献者公约
==========

我们的承诺
---------

身为社区成员、贡献者和领袖,我们承诺使社区参与者不受骚扰,无论其年龄、体型、可见或不可见的缺陷、族裔、性征、性别认同和表达、经验水平、教育程度、社会与经济地位、国籍、相貌、种族、种姓、肤色、宗教信仰、性倾向或性取向如何。

我们承诺以有助于建立开放、友善、多样化、包容、健康社区的方式行事和互动。


我们的准则
---------

有助于为我们的社区创造积极环境的行为例子包括但不限于:

* 表现出对他人的同情和善意
* 尊重不同的主张、观点和感受
* 提出和大方接受建设性意见
* 承担责任并向受我们错误影响的人道歉
* 注重社区共同诉求,而非个人得失

不当行为例子包括:

* 使用情色化的语言或图像,及性引诱或挑逗
* 嘲弄、侮辱或诋毁性评论,以及人身或政治攻击
* 公开或私下的骚扰行为
* 未经他人明确许可,公布他人的私人信息,如物理或电子邮件地址
* 其他有理由认定为违反职业操守的不当行为


责任和权力
---------

社区领袖有责任解释和落实我们所认可的行为准则,并妥善公正地对他们认为不当、威胁、冒犯或有害的任何行为采取纠正措施。

社区领导有权力和责任删除、编辑或拒绝或拒绝与本行为准则不相符的评论(comment)、提交(commits)、代码、维基(wiki)编辑、议题(issues)或其他贡献,并在适当时机知采取措施的理由。


适用范围
--------

本行为准则适用于所有社区场合,也适用于在公共场所代表社区时的个人。

代表社区的情形包括使用官方电子邮件地址、通过官方社交媒体帐户发帖或在线上或线下活动中担任指定代表。


监督
----

辱骂、骚扰或其他不可接受的行为可通过 [插入联系方式] 向负责监督的社区领袖报告。
所有投诉都将得到及时和公平的审查和调查。

所有社区领袖都有义务尊重任何事件报告者的隐私和安全。


处理方针
--------

社区领袖将遵循下列社区处理方针来明确他们所认定违反本行为准则的行为的处理方式:


1. 纠正
^^^^^^^

**社区影响**:使用不恰当的语言或其他在社区中被认定为不符合职业道德或不受欢迎的行为。

**处理意见**:由社区领袖发出非公开的书面警告,明确说明违规行为的性质,并解释举止如何不妥。或将要求公开道歉。


2. 警告
^^^^^^^

**社区影响**:单个或一系列违规行为。

**处理意见**:警告并对连续性行为进行处理。在指定时间内,不得与相关人员互动,包括主动与行为准则执行者互动。这包括避免在社区场所和外部渠道中的互动。违反这些条款可能会导致临时或永久封禁。


3. 临时封禁
^^^^^^^^^^^

**社区影响**: 严重违反社区准则,包括持续的不当行为。

**处理意见**: 在指定时间内,暂时禁止与社区进行任何形式的互动或公开交流。在此期间,不得与相关人员进行公开或私下互动,包括主动与行为准则执行者互动。违反这些条款可能会导致永久封禁。


4. 永久封禁
^^^^^^^^^^^

**社区影响**:行为模式表现出违反社区准则,包括持续的不当行为、骚扰个人或攻击或贬低某个类别的个体。

**处理意见**:永久禁止在社区内进行任何形式的公开互动。


参见
----

本行为准则改编自 [Contributor Covenant][homepage] 2.1 版, 参见 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]。

社区处理方针灵感来源于 [Mozilla's code of conduct enforcement ladder][Mozilla CoC]。

有关本行为准则的常见问题的答案,参见 [https://www.contributor-covenant.org/faq][FAQ]。
其他语言翻译参见 [https://www.contributor-covenant.org/translations][translations]。

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
3 changes: 2 additions & 1 deletion docs/source/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@

asset_library/index
channels
tutorials
tutorials
code-of-conduct
12 changes: 6 additions & 6 deletions examples/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ rule_dirs = ["rules"]
adapters = [
"iamai.adapter.onebot11",
# "iamai.adapter.gensokyo",
# "iamai.adapter.apscheduler",
"iamai.adapter.apscheduler",
# "iamai.adapter.dingtalk"
]
]

[bot.log]
level = "INFO"
verbose_exception = true

[adapter.onebot11]
adapter_type = "reverse-ws"
adapter_type = "ws"
host = "127.0.0.1"
port = 8080
url = "/cqhttp/ws"
show_raw = true
port = 3002
# url = "/onebot"
# show_raw = true

[adapter.gensokyo]
adapter_type = "reverse-ws"
Expand Down
File renamed without changes.
Loading

0 comments on commit 525de52

Please sign in to comment.