Skip to content

About

Gemini Code Assist plugin for FiveM resource development. Supports QBox, QBCore, and ESX frameworks with Lua and NUI.

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

FiveM Development Plugin (Gemini Edition)

A comprehensive Gemini Code Assist plugin for FiveM resource development. Provides framework support for QBox, QBCore, and ESX with Lua and NUI (JavaScript/TypeScript).

Supports: Gemini Code Assist, Cursor, Windsurf, and other AI coding assistants.

Features

  • Dynamic Documentation - References for natives, framework APIs, and asset discovery
  • Multi-Framework Support - QBox, QBCore, ESX with auto-detection
  • No-Hallucination Policy - Verifies all natives and APIs against documentation
  • Performance-First - Thread management, adaptive wait patterns, ox_lib optimization
  • Security-Aware - Server-side validation patterns, rate limiting, input sanitization
  • NUI Guide - HTML/CSS/JS interface patterns, React/Vue integration

Installation

Gemini Code Assist

  1. Copy the .gemini/ directory to your FiveM resource project root
  2. Copy the supporting files (scripting/, frameworks/, resources/, assets/) alongside it
  3. Gemini Code Assist will automatically load GEMINI.md as project context
# Clone and copy to your project
git clone https://github.com/DankMindless/fivem-dev-plugin.git /tmp/fivem-dev
cp -r /tmp/fivem-dev/.gemini /tmp/fivem-dev/scripting /tmp/fivem-dev/frameworks /tmp/fivem-dev/resources /tmp/fivem-dev/assets your-project/

Cursor / Windsurf

  1. Copy FIVEM_CURSOR_RULES.md to your project root as .cursorrules
cp FIVEM_CURSOR_RULES.md your-project/.cursorrules

Documentation Sources

Source URL Coverage
FiveM Natives https://docs.fivem.net/natives/ All GTA V + CFX natives
QBox https://docs.qbox.re/ QBox framework API
QBCore https://docs.qbcore.org/ QBCore framework API
ESX https://docs.esx-framework.org/ ESX Legacy framework API
ox_lib https://overextended.dev/ox_lib Utility library docs
PlebMasters Forge https://forge.plebmasters.de/ GTA V assets

File Structure

Directory Contents
.gemini/GEMINI.md Main Gemini context with @imports and rules
.gemini/styleguide.md Code review style guide
scripting/ Lua patterns, NUI guide, client-server, thread management
frameworks/ Framework detection, QBox, QBCore, ESX references
resources/ fxmanifest.lua reference, ox_lib guide
assets/ GTA V asset discovery guide
FIVEM_CURSOR_RULES.md Consolidated rules for Cursor/Windsurf

What's Covered

Scripting

  • Lua 5.4 patterns and FiveM-specific idioms
  • Client-server architecture (events, callbacks, statebags)
  • Thread management and performance optimization
  • NUI (HTML/CSS/JS) development guide

Frameworks

  • QBox, QBCore, ESX framework references
  • Auto-detection patterns
  • Framework-agnostic bridge pattern
  • ox_lib utilities (callbacks, menus, progress, zones, target)

Resources

  • fxmanifest.lua complete reference
  • Resource structure best practices

Assets

  • GTA V asset discovery via PlebMasters Forge
  • Common prop, vehicle, ped, weapon, and animation names

Credits

  • Bohemia Interactive / Rockstar Games - GTA V assets
  • QBox Core Team - QBox framework
  • QBCore Framework - QBCore
  • ESX Framework - ESX Legacy
  • Overextended - ox_lib
  • PlebMasters - Forge asset browser
  • melihbozkurt10 - Original FiveM Dev Plugin architecture (Claude Code version)

License

MIT License - Feel free to use and modify.

About

Gemini Code Assist plugin for FiveM resource development. Supports QBox, QBCore, and ESX frameworks with Lua and NUI.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors