roblox
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chineseroblox
roblox
Engine API Reference (always the source of truth for classes/properties): https://create.roblox.com/docs/reference/engine
Full documentation indexes for agents:
- https://create.roblox.com/docs/llms.txt (start here, then route to Engine vs Open Cloud sub-indexes)
- Engine-specific: https://create.roblox.com/docs/reference/engine/llms.txt
This hub skill gives the big picture and routes to specialist entry points. Each specialist owns its deep index so agents load only the material needed.
SKILL.mdreferences/Engine API Reference(类/属性的唯一依据): https://create.roblox.com/docs/reference/engine
供 Agent 使用的完整文档索引:
- https://create.roblox.com/docs/llms.txt(从这里开始,然后转到 Engine 或 Open Cloud 子索引)
- Engine 专用:https://create.roblox.com/docs/reference/engine/llms.txt
此 hub skill 提供全局概览,并将任务路由到各专项 入口。每个专项 skill 负责自己的深度 索引,让 Agent 仅需加载所需材料。
SKILL.mdreferences/Specialist skills
专项 skill
Choose the skill matching the task. Each specialist links to its own detailed references.
<!-- catalog:specialists:start -->
- roblox-core: Choose services, types, serialization, and script locations
- roblox-networking: Design remotes, validate client requests, and control replication
- roblox-datastores: Save player data, handle concurrent writes, and recover versions
- roblox-user-interfaces: Build responsive GUIs, handle input, and add UI effects
- roblox-animation: Animate rigs, configure IK, tween properties, and time marker events
- roblox-vfx: Build particles, flipbooks, beams, trails, and highlights
- roblox-audio: Build audio graphs, mix effects, and migrate legacy Sound code
- roblox-gamepasses: Handle passes, products, subscriptions, transfers, and purchase policy
- roblox-open-cloud: Automate Roblox resources through REST APIs or supported HttpService calls
- roblox-teleport: Move players between places, coordinate matchmaking, and hand off data
- roblox-rojo: Set up filesystem projects, sync with Studio, build, and export places
- roblox-mcp: Connect agents to Studio, inspect instances, edit scripts, and playtest
- roblox-physics: Build mechanisms, choose constraints, and assign physics ownership
- roblox-npcs: Navigate NPCs, handle blocked paths, and build patrol or chase behavior
- roblox-testing: Reproduce bugs, write tests, and profile performance
选择与任务匹配的 skill。每个专项 skill 都会链接到自己的详细参考资料。
<!-- catalog:specialists:start -->
- roblox-core:选择 Service、Type、序列化方式和脚本位置
- roblox-networking:设计 remote、验证客户端请求并控制 replication
- roblox-datastores:保存玩家数据、处理并发写入并恢复版本
- roblox-user-interfaces:构建响应式 GUI、处理输入并添加 UI 特效
- roblox-animation:为 rig 制作动画、配置 IK、tween 属性并安排时间标记事件
- roblox-vfx:构建 particles、flipbooks、beams、trails 和 highlights
- roblox-audio:构建 audio graph、混音效果并迁移旧版 Sound 代码
- roblox-gamepasses:处理 pass、product、subscription、transfer 和购买策略
- roblox-open-cloud:通过 REST API 或受支持的 HttpService 调用自动化 Roblox 资源
- roblox-teleport:在 place 之间移动玩家、协调 matchmaking 并交接数据
- roblox-rojo:设置 filesystem 项目、与 Studio 同步、构建和导出 place
- roblox-mcp:将 Agent 连接到 Studio、检查 instance、编辑脚本并进行 playtest
- roblox-physics:构建 mechanism、选择 constraint 并指定 physics ownership
- roblox-npcs:为 NPC 导航、处理路径阻塞并构建巡逻或追逐行为
- roblox-testing:复现 bug、编写测试并分析性能
Shared constraints
共享约束
- Server authority first. Validate or simulate on the server. Client is for input, prediction, and cosmetics.
- Everything that talks to the cloud is fallible. Wrap DataStore, Marketplace, Http, etc. calls in pcall. Have a plan for transient vs permanent errors.
- Preload assets. ContentProvider:PreloadAsync for animations, images, sounds, models.
- Use modern APIs. Animator + LoadAnimation, task.* scheduler, TweenService, IKControl, CollectionService tags, Attributes, etc. Avoid deprecated BodyMovers, wait/spawn/delay, Humanoid:LoadAnimation, etc.
- Respect limits. DataStore budgets scale with concurrent users but are still finite. Particles and transparent UI are fill-rate expensive. Profile early.
- Structure for maintainability. ServerScriptService for authority, ReplicatedStorage for shared modules, StarterGui for client UI roots, clear module boundaries, consistent naming.
- Test the hard parts. Studio with API access only on test places. Multiple device classes. Low graphics quality for effects/UI. Concurrency (multiple servers touching the same keys).
- 服务器权威优先。 在服务器端进行验证或模拟。客户端只负责输入、预测和视觉表现。
- 所有与云端通信的逻辑都可能出现故障。 使用 pcall 包装 DataStore、Marketplace、Http 等调用。针对瞬时错误和永久错误分别制定处理方案。
- 预加载资源。 对动画、图像、声音和模型使用 ContentProvider:PreloadAsync。
- 使用现代 API。 使用 Animator + LoadAnimation、task.* 调度器、TweenService、IKControl、CollectionService tags、Attributes 等。避免使用已弃用的 BodyMovers、wait/spawn/delay、Humanoid:LoadAnimation 等。
- 遵守限制。 DataStore 配额会随并发用户数量扩展,但仍然有限。Particles 和透明 UI 会消耗大量 fill rate。尽早进行性能分析。
- 以可维护性为目标进行结构设计。 使用 ServerScriptService 承载权威逻辑,使用 ReplicatedStorage 存放共享 module,使用 StarterGui 作为客户端 UI 根节点;保持明确的 module 边界和一致的命名。
- 测试困难部分。 仅在测试 place 中使用可访问 API 的 Studio。测试多种设备类型。以较低图像质量测试 effects/UI。测试并发情况(多个服务器访问相同 key)。
Modern API notes
现代 API 注意事项
- Deferred events: Set (or use the corresponding project setting) so events queue and flush, avoiding re-entrancy issues.
Workspace.SignalBehavior = Enum.SignalBehavior.Deferred - Chat: Use for modern chat; the legacy
TextChatServiceservice still exists but is the older API.Chat - MemoryStore: Use for cross-server, short-lived, or high-throughput data, not regular DataStores.
MemoryStoreService - Parallel Luau: Use instances and
Actor/task.synchronize()for compute-heavy work, with careful shared-state rules.task.desynchronize() - buffer type: Use the Luau type for compact binary data, serialization, and bit/byte manipulation.
buffer - UI safe zones: Use and related properties to respect device notches and safe areas.
ScreenGui.ScreenInsets - ConfigService: Use a centralized configuration system (commonly a custom ConfigService module or instances) for live configuration and feature flags.
Configuration
- 延迟事件: 设置 (或使用对应的项目设置),让事件进入队列并统一处理,从而避免重入问题。
Workspace.SignalBehavior = Enum.SignalBehavior.Deferred - 聊天: 现代聊天使用 TextChatService;旧版 Chat service 仍然存在,但属于旧 API。
- MemoryStore: 对于跨服务器、短生命周期或高吞吐量的数据,使用 MemoryStoreService,而不是普通 DataStore。
- Parallel Luau: 对于计算密集型工作,使用 Actor instance 和 /
task.synchronize(),并谨慎制定共享状态规则。task.desynchronize() - buffer 类型: 使用 Luau 的 类型进行紧凑二进制数据处理、序列化和位/字节操作。
buffer - UI 安全区: 使用 及相关属性,以适配设备缺口和安全区域。
ScreenGui.ScreenInsets - ConfigService: 使用集中式配置系统(通常是自定义 ConfigService module 或 instance)管理实时配置和 feature flags。
Configuration
Workflow
工作流
- Load the specialist that owns the task. For broad architecture work, also read architecture-principles.md.
- Follow that specialist's reference links for the feature or failure you are handling. For systems that interact, read cross-skill-integration.md.
- Adapt script examples to the project and check their maturity labels. Validate changes in a dedicated test experience.
- Before handing off, report which checks passed, which need Roblox integration, and any unresolved API or policy questions. Check uncertain behavior against the official sources above.
- 加载负责该任务的专项 skill。对于广泛的架构工作,还应阅读 architecture-principles.md。
- 按照专项 skill 的参考链接处理当前功能或故障。对于相互交互的系统,请阅读 cross-skill-integration.md。
- 根据项目调整 script 示例,并检查其成熟度标签。在专用测试环境中验证变更。
- 交接前,报告哪些检查已通过、哪些仍需 Roblox 集成测试,以及尚未解决的 API 或策略问题。针对不确定的行为,应查阅上述官方来源进行核实。
Reference index
参考资料索引
- architecture-principles.md: Choose authority boundaries, data flow, or project structure across systems.
- cross-skill-integration.md: Combine purchases with persistence, or animation with effects and UI.
- architecture-principles.md:跨系统选择 authority boundary、数据流或项目结构。
- cross-skill-integration.md:将购买与数据持久化结合,或将动画与特效和 UI 结合。