2个版本
| 0.3.0-development-2 | 2021年1月3日 |
|---|---|
| 0.3.0-development-1 | 2020年9月28日 |
#2172 in 编码
在 3 个crate中使用（通过 df_st_parser）
330KB
7.5K SLoC
DF Storyteller
给 Dwarf Fortress Storyteller 你的传说，我们将讲述故事。你只需坐下来享受即可。
DF Storyteller是一个应用程序，它导入Dwarf Fortress的传说文件，将其存储在内部，并使用API使其可查询。DF Storyteller目前支持解析以下内容：
- ...-legends.xml
- ...-legends_plus.xml
- ...-world_history.txt（计划中）
- ...-world_site_and_pops.txt（计划中）
DF Storyteller目前支持使用以下方式查询数据：
- RESTfull API（目前为只读）
- GraphQL（进行中）
为什么使用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 来查看数据。
安装您自己的叙事者！
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 ... |
| 内存[^1] | 512MB（不包括 PostgreSQL） | 1-2GB（不包括 PostgreSQL） |
| 处理器 | 适用于任何不错的系统 可能需要更长时间来导入 |
见最小要求 |
| 显卡 | 不需要，也没有使用。 | 不需要，也没有使用。 |
| 互联网连接 | 不需要（仅用于检查更新）。 尽管它使用浏览器（几乎）所有资源都是本地的。 |
见最小要求 |
[^1]：这很大程度上取决于您想使用import子命令导入的文件。 start子命令使用的RAM非常少，应该在所有现代系统上都能运行。
有关我们支持的Dwarf Fortress、DFHack和mod的版本信息，请查看这里
想要贡献吗？
- 此项目的贡献指南。
- 使用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文档以及此代码库中的其他信息。
依赖项
~13–25MB
~389K SLoC