Add RedM example resources and RDR3-specific snippets

Đang mở
#68 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
lua, markdown, python

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Python
Star
7
Fork
4
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/CFX-Developer-Tools

Tất cả issue của TMHSDigital/CFX-Developer-Tools

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.