2 个版本
| 0.3.0-development-2 | 2021年1月3日 |
|---|---|
| 0.3.0-development-1 | 2020年9月28日 |
#13 in #storyteller
27 每月下载量
用于 2 个crate（通过 df_st_cli）
135KB
283 行
DF Storyteller
将您的《矮人要塞传奇》故事交给我们，我们将为您讲述。您可以坐下来尽情享受。
DF Storyteller是一个应用程序，可以导入《矮人要塞》传奇文件，将其存储在内部，并通过API进行查询。DF Storyteller目前支持解析以下文件：
- ...-legends.xml
- ...-legends_plus.xml
- ...-world_history.txt（计划中）
- ...-world_site_and_pops.txt（计划中）
DF Storyteller目前支持使用以下方式查询数据：
- RESTful API（目前只读）
- GraphQL（正在进行中）
为什么使用DF Storyteller
在过去，传奇查看器必须实现自己的传奇解析器以从文件中获取数据。保持它们更新需要花费大量时间来制作一个美观的界面。DF Storyteller改变了这一点。我们负责所有复杂的事情。您只需要请求您需要的确切数据，我们会提供给您。您所要做的就是以独特的方式可视化数据。
DF Storyteller还合并了所有导入的文件，使您能够访问所有数据。然后您可以选择您感兴趣的数据。
文档非常重要，因此我们尽力使所有描述尽可能清晰。对于我们的API，我们内置了自动生成的文档，因此所有文档都是最新的。
想要成为一名画家并创建一些美丽的视觉作品，请查看这里。
功能
DF Storyteller功能丰富，更多功能正在计划中，以下是一些：
- 低内存使用：应用程序（+ PostgreSQL）< 100 MB RAM
- 文件导入仍需优化，并且根据传奇文件的大小，将使用更多的内存。但只需执行一次。
- 小二进制文件：< 100 MB（并包含大多数/所有依赖项）
- RESTful和GraphQL：查询数据的接口。
- 在地图上详细查看您的世界！：计划中的功能，尚未提供。
- 优秀的文档： API 文档、开发者文档、内置文档和 其他支持文档。
- 最佳努力解析： 应该适用于 Dwarf Fortress 和 DF Hack 的所有版本。
- 非常稳定和安全！ 我们喜欢 Rust，DF ST 会一直告诉你出了什么问题，并且内置了错误报告创建功能。
- 隐私： 我们不会以任何方式跟踪您！ 更多信息请参阅此处。
它是如何工作的？
DF Storyteller 从 Dwarf Fortress 和 DFHack 的传说文件中提取数据，并将其导入数据库。然后提供 API 来查看数据。
安装您自己的叙事者！
DF Storyteller 旨在被其他应用程序使用，因此它可能包含您想要使用的可视化器中。请在此处查看 可视化器（画家）列表。要开始，请从 发布页面 下载可执行文件。
在此处您可以找到有关如何为您的系统安装它的说明。 您可以在此处找到带有说明的视频。
指挥您的叙事者
DF Storyteller 被设计为命令行工具。这使得我们可以根据用户的需求提供不同的功能。这些命令也可以由其他应用程序用于以不同的方式打开应用程序。
开始使用
要开始使用命令行，您可以在命令行中使用 help 标志，如下所示
# Get the general help from the app
./df_storyteller --help
# For windows this changes to:
./df_storyteller.exe --help
您可能想要使用的第一个子命令是 guide、import 和 start。例如
./df_storyteller guide
./df_storyteller import -w 1 ./region4-00125-01-01-legends.xml
./df_storyteller start -w 1
然后您可以通过访问 https://127.0.0.1:20350 来获取更多信息。start 命令将在终端中打印确切的 URL，如下所示
INFO :launch - 🚀 Rocket has launched from http://127.0.0.1:20350
有关更多命令和更多信息，请参阅 此页面。
文档
每个 DF Storyteller 实例都附带其自己的 内置文档。但我们还提供了最新构建的文档 在此处。
成为画家
您想要自己可视化传说数据！您来对了地方。我们将立即为您开始。只需 查看此处。
需要帮助？
加入我们 Discord 或 bay12forums。
系统要求及支持
DF Storyteller 的系统要求非常低，这高度取决于您想要导入的文件。
| 最低要求 | 推荐要求 | |
|---|---|---|
| 操作系统 | Windows 64位，Linux 64位，MaxOS ... | Windows 64位，Linux 64位，MaxOS ... |
| RAM[^1] | 512MB（不包括 PostgreSQL） | 1-2GB（不包括 PostgreSQL） |
| 处理器 | 适用于任何 decent 系统， 可能需要更长的时间来导入 |
参见最低要求 |
| 显卡 | 不需要，也没有使用。 | 不需要，也没有使用。 |
| 互联网连接 | 不需要（仅用于检查更新）。 尽管它使用浏览器（几乎）所有资源都是本地的。 |
参见最低要求 |
^[1]: 这很大程度上取决于你想要使用 import 子命令导入的文件。 start 子命令使用的 RAM 非常少，因此应该在所有现代系统上运行。
有关我们支持 Dwarf Fortress、DFHack 和模组的版本信息，请查看此处
想要贡献吗？
- 本项目的贡献指南。
- 使用 DF Storyteller 创建您自己的应用程序。
- 我想帮忙，但不是程序员，我还能帮忙吗？是的！ 更多信息请查看此处。
我们的行为准则。
其他信息
许可证
本项目根据AGPL-3.0-or-later 许可证授权。
所有文档[^2]也根据GNU FDL、MIT 许可证和/或Creative Commons Attribution-ShareAlike 3.0 Unported 许可证授权。
这使得文档既与Dwarf Fortress Wiki兼容，也与Wikipedia兼容。
对本项目的所有贡献都将以类似的方式授权。
^[2]: 这包括所有 Rust Doc、API 文档以及此代码库中的其他信息。
依赖项
~9–20MB
~312K SLoC