DF Storyteller

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

DF Storyteller是一款导入Dwarf Fortress传说文件、内部存储并使用API使其可查询的应用程序。

• ...-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 文档](https://docs.dfstoryteller.com/rapidoc/)，[开发者文档](https://docs.dfstoryteller.com/rust-docs/)，内置文档以及其他支持文档。
• 最佳努力解析：应适用于Dwarf Fortress和DF Hack的每个版本。
• 非常稳定和安全：我们喜欢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)。要开始，从发布页面下载可执行文件。

这里您可以找到如何为您的系统安装它的说明。 您可以在这里找到视频说明。

指挥你的叙事者

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

然后您可以通过打开http://localhost:20350来找到更多信息。start命令将在终端中打印确切的URL，如下所示

INFO :launch - 🚀 Rocket has launched from http://127.0.0.1:20350

有关更多命令和更多信息，请参阅此页面。

文档

每个DF Storyteller实例都自带内置文档。但我们也为最新构建提供了文档在这里。

成为一名画家

你想自己可视化传奇数据！你来了对地方。我们将立即开始。只需查看这里。

需要帮助？

加入我们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 文档和其他信息。