Avatar Setup | Documentation - Roblox Creator Hub (2024)

The auto-setup feature of this tool is currently in beta release.

The Avatar Setup tool, accessible from the Avatar tab, allows you to auto-setup avatar meshes, preview animations, clothing, skin tones, and test avatar character bodies directly in Studio. In the future, Marketplace creators can also begin the uploading and validation process from this tool to quickly publish their assets.

Avatar Setup | Documentation - Roblox Creator Hub (1)

Avatar Auto-Setup

The Auto-Setup feature converts a single-mesh body model into a finished avatar model with all the advanced components that allow characters to interact with the world and express themselves.

Creating these avatar components, including tasks like rigging, skinning, facial animation, and more, often require hours or days to configure in a third-party modeling tool such as Blender or Maya. Using the Avatar Auto-Setup tool, you can input a simple single-mesh character body and create a Marketplace-ready avatar model within minutes.

Avatar Setup | Documentation - Roblox Creator Hub (2)
Avatar Setup | Documentation - Roblox Creator Hub (3)

The avatar auto-setup performs the following on a submitted character model:

  • Rigging - adds an R15 armature to your body model to enable movement and animation.

  • Skinning - adds weights and influences to various surfaces of your mesh, ensuring an organic and natural flexibility during movement.

  • Facial animation - generates the FACS poses, facial rigging, skinning, and animation data required for facial animation and avatar chat.

  • Caging - adds the outer cage mesh to your avatar, enabling it to wear layered clothing.

  • Partitioning - separates the single body mesh into the appropriate R15 parts.

  • Creating attachments - adds the appropriate attachment points enabling the character to wear rigid accessories.

How Auto-Setup Works

The Auto-Setup tool utilizes machine learning (ML) models that handles the rigging, skinning, and caging application. After creating the rigging, skinning, and caging data, the tool applies body partitioning and attachment point generation using a geometry-based solution. If existing components, such as bones, cages, attachments, or animation, are already included in the imported Model, the Auto-Setup tool removes them and generates new components.

The ML models train on a dataset consisting of hundreds of different body shapes and styles. The tool performs best with human-like body models that are similar to those used for training and becomes more inconsistent for body models that diverge from the training set.

See the following examples for the types of bodies and styles that work best with Auto-Setup:

Avatar Setup | Documentation - Roblox Creator Hub (4)

Robots and other characters that use stiff, artificial, and inorganic movement and body styles.

Avatar Setup | Documentation - Roblox Creator Hub (5)

Animals, or other characters that use non-human, or overly exaggerated movements and body styles.

Avatar Setup | Documentation - Roblox Creator Hub (6)

Humanoid characters that use realistic proportions. Some stylization and cartoon elements can still apply.

Roblox intends to continue releasing updated versions of the auto setup ML models over time. When uploading an avatar body asset, Studio gives you the option to add your input model as part of a dataset for additional training and improvements as well as provide feedback on the quality of the auto-setup output.

Model Requirements

For best results, Avatar Auto-Setup expects the input body model to follow a specific set of requirements. These requirements may require using a third-party modeling tool to adjust your current character mesh, as they are different from the traditional avatar character requirements. As the Auto-Setup tool improves, some of these requirements may lift.

Many existing downloadable resources for avatar bodies do not follow the auto-setup requirements below. Existing avatar references may need modification to ensure the asset follows the auto-setup models. See the specific Auto-Setup References for assets that were created for Auto-Setup requirements.

The full requirements for the input body model are as follows:

  1. Single mesh - The body must be a single mesh with 6 merged components:

    1. 1 main head and body - singly connected, watertight, manifold mesh with 2 eye bags and 1 mouth bag.

    2. 5 distinct head components - While the entire input model must be a single mesh, the following head components are required:

      1. 2 eyes - Heads must include 2 eyes that are half spheres and each connected by their own single vertex to the head component.

      2. 3 mouthparts - Heads must include upper teeth, lower teeth, and tongue within the mouth bag. Each must be connected by their own single vertex to the head component.

    Avatar Setup | Documentation - Roblox Creator Hub (7)
    Avatar Setup | Documentation - Roblox Creator Hub (8)
  2. Head geometry must not share vertices - Eyeballs, teeth, and tongue must be part of the model without sharing vertices with the body mesh.

    Avatar Setup | Documentation - Roblox Creator Hub (9)
    Avatar Setup | Documentation - Roblox Creator Hub (10)
  3. _Geo affix - The asset name must end with a "_Geo".

  4. Within triangle budget - The total body mesh resolution must be within 20k triangles. Use the following guidance to ensure each part doesn't exceed expected polycounts:

    Body Part GroupingMaximum TrianglesMaximum Quads
    Head40002000
    Arms1248 per arm624 per arm
    Legs1248 per leg624 per arm
    Torso1750875
    Total: 10,7425495
  5. Humanoid shape - The body must follow a general humanoid shape, with two arms, two legs, a torso, and a head.

  6. A-pose - The body should form an upright A-pose with the front facing the negative Z axis.

    1. Bodies with I-pose or T-pose may produce lower quality results.

    2. Ensure that no limbs obscure or overlap each other from the front view.

  7. Symmetrical - The body should be left and right symmetrical.

    1. Asymmetrical bodies may still work on a case-to-case basis. Position the center of the body with the Y-axis to improve the accuracy of the result.

  8. Watertight - Ensure the model is watertight in all regions with the exception of the eyes and mouth. Watertight means that there are no holes in the mesh and no back faces are exposed.

  9. No accessories - Do not include accessories, including face accessories, like hair, eyebrows, beards, and eyelashes.

  10. Distinct neck area - Keep the neck distinct and not merged with the shoulders or upper torso.

  11. Includes texture - The input model should include a base textureID or SurfaceAppearance object (PBR textures).

  12. Follows Marketplace and Community Policy - The model must conform to Roblox's Marketplace Policy and Community Standards.

Examples of Non-Supported Models

The following are common examples of models that may not yield expected results with auto-setup:

Importing Models

Studio supports .gltf, .fbx, and .obj models using the 3D Importer. If you are exporting your model from a third-party tool, see Export Settings for export configurations. For an asset that meets all of these model requirements, download an example model to use as a reference and testing.

To prevent uploading an incomplete asset to the Roblox servers, disable the Upload to Roblox option in the 3D Importer to only add the character mesh locally before using the Auto-Setup feature.

To save time in the future, you can save this import profile using the ... dropdown in the top-right of the 3D Importer window.

To import the model into Studio:

  1. In Studio, navigate to the Avatar tab and select 3D Importer.

  2. In the file browser, select your model object.

  3. When your model object loads in the 3D Import preview, disable the Upload To Roblox option.

    1. To save time in the future, click the ... dropdown in the top-right of the 3D Importer window and Save as New to create an import profile for this workflow.

  4. Verify the preview and any warnings or errors in your model object.

    1. See 3D Importer for additional information. Certain warnings and errors may require readjusting the model in a third-party software.

  5. Select Import to add the Model instance into your workspace.

    When a new model is imported, it's also added to the moderation queue. If an avatar asset is moderated incorrectly, you will receive a moderation email with a link to appeal. This appeal takes up to 10 minutes to resolve.

Running Auto-Setup

When your project has the appropriate Model in your workspace, you can begin the auto setup process.

  1. With the Model selected, navigate to the Avatar tab and select Avatar Setup.

  2. In the Avatar Setup panel, click the blue Set Up Avatar button. This process can take several minutes.

    Avatar Setup | Documentation - Roblox Creator Hub (17)
  3. Once complete, a Model of your avatar populates in your workspace.

    1. Review any warnings or errors. You may need to readjust your mesh in a third-party modeling software to resolve some issues.

      1. Common errors you may need to resolve with external software:

        1. Increase/decrease size of avatar mesh. This might require adjusting export scale settings in your third-party modeling software to ensure a 1 cm to 1 stud parity.

        2. Reduce poly count if you're exceeding the maximum.

    2. Use the various auto setup tools to verify the components of your avatar before saving the Model to your Toolbox or uploading to the Marketplace.

Testing Interface

After the auto-setup is complete, the avatar populates in the preview window. It's important to test that your avatar components have correctly generated by testing out different clothing, rigid accessories, and animations. If you discover any issues, you may need to update your base input model in your third-party modeling software and retry the auto-setup process.

Avatar Setup | Documentation - Roblox Creator Hub (18)
Once an avatar is added to the tool, four tabs appear on the left side of the panel:
  • Check Body

  • Check Face

  • Test in Experience

  • Publish

Check Body

The Check Body interface contains tabs for Animations, Clothing, Accessories, and Body assets, such as skin-tone and swapping body parts. Clicking a subtab like Shirts, Waist, or Skin reveals a selection column along the left side of the window for testing various cosmetics and visuals.

Avatar Setup | Documentation - Roblox Creator Hub (19)

Equipping Items

Selected items are equipped on the avatar and are added to the currently equipped column on the right side. Selected animations begin playing as a preview of how they'll look in a running experience.

To unequip an item, click it again in the selection column, press the X button at the top right of the equipped item, or right-click the asset in the Equipped column and select Unequip. You can also drag and order the various equipped accessories to set the worn order.

Adding Items

The add item button allows you to add custom assets to the tool's palette for testing.

To add an item to the palette:

  1. Select a valid Accessory or Body Part asset from the Explorer or 3D workspace.

  2. Click the add item button at the bottom of the selection column along the left side of the window.

    Avatar Setup | Documentation - Roblox Creator Hub (20)
  3. The item appears in the appropriate section and subsection of the Check Body interface, such as AccessoriesHair.

Check Face

The Check Face interface zooms into the face and allows you test various facial poses.

Avatar Setup | Documentation - Roblox Creator Hub (21)
Avatar Setup | Documentation - Roblox Creator Hub (22)

Test in Experience

The Test in Experience button starts playtesting the experience with the previewed avatar. Any changes made in the Avatar Setup preview tools, such as equipped clothing or accessories, or modifications, such as skin tone or body part swaps, do not transfer over to the playable character model in this mode.

Publish

The Publish feature is disabled during the Auto-Setup beta. Assets created with the Avatar Setup tool can be used in experience and for testing purposes.

The Publish button opens the publish asset dialog, with an option to upload the avatar and any accessory items to the Marketplace

When selecting the Publish option, you can upload the asset to the Marketplace, where you can sell the item paying an upload fee, clearing moderation, and publishing the asset to the catalog.

The upload option opens the following prompt which goes through additional validation checks before uploading to the moderation queue. At this time, only members of the UGC program can submit avatar assets to the Marketplace.

For additional resources on the publishing process and Marketplace, see the following:

  • Publishing to the Marketplace

  • Marketplace Fees and Commissions

  • Marketplace Policy

Avatar Setup | Documentation - Roblox Creator Hub (2024)
Top Articles
Latest Posts
Article information

Author: Carmelo Roob

Last Updated:

Views: 5789

Rating: 4.4 / 5 (65 voted)

Reviews: 88% of readers found this page helpful

Author information

Name: Carmelo Roob

Birthday: 1995-01-09

Address: Apt. 915 481 Sipes Cliff, New Gonzalobury, CO 80176

Phone: +6773780339780

Job: Sales Executive

Hobby: Gaming, Jogging, Rugby, Video gaming, Handball, Ice skating, Web surfing

Introduction: My name is Carmelo Roob, I am a modern, handsome, delightful, comfortable, attractive, vast, good person who loves writing and wants to share my knowledge and understanding with you.