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

#1450 in 编码

37 每月下载量
在 3 个crate中（通过 df_st_parser）使用

AGPL-3.0-or-later

235KB
5.5K 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功能丰富，更多功能正在计划中，以下是一些功能

低内存使用：应用程序（+ PostgreSQL）< 100 MB RAM
- 文件导入仍需优化，并且根据传说文件的大小，将使用更多的内存。但只需执行一次。
小型二进制文件：< 100 MB（包含大多数/所有依赖项）
RESTfull和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 ...
内存[^1]	512MB（不包括PostgreSQL）	1-2GB（不包括PostgreSQL）
处理器	适用于任何不错的系统，导入可能需要一些时间	请参阅最低要求
显卡	不需要也不使用。	不需要也不使用。
网络连接	不需要（仅用于检查更新）。尽管它使用了浏览器（几乎是），但几乎所有资产都是本地的。	请参阅最低要求