跳转到内容

开源

如果没有自 FFXIV 发布以来围绕它形成的广泛开发者社区,以及投入到构建和维护我们期望的工具和生态系统中的无数小时,这个 API 根本不可能存在。

XIVAPI 诞生自开源社区,以开源形式发布,并将始终贡献给开源社区。您可以在 xivapi 查看与之相关的项目。 您也可以在 thewakingsands 查看 FFCafe 的相关项目。

XIVAPI 使用或由以下项目提供支持:

xivapi/static
XIVAPI 官方文档网站,包括文档和实用程序,由 Astro 构建。
ackwell/boilmaster
API 服务器本身,负责 /api 下的一切。Boilmaster 从一开始就编写为形成一个可扩展和可维护的平台,可以在未来几年为 XIVAPI 提供支持。
xivdev/EXDSchema
整个 API 中使用的默认 excel 模式。如果没有 EXDSchema 和 SaintCoinach 模式的先例,查找和利用表格中的内容将变得非常困难。
Thaliak
为整个 API 的自动版本发现提供支持的服务。有了 Thaliak,我们可以确保 API 保持与最新游戏数据的同步。

FFCafe 版本还使用了以下项目:

thewakingsands/xivapi-v2
FFCafe 版本的 XIVAPI 文档网站(即本网站)。
thewakingsands/boilmaster
基于原始 Boilmaster 项目构建,用于提供 FFCafe 版本的 API 服务端。
thewakingsands/ixion
FFXIV 版本更新、管理及数据文件处理工具。

XIVAPI 可以通过任意 HTTP 请求工具使用。您也可以使用社区维护的、针对特定语言优化的包:

您可以在 /api/openapi.json 获取基于当前 API 实现生成的 OpenAPI 文档。/api/docs 的 API 参考工具也使用此文档。

XIVAPI 并不适合每个用例——也不试图做到这一点!FFXIV 开发者社区提供了极其广泛的替代工具和服务选择。下面的列表是其中的一小部分,可能更适合您要实现的目标。

FFXIV 的官方网站 Lodestone 有公开可访问的页面,包含有关角色、自由公司等的信息。有一些库和/或服务可用于读取此信息以供使用。

您也可以使用在 xivapi/lodestone-css-selectors 找到的共享 CSS 选择器编写自己的库。

API 以前不支持 Lodestone 吗?

是的,它支持。不幸的是,这意味着每个访问 Lodestone 的请求都来自 API,而不是个人消费者。尽管当时做出了努力,但下游对 Lodestone 数据的过度使用导致响应中的错误率越来越高。最终 API 被 Lodestone 完全阻止。

目前没有计划重新引入此功能。

API 主要用于网页,在网页上游戏文件不容易访问。如果您知道您的代码将可以访问游戏安装,使用游戏数据库可能会比 API 快得多且功能更强大。

NotAdam/Lumina
C#/.NET。社区中使用最广泛的游戏数据库。支持许多游戏文件格式,并提供生成的类库以便于使用表格数据。
ackwell/ironworks
Rust。为 XIVAPI 提供支持的数据库。模块化,支持常见文件格式并直接从游戏补丁文件读取。

虽然如果您知道要查找什么,访问数据是很好的,但浏览可能会令人生畏。一些工具整理和/或提供用于研究和探索可用数据的界面。

NotNite/Alpha
Alpha 是一个现代数据探索工具包,包含用于导航游戏数据的各种工具。
Godbert
主要专注于表格的数据探索工具。SaintCoinach 的一部分——虽然 Godbert 是一个有用的工具,但如果在 .NET 中构建新项目,强烈建议使用 Lumina。
goaaats/ffxiv-explorer-fork
较旧的工具之一,FFXIV Explorer 仍然是一个用于导航游戏文件内容的简单工具。
ResLogger2
游戏中所有已知资源路径的集中存储库。被上述许多工具和服务广泛使用。

对于从静态游戏文件或 lodestone 无法获得的数据,可以将项目构建为插件,其中可以使用来自游戏会话的运行时信息。

Dalamud
Dalamud 是 FFXIV 的主要插件生态系统,是构建运行时工具和实用程序的绝佳起点。