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

#2236 in 编码

在3个crate中使用（通过df_st_parser）

AGPL-3.0-or-later

375KB
8K SLoC

DF Storyteller

将您的Legends文件交给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功能丰富，更多功能正在计划中，以下是一些：

低内存使用：应用程序（+ PostgreSQL）< 100 MB RAM
- 文件导入仍需优化，并且根据传奇文件的大小将使用更多的内存。但只需要执行一次。
小型二进制文件：< 100 MB（并包含大多数/所有依赖项）
RESTful和GraphQL：查询数据的接口。
在地图上详细查看您的世界！：计划中的功能，目前尚未提供。
出色的文档：API 文档，开发者文档，内置文档和其他支持文档。
最佳努力解析：应适用于Dwarf Fortress和DF Hack的每个版本。
非常稳定和安全！：我们喜欢Rust，DF ST将始终告诉您出了什么问题，并具有内置的故障报告创建功能。
隐私：我们不会以任何方式跟踪您！有关隐私的更多信息，请查看这里。

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的每个实例都包含其自己的内置文档。但我们还提供了有关最新构建的文档在此。

您想自己可视化传奇数据！您来到了正确的地方。我们将让您立即开始。只需查看这里。

DF Storyteller的系统要求非常低，这高度取决于您想要导入的文件。

	最小要求	推荐要求
操作系统	Windows 64位，Linux 64位，MaxOS ...	Windows 64位，Linux 64位，MaxOS ...
RAM[^1]	512MB（不包括PostgreSQL）	1-2GB（不包括PostgreSQL）
处理器	适用于任何 decent 系统，导入可能需要更长的时间	见最小要求
显卡	不需要也不使用。	不需要也不使用。
互联网连接	不需要（仅用于检查更新）。尽管它使用浏览器（几乎）所有资源都是本地的。	见最小要求