0.3.0-development-2	2021年1月4日
0.3.0-development-1	2020年9月28日

#2372 in 编码

在 2 个crate中使用（通过 df_st_cli）

AGPL-3.0-or-later

2.5MB
38K SLoC

DF Storyteller

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

Explain how it works

DF Storyteller是一个应用程序，可以导入Dwarf Fortress传说文件，将它们存储在内部，并使用API使它们可查询。DF Storyteller目前支持解析

DF Storyteller目前支持使用

为什么使用DF Storyteller

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

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

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

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

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

DF Storyteller 从 Dwarf Fortress 和 DFHack 的传奇文件中提取数据并将其导入数据库。然后提供 API 以查看数据。

Diagram of import and start commands

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

	最低要求	推荐要求
OS	Windows 64位，Linux 64位，MaxOS ...	Windows 64位，Linux 64位，MaxOS ...
RAM[^1]	512MB（不包括 PostgreSQL）	1-2GB（不包括 PostgreSQL）
CPU	在所有不错的系统上都能工作，可能只是导入需要更长的时间	参见最低要求
显卡	不需要且未使用。	不需要且未使用。
互联网连接	不需要（仅用于检查更新）。尽管它使用浏览器（几乎是），但几乎所有资源都是本地的。	参见最低要求