DOCSEARCHbyAlgolia
Submit Docs

Roblox Creator Documentation

repository·main·Indexed 21 days ago

https://github.com/roblox/creator-docs

Source code for the Roblox Creator Documentation hosted at create.roblox.com. This repository contains conceptual and task-based guides, tutorials, and the source for the Roblox Engine API reference and Roblox Open Cloud APIs, including OpenAPI specification files and engine JSON schemas.

Tokens
248.5K
Snippets
303
Records
1.1K
Agent score
73%

What's inside roblox-creator-docs

  1. Overview of 3D art and Studio tools

    main
    Roblox Studio provides a suite of 3D creation tools for asset creation and world building. This overview covers the fundamental workflows for using Studio's interface, managing assets and packages, performing 3D modeling (both via basic parts and imported meshes), and configuring environments using materials, textures, and terrain.

  2. Overview of the Roblox Platform

    main

    Roblox is a platform that hosts millions of user-generated games rather than being a single game itself. It supports two primary modes of engagement:

    1. Playing: Students can visit games (such as historical roleplaying or physics simulations) using the Roblox Client.
    2. Creating: Students can design 3D worlds and learn computer science using Roblox Studio.

    Roblox is designed for educators and does not require prior coding or game development experience to use for classroom activities.

  3. Overview of the Studio interface

    main

    The Roblox Studio interface is organized into several key areas:

    • Mezzanine and Toolbar: Located at the top of the screen. The mezzanine contains testing controls (left), collaboration and account options (right), and tool tabs (center). The toolbar contains the specific tools for the selected tab.
    • Default Tool Tabs:
      • Home: Core transform tools, part insertion, color/material widgets, grouping, locking, anchoring, and the Terrain Editor.
      • Model: Transform tools, pivot and align tools, effects and constraints insertion, and solid-modeling tools.
      • Avatar: Transform tools, rig building, avatar configuration, animation tools, and accessory fitting.
      • UI: UI object insertion and the Style Editor.
      • Script: Script writing, testing, and debugging tools.
      • Plugins: Community or user-created plugins.
    • Other Windows: Includes the Explorer, Properties, and Asset Manager (details in subsequent sections).

  4. Overview of Avatar Setup specifications

    main

    The Avatar Setup tool in Roblox Studio allows you to preview animations, clothing, accessories, and body constructs directly on avatar rigs. It provides automatic conversion for basic custom models into Roblox-ready assets, including:

    • Bodies: Custom character models converted to Roblox-ready bodies.
    • Rigid Accessories: Custom models converted to rigid accessories.
    • Layered Accessories: Custom models converted to layered accessories.

    You can use the bundling feature to group multiple models together, enabling the automatic setup of multiple custom models into avatar items simultaneously for in-game use or Marketplace upload.

  5. Overview of the Roblox Developer 101 Course

    main

    The 'Roblox developer 101' is an introductory course designed for educators to teach coding and game creation on the Roblox platform. The course is divided into several sessions that progress from foundational 3D modeling and scripting to building a complex adventure game.

    Course Structure

    • Session 1: Roblox Studio Basics: Focuses on manipulating parts, creating obstacle courses, and basic scripting (variables and loops).
    • Session 2: Coding Fundamentals: Explores functions, loops, and if/then statements through mini-projects like traps and color-changing platforms.
    • Session 3: Adventure Game Pt. 1: Students begin a complex project, planning elements and setting up gameplay components like item tracking.
    • Session 4: Adventure Game Pt. 2: Focuses on advanced scripting for tools, selling items, and upgrading spaces.
    • Session 5: Adventure Game Pt. 3: Includes catching up, playtesting, and refining the game to ensure it is fun and bug-free.

  7. Overview of Avatar in-experience creation

    main

    In-experience creation allows players to create, customize, and purchase custom avatar bodies in real time within your experience. When a player purchases a custom body, it is saved directly to their Roblox inventory, making it wearable in other experiences.

    Key Benefits and Limitations:

    • Commissions: Experience owners receive Marketplace commissions as both the creator of the avatar item and the experience owner.
    • Attribution: Assets created in-experience include a link to the original experience when inspected.
    • Scope: Currently, in-experience creation only supports the creation of custom avatar bodies.
    • Marketplace Availability: Assets created this way are not listed on the public Marketplace and cannot be resold or traded.

    To test this functionality, you can use the Roblox Avatar Creator demo.

  8. Overview of Event Sequencer

    main

    EventSequencer is a framework designed for building live, cross-server events and cutscenes. It allows developers to orchestrate complex sequences of actions and triggers using a structured timeline. Key capabilities include:

    • Scheduled Configurations: Orchestrate audio, animations, and tweens through a structured framework.
    • Cross-Server Synchronization: Transition between multiple scenes across different servers, ensuring complex visuals and animations are synchronized to a timeline.
    • Testing and Development: Seek through an event timeline to preview specific moments within the game for testing purposes.

  9. Overview of MemoryStoreService

    main

    Class.MemoryStoreService is a high-throughput, low-latency data service designed for frequent, ephemeral, and rapidly changing data that is shared across all servers in a live session.

    Key Characteristics:

    • Speed: Faster access than standard Data Stores.
    • Ephemeral: Data is not durable and vanishes after reaching its maximum lifetime (TTL).
    • Use Case: Use Memory Stores for real-time data like matchmaking, global leaderboards, or caching persistent data. For data that must persist across sessions, use Data Stores instead.

  10. Overview of Roblox diagnostic tools

    main

    Roblox provides several tools to identify performance issues across three main categories: frame rate (compute), memory, and load time. These tools are available in both Roblox Studio and the live client, though some are exclusive to Studio.

    Available Tools

    ToolDescriptionLocationKeyboard ShortcutEnvironment
    Developer ConsoleReal-time logs, errors, and detailed memory, networking, and script performance stats.Studio / In-GameF9Studio Testing / Live Sessions
    MicroProfilerBreaks down computational time spent on tasks per frame. Useful for identifying specific task spikes.Studio / In-GameCtrl+Alt+F6 (⌘+⌥+F6)Studio Testing / Live Sessions
    Scene AnalysisComparative info on resource usage by client/server and the responsible instances.StudioN/AStudio Testing
    Performance StatsToolbar showing memory, CPU, GPU, network data, and ping.In-GameCtrl+Alt+F7 (⌘+⌥+F7)Studio Testing / Live Sessions
    Debug StatsOverlays for graphics, physics, network traffic, and FPS.Studio / In-GameShift+Ctrl+F1 through F5Studio Testing / Live Sessions
    Network SimulationSimulates latency, jitter, and packet loss.StudioAlt+S (⌥+S)Studio Testing
    Performance DashboardAggregate charts for memory, frame rate, heartbeat, and crash rates.Creator DashboardN/ALive Sessions

  11. Overview of the Create and Destroy lesson plan

    main

    The 'Create and Destroy' lesson plan teaches design thinking and world building. Students learn to design a city using buildings, props, and terrain, practice coding by modifying game variables in a script, and follow an iterative process of testing, evaluating, and redesigning.

    Key Concepts:

    • Level Designer: The role responsible for designing the game environment.
    • Script: An object that holds code.

    Prerequisites:

    • Students must have a Roblox account and login information.
    • Windows or Mac computer with Roblox Studio installed.
    • Presentation materials (provided in the lesson assets).