FiveM / GTA V 开发(本地文档数据库)
本技能通过一个本地文档数据库回答 FiveM / GTA V 相关问题。该数据库由两部分组成,每部分位于各自的家目录文件夹中:
- 原生函数 (Natives) →
~/.fivem-natives/—— 所有 GTA V 原生函数。 - 指南与参考 (Guides & references) →
~/.fivem-docs/content/docs/—— 事件、函数、控制台变量 (convars)、游戏参考、服务器配置、指南(来自citizenfx/fivem-docs仓库的content/docs内容)。
~/ 符号代表用户的家目录。根据操作系统的不同,这些绝对路径分别是:
- Windows:
C:/Users/<username>/.fivem-natives/和C:/Users/<username>/.fivem-docs/content/docs/ - Linux:
/home/<username>/.fivem-natives/和/home/<username>/.fivem-docs/content/docs/ - macOS:
/Users/<username>/.fivem-natives/和/Users/<username>/.fivem-docs/content/docs/
管理数据库(这是你的任务 —— 请勿询问用户)
你负责维护此本地数据库的可用性。在回答 FiveM 问题之前,请遵循以下流程:
- 检查 数据库是否已安装。你可以通过检查文件夹(
~/.fivem-natives/、~/.fivem-docs/)是否存在来验证,或者运行下面的脚本并带上status命令。 - 如果缺失,则安装它 —— 根据用户的操作系统运行下方的一条命令,然后继续。一条
install命令即可下载两部分(约 22 MB,一次性)。告知用户正在下载 FiveM 文档一次。不要在数据库缺失时偷偷回退到网络。 - 仅在用户要求时刷新 —— 如果用户要求获取最新/更新后的文档,请运行相同命令,但使用
update而不是install。不要在每个问题上都自动更新。
命令(直接从 GitHub 运行 —— 无需克隆仓库)。根据需要将 install 替换为以下操作之一:
-
install—— 下载并设置数据库。 -
update—— 获取数据库的最新更新。 -
status—— 检查数据库当前是否已安装。 -
uninstall—— 完全删除已下载的数据库。 -
Windows (PowerShell):
& ([scriptblock]::Create((irm https://raw.githubusercontent.com/anx-scripts/fivem-skills/main/scripts/fivem-skills.ps1))) install -
Linux / macOS:
curl -fsSL https://raw.githubusercontent.com/anx-scripts/fivem-skills/main/scripts/fivem-skills.sh | bash -s -- install
第一部分 —— GTA V 原生函数 (~/.fivem-natives/)
当你需要查找原生函数、检查其签名、参数、返回值或使用示例时 —— 首先在此处搜索,然后再上网查找。
结构:
- 原生函数按类别分组到子目录中,例如
PLAYER/、VEHICLE/、PED/、ENTITY/、STREAMING/、TASK/、MISC/等。 - 每个原生函数都是一个独立的
.md文件,采用 PascalCase 命名,例如~/.fivem-natives/PLAYER/ChangePlayerPed.md。
如何搜索:
- 务必使用专用的搜索脚本,并带上
--natives标志,以便仅搜索原生函数。 - AND 逻辑(推荐): 若要搜索文件中任意位置出现的多个单词,请不加引号地传递它们:
node ~/.fivem-natives/search.js --natives create vehicle network - 精确短语: 若要搜索精确短语,请用引号将其括起来:
node ~/.fivem-natives/search.js --natives "CreateVehicle" - 限制结果: 使用
--limit N来更改最大结果数量(默认为 20):node ~/.fivem-natives/search.js --natives --limit 5 create vehicle - 如果 Node.js 提示
Cannot find module ...或脚本返回数据库缺失错误,你必须先运行安装脚本(上面的.ps1或.sh)来下载它。 - 如果脚本输出了关于数据库过旧的
[INFO FOR AI]提示,请友好地提醒用户运行update命令。 - 一旦从搜索结果中获得文件路径,请使用你的文件读取工具读取整个文件。不要使用
grep。
仅当本地文档中不存在某个原生函数时,才使用 https://docs.fivem.net/natives/。
第二部分 —— 指南与参考 (~/.fivem-docs/content/docs/)
当你需要非原生函数的 FiveM 知识 —— 例如事件、客户端/服务器函数、控制台变量 (convars)、资源清单、OneSync、NUI、游戏数据(闪光点、标记、载具/角色模型、武器哈希、控制、文本格式)、服务器配置、指南 —— 首先在此处搜索,然后再上网查找。
结构(~/.fivem-docs/content/docs/ 的子目录):
scripting-reference/—— 脚本参考:client-functions/、server-functions/、events/、convars/、onesync/、resource-manifest/、runtimes/。scripting-manual/—— 脚本指南:事件、网络、NUI、scaleform、语音、迁移、运行时。game-references/—— 游戏参考数据:blips.md、markers.md、controls.md、ped-models.md、weapon-models.md、vehicle-references/、hud-colors.md、game-events.md、net-game-events.md、text-formatting.md、pickup-hashes.md、zones.md等。cookbook/—— 实用示例/配方(按年份分组)。developers/—— 编码指南、脚本运行时、服务器安全、沙箱。resources/—— 标准资源文档(聊天、spawnmanager、mapmanager、sessionmanager、baseevents、txAdmin 等)。server-manual/、client-manual/、getting-started/、fxdk/、assets-manual/—— 服务器/客户端配置与操作。
每个主题都是一个 .md 文件(短横线命名,例如 game-references/markers.md),目录中的 _index.md 描述了其内容。
如何搜索:
- 务必使用专用的搜索脚本,并带上
--docs标志,以便仅搜索指南与参考。 - AND 逻辑(推荐): 若要搜索文件中任意位置出现的多个单词,请不加引号地传递它们:
node ~/.fivem-natives/search.js --docs blip color - 精确短语: 若要搜索精确短语,请用引号将其括起来:
node ~/.fivem-natives/search.js --docs "add blip" - 限制结果: 使用
--limit N来更改最大结果数量(默认为 20):node ~/.fivem-natives/search.js --docs --limit 5 blip color - 如果 Node.js 提示
Cannot find module ...或脚本返回数据库缺失错误,你必须先运行安装脚本(上面的.ps1或.sh)来下载它。 - 如果脚本输出了关于数据库过旧的
[INFO FOR AI]提示,请友好地提醒用户运行update命令。 - 一旦从搜索结果中获得文件路径,请使用你的文件读取工具读取整个文件。不要使用
grep。
仅当本地文档中不存在某个主题时,才使用 https://docs.fivem.net/docs/。