DF Storyteller

给 Dwarf Fortress Storyteller 您的传说，我们将为您讲述故事。您可以坐下来尽情享受。

DF Storyteller 是一个应用程序，它可以导入 Dwarf Fortress 传说文件，将其存储在内部，并通过 API 进行查询。DF Storyteller 目前支持解析以下文件：

• ...-legends.xml
• ...-legends_plus.xml
• ...-world_history.txt (计划中)
• ...-world_site_and_pops.txt (计划中)

DF Storyteller 目前支持使用以下方式查询数据：

• RESTfull API (目前为只读)
• GraphQL (进行中)

为什么使用 DF Storyteller

过去，传奇查看器必须实现自己的传奇解析器以从文件中获取数据。保持它们更新会耗费制作良好界面的宝贵时间。DF Storyteller 改变了这一点。我们处理所有复杂的事情。您只需请求所需的确切数据，我们就会提供给您。您需要做的只是以独特的方式可视化数据。

DF Storyteller 还将所有导入的文件合并，使您能够访问所有数据。然后，您可以选择您感兴趣的数据。

文档非常重要，所以我们尽力使所有描述尽可能清晰。对于我们的 API，我们构建了内置文档，该文档会自动生成，因此所有文档都是最新的。

想要成为画家并创建一些美丽的视觉效果，请看这里。

功能

DF Storyteller 充满了功能，并且还有更多计划，以下是一些：

• 低内存使用：应用程序 (+ PostgreSQL) < 100 MB RAM
  • 文件导入仍然需要优化，并且将根据传说文件的大小使用更多内存。但只需执行一次。
• 小型二进制文件：< 100 MB (包括大多数/所有依赖项)
• RESTfull 和 GraphQL：用于查询数据的接口。
• 在地图上详细查看您的世界！：计划中的功能，尚未提供。
• 优秀的文档：[API 文档](https://docs.dfstoryteller.com/rapidoc/)，[开发者文档](https://docs.dfstoryteller.com/rust-docs/)，内置文档和[其他支持文档](https://gitlab.com/df_storyteller/df-storyteller/-/tree/master/docs)。
• 最佳努力解析：应适用于[每个版本的 Dwarf Fortress 和 DF Hack](https://gitlab.com/df_storyteller/df-storyteller/-/blob/master/docs/versions.md#file-support-for-dwarf-fortress-versions)。
• 非常稳定和安全！：我们喜欢 Rust，DF ST 总会告诉你哪里出了问题，并且内置了错误报告创建功能。
• 隐私：我们不会以任何方式追踪你！[了解更多关于隐私的信息](https://gitlab.com/df_storyteller/df-storyteller/blob/HEAD/docs/privacy.md)。

它是如何工作的？

DF Storyteller 从 Dwarf Fortress 和 DFHack 的传奇文件中提取数据并将其导入数据库。然后它提供了一个 API 来查看这些数据。

安装您自己的讲述者！

DF Storyteller 被编写为其他应用程序使用，因此它可能包含您希望使用的可视化器中。请查看[可视化器列表（画家）](https://gitlab.com/df_storyteller/df-storyteller/blob/HEAD/docs/paintings.md)。要开始，请从[发布页面](https://gitlab.com/df_storyteller/df-storyteller/-/releases)下载可执行文件。

您可以在[这里](https://gitlab.com/df_storyteller/df-storyteller/blob/HEAD/docs/install.md)找到如何安装它的说明。[这里](https://www.youtube.com/watch?v=8PAYa5lkP24)有一个视频教程。

指挥您的讲述者

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 的每个实例都附带其自己的[内置文档](https://gitlab.com/df_storyteller/df-storyteller/blob/HEAD/docs/commands.md#docs)。但我们还提供了最新构建的文档[在此](https://docs.dfstoryteller.com)。

成为一名画家

您想要自己可视化传奇数据吗！您来对地方了。我们将迅速帮助您入门。只需[查看这里](https://gitlab.com/df_storyteller/df-storyteller/blob/HEAD/docs/become_a_painter.md)。

需要帮助？

加入我们加入 Discord 或 bay12forums。

系统要求和支持

DF Storyteller 的系统要求非常低，这高度依赖于您想要导入的文件。

[^1]: 这在很大程度上取决于你想要使用 import 子命令导入的文件。 start 子命令使用的内存非常少，因此应该在所有现代系统上都能工作。

有关我们支持的 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 文档和此代码库中的其他信息。