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目前支持以下方式查询数据：

• RESTfull API（目前为只读）
• GraphQL（正在开发中）

为什么使用DF Storyteller

在过去，传说查看器必须实现自己的传说解析器以从文件中获取数据。保持它们更新会耗费制作精美界面的大量时间。DF Storyteller改变了这一点。我们负责所有复杂的事情。你只需请求你需要的确切数据，我们就会提供给你。你只需要以独特的方式可视化数据。

DF Storyteller还合并了所有导入的文件，因此你可以使用所有可用的数据。然后你可以选择你感兴趣的数据。

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

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

功能

DF Storyteller功能丰富，更多功能正在计划中，以下是一些：

• 内存使用低：应用程序（+ PostgreSQL）< 100 MB RAM
  • 文件导入仍需优化，将根据传说文件的大小使用更多内存。但只需要执行一次。
• 二进制文件小：< 100 MB（包含大多数/所有依赖项）
• RESTfull和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 子命令使用的内存非常少，因此应在所有现代系统上运行。

有关我们支持的小矮人堡垒、DFHack 和模组的版本信息，请查看这里

想要贡献力量吗？

• 此项目的贡献指南。
• 使用 DF Storyteller 创建自己的应用程序。
• 我想帮忙，但不是程序员，我还能帮忙吗？是的！更多信息请查看这里。

我们的行为准则。

其他信息

• 安全
• 隐私
• 技术信息

许可

本项目根据AGPL-3.0-or-later 许可协议授权。

所有文档[^2]也根据GNU FDL、MIT 许可协议和/或Creative Commons Attribution-ShareAlike 3.0 Unported 许可协议授权。

这使得文档既能与小矮人堡垒维基兼容，也能与维基百科兼容。

对本项目的所有贡献都将根据类似的许可协议授权。

^[2]：这包括所有 Rust Doc、API 文档和代码库中的其他信息。