API Reference

From 86d15a7638dd1b1ea53a9e56acd471efd8349e1d Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 7 Oct 2023 10:03:46 +0000 Subject: Deployed 7967a13 to dev with MkDocs 1.5.3 and mike 1.1.2 --- dev/API/index.html | 2 +- dev/CLI/index.html | 2 +- dev/Core/index.html | 2 +- dev/RulePackage/Write/prepare/index.html | 2 +- dev/RulePackage/Write/python/index.html | 2 +- dev/RulePackage/Write/write/index.html | 2 +- dev/RulePackage/getStart/attribute/index.html | 2 +- dev/RulePackage/getStart/class/index.html | 2 +- dev/RulePackage/getStart/getDeeper/Module/index.html | 2 +- dev/RulePackage/getStart/getDeeper/Package/index.html | 2 +- dev/RulePackage/getStart/getDeeper/object/index.html | 2 +- dev/RulePackage/getStart/method/index.html | 2 +- dev/RulePackage/intro/index.html | 2 +- dev/RulePackage/skill/fstring/index.html | 2 +- dev/RulePackage/skill/index.html | 2 +- dev/Standard/Term/DefaultDice/_counts/index.html | 2 +- dev/Standard/Term/DefaultDice/_sides/index.html | 2 +- dev/Standard/Term/DefaultDice/index.html | 2 +- dev/Standard/Term/PlayerCard/index.html | 2 +- dev/Standard/Term/check/ability/index.html | 2 +- dev/Standard/Term/check/index.html | 2 +- dev/Standard/Term/duration/campaign/index.html | 2 +- dev/Standard/Term/duration/index.html | 2 +- dev/Standard/Term/duration/module/index.html | 2 +- dev/Standard/Term/duration/sene/index.html | 2 +- dev/Standard/Term/scenario/index.html | 2 +- dev/Standard/Term/setting/index.html | 2 +- dev/Standard/what-is-rule-package/index.html | 2 +- dev/Standard/what-is-standard/index.html | 2 +- dev/Standard/why-rule-package/index.html | 2 +- dev/blog/2023/10/07/rule/index.html | 2 +- dev/changelog/index.html | 2 +- dev/search/search_index.json | 2 +- dev/sitemap.xml.gz | Bin 127 -> 127 bytes 34 files changed, 33 insertions(+), 33 deletions(-) diff --git a/dev/API/index.html b/dev/API/index.html index f8922e69..b032b177 100644 --- a/dev/API/index.html +++ b/dev/API/index.html @@ -1 +1 @@ - API Reference - HydroRollCore 核心文档

\ No newline at end of file + API Reference - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/CLI/index.html b/dev/CLI/index.html index 949a6cd4..e23fffd0 100644 --- a/dev/CLI/index.html +++ b/dev/CLI/index.html @@ -59,4 +59,4 @@ result.append("") return "\n".join(result) -

print(render_parser(parser, "HydroRollCore")) ```

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

print(render_parser(parser, "HydroRollCore")) ```

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/Core/index.html b/dev/Core/index.html index 63afe2b4..abcf49d5 100644 --- a/dev/Core/index.html +++ b/dev/Core/index.html @@ -19,4 +19,4 @@ class Myrule(Rule): """自设规则包，继承 Rule 基类""" -

合理修改你的 config.toml 配置文件，完成注册!

📄 License⚓︎

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

合理修改你的 config.toml 配置文件，完成注册!

📄 License⚓︎

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/RulePackage/Write/prepare/index.html b/dev/RulePackage/Write/prepare/index.html index a51524ff..b77a0edb 100644 --- a/dev/RulePackage/Write/prepare/index.html +++ b/dev/RulePackage/Write/prepare/index.html @@ -1 +1 @@ - 准备规则书 - HydroRollCore 核心文档

\ No newline at end of file + 准备规则书 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/Write/python/index.html b/dev/RulePackage/Write/python/index.html index 7a8aba8d..ea970a49 100644 --- a/dev/RulePackage/Write/python/index.html +++ b/dev/RulePackage/Write/python/index.html @@ -1 +1 @@ - 了解Python - HydroRollCore 核心文档

\ No newline at end of file + 了解Python - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/Write/write/index.html b/dev/RulePackage/Write/write/index.html index 1bd548db..b686b5d3 100644 --- a/dev/RulePackage/Write/write/index.html +++ b/dev/RulePackage/Write/write/index.html @@ -1 +1 @@ - 编写规则包 - HydroRollCore 核心文档

\ No newline at end of file + 编写规则包 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/getStart/attribute/index.html b/dev/RulePackage/getStart/attribute/index.html index 83924f4d..950f7bb7 100644 --- a/dev/RulePackage/getStart/attribute/index.html +++ b/dev/RulePackage/getStart/attribute/index.html @@ -1 +1 @@ - attribute 属性 - HydroRollCore 核心文档

\ No newline at end of file + attribute 属性 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/getStart/class/index.html b/dev/RulePackage/getStart/class/index.html index acde4027..cde7e6c9 100644 --- a/dev/RulePackage/getStart/class/index.html +++ b/dev/RulePackage/getStart/class/index.html @@ -1 +1 @@ - class 类 - HydroRollCore 核心文档

\ No newline at end of file + class 类 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/getStart/getDeeper/Module/index.html b/dev/RulePackage/getStart/getDeeper/Module/index.html index 58ea776f..93964490 100644 --- a/dev/RulePackage/getStart/getDeeper/Module/index.html +++ b/dev/RulePackage/getStart/getDeeper/Module/index.html @@ -1 +1 @@ - Module 模块 - HydroRollCore 核心文档

\ No newline at end of file + Module 模块 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/getStart/getDeeper/Package/index.html b/dev/RulePackage/getStart/getDeeper/Package/index.html index 8900cb65..6c4180c1 100644 --- a/dev/RulePackage/getStart/getDeeper/Package/index.html +++ b/dev/RulePackage/getStart/getDeeper/Package/index.html @@ -1 +1 @@ - Package 包 - HydroRollCore 核心文档

\ No newline at end of file + Package 包 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/getStart/getDeeper/object/index.html b/dev/RulePackage/getStart/getDeeper/object/index.html index 540082dd..4fa55068 100644 --- a/dev/RulePackage/getStart/getDeeper/object/index.html +++ b/dev/RulePackage/getStart/getDeeper/object/index.html @@ -1 +1 @@ - object 对象 - HydroRollCore 核心文档

\ No newline at end of file + object 对象 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/getStart/method/index.html b/dev/RulePackage/getStart/method/index.html index deda007c..b589c6b7 100644 --- a/dev/RulePackage/getStart/method/index.html +++ b/dev/RulePackage/getStart/method/index.html @@ -1 +1 @@ - method 方法 - HydroRollCore 核心文档

\ No newline at end of file + method 方法 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/intro/index.html b/dev/RulePackage/intro/index.html index 245ecda3..de80692d 100644 --- a/dev/RulePackage/intro/index.html +++ b/dev/RulePackage/intro/index.html @@ -1 +1 @@ - 规则包简介 - HydroRollCore 核心文档

\ No newline at end of file + 概述 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/skill/fstring/index.html b/dev/RulePackage/skill/fstring/index.html index 64b81c9d..cd51c1ac 100644 --- a/dev/RulePackage/skill/fstring/index.html +++ b/dev/RulePackage/skill/fstring/index.html @@ -1 +1 @@ - 善用语法糖 - HydroRollCore 核心文档

\ No newline at end of file + 善用语法糖 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/RulePackage/skill/index.html b/dev/RulePackage/skill/index.html index f02d6b22..4f4754b7 100644 --- a/dev/RulePackage/skill/index.html +++ b/dev/RulePackage/skill/index.html @@ -1 +1 @@ - Index - HydroRollCore 核心文档

\ No newline at end of file + Index - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/Term/DefaultDice/_counts/index.html b/dev/Standard/Term/DefaultDice/_counts/index.html index bb23ec92..aed90e7a 100644 --- a/dev/Standard/Term/DefaultDice/_counts/index.html +++ b/dev/Standard/Term/DefaultDice/_counts/index.html @@ -1 +1 @@ - _counts 骰子个数 - HydroRollCore 核心文档

跳转至

\ No newline at end of file + _counts 骰子个数 - HydroRollCore 核心文档

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/DefaultDice/_sides/index.html b/dev/Standard/Term/DefaultDice/_sides/index.html index 2dbba14d..419617e3 100644 --- a/dev/Standard/Term/DefaultDice/_sides/index.html +++ b/dev/Standard/Term/DefaultDice/_sides/index.html @@ -1 +1 @@ - _sides 骰子面数 - HydroRollCore 核心文档

跳转至

\ No newline at end of file + _sides 骰子面数 - HydroRollCore 核心文档

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/DefaultDice/index.html b/dev/Standard/Term/DefaultDice/index.html index ba0a7fca..a6ac37a5 100644 --- a/dev/Standard/Term/DefaultDice/index.html +++ b/dev/Standard/Term/DefaultDice/index.html @@ -1 +1 @@ - DefaultDice 默认骰子 - HydroRollCore 核心文档

跳转至

\ No newline at end of file + DefaultDice 默认骰子 - HydroRollCore 核心文档

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/PlayerCard/index.html b/dev/Standard/Term/PlayerCard/index.html index 4e5bcbae..0b47e77b 100644 --- a/dev/Standard/Term/PlayerCard/index.html +++ b/dev/Standard/Term/PlayerCard/index.html @@ -1 +1 @@ - PlayerCard 人物卡 - HydroRollCore 核心文档

跳转至

\ No newline at end of file + PlayerCard 人物卡 - HydroRollCore 核心文档

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/check/ability/index.html b/dev/Standard/Term/check/ability/index.html index e673ef7d..4c34bbfc 100644 --- a/dev/Standard/Term/check/ability/index.html +++ b/dev/Standard/Term/check/ability/index.html @@ -1 +1 @@ - ability 检定 - HydroRollCore 核心文档

\ No newline at end of file + ability 检定 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/Term/check/index.html b/dev/Standard/Term/check/index.html index c0db432d..fbc8cdf4 100644 --- a/dev/Standard/Term/check/index.html +++ b/dev/Standard/Term/check/index.html @@ -1 +1 @@ - check 检定 - HydroRollCore 核心文档

跳转至

\ No newline at end of file + check 检定 - HydroRollCore 核心文档

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/duration/campaign/index.html b/dev/Standard/Term/duration/campaign/index.html index 94ab0892..4f99b787 100644 --- a/dev/Standard/Term/duration/campaign/index.html +++ b/dev/Standard/Term/duration/campaign/index.html @@ -1 +1 @@ - campaign 战役 - HydroRollCore 核心文档

\ No newline at end of file + campaign 战役 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/Term/duration/index.html b/dev/Standard/Term/duration/index.html index 497d6714..7c263d7a 100644 --- a/dev/Standard/Term/duration/index.html +++ b/dev/Standard/Term/duration/index.html @@ -1 +1 @@ - duration (时长) - HydroRollCore 核心文档

跳转至

\ No newline at end of file + duration (时长) - HydroRollCore 核心文档

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/duration/module/index.html b/dev/Standard/Term/duration/module/index.html index e18b2132..beec7b79 100644 --- a/dev/Standard/Term/duration/module/index.html +++ b/dev/Standard/Term/duration/module/index.html @@ -1 +1 @@ - module 模组 - HydroRollCore 核心文档

\ No newline at end of file + module 模组 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/Term/duration/sene/index.html b/dev/Standard/Term/duration/sene/index.html index 53e52d6b..d724f5da 100644 --- a/dev/Standard/Term/duration/sene/index.html +++ b/dev/Standard/Term/duration/sene/index.html @@ -1 +1 @@ - sene 场 - HydroRollCore 核心文档

\ No newline at end of file + sene 场 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/Term/scenario/index.html b/dev/Standard/Term/scenario/index.html index 8a29f761..0ecb8b50 100644 --- a/dev/Standard/Term/scenario/index.html +++ b/dev/Standard/Term/scenario/index.html @@ -1 +1 @@ - scenario 剧本 - HydroRollCore 核心文档

\ No newline at end of file + scenario 剧本 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/Term/setting/index.html b/dev/Standard/Term/setting/index.html index bd6d8f6e..58defdc2 100644 --- a/dev/Standard/Term/setting/index.html +++ b/dev/Standard/Term/setting/index.html @@ -1 +1 @@ - setting 背景 - HydroRollCore 核心文档

\ No newline at end of file + setting 背景 - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/what-is-rule-package/index.html b/dev/Standard/what-is-rule-package/index.html index 53b60807..2ceed96d 100644 --- a/dev/Standard/what-is-rule-package/index.html +++ b/dev/Standard/what-is-rule-package/index.html @@ -45,4 +45,4 @@ return self.rule.ability.success # 返回大成功时骰主自定义的大成功文本 else: ... # 其他的检定情况 -

这样就实现了一个水系规则包，当pl使用检定掷骰指令时就会调用check()方法，如果检定结果数值小于5且大于0那么返回大成功。

我们要做的通用规则包标准就是这样一个“到底需要在Rule的子类MyRule里必须实现哪些方法？”的问题。

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

这样就实现了一个水系规则包，当pl使用检定掷骰指令时就会调用check()方法，如果检定结果数值小于5且大于0那么返回大成功。

我们要做的通用规则包标准就是这样一个“到底需要在Rule的子类MyRule里必须实现哪些方法？”的问题。

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/Standard/what-is-standard/index.html b/dev/Standard/what-is-standard/index.html index 35060a28..bb266c84 100644 --- a/dev/Standard/what-is-standard/index.html +++ b/dev/Standard/what-is-standard/index.html @@ -1 +1 @@ - 什么是通用规则包标准? - HydroRollCore 核心文档

\ No newline at end of file + 什么是通用规则包标准? - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/Standard/why-rule-package/index.html b/dev/Standard/why-rule-package/index.html index 7e26687d..66da34d3 100644 --- a/dev/Standard/why-rule-package/index.html +++ b/dev/Standard/why-rule-package/index.html @@ -1 +1 @@ - 为什么要做规则包? - HydroRollCore 核心文档

\ No newline at end of file + 为什么要做规则包? - HydroRollCore 核心文档

\ No newline at end of file diff --git a/dev/blog/2023/10/07/rule/index.html b/dev/blog/2023/10/07/rule/index.html index 6bf0d0df..a78a7f04 100644 --- a/dev/blog/2023/10/07/rule/index.html +++ b/dev/blog/2023/10/07/rule/index.html @@ -103,4 +103,4 @@ arcu tincidunt pulvinar. Vestibulum laoreet risus scelerisque porta congue. In velit purus, dictum quis neque nec, molestie viverra risus. Nam pellentesque tellus id elit ultricies, vel finibus erat cursus. -

If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.

When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:

Blog

However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:

Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.

What's next?⚓︎

Getting basic blogging support out the door was quite a challenge – the built-in blog plugin is probably the biggest release this year and already packs a lot of functionality. However, Material for MkDocs is used in many different contexts, which is why we'd expect to iterate, as always.

Some ideas already proposed by users:

Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.
Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.
Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.

What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.

When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:

Blog

However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:

Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.

What's next?⚓︎

Some ideas already proposed by users:

Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.
Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.
Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.

What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/changelog/index.html b/dev/changelog/index.html index b83a6f43..2e93d22b 100644 --- a/dev/changelog/index.html +++ b/dev/changelog/index.html @@ -1 +1 @@ - 变更日志 - HydroRollCore 核心文档

跳转至

\ No newline at end of file + 变更日志 - HydroRollCore 核心文档

跳转至

\ No newline at end of file diff --git a/dev/search/search_index.json b/dev/search/search_index.json index 222056e6..948cac06 100644 --- a/dev/search/search_index.json +++ b/dev/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\u200b\\-_,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])","pipeline":["stemmer"]},"docs":[{"location":"","title":"\u6c34\u7cfb\u6838\u5fc3","text":"

\u4f60\u597d!\u4e16\u754c\u4e3b\u3002

"},{"location":"changelog/","title":"\u53d8\u66f4\u65e5\u5fd7","text":"

Changelog ...

"},{"location":"changelog/#104-2023-10-07","title":"1.0.4 (2023-10-07)","text":""},{"location":"changelog/#features","title":"FEATURES","text":"

Docs: \u7f8e\u5316 style\u3002
Deps: \u6dfb\u52a0 reportlab \u4f9d\u8d56\uff0c\u7528\u4e8e\u4ee5\u540e\u7684 pdf \u751f\u6210\u3002

"},{"location":"changelog/#103-2023-10-07","title":"1.0.3 (2023-10-07)","text":""},{"location":"changelog/#102-2023-10-07","title":"1.0.2 (2023-10-07)","text":""},{"location":"changelog/#features_1","title":"FEATURES","text":"

Docs: \u4f18\u5316 css \u7ec6\u8282\u3002

"},{"location":"changelog/#101-2023-10-07","title":"1.0.1 (2023-10-07)","text":""},{"location":"changelog/#bug-fix","title":"BUG FIX","text":"

Docs: \u4fee\u590d Dev \u4e0e latest \u5206\u652f\u7684\u9519\u522b\u5b57\u3002

"},{"location":"changelog/#012-2023-10-07","title":"0.1.2 (2023-10-07)","text":"

\u540c\u6b65\u7248\u672c\u6240\u505a\u7684\u6d4b\u8bd5\u3002

"},{"location":"changelog/#011-2023-10-07","title":"0.1.1 (2023-10-07)","text":""},{"location":"changelog/#bug-fix_1","title":"BUG FIX","text":"

CLI: \u6dfb\u52a0\u547d\u4ee4\u884c\u53c2\u6570\u89e3\u6790\u3002

"},{"location":"changelog/#010-rc1-2023-10-07","title":"0.1.0-rc1 (2023-10-07)","text":""},{"location":"changelog/#chore","title":"CHORE","text":"

README: \u66f4\u65b0\u4e3b\u9875\u4ecb\u7ecd\u7684\u5b89\u88c5\u6307\u5357\u3002

"},{"location":"changelog/#010-2023-10-07","title":"0.1.0 (2023-10-07)","text":""},{"location":"changelog/#features_2","title":"Features","text":"

CLI \u6dfb\u52a0\u4e24\u4e2a\u547d\u4ee4\u884c\u540d\u79f0 HydroRollCore \u4e0e HRC\u3002

"},{"location":"changelog/#001-2023-07-04","title":"0.0.1 (2023-07-04)","text":""},{"location":"changelog/#features_3","title":"Features","text":"

init: \u6dfb\u52a0\u547d\u4ee4\u884c\u53c2\u6570\u89e3\u6790\u3002
Rule: \u6dfb\u52a0 Rule \u57fa\u7c7b\uff0c\u5b9e\u73b0\u8bfb\u53d6\u6307\u5b9a\u6587\u4ef6\u5939\u4e0b\u7684 python \u811a\u672c\u6216 python \u5305

"},{"location":"changelog/#breaking-change","title":"BREAKING CHANGE","text":"

HydroRollCore: \u6dfb\u52a0\u547d\u4ee4\u884cPath\u3002

"},{"location":"CLI/","title":"CLI Reference","text":"

```python exec=\"1\" idprefix=\"\" import argparse import re from HydroRollCore import Cli

parser = Cli().parser

MONOSPACED = (\"pyproject.toml\", \"pdm.lock\", \".pdm-python\", \":pre\", \":post\", \":all\")

def clean_help(help: str) -> str: # Make dunders monospaced avoiding italic markdown rendering help = re.sub(r\"([\\w\\d_]+)\", r\"__\\1__\", help) # Make env vars monospaced help = re.sub(r\"env var: ([A-Z_]+)\", r\"env var: \\1\", help) for monospaced in MONOSPACED: help = re.sub(rf\"\\s(['\\\"]?{monospaced}['\\\"]?)\", f\"{monospaced}\", help) return help

def render_parser( parser: argparse.ArgumentParser, title: str, heading_level: int = 2 ) -> str: \"\"\"Render the parser help documents as a string.\"\"\" result = [f\"{'#' * heading_level} {title}\\n\"] if parser.description and title != \"HydroRollCore\": result.append(\"> \" + parser.description + \"\\n\")

for group in sorted(\n    parser._action_groups, key=lambda g: g.title.lower(), reverse=True\n):\n    if not any(\n        bool(action.option_strings or action.dest)\n        or isinstance(action, argparse._SubParsersAction)\n        for action in group._group_actions\n    ):\n        continue\n\n    result.append(f\"{group.title.title()}:\\n\")\n    for action in group._group_actions:\n        if isinstance(action, argparse._SubParsersAction):\n            for name, subparser in action._name_parser_map.items():\n                result.append(render_parser(subparser, name, heading_level + 1))\n            continue\n\n        opts = [f\"`{opt}`\" for opt in action.option_strings]\n        if not opts:\n            line = f\"- `{action.dest}`\"\n        else:\n            line = f\"- {', '.join(opts)}\"\n        if action.metavar:\n            line += f\" `{action.metavar}`\"\n        line += f\": {clean_help(action.help)}\"\n        if action.default and action.default != argparse.SUPPRESS:\n            line += f\" (default: `{action.default}`)\"\n        result.append(line)\n    result.append(\"\")\n\nreturn \"\\n\".join(result)\n

print(render_parser(parser, \"HydroRollCore\")) ```

"},{"location":"Core/","title":"\u6838\u5fc3\u6982\u89c8","text":"HydroRollCore'\u6c34\u7cfb\u6838\u5fc3"},{"location":"Core/#getting","title":"\ud83c\udf81 Getting","text":"

\u5b89\u88c5\u5e93

\u5728\u547d\u4ee4\u884c\u8f93\u5165\u3002

git clone https://github.com/HydroRoll-Team/HydroRollCore.git\ncd HydroRollCore\npdm install\n# \u6216\u8005\u4f7f\u7528pip\n# pip install HydroRollCore\n

\u521b\u5efa\u89c4\u5219\u5305\u5b9e\u4f8b

mkdir myrules && cd myrules && mkdir rule1\necho.> config.toml\necho.> __init__.py\n

\u5728 __init__.py \u521b\u5efa\u4e00\u4e2a rule \u5b9e\u4f8b\u5e76\u7ee7\u627f Rule \u57fa\u7c7b, \u901a\u8fc7\u7f16\u5199\u5408\u9002\u7684\u76f8\u5173\u65b9\u6cd5\u4e0e\u7c7b\u6ce8\u518c\u89c4\u5219\u5305\u5b9e\u73b0\u89c4\u5219\u7684\u81ea\u5b9a\u4e49\u3002

from HydroRollCore import Rule\n\nclass Myrule(Rule):\n  \"\"\"\u81ea\u8bbe\u89c4\u5219\u5305\uff0c\u7ee7\u627f Rule \u57fa\u7c7b\"\"\"\n

\u5408\u7406\u4fee\u6539\u4f60\u7684 config.toml \u914d\u7f6e\u6587\u4ef6\uff0c\u5b8c\u6210\u6ce8\u518c!

"},{"location":"Core/#license","title":"\ud83d\udcc4 License","text":"

MIT \u00a9 2023-PRESENT \u7b80\u5f8b\u7eaf

"},{"location":"RulePackage/intro/","title":"\u89c4\u5219\u5305\u7b80\u4ecb","text":"

Warning

\u6b64\u7ae0\u8282\u6d89\u53ca\u5230\u771f\u6b63\u7684 Python \u89c4\u8303\u95ee\u9898\uff0c\u56e0\u6b64\u8bf7\u8ba4\u771f\u9605\u8bfb\u5e76\u591a\u52a0\u7ec3\u4e60\uff0c\u65b9\u80fd\u5199\u51fa\u6f02\u4eae\u7684\u4ee3\u7801\u3002

"},{"location":"RulePackage/getStart/attribute/","title":"attribute \u5c5e\u6027","text":"

Info

\u5173\u8054\u5230\u4e00\u4e2a\u5bf9\u8c61\u7684\u503c\uff0c\u901a\u5e38\u4f7f\u7528\u70b9\u53f7\u8868\u8fbe\u5f0f\u6309\u540d\u79f0\u6765\u5f15\u7528\u3002 \u4e3e\u4f8b\u6765\u8bf4\uff0c\u5982\u679c\u5bf9\u8c61 o \u5177\u6709\u5c5e\u6027 a \u5219\u53ef\u4ee5\u7528 o.a \u6765\u5f15\u7528\u5b83\u3002

\u5982\u679c\u5bf9\u8c61\u5141\u8bb8\uff0c\u5c06\u672a\u88ab\u5b9a\u4e49\u4e3a \u6807\u8bc6\u7b26\u548c\u5173\u952e\u5b57 \u7684\u975e\u6807\u8bc6\u540d\u79f0\u7528\u4f5c\u4e00\u4e2a\u5bf9\u8c61\u7684\u5c5e\u6027\u4e5f\u662f\u53ef\u4ee5\u7684\uff0c\u4f8b\u5982\u4f7f\u7528 setattr()\u3002 \u8fd9\u6837\u7684\u5c5e\u6027\u5c06\u65e0\u6cd5\u4f7f\u7528\u70b9\u53f7\u8868\u8fbe\u5f0f\u6765\u8bbf\u95ee\uff0c\u800c\u662f\u5fc5\u987b\u901a\u8fc7 getattr() \u6765\u83b7\u53d6\u3002

"},{"location":"RulePackage/getStart/class/","title":"class \u7c7b","text":"

Info

\u7528\u6765\u521b\u5efa\u7528\u6237\u5b9a\u4e49\u5bf9\u8c61\u7684\u6a21\u677f\u3002\u7c7b\u5b9a\u4e49\u901a\u5e38\u5305\u542b\u5bf9\u8be5\u7c7b\u7684\u5b9e\u4f8b\u8fdb\u884c\u64cd\u4f5c\u7684\u65b9\u6cd5\u5b9a\u4e49\u3002

"},{"location":"RulePackage/getStart/method/","title":"method \u65b9\u6cd5","text":"

Info

\u5728\u7c7b\u5185\u90e8\u5b9a\u4e49\u7684\u51fd\u6570\u3002\u5982\u679c\u4f5c\u4e3a\u8be5\u7c7b\u7684\u5b9e\u4f8b\u7684\u4e00\u4e2a\u5c5e\u6027\u6765\u8c03\u7528\uff0c\u65b9\u6cd5\u5c06\u4f1a\u83b7\u53d6\u5b9e\u4f8b\u5bf9\u8c61\u4f5c\u4e3a\u5176\u7b2c\u4e00\u4e2a argument (\u901a\u5e38\u547d\u540d\u4e3a self)\u3002\u53c2\u89c1 function \u548c nested scope\u3002

"},{"location":"RulePackage/getStart/getDeeper/Module/","title":"Module \u6a21\u5757","text":"

Info

\u6b64\u5bf9\u8c61\u662f Python \u4ee3\u7801\u7684\u4e00\u79cd\u7ec4\u7ec7\u5355\u4f4d\u3002\u5404\u6a21\u5757\u5177\u6709\u72ec\u7acb\u7684\u547d\u540d\u7a7a\u95f4\uff0c\u53ef\u5305\u542b\u4efb\u610f Python \u5bf9\u8c61\u3002\u6a21\u5757\u53ef\u901a\u8fc7 importing \u64cd\u4f5c\u88ab\u52a0\u8f7d\u5230 Python \u4e2d\u3002

\u53e6\u89c1 package\u3002

"},{"location":"RulePackage/getStart/getDeeper/Package/","title":"Package \u5305","text":"

Info

\u4e00\u79cd\u53ef\u5305\u542b\u5b50\u6a21\u5757\u6216\u9012\u5f52\u5730\u5305\u542b\u5b50\u5305\u7684 Python module\u3002 \u4ece\u6280\u672f\u4e0a\u8bf4\uff0c\u5305\u662f\u5177\u6709 path \u5c5e\u6027\u7684 Python \u6a21\u5757\u3002

\u53e6\u53c2\u89c1 regular package \u548c namespace package\u3002

"},{"location":"RulePackage/getStart/getDeeper/object/","title":"object \u5bf9\u8c61","text":"

Info

\u4efb\u4f55\u5177\u6709\u72b6\u6001\uff08\u5c5e\u6027\u6216\u503c\uff09\u4ee5\u53ca\u9884\u5b9a\u4e49\u884c\u4e3a\uff08\u65b9\u6cd5\uff09\u7684\u6570\u636e\u3002object \u4e5f\u662f\u4efb\u4f55 new-style class \u7684\u6700\u9876\u5c42\u57fa\u7c7b\u540d\u3002

"},{"location":"Standard/what-is-rule-package/","title":"\u4ec0\u4e48\u662f\u89c4\u5219\u5305\uff1f","text":"

\u89c4\u5219\u5305\u662f\u6c34\u7cfb\u6838\u5fc3\u7528\u6765\u52a0\u8f7d\u7684\u5bf9\u8c61\uff0c\u53ef\u4ee5\u7406\u89e3\u4e3a\u6c34\u7cfb\u6838\u5fc3\u52a0\u8f7d\u7684\u4e00\u4e2a\u4e00\u4e2a\u89c4\u5219\u5b9e\u4f8b\u3002

\u89c4\u5219\u5305\u66f4\u7c7b\u4f3c\u4e8e\u63d2\u4ef6\u7684\u8bbe\u8ba1\uff0c\u6240\u4ee5\u89c4\u5219\u5305\u4e5f\u53ef\u4ee5\u662f\u4e00\u4e2aPython\u6587\u4ef6\u6216\u8005\u4e00\u4e2aPython\u5305\uff0c\u4f46\u5b83\u5fc5\u987b\u50cf\u63d2\u4ef6\u90a3\u6837\u7ee7\u627f\u4e00\u4e2a\u50cfPlugin\u8fd9\u6837\u7684\u7c7b\uff08\u4e0d\u7136\u65e0\u6cd5\u8bfb\u53d6\uff0c\u6211\u4eec\u59d1\u4e14\u53eb\u8fd9\u4e2a\u7c7b\u4e3aRule\uff09\uff0c\u4ee5\u53ca\u5728Rule\u7684\u5b50\u7c7b\u91cc\u5b9e\u73b0\u4e00\u4e9b\u50cfhandle()\u6216\u8005rule()\u8fd9\u6837\u5fc5\u987b\u5b9e\u73b0\u7684\u65b9\u6cd5\uff08\u4e5f\u53eb\u51fd\u6570\uff09\uff0c\u800c\u8fd9\u4e9b\u5fc5\u987b\u5b9e\u73b0\u7684\u65b9\u6cd5\uff0c\u5c31\u662f\u6211\u4eec\u8981\u8ba8\u8bba\u7684\uff0c\u4e00\u4e2a\u901a\u7528\u89c4\u5219\u5305\u6807\u51c6\u5c31\u662f\u660e\u786e\u4e86\u4e00\u4e2a\u7ee7\u627f\u81eaRule\u7c7b\u7684\u5b50\u7c7b\u5b83\u672c\u8eab\u5e94\u8be5\u5b9e\u73b0\u4ec0\u4e48\u65b9\u6cd5\u3002

\u4e3e\u4e2a\u4f8b\u5b50\uff08\u968f\u4fbf\u5199\u7684\uff0c\u5176\u4e2d\u4e00\u4e9b\u5fc5\u987b\u5b9e\u73b0\u7684\u5c5e\u6027\u6216\u8005\u7c7b\u540d\u90fd\u662f\u4e0d\u786e\u5b9a\u7684\uff0c\u4ee5\u540e\u6216\u8bb8\u4f1a\u6539\uff09\uff1a

from HydroRolicore import RuLe\n\nclass MyRule(Rule):\n    \"\"\"\u6211\u7684\u81ea\u5b9a\u4e49\u89c4\u5219\u5305\n\n    check \u51fd\u6570\u662f\u5fc5\u987b\u5b9e\u73b0\u7684\u65b9\u6cd5\u4e4b\u4e00\n    name\u5c5e\u6027\u662f\u5fc5\u987b\u5b9e\u73b0\u7684\u5c5e\u6027\u4e4b\u4e00\uff0c\u7528\u6765\u5b9a\u4e49\u8fd9\u4e2a\u89c4\u5219\u5305\u7684\u540d\u5b57\n    priority\u662f\u53ef\u9009\u5b9e\u73b0\u7684\u5c5e\u6027\u4e4b\u4e00\uff0c\u9ed8\u8ba40\n    \"\"\"\n\n    name = \"\u6211\u7684\u81ea\u5b9a\u4e49\u89c4\u5219\u5305\"\n    priority = 0 # \u4f18\u5148\u7ea7\n\n    def check(self):\n        \"\"\"\u68c0\u5b9a\u65b9\u6cd5\n\n        self.result \u662f\u9700\u8981\u68c0\u5b9a\u65f6\u8ba1\u7b97\u7684\u7ed3\u679c\uff0c\u53ef\u4ee5\u76f4\u63a5\u4f7f\u7528\n        self.rule.ability \u662fRule\u7c7b\u91cc\u63d0\u4f9b\u7684\u7528\u4e8e\u5224\u65ad\u68c0\u5b9a\u60c5\u51b5\u7684\u5c5e\u6027\n        \"\"\"\n\n        if self.result < 5 and self.result > 0:\n            return self.rule.ability.success # \u8fd4\u56de\u5927\u6210\u529f\u65f6\u9ab0\u4e3b\u81ea\u5b9a\u4e49\u7684\u5927\u6210\u529f\u6587\u672c\n        else:\n            ... # \u5176\u4ed6\u7684\u68c0\u5b9a\u60c5\u51b5\n

\u8fd9\u6837\u5c31\u5b9e\u73b0\u4e86\u4e00\u4e2a\u6c34\u7cfb\u89c4\u5219\u5305\uff0c\u5f53pl\u4f7f\u7528\u68c0\u5b9a\u63b7\u9ab0\u6307\u4ee4\u65f6\u5c31\u4f1a\u8c03\u7528check()\u65b9\u6cd5\uff0c\u5982\u679c\u68c0\u5b9a\u7ed3\u679c\u6570\u503c\u5c0f\u4e8e5\u4e14\u5927\u4e8e0\u90a3\u4e48\u8fd4\u56de\u5927\u6210\u529f\u3002

\u6211\u4eec\u8981\u505a\u7684\u901a\u7528\u89c4\u5219\u5305\u6807\u51c6\u5c31\u662f\u8fd9\u6837\u4e00\u4e2a\u201c\u5230\u5e95\u9700\u8981\u5728Rule\u7684\u5b50\u7c7bMyRule\u91cc\u5fc5\u987b\u5b9e\u73b0\u54ea\u4e9b\u65b9\u6cd5\uff1f\u201d\u7684\u95ee\u9898\u3002

"},{"location":"Standard/Term/DefaultDice/","title":"DefaultDice \u9ed8\u8ba4\u9ab0\u5b50","text":"

Tip

\u8fd9\u662f\u4e00\u4e2a\u5fc5\u987b\u7684\u7c7b\uff0c\u6839\u636e\u4e0d\u540c\u89c4\u5219\u4e66\u7684\u8981\u6c42\u8bbe\u7f6e\u76f8\u5bf9\u5e94\u7684\u503c

"},{"location":"Standard/Term/DefaultDice/#_1","title":"\u7c7b\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u9ed8\u8ba4\u6295\u63b7\u65f6\u9ab0\u5b50\u7684\u5404\u79cd\u5c5e\u6027\uff0c\u4f8b\u5982\u9ed8\u8ba4\u9ab0\u5b50\u6570\u91cf\uff0c\u9762\u6570

"},{"location":"Standard/Term/DefaultDice/_counts/","title":"_counts \u9ab0\u5b50\u4e2a\u6570","text":"

Tip

\u8fd9\u662f\u4e00\u4e2a\u5fc5\u987b\u7684\u503c\uff0c\u6839\u636e\u4e0d\u540c\u89c4\u5219\u4e66\u7684\u8981\u6c42\u8bbe\u7f6e\u76f8\u5bf9\u5e94\u7684\u503c

"},{"location":"Standard/Term/DefaultDice/_counts/#_1","title":"\u5c5e\u6027\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u9ed8\u8ba4\u6295\u63b7\u65f6\u9ab0\u5b50\u7684\u4e2a\u6570

"},{"location":"Standard/Term/DefaultDice/_sides/","title":"_sides \u9ab0\u5b50\u9762\u6570","text":""},{"location":"Standard/Term/DefaultDice/_sides/#_1","title":"\u5c5e\u6027\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u9ed8\u8ba4\u6295\u63b7\u65f6\u9ab0\u5b50\u7684\u9762\u6570

"},{"location":"Standard/Term/PlayerCard/","title":"PlayerCard \u4eba\u7269\u5361","text":"

Tip

\u8fd9\u662f\u4e00\u4e2a\u53ef\u9009\u5b9e\u73b0\u4f46\u662f{\u5efa\u8bae\u5c3d\u91cf\u5fc5\u987b\u5b9e\u73b0}\u7684\u65b9\u6cd5\uff0c\u4e3b\u8981\u8868\u73b0\u5728\u89c4\u5219\u4e66\u6b63\u662f\u68c0\u5b9a\u65b9\u6cd5\u4e0d\u540c\u800c\u6709\u6240\u4e0d\u540c\u4e0a\u3002

"},{"location":"Standard/Term/PlayerCard/#_1","title":"\u7c7b\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u4eba\u7269\u5361\u7684\u683c\u5f0f\uff0c\u5305\u62ec\u4eba\u7269\u5c5e\u6027\uff0c\u5c5e\u6027\u4e4b\u95f4\u7684\u8ba1\u7b97\u5173\u7cfb\u7b49

"},{"location":"Standard/Term/check/","title":"check \u68c0\u5b9a","text":"

Tip

"},{"location":"Standard/Term/check/#_1","title":"\u65b9\u6cd5\u8bf4\u660e","text":"

\u4f7f\u7528check\u6216\u8005ability\u65b9\u6cd5, \u5fc5\u987b\u5bf9\u68c0\u5b9a\u7ed3\u679c\u8bbe\u5b9a\u4e00\u4e2a\u5b8c\u6574\u7684\u8f93\u51fa\u5224\u5b9a\u8303\u56f4\u3002

"},{"location":"Standard/Term/check/#_2","title":"\u68c0\u5b9a\u7ed3\u679c\u8868","text":"

\u5982\u65b9\u6cd5\u6240\u8a00\uff0c\u4f60\u5fc5\u987b\u4e3a\u68c0\u5b9a\u7684\u7ed3\u679c\u8bbe\u8ba1\u4e00\u4e2a\u5b8c\u6574\u7684\u8f93\u51fa\u5224\u5b9a\u8303\u56f4\uff0c\u56e0\u6b64\u4f60\u9700\u8981\u4e25\u683c\u5e76\u4e14\u5408\u7406\u7684\u5206\u914d\u5212\u5206\u754c\u9650\uff0c\u4fdd\u8bc1\u6240\u6709\u60c5\u51b5\u90fd\u5728\u5141\u8bb8\u8303\u56f4\u5185\u6709\u4e00\u4e2a\u7c7b\u4f3c\u201d\u6210\u529f\u201d\u201d\u5931\u8d25\u201d\u7684\u8f93\u51fa\u3002

"},{"location":"Standard/Term/check/ability/","title":"ability \u68c0\u5b9a","text":"

Info

\u5173\u4e8e\u8fd9\u90e8\u5206\u5185\u5bb9\u8bf7\u79fb\u6b65\u6b63\u5f0f\u672f\u8bed: check \u68c0\u5b9a

\u8fd9\u90e8\u5206\u5176\u5b9e\u5df2\u7ecf\u79fb\u9664\u3002

"},{"location":"Standard/Term/duration/","title":"duration (\u65f6\u957f)","text":""},{"location":"blog/","title":"Blog","text":""},{"location":"blog/2023/10/07/rule/","title":"Rule \u57fa\u7c7b\u5df2\u7ecf\u652f\u6301\u6cdb\u578b\u4e86","text":"

Hey there! You're looking at our new blog, built with the brand new built-in blog plugin. With this plugin, you can easily build a blog alongside your documentation or standalone.

Proper support for blogging, as requested by many users over the past few years, was something that was desperately missing from Material for MkDocs' feature set. While everybody agreed that blogging support was a blind spot, it was not obvious whether MkDocs could be extended in a way to allow for blogging as we know it from Jekyll and friends. The built-in blog plugin proves that it is, after all, possible to build a blogging engine on top of MkDocs, in order to create a technical blog alongside your documentation, or as the main thing.

This article explains how to build a standalone blog with Material for MkDocs. If you want to build a blog alongside your documentation, please refer to the plugin's documentation.

"},{"location":"blog/2023/10/07/rule/#quick-start","title":"Quick start","text":""},{"location":"blog/2023/10/07/rule/#creating-a-standalone-blog","title":"Creating a standalone blog","text":"

You can bootstrap a new project using the mkdocs executable:

mkdocs new .\n

This will create the following structure:

.\n\u251c\u2500 docs/\n\u2502  \u2514\u2500 index.md\n\u2514\u2500 mkdocs.yml\n

"},{"location":"blog/2023/10/07/rule/#configuration","title":"Configuration","text":"

In this article, we're going to build a standalone blog, which means that the blog lives at the root of your project. For this reason, open mkdocs.yml, and replace its contents with:

site_name: My Blog\ntheme:\n  name: material\n  features:\n    - navigation.sections\nplugins:\n  - blog:\n      blog_dir: . # (1)!\n  - search\n  - tags\nnav:\n  - index.md\n

This is the important part \u2013 we're hosting the blog at the root of the project, and not in a subdirectory. For more information, see the blog_dir configuration option.

"},{"location":"blog/2023/10/07/rule/#blog-setup","title":"Blog setup","text":"

The blog index page lives in docs/index.md. This page was pre-filled by MkDocs with some content, so we're going to replace it with what we need to bootstrap the blog:

# Blog\n

That's it.

"},{"location":"blog/2023/10/07/rule/#writing-your-first-post","title":"Writing your first post","text":"

Now that we have set up the built-in blog plugin, we can start writing our first post. All blog posts are written with the exact same Markdown flavor as already included with Material for MkDocs. First, create a folder called posts with a file called hello-world.md:

.\n\u251c\u2500 docs/\n\u2502  \u251c\u2500 posts/\n\u2502  \u2502  \u2514\u2500 hello-world.md # (1)!\n\u2502  \u2514\u2500 index.md\n\u2514\u2500 mkdocs.yml\n

If you'd like to arrange posts differently, you're free to do so. The URLs are built from the format specified in post_url_format and the titles and dates of posts, no matter how they are organized inside the posts directory.

Then, open up hello-world.md, and add the following lines:

---\ndraft: true # (1)!\ndate: 2022-01-31\ncategories:\n  - Hello\n  - World\n---\n\n# Hello world!\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque nec\nmaximus ex. Sed consequat, nulla quis malesuada dapibus, elit metus vehicula\nerat, ut egestas tellus eros at risus. In hac habitasse platea dictumst.\nPhasellus id lacus pulvinar erat consequat pretium. Morbi malesuada arcu mauris\nNam vel justo sem. Nam placerat purus non varius luctus. Integer pretium leo in\nsem rhoncus, quis gravida orci mollis. Proin id aliquam est. Vivamus in nunc ac\nmetus tristique pellentesque. Suspendisse viverra urna in accumsan aliquet.\n\n<!-- more -->\n\nDonec volutpat, elit ac volutpat laoreet, turpis dolor semper nibh, et dictum\nmassa ex pulvinar elit. Curabitur commodo sit amet dolor sed mattis. Etiam\ntempor odio eu nisi gravida cursus. Maecenas ante enim, fermentum sit amet\nmolestie nec, mollis ac libero. Vivamus sagittis suscipit eros ut luctus.\n\nNunc vehicula sagittis condimentum. Cras facilisis bibendum lorem et feugiat.\nIn auctor accumsan ligula, at consectetur erat commodo quis. Morbi ac nunc\npharetra, pellentesque risus in, consectetur urna. Nulla id enim facilisis\narcu tincidunt pulvinar. Vestibulum laoreet risus scelerisque porta congue.\nIn velit purus, dictum quis neque nec, molestie viverra risus. Nam pellentesque\ntellus id elit ultricies, vel finibus erat cursus.\n

If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.

When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:

However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:

Adding an excerpt
Adding authors
Adding categories
Adding tags
Adding related links
Linking from and to posts
Setting the reading time
Setting defaults

Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.

"},{"location":"blog/2023/10/07/rule/#whats-next","title":"What's next?","text":"

Getting basic blogging support out the door was quite a challenge \u2013 the built-in blog plugin is probably the biggest release this year and already packs a lot of functionality. However, Material for MkDocs is used in many different contexts, which is why we'd expect to iterate, as always.

Some ideas already proposed by users:

Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.
Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.
Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.

What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!

"},{"location":"blog/archive/2023/","title":"2023","text":""},{"location":"blog/category/rules/","title":"Rules","text":""}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\u200b\\-_,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])","pipeline":["stemmer"]},"docs":[{"location":"","title":"\u6c34\u7cfb\u6838\u5fc3","text":"

\u4f60\u597d!\u4e16\u754c\u4e3b\u3002

"},{"location":"changelog/","title":"\u53d8\u66f4\u65e5\u5fd7","text":"

Changelog ...

"},{"location":"changelog/#104-2023-10-07","title":"1.0.4 (2023-10-07)","text":""},{"location":"changelog/#features","title":"FEATURES","text":"

Docs: \u7f8e\u5316 style\u3002
Deps: \u6dfb\u52a0 reportlab \u4f9d\u8d56\uff0c\u7528\u4e8e\u4ee5\u540e\u7684 pdf \u751f\u6210\u3002

Docs: \u4f18\u5316 css \u7ec6\u8282\u3002

"},{"location":"changelog/#101-2023-10-07","title":"1.0.1 (2023-10-07)","text":""},{"location":"changelog/#bug-fix","title":"BUG FIX","text":"

Docs: \u4fee\u590d Dev \u4e0e latest \u5206\u652f\u7684\u9519\u522b\u5b57\u3002

"},{"location":"changelog/#012-2023-10-07","title":"0.1.2 (2023-10-07)","text":"

\u540c\u6b65\u7248\u672c\u6240\u505a\u7684\u6d4b\u8bd5\u3002

"},{"location":"changelog/#011-2023-10-07","title":"0.1.1 (2023-10-07)","text":""},{"location":"changelog/#bug-fix_1","title":"BUG FIX","text":"

CLI: \u6dfb\u52a0\u547d\u4ee4\u884c\u53c2\u6570\u89e3\u6790\u3002

"},{"location":"changelog/#010-rc1-2023-10-07","title":"0.1.0-rc1 (2023-10-07)","text":""},{"location":"changelog/#chore","title":"CHORE","text":"

README: \u66f4\u65b0\u4e3b\u9875\u4ecb\u7ecd\u7684\u5b89\u88c5\u6307\u5357\u3002

"},{"location":"changelog/#010-2023-10-07","title":"0.1.0 (2023-10-07)","text":""},{"location":"changelog/#features_2","title":"Features","text":"

CLI \u6dfb\u52a0\u4e24\u4e2a\u547d\u4ee4\u884c\u540d\u79f0 HydroRollCore \u4e0e HRC\u3002

"},{"location":"changelog/#001-2023-07-04","title":"0.0.1 (2023-07-04)","text":""},{"location":"changelog/#features_3","title":"Features","text":"

init: \u6dfb\u52a0\u547d\u4ee4\u884c\u53c2\u6570\u89e3\u6790\u3002
Rule: \u6dfb\u52a0 Rule \u57fa\u7c7b\uff0c\u5b9e\u73b0\u8bfb\u53d6\u6307\u5b9a\u6587\u4ef6\u5939\u4e0b\u7684 python \u811a\u672c\u6216 python \u5305

"},{"location":"changelog/#breaking-change","title":"BREAKING CHANGE","text":"

HydroRollCore: \u6dfb\u52a0\u547d\u4ee4\u884cPath\u3002

"},{"location":"CLI/","title":"CLI Reference","text":"

```python exec=\"1\" idprefix=\"\" import argparse import re from HydroRollCore import Cli

parser = Cli().parser

MONOSPACED = (\"pyproject.toml\", \"pdm.lock\", \".pdm-python\", \":pre\", \":post\", \":all\")

for group in sorted(\n    parser._action_groups, key=lambda g: g.title.lower(), reverse=True\n):\n    if not any(\n        bool(action.option_strings or action.dest)\n        or isinstance(action, argparse._SubParsersAction)\n        for action in group._group_actions\n    ):\n        continue\n\n    result.append(f\"{group.title.title()}:\\n\")\n    for action in group._group_actions:\n        if isinstance(action, argparse._SubParsersAction):\n            for name, subparser in action._name_parser_map.items():\n                result.append(render_parser(subparser, name, heading_level + 1))\n            continue\n\n        opts = [f\"`{opt}`\" for opt in action.option_strings]\n        if not opts:\n            line = f\"- `{action.dest}`\"\n        else:\n            line = f\"- {', '.join(opts)}\"\n        if action.metavar:\n            line += f\" `{action.metavar}`\"\n        line += f\": {clean_help(action.help)}\"\n        if action.default and action.default != argparse.SUPPRESS:\n            line += f\" (default: `{action.default}`)\"\n        result.append(line)\n    result.append(\"\")\n\nreturn \"\\n\".join(result)\n

print(render_parser(parser, \"HydroRollCore\")) ```

"},{"location":"Core/","title":"\u6838\u5fc3\u6982\u89c8","text":"HydroRollCore'\u6c34\u7cfb\u6838\u5fc3"},{"location":"Core/#getting","title":"\ud83c\udf81 Getting","text":"

\u5b89\u88c5\u5e93

\u5728\u547d\u4ee4\u884c\u8f93\u5165\u3002

git clone https://github.com/HydroRoll-Team/HydroRollCore.git\ncd HydroRollCore\npdm install\n# \u6216\u8005\u4f7f\u7528pip\n# pip install HydroRollCore\n

\u521b\u5efa\u89c4\u5219\u5305\u5b9e\u4f8b

mkdir myrules && cd myrules && mkdir rule1\necho.> config.toml\necho.> __init__.py\n

from HydroRollCore import Rule\n\nclass Myrule(Rule):\n  \"\"\"\u81ea\u8bbe\u89c4\u5219\u5305\uff0c\u7ee7\u627f Rule \u57fa\u7c7b\"\"\"\n

\u5408\u7406\u4fee\u6539\u4f60\u7684 config.toml \u914d\u7f6e\u6587\u4ef6\uff0c\u5b8c\u6210\u6ce8\u518c!

"},{"location":"Core/#license","title":"\ud83d\udcc4 License","text":"

MIT \u00a9 2023-PRESENT \u7b80\u5f8b\u7eaf

"},{"location":"RulePackage/intro/","title":"\u6982\u8ff0","text":"

Warning

"},{"location":"RulePackage/getStart/attribute/","title":"attribute \u5c5e\u6027","text":"

Info

"},{"location":"RulePackage/getStart/class/","title":"class \u7c7b","text":"

Info

"},{"location":"RulePackage/getStart/method/","title":"method \u65b9\u6cd5","text":"

Info

"},{"location":"RulePackage/getStart/getDeeper/Module/","title":"Module \u6a21\u5757","text":"

Info

\u53e6\u89c1 package\u3002

"},{"location":"RulePackage/getStart/getDeeper/Package/","title":"Package \u5305","text":"

Info

\u53e6\u53c2\u89c1 regular package \u548c namespace package\u3002

"},{"location":"RulePackage/getStart/getDeeper/object/","title":"object \u5bf9\u8c61","text":"

Info

"},{"location":"Standard/what-is-rule-package/","title":"\u4ec0\u4e48\u662f\u89c4\u5219\u5305\uff1f","text":"

from HydroRolicore import RuLe\n\nclass MyRule(Rule):\n    \"\"\"\u6211\u7684\u81ea\u5b9a\u4e49\u89c4\u5219\u5305\n\n    check \u51fd\u6570\u662f\u5fc5\u987b\u5b9e\u73b0\u7684\u65b9\u6cd5\u4e4b\u4e00\n    name\u5c5e\u6027\u662f\u5fc5\u987b\u5b9e\u73b0\u7684\u5c5e\u6027\u4e4b\u4e00\uff0c\u7528\u6765\u5b9a\u4e49\u8fd9\u4e2a\u89c4\u5219\u5305\u7684\u540d\u5b57\n    priority\u662f\u53ef\u9009\u5b9e\u73b0\u7684\u5c5e\u6027\u4e4b\u4e00\uff0c\u9ed8\u8ba40\n    \"\"\"\n\n    name = \"\u6211\u7684\u81ea\u5b9a\u4e49\u89c4\u5219\u5305\"\n    priority = 0 # \u4f18\u5148\u7ea7\n\n    def check(self):\n        \"\"\"\u68c0\u5b9a\u65b9\u6cd5\n\n        self.result \u662f\u9700\u8981\u68c0\u5b9a\u65f6\u8ba1\u7b97\u7684\u7ed3\u679c\uff0c\u53ef\u4ee5\u76f4\u63a5\u4f7f\u7528\n        self.rule.ability \u662fRule\u7c7b\u91cc\u63d0\u4f9b\u7684\u7528\u4e8e\u5224\u65ad\u68c0\u5b9a\u60c5\u51b5\u7684\u5c5e\u6027\n        \"\"\"\n\n        if self.result < 5 and self.result > 0:\n            return self.rule.ability.success # \u8fd4\u56de\u5927\u6210\u529f\u65f6\u9ab0\u4e3b\u81ea\u5b9a\u4e49\u7684\u5927\u6210\u529f\u6587\u672c\n        else:\n            ... # \u5176\u4ed6\u7684\u68c0\u5b9a\u60c5\u51b5\n

"},{"location":"Standard/Term/DefaultDice/","title":"DefaultDice \u9ed8\u8ba4\u9ab0\u5b50","text":"

Tip

\u8fd9\u662f\u4e00\u4e2a\u5fc5\u987b\u7684\u7c7b\uff0c\u6839\u636e\u4e0d\u540c\u89c4\u5219\u4e66\u7684\u8981\u6c42\u8bbe\u7f6e\u76f8\u5bf9\u5e94\u7684\u503c

"},{"location":"Standard/Term/DefaultDice/#_1","title":"\u7c7b\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u9ed8\u8ba4\u6295\u63b7\u65f6\u9ab0\u5b50\u7684\u5404\u79cd\u5c5e\u6027\uff0c\u4f8b\u5982\u9ed8\u8ba4\u9ab0\u5b50\u6570\u91cf\uff0c\u9762\u6570

"},{"location":"Standard/Term/DefaultDice/_counts/","title":"_counts \u9ab0\u5b50\u4e2a\u6570","text":"

Tip

\u8fd9\u662f\u4e00\u4e2a\u5fc5\u987b\u7684\u503c\uff0c\u6839\u636e\u4e0d\u540c\u89c4\u5219\u4e66\u7684\u8981\u6c42\u8bbe\u7f6e\u76f8\u5bf9\u5e94\u7684\u503c

"},{"location":"Standard/Term/DefaultDice/_counts/#_1","title":"\u5c5e\u6027\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u9ed8\u8ba4\u6295\u63b7\u65f6\u9ab0\u5b50\u7684\u4e2a\u6570

"},{"location":"Standard/Term/DefaultDice/_sides/","title":"_sides \u9ab0\u5b50\u9762\u6570","text":""},{"location":"Standard/Term/DefaultDice/_sides/#_1","title":"\u5c5e\u6027\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u9ed8\u8ba4\u6295\u63b7\u65f6\u9ab0\u5b50\u7684\u9762\u6570

"},{"location":"Standard/Term/PlayerCard/","title":"PlayerCard \u4eba\u7269\u5361","text":"

Tip

"},{"location":"Standard/Term/PlayerCard/#_1","title":"\u7c7b\u8bf4\u660e","text":"

\u7528\u4e8e\u89c4\u5b9a\u4eba\u7269\u5361\u7684\u683c\u5f0f\uff0c\u5305\u62ec\u4eba\u7269\u5c5e\u6027\uff0c\u5c5e\u6027\u4e4b\u95f4\u7684\u8ba1\u7b97\u5173\u7cfb\u7b49

"},{"location":"Standard/Term/check/","title":"check \u68c0\u5b9a","text":"

Tip

"},{"location":"Standard/Term/check/#_1","title":"\u65b9\u6cd5\u8bf4\u660e","text":"

\u4f7f\u7528check\u6216\u8005ability\u65b9\u6cd5, \u5fc5\u987b\u5bf9\u68c0\u5b9a\u7ed3\u679c\u8bbe\u5b9a\u4e00\u4e2a\u5b8c\u6574\u7684\u8f93\u51fa\u5224\u5b9a\u8303\u56f4\u3002

"},{"location":"Standard/Term/check/#_2","title":"\u68c0\u5b9a\u7ed3\u679c\u8868","text":"

"},{"location":"Standard/Term/check/ability/","title":"ability \u68c0\u5b9a","text":"

Info

\u5173\u4e8e\u8fd9\u90e8\u5206\u5185\u5bb9\u8bf7\u79fb\u6b65\u6b63\u5f0f\u672f\u8bed: check \u68c0\u5b9a

\u8fd9\u90e8\u5206\u5176\u5b9e\u5df2\u7ecf\u79fb\u9664\u3002

Hey there! You're looking at our new blog, built with the brand new built-in blog plugin. With this plugin, you can easily build a blog alongside your documentation or standalone.

This article explains how to build a standalone blog with Material for MkDocs. If you want to build a blog alongside your documentation, please refer to the plugin's documentation.

"},{"location":"blog/2023/10/07/rule/#quick-start","title":"Quick start","text":""},{"location":"blog/2023/10/07/rule/#creating-a-standalone-blog","title":"Creating a standalone blog","text":"

You can bootstrap a new project using the mkdocs executable:

mkdocs new .\n

This will create the following structure:

.\n\u251c\u2500 docs/\n\u2502  \u2514\u2500 index.md\n\u2514\u2500 mkdocs.yml\n

"},{"location":"blog/2023/10/07/rule/#configuration","title":"Configuration","text":"

In this article, we're going to build a standalone blog, which means that the blog lives at the root of your project. For this reason, open mkdocs.yml, and replace its contents with:

site_name: My Blog\ntheme:\n  name: material\n  features:\n    - navigation.sections\nplugins:\n  - blog:\n      blog_dir: . # (1)!\n  - search\n  - tags\nnav:\n  - index.md\n

This is the important part \u2013 we're hosting the blog at the root of the project, and not in a subdirectory. For more information, see the blog_dir configuration option.

"},{"location":"blog/2023/10/07/rule/#blog-setup","title":"Blog setup","text":"

The blog index page lives in docs/index.md. This page was pre-filled by MkDocs with some content, so we're going to replace it with what we need to bootstrap the blog:

# Blog\n

That's it.

"},{"location":"blog/2023/10/07/rule/#writing-your-first-post","title":"Writing your first post","text":"

.\n\u251c\u2500 docs/\n\u2502  \u251c\u2500 posts/\n\u2502  \u2502  \u2514\u2500 hello-world.md # (1)!\n\u2502  \u2514\u2500 index.md\n\u2514\u2500 mkdocs.yml\n

If you'd like to arrange posts differently, you're free to do so. The URLs are built from the format specified in post_url_format and the titles and dates of posts, no matter how they are organized inside the posts directory.

Then, open up hello-world.md, and add the following lines:

---\ndraft: true # (1)!\ndate: 2022-01-31\ncategories:\n  - Hello\n  - World\n---\n\n# Hello world!\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque nec\nmaximus ex. Sed consequat, nulla quis malesuada dapibus, elit metus vehicula\nerat, ut egestas tellus eros at risus. In hac habitasse platea dictumst.\nPhasellus id lacus pulvinar erat consequat pretium. Morbi malesuada arcu mauris\nNam vel justo sem. Nam placerat purus non varius luctus. Integer pretium leo in\nsem rhoncus, quis gravida orci mollis. Proin id aliquam est. Vivamus in nunc ac\nmetus tristique pellentesque. Suspendisse viverra urna in accumsan aliquet.\n\n<!-- more -->\n\nDonec volutpat, elit ac volutpat laoreet, turpis dolor semper nibh, et dictum\nmassa ex pulvinar elit. Curabitur commodo sit amet dolor sed mattis. Etiam\ntempor odio eu nisi gravida cursus. Maecenas ante enim, fermentum sit amet\nmolestie nec, mollis ac libero. Vivamus sagittis suscipit eros ut luctus.\n\nNunc vehicula sagittis condimentum. Cras facilisis bibendum lorem et feugiat.\nIn auctor accumsan ligula, at consectetur erat commodo quis. Morbi ac nunc\npharetra, pellentesque risus in, consectetur urna. Nulla id enim facilisis\narcu tincidunt pulvinar. Vestibulum laoreet risus scelerisque porta congue.\nIn velit purus, dictum quis neque nec, molestie viverra risus. Nam pellentesque\ntellus id elit ultricies, vel finibus erat cursus.\n

If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.

When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:

However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:

Adding an excerpt
Adding authors
Adding categories
Adding tags
Adding related links
Linking from and to posts
Setting the reading time
Setting defaults

Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.

"},{"location":"blog/2023/10/07/rule/#whats-next","title":"What's next?","text":"

Some ideas already proposed by users:

Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.
Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.
Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.

What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!

"},{"location":"blog/archive/2023/","title":"2023","text":""},{"location":"blog/category/rules/","title":"Rules","text":""}]} \ No newline at end of file diff --git a/dev/sitemap.xml.gz b/dev/sitemap.xml.gz index 21f8a0af..2b544e46 100644 Binary files a/dev/sitemap.xml.gz and b/dev/sitemap.xml.gz differ -- cgit v1.2.3-70-g09d2

API Reference

📄 License⚓︎

📄 License⚓︎

准备规则书

准备规则书

了解Python

了解Python

编写规则包

编写规则包

属性

属性

类

类

模块

模块

包

包

对象

对象

方法

方法

概述

概述

善用语法糖

善用语法糖

Index

Index

_counts 骰子个数

属性说明⚓︎

_counts 骰子个数

属性说明⚓︎

_sides 骰子面数

属性说明⚓︎

_sides 骰子面数

属性说明⚓︎

DefaultDice 默认骰子

类说明⚓︎

DefaultDice 默认骰子

类说明⚓︎

PlayerCard 人物卡

类说明⚓︎

PlayerCard 人物卡

类说明⚓︎

ability 检定

ability 检定

check 检定

方法说明⚓︎

检定结果表⚓︎

check 检定

方法说明⚓︎

检定结果表⚓︎

campaign 战役

campaign 战役

duration (时长)⚓︎

duration (时长)⚓︎

module 模组

module 模组

sene 场

sene 场

scenario 剧本

scenario 剧本

setting 背景

setting 背景

什么是通用规则包标准?

什么是通用规则包标准?

为什么要做规则包?

为什么要做规则包?

What's next?⚓︎

What's next?⚓︎

变更日志

1.0.4 (2023-10-07)⚓︎

FEATURES⚓︎

1.0.3 (2023-10-07)⚓︎

1.0.2 (2023-10-07)⚓︎

FEATURES⚓︎

1.0.1 (2023-10-07)⚓︎

BUG FIX⚓︎

0.1.2 (2023-10-07)⚓︎

0.1.1 (2023-10-07)⚓︎