Skip to content

ROADMAP.md

Latest commit

 

History

History
196 lines (140 loc) · 8.94 KB

ROADMAP.md

File metadata and controls

196 lines (140 loc) · 8.94 KB

Roadmap

Milestone 1 - Foundation (v0.1.x--v0.2.0, complete)

Core plugin scaffolding and content that enables basic CFX resource development in Cursor.

Deliverables

  • Repository structure and Cursor plugin manifest (.cursor-plugin/plugin.json)
  • MCP server configuration (.cursor/mcp.json)
  • Resource scaffolding skill and templates for all languages (Lua, JavaScript, C#)
  • Resource scaffolding templates for all frameworks (standalone, ESX, QBCore, ox_core)
  • fxmanifest.lua generation skill with full directive coverage
  • Client-server patterns skill covering all three runtimes
  • Framework detection skill (ESX, QBCore, ox_core, standalone)
  • Performance optimization skill with CFX-specific rules
  • NUI development skill
  • Database integration skill (oxmysql, mysql-async)
  • 6 coding convention and safety rules (.mdc files)
  • 15 code snippets (7 Lua, 5 JavaScript, 3 C#)
  • MCP server with 4 tool definitions (scaffold, native lookup, manifest gen, event search)
  • Native function database stubs (GTA5: 50 natives, RDR3: 10 natives)
  • Common events reference database (20 events)
  • Documentation: Getting Started, Architecture, Contributing, Roadmap, Changelog
  • CI/CD: PR validation, auto release, weekly native updates, stale cleanup
  • AGENTS.md and .cursorrules for AI agent guidance
  • Plugin logo and branding assets

Milestone 2 - Intelligence (v0.3.0--v0.4.x, complete)

Expanded the data layer and added new skills and content for real development workflows.

Native function database

  • Expand GTA5 native database to 6300+ real natives from runtime.fivem.net
  • Expand RDR3 native database to 5800+ real natives from runtime.fivem.net
  • Full parameter type annotations and usage examples
  • Deprecation flags and replacement recommendations
  • Namespace/category browsing (44 GTA5 categories, 84 RDR3 categories)
  • Native hash field in output schema
  • Merge 942 CFX platform natives with accurate apiset-based side classification
  • Update weekly CI workflow to fetch from runtime.fivem.net (GTA5, RDR3, CFX sources)

Content expansion

  • State Bags skill covering Entity/Player/Global state, change handlers, replication, and security
  • State Bags snippets for Lua and JavaScript (entity, player, change handler)
  • CfxLua vector/quaternion type documentation in Lua conventions rule and client-server patterns skill
  • NUI Vite + React template with postMessage bridge and HMR dev workflow
  • Balanced FiveM/RedM representation across all documentation, skills, templates, and snippets
  • Comprehensive Getting Started guide for complete beginners with collapsible sections

Milestone 3 - Expansion (v0.5.0, complete)

Expanded event coverage, added documentation search and framework detection MCP tools, and improved code generation intelligence.

Documentation search

  • Implement search_docs_tool MCP tool that queries a local index of FiveM/RedM documentation
  • Pre-built local index (~80 pages) from docs.fivem.net, updated monthly by CI
  • Support searching by topic, function name, keyword, or section filter
  • CI workflow (update-docs-index.yml) for automated monthly index rebuilds

Event reference

  • Expand events.json from 20 to 82 events (base game, CFX, and popular framework events)
  • Add ESX-specific events (15 events: esx:playerLoaded, esx:setJob, etc.)
  • Add QBCore-specific events (15 events: QBCore:Client:OnPlayerLoaded, etc.)
  • Add ox_core events (8 events: ox:playerLoaded, ox:setGroup, etc.)
  • Add chat resource events (7 events)
  • Add game and framework fields to event schema with filter support

Framework auto-detection

  • Implement workspace scanning MCP tool (detect_framework_tool)
  • Auto-detect framework from fxmanifest.lua dependencies and script imports
  • Scan code patterns (exports['es_extended'], QBCore = exports, require '@ox_core')
  • Return framework name, confidence level, and evidence

Code generation improvements

  • Context-aware scaffolding that reads existing workspace for author/description
  • Smarter manifest generation that scans existing files for script paths and NUI
  • Template variable substitution utility (substitute_variables)
  • Workspace-aware scaffold_resource_tool and generate_manifest_tool

Milestone 3.5 - Research Alignment (v0.6.0, complete)

Aligned the toolkit with 2026 platform realities based on comprehensive research audit. Added missing frameworks, modern patterns, and expanded content.

New framework support

  • Qbox framework: detection, template, events (10), scaffold init, manifest_common
  • VORP framework (RedM): detection, template, events (4), scaffold init
  • RSG framework (RedM): detection, template, events (5), scaffold init
  • All 7 frameworks in detect_framework.py, manifest_common.py, scaffold.py, server.py

Modern patterns and content

  • NUI Svelte 5 template with Vite and Runes ($state, $derived, $effect)
  • node_version '22' in JS template, manifest_gen, and scaffold output
  • Compile-time backtick hashing snippet and rule enhancement
  • Routing bucket (instancing) snippet and skill content
  • Lua 5.4 <const> and <close> variable attributes snippet and rule content
  • ACE permissions snippet
  • setImmediate() thread affinity warning in JS conventions and client-server skill
  • mysql-async/ghmattimysql explicit deprecation in database skill
  • repository, version, and escrow_ignore manifest directives in fxmanifest skill
  • Citizen. prefix explicitly deprecated across all rules and skills
  • NUI skill updated to recommend Svelte 5 as the community favorite

Counts after M3.5

  • 9 skills, 6 rules, 24 snippets, 11 templates, 6 MCP tools, 101 events

Milestone 4 - Integration (planned)

Connect the plugin to live FiveM/RedM server infrastructure for real-time development workflows.

txAdmin API integration

txAdmin exposes a REST API on port 40120 (default) with session cookie authentication.

  • Add MCP tool: txadmin_server_control (start, stop, restart FXServer)
  • Add MCP tool: txadmin_resource_control (start, stop, restart, refresh individual resources)
  • Add MCP tool: txadmin_player_search (search connected players by name or identifier)
  • Add MCP tool: txadmin_kick_player (kick with reason)
  • Add connection configuration (host, port, session token via environment variable)
  • Add skill for txAdmin setup and authentication

RCON and server commands

  • Add MCP tool: execute_rcon (run server console commands)
  • Common commands skill: refresh, ensure, stop, start, restart resources
  • Server convar management (get/set convars)

Live development workflow

  • Resource hot-reload: detect file changes and auto-restart the resource via txAdmin
  • Error log streaming: tail server console for Lua/JS/C# errors related to the active resource
  • Bridge resource: a FiveM/RedM resource that connects to the MCP server for bidirectional debugging
  • Player state inspection: read player data (position, health, vehicle) from a running server

Server configuration

  • server.cfg editor skill with convar reference
  • Dependency resolver: check if required resources are present and started

Milestone 5 - Polish (planned)

Harden the plugin for public release and community adoption.

Linting and validation

  • Static analysis rules for common Lua mistakes (missing Wait in loops, uncaptured source, etc.)
  • fxmanifest.lua validator that checks for missing fields, invalid paths, deprecated directives
  • Detect deprecated patterns: Citizen.CreateThread, __resource.lua, lua54 'yes' (now a no-op)
  • Detect dangerous patterns: string concatenation in SQL, unsanitized ExecuteCommand

Testing

  • Mock environment for unit testing CFX resources outside a running server
  • Sample test harness for common patterns (event handlers, commands, exports)
  • CI-friendly test runner that validates resource structure

RedM expansion

  • Expand RDR3 native database to full coverage (done in M2: 5800+ natives)
  • Add RedM-specific templates (VORP, RSG framework support) (done in M3.5)
  • Add RedM-specific snippets (prompts, scenarios, RDR3 peds)
  • RedM-specific coding conventions rule

Community and marketplace

  • Plugin logo and branding assets
  • Submission to the Cursor Marketplace (requires public Git repo, valid manifest, manual review)
  • Community template contribution workflow (PR template, validation script)
  • Plugin versioning and update strategy

Documentation

  • Hosted documentation site (MkDocs Material on GitHub Pages, auto-deploys on push to main)
  • Video walkthrough or GIF demos for Getting Started
  • Expanded architecture docs with MCP tool flow diagrams
  • FAQ and troubleshooting guide
  • Example resources built entirely with the plugin (showcase)