feat: ai's first take...

2026-02-26 00:17:23 +08:00
parent f005514f56
commit 3c9cf552e5
21 changed files with 4001 additions and 0 deletions
@@ -0,0 +1,69 @@
+# TTRPG Tools
+
+一个基于 `solid.js` 和 `rsbuild` 的 `ttrpg` 工具箱。
+
+## 功能
+
+- **CLI**: 提供一个 cli 工具，用于将目录内的各种 ttrpg 文档编译为 html。
+- **Markdown**: 解析以各种格式编写的 ttrpg 内容，并支持扩展的语法。
+- **TTRPG 组件**: 用于 ttrpg 内容的各种 UI 组件，且可以在 markdown 中通过扩展语法插入。
+
+## CLI 命令
+
+```bash
+# 预览模式
+npx ttrpg serve [dir] -p 3000
+
+# 编译模式
+npx ttrpg compile [dir] -o ./dist/output
+```
+
+## 组件语法
+
+### 骰子组件
+
+```markdown
+:dice[2d6+d8]
+:dice[1d20+5]{key="attack"}
+```
+
+### 表格组件
+
+```markdown
+:table[./sparks.csv]
+:table[./sparks.csv]{roll=true}
+:table[./sparks.csv]{roll=true remix=true}
+```
+
+## 开发
+
+```bash
+# 安装依赖
+npm install
+
+# 开发模式
+npm run dev
+
+# 构建
+npm run build
+
+# 预览
+npm run preview
+```
+
+## 项目结构
+
+```
+ttrpg-tools/
+├── src/
+│   ├── cli/           # CLI 工具源码
+│   ├── components/    # TTRPG 组件
+│   ├── markdown/      # Markdown 解析器
+│   ├── App.tsx        # 主应用组件
+│   ├── main.tsx       # 入口文件
+│   └── styles.css     # 样式文件
+├── content/           # 示例内容
+├── package.json
+├── tsconfig.json
+└── rsbuild.config.ts
+```