DF Storyteller

将您的Dwarf Fortress传奇故事交给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目前支持使用以下方式查询数据：

• 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 的系统需求非常有限，这高度依赖于您想要导入的文件。

注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 文档和其他信息。