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会始终告诉你出了什么问题，并具有内置的bug报告创建功能。
• 隐私：我们不会以任何方式跟踪你！有关隐私的更多信息，请查看这里。

它是如何工作的？

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或更高版本许可。

所有文档[^2]也采用GNU FDL、MIT许可和/或Creative Commons Attribution-ShareAlike 3.0 Unported许可。

这使得文档既与Dwarf Fortress Wiki兼容，也与Wikipedia兼容。

对本项目的所有贡献都将采用类似的许可。

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