2个版本

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

#1667 在编码

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

AGPL-3.0-or-later

3KB

DF Storyteller

给矮人要塞故事讲述者你的传说，我们将讲述故事。你可以坐下来享受。

Explain how it works

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

它是如何工作的？

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

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

^[1]：这高度依赖于您想通过import子命令导入的文件。start子命令使用的RAM非常少，应在所有现代系统上都能工作。

有关我们支持的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文档和代码库中的其他信息。

df_st_world_history