50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# TTTK — Tabletop Toolkit
|
|
|
|
A TTRPG content preview and compilation tool based on `solid.js` and `rsbuild`. Write markdown, preview in browser.
|
|
|
|
## 快速开始
|
|
|
|
```bash
|
|
# 无需安装，直接使用
|
|
npx tttk serve ./content
|
|
```
|
|
|
|
## 文档导航
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [📖 CLI 使用说明](./docs/cli.md) | CLI 安装、命令和用法 |
|
|
| [📦 npm](https://www.npmjs.com/package/tttk) | `npx tttk serve ./content` |
|
|
| [🛠️ 开发指南](./docs/development.md) | 项目结构、开发规范和构建 |
|
|
| [📝 Markdown 编写说明](./docs/markdown.md) | Markdown 语法和组件用法 |
|
|
| [📊 CSV 编写说明](./docs/csv.md) | CSV 文件格式、字段定义、变量语法 |
|
|
| [🤖 MCP 服务器说明](./docs/mcp.md) | AI 助手集成、卡牌生成工具 |
|
|
|
|
## 功能概览
|
|
|
|
- **CLI 工具**: `tttk serve` 预览模式 和 `tttk compile` 编译模式
|
|
- **Markdown 解析**: 支持指令语法、YAML 标签、mermaid 图表
|
|
- **TTRPG 组件**: 骰子、表格、卡牌、标记、命令追踪器等
|
|
|
|
## 核心组件
|
|
|
|
| 组件 | 语法 | 说明 |
|
|
|------|------|------|
|
|
| 🎲 骰子 | `:dice[2d6+d8]` | 掷骰并记录结果 |
|
|
| 📊 表格 | `:table[./data.csv]` | 标签页式表格 |
|
|
| 🃏 卡牌 | `:md-deck[./cards.csv]` | 卡牌布局 |
|
|
| 📍 标记 | `:md-pin[A]{x=40 y=40}` | 图片标记 |
|
|
| 📋 追踪器 | `:md-commander` | 命令历史和状态追踪 |
|
|
|
|
## 技术栈
|
|
|
|
- **前端**: Solid.js 1.9+
|
|
- **构建**: Rsbuild
|
|
- **样式**: Tailwind CSS 4
|
|
- **Markdown**: marked + marked-directive
|
|
- **测试**: Jest
|
|
|
|
## 许可证
|
|
|
|
MIT
|