Desarrollo de FiveM / GTA V (base de datos de documentación local)
Esta habilidad responde preguntas sobre FiveM / GTA V a partir de una base de datos de documentación local compuesta por dos partes, cada una en su propia carpeta dentro del directorio personal:
- Natives →
~/.fivem-natives/— cada native de GTA V. - Guías y referencias →
~/.fivem-docs/content/docs/— eventos, funciones, convars, referencias del juego, configuración del servidor, guías (el contenido decontent/docsdel repositoriocitizenfx/fivem-docs).
El símbolo ~/ se resuelve al directorio personal del usuario. Dependiendo del sistema operativo, estas rutas absolutas son:
- Windows:
C:/Users/<nombre_de_usuario>/.fivem-natives/yC:/Users/<nombre_de_usuario>/.fivem-docs/content/docs/ - Linux:
/home/<nombre_de_usuario>/.fivem-natives/y/home/<nombre_de_usuario>/.fivem-docs/content/docs/ - macOS:
/Users/<nombre_de_usuario>/.fivem-natives/y/Users/<nombre_de_usuario>/.fivem-docs/content/docs/
Gestión de la base de datos (tu trabajo — hazlo sin preguntar al usuario)
Eres responsable de mantener disponible esta base de datos local. Antes de responder una pregunta sobre FiveM, sigue este procedimiento:
- Verifica si la base de datos está instalada. Puedes comprobarlo viendo si las carpetas (
~/.fivem-natives/,~/.fivem-docs/) existen, o ejecutando el siguiente script con el comandostatus. - Si falta, instálala — ejecuta el comando correspondiente al sistema operativo del usuario que se muestra más abajo, luego continúa. Una sola ejecución de
installdescarga ambas partes (~22 MB, única vez). Informa al usuario una vez que estás descargando la documentación de FiveM. No recurras silenciosamente a la web mientras la base de datos falte. - Actualiza solo cuando se te pida — si el usuario solicita la documentación más reciente/actualizada, ejecuta el mismo comando con
updateen lugar deinstall. No actualices automáticamente en cada pregunta.
Comandos (se ejecutan directamente desde GitHub — no es necesario clonar el repositorio). Reemplaza install por una de las siguientes acciones según sea necesario:
-
install— descarga y configura la base de datos. -
update— obtiene las últimas actualizaciones de la base de datos. -
status— verifica si la base de datos está actualmente instalada. -
uninstall— elimina completamente las bases de datos descargadas. -
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
Parte 1 — Natives de GTA V (~/.fivem-natives/)
Cuando necesites encontrar una native, verificar su firma, parámetros, tipo de retorno o ejemplo de uso — busca aquí primero, antes de recurrir a internet.
Estructura:
- Las natives se agrupan en subdirectorios por categoría, por ejemplo
PLAYER/,VEHICLE/,PED/,ENTITY/,STREAMING/,TASK/,MISC/, etc. - Cada native es un archivo
.mdindependiente con nombre en PascalCase, por ejemplo~/.fivem-natives/PLAYER/ChangePlayerPed.md.
Cómo buscar:
- Siempre usa el script de búsqueda dedicado con la bandera
--nativespara buscar solo en natives. - Lógica AND (Recomendada): Para buscar varias palabras en cualquier parte del archivo, pásalas sin comillas:
node ~/.fivem-natives/search.js --natives create vehicle network - Frase exacta: Para buscar una frase exacta, enciérrala entre comillas:
node ~/.fivem-natives/search.js --natives "CreateVehicle" - Limitar resultados: Usa
--limit Npara cambiar el número máximo de resultados (por defecto es 20):node ~/.fivem-natives/search.js --natives --limit 5 create vehicle - Si Node.js dice
Cannot find module ...o el script devuelve un error de base de datos faltante, DEBES ejecutar el script de instalación (.ps1o.shde arriba) para descargarla primero. - Si el script muestra una nota
[INFO FOR AI]sobre que la base de datos está desactualizada, recuerda amablemente al usuario que ejecute el comandoupdate. - Una vez que tengas la ruta del archivo desde los resultados de búsqueda, usa tu herramienta de lectura de archivos para leer el archivo completo. NO uses
grep.
Solo cuando una native no exista en esta documentación local, usa https://docs.fivem.net/natives/.
Parte 2 — Guías y referencias (~/.fivem-docs/content/docs/)
Cuando necesites conocimiento de FiveM que NO sea una native — por ejemplo, eventos, funciones de cliente/servidor, convars, manifiesto de recursos, OneSync, NUI, datos del juego (blips, marcadores, modelos de vehículos/personajes, hashes de armas, controles, formato de texto), configuración del servidor, guías — busca aquí primero, antes de recurrir a internet.
Estructura (subdirectorios de ~/.fivem-docs/content/docs/):
scripting-reference/— referencia de scripting:client-functions/,server-functions/,events/,convars/,onesync/,resource-manifest/,runtimes/.scripting-manual/— guías de scripting: eventos, redes, NUI, scaleform, voz, migraciones, runtimes.game-references/— datos de referencia del juego: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, etc.cookbook/— ejemplos/recetas prácticas (agrupados por año).developers/— guías de codificación, runtimes de scripts, seguridad del servidor, sandbox.resources/— documentación de recursos estándar (chat, spawnmanager, mapmanager, sessionmanager, baseevents, txAdmin, etc.).server-manual/,client-manual/,getting-started/,fxdk/,assets-manual/— configuración y operación de servidor/cliente.
Cada tema es un archivo .md (nombres en kebab-case, por ejemplo game-references/markers.md), y el archivo _index.md en un directorio describe su contenido.
Cómo buscar:
- Siempre usa el script de búsqueda dedicado con la bandera
--docspara buscar solo en guías y referencias. - Lógica AND (Recomendada): Para buscar varias palabras en cualquier parte del archivo, pásalas sin comillas:
node ~/.fivem-natives/search.js --docs blip color - Frase exacta: Para buscar una frase exacta, enciérrala entre comillas:
node ~/.fivem-natives/search.js --docs "add blip" - Limitar resultados: Usa
--limit Npara cambiar el número máximo de resultados (por defecto es 20):node ~/.fivem-natives/search.js --docs --limit 5 blip color - Si Node.js dice
Cannot find module ...o el script devuelve un error de base de datos faltante, DEBES ejecutar el script de instalación (.ps1o.shde arriba) para descargarla primero. - Si el script muestra una nota
[INFO FOR AI]sobre que la base de datos está desactualizada, recuerda amablemente al usuario que ejecute el comandoupdate. - Una vez que tengas la ruta del archivo desde los resultados de búsqueda, usa tu herramienta de lectura de archivos para leer el archivo completo. NO uses
grep.
Solo cuando un tema no exista en esta documentación local, usa https://docs.fivem.net/docs/.