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

#1019 in 编码

AGPL-3.0-or-later

1.5MB
33K 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（包括大多数/所有依赖项）
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 ...
内存[^1]	512MB（不包括PostgreSQL）	1-2GB（不包括PostgreSQL）
处理器	适用于任何不错的系统可能需要更长的时间来导入	参见最低要求
显卡	不需要且未使用。	不需要且未使用。
互联网连接	不需要（仅用于检查更新）。尽管它使用了浏览器（几乎）所有资源都是本地的。	参见最低要求