Add RedM example resources and RDR3-specific snippets

Aberta
#68 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
55/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
lua, markdown, python

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
Python
Estrelas
7
Forks
4
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/CFX-Developer-Tools

Todas as issues de TMHSDigital/CFX-Developer-Tools

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.