Add RedM example resources and RDR3-specific snippets

Aperta
#68 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
55/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
lua, markdown, python

Direzione di ricerca

Start by reading examples/README.md and an existing GTA5 example's fxmanifest.lua plus its README to copy the layout, then look at templates/vorp/ and templates/rsg/ for the bridge pattern. Check docs/ROADMAP.md Milestone 5 for the intended scope, and verify every RDR3 native against mcp-server/data/natives_rdr3.json (or lookup_native_tool with game="rdr3") before writing snippets. Run the MCP server with cd mcp-server && pip install -r requirements.txt && python server.py and read .github/workflows/validate.yml to see what CI checks; done means a games { 'rdr3' } resource with README, snippets that load, and updated counts.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement help wanted severity: low

Summary

All five example resources target GTA5, and no snippet targets RDR3. RedM appears only in the VORP and RSG templates, which are short skeletons. Add at least one RedM example and a few RDR3-specific snippets.

Where

  • examples/*/fxmanifest.lua (all games { 'gta5' })
  • examples/README.md:5
  • snippets/lua/
  • templates/vorp/, templates/rsg/
  • docs/ROADMAP.md (Milestone 5, RedM expansion)

Details

docs/ROADMAP.md lists "RedM-specific snippets (prompts, scenarios, RDR3 peds)" as planned, and Milestone 2 aims for balanced FiveM/RedM representation. RDR3 differs most from GTA5 in UI prompts (PromptRegisterBegin and related natives), which agents commonly get wrong, and the repo has no runnable reference for them.

Impact

RedM developers have no runnable reference resource, and agents have no RDR3 patterns to copy.

Suggested fix

  • Add one RedM example, for example a VORP/RSG-bridged camp-crafting or stable resource that uses PromptRegisterBegin prompts, keeps rewards server-side, declares games { 'rdr3' }, and has a README like the other examples.
  • Add 2-3 Lua snippets: prompt registration, scenario playback, and ped spawn with outfit variation.
  • Verify every native name against mcp-server/data/natives_rdr3.json (or lookup_native_tool with game="rdr3").

Acceptance criteria

  • examples/ contains at least one rdr3 resource with a README.
  • snippets/lua/ contains RDR3-specific snippets that load cleanly.
  • All natives used exist in natives_rdr3.json.
  • Counts in README and other docs are updated.

Getting started

  • Relevant files: examples/, snippets/lua/, templates/vorp/, templates/rsg/, mcp-server/data/natives_rdr3.json
  • How to run checks: there is no test suite yet; run the MCP server with cd mcp-server && pip install -r requirements.txt && python server.py, and CI checks live in .github/workflows/validate.yml
  • Related docs: examples/README.md, docs/ROADMAP.md, RedM documentation on docs.fivem.net

Filed by repo-audit/full-audit at 701824d. Severity: low. Effort: M. audit-key: enhancement|examples|redm-example

Lingua principale
Python
Stelle
7
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/CFX-Developer-Tools

Tutte le issue di TMHSDigital/CFX-Developer-Tools

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.