ttrpg-convert-cli：将TTRPG数据转换为Markdown的利器

ttrpg-convert-cli：将TTRPG数据转换为Markdown的利器

ttrpg-convert-cli Utility to convert JSON data (for content you own) from 5etools or pf2etools into Obsidian-friendly Markdown. 项目地址: https://gitcode.com/gh_mirrors/tt/ttrpg-convert-cli

项目介绍

ttrpg-convert-cli是一款命令行工具，专门设计用于将TTRPG（桌上角色扮演游戏）数据从5eTools和Pf2eTools转换为适用于Obsidian.md的交叉链接、标记和格式化的Markdown文件。该项目能够帮助游戏玩家和组织者高效地管理和查阅游戏资料，提升游戏体验。

项目技术分析

ttrpg-convert-cli采用命令行界面，支持多种运行方式，包括使用JBang、Homebrew、预构建的平台二进制文件、Java运行jar包以及从源代码构建。它能够解析5eTools和Pf2eTools生成的JSON数据，并将其转换为Markdown格式，便于在Obsidian.md中查看和整理。

项目使用的技术包括：

• JSON解析：处理5eTools和Pf2eTools的数据格式。
• Markdown生成：根据游戏数据生成格式化的Markdown文件。
• 交叉链接：自动生成文档间的链接，方便查阅。
• 标记和样式：通过CSS样式和Admonitions插件增强文档的可读性和可用性。

项目技术应用场景

ttrpg-convert-cli适用于以下场景：

1. 游戏资料整理：玩家可以将自己的游戏资料从5eTools和Pf2eTools转换为Markdown格式，便于整理和分享。
2. Obsidian/md笔记整合：使用Obsidian.md的用户可以将游戏资料整合到笔记库中，实现统一管理。
3. 游戏文档制作：游戏主持人可以使用该工具生成游戏背景、规则、怪物等文档，提高游戏准备效率。

项目特点

ttrpg-convert-cli具有以下特点：

• 多平台支持：支持Linux、macOS和Windows操作系统，满足不同用户的需求。
• 配置灵活：允许用户自定义输出路径、样式和格式，适应不同用户的个性化需求。
• 易于集成：可以与其他Obsidian插件（如Admonitions、Force Note View Mode、Fantasy Statblocks等）无缝集成，增强功能。
• 高效处理：使用命令行工具，提高数据转换效率，减少手动操作。
• 可维护性：生成的Markdown文件易于维护和更新，保持资料库的时效性。

以下是一个关于ttrpg-convert-cli的使用示例：

首先，安装ttrpg-convert-cli，这里以使用Homebrew的方式为例：

brew install ttrpg-convert-cli

然后，使用以下命令转换5eTools的JSON数据：

ttrpg-convert 5etools.json -o output_directory

转换后的Markdown文件将保存在指定的输出目录中，可以直接在Obsidian.md中打开和使用。

总结，ttrpg-convert-cli是一个强大的开源工具，它能够帮助TTRPG玩家和主持人高效地整理和管理游戏资料，提升游戏体验。通过其多平台支持和灵活配置的特点，用户可以轻松地将游戏数据转换为Markdown格式，实现资料库的统一管理和高效查阅。

ttrpg-convert-cli Utility to convert JSON data (for content you own) from 5etools or pf2etools into Obsidian-friendly Markdown. 项目地址: https://gitcode.com/gh_mirrors/tt/ttrpg-convert-cli