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的系统要求非常低，这高度取决于您想要导入的文件。

^[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 文档和代码库中的其他信息。