Add RedM example resources and RDR3-specific snippets

未关闭
#68 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
lua, markdown, python

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
Python
星标
7
派生
4
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/CFX-Developer-Tools 的其他 Issue

查看 TMHSDigital/CFX-Developer-Tools 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。