Add RedM example resources and RDR3-specific snippets

Ouverte
#68 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
55/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
lua, markdown, python

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Python
Étoiles
7
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/CFX-Developer-Tools

Toutes les issues de TMHSDigital/CFX-Developer-Tools

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.