Skip to content

Commit 8d833c1

Browse files
update Open Source Docs from Roblox internal teams
1 parent c87ebb9 commit 8d833c1

File tree

18 files changed

+209
-239
lines changed

18 files changed

+209
-239
lines changed

content/common/navigation/cloud/reference.yaml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -299,12 +299,6 @@ navigation:
299299
versions:
300300
- name: v1
301301
path: /cloud/legacy/badges/v1
302-
- title: Chat
303-
type: cloudlegacy
304-
ignoreTranslation: true
305-
versions:
306-
- name: v2
307-
path: /cloud/legacy/chat/v2
308302
- title: Develop v2
309303
type: cloudlegacy
310304
ignoreTranslation: true

content/en-us/art/accessories/clothing-export-settings.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,42 @@ Export your mesh or model as a `.fbx` or `.gltf` to take advantage of all of Stu
99
- If you are creating an avatar character model, ensure that your model follows [character specifications](../../art/characters/specifications.md) and use the [character body export settings](../../art/characters/export-settings.md).
1010
- If you are creating a generic mesh, ensure that your model follows Roblox's [general specifications](../../art/modeling/specifications.md) and use the [general export settings](../../art/modeling/export-requirements.md).
1111

12+
## Before exporting
13+
14+
Before exporting, ensure that you are only exporting the Roblox supported objects related to your model. If you have any modifiers to your mesh or project objects, make sure to apply or delete them before export.
15+
16+
You can export layered clothing models with the following object structure:
17+
18+
<img src="../../assets/modeling/skinned-meshes/Clothing-Data-Model.png" width="60%" alt="Blender clothing data model example" />
19+
20+
- Armature parent
21+
- Bones / joints
22+
- Primary mesh object
23+
- Cage parent object
24+
25+
- Inner cage mesh object
26+
- Outer cage mesh object
27+
28+
You can also export shoes together. Even though left and right shoes are separate accessories, you can either export the left and right shoe individually, or export both shoes at the same time using the following structure:
29+
30+
<img src="../../assets/modeling/skinned-meshes/Shoe-Data-Model.png" width="60%" alt="Shoe clothing data model example"/>
31+
32+
- Armature parent
33+
- Bones / joints
34+
- Left shoe mesh object
35+
- Right shoe mesh object
36+
- Cage parent object
37+
- Left shoe inner cage
38+
- Left shoe outer cage
39+
- Right shoe inner cage
40+
- Right shoe outer cage
41+
1242
<Alert severity = 'warning'>
13-
If you have any modifiers to your mesh or project objects, make sure to apply
14-
or delete them before export.
43+
Each shoe must include their own inner and outer cage.
1544
</Alert>
1645

46+
## Software specific export settings
47+
1748
<Tabs>
1849
<TabItem label="Blender">
1950

content/en-us/art/accessories/clothing-specifications.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ If setting attachment names manually in Studio, use the following `Class.Attachm
133133

134134
### Face Accessories
135135

136-
Face accessories, such as hair, eyebrows, and eyelashes are unique accessories that you can bundle with an avatar body upload. At this time, eyebrows and eyelashes can not be uploaded as standalone accessories and must be bundled with avatar bodies. For more information on bundling your face accessories with avatar models, see [Publishing Bodies with Eyelashes and Eyebrows](../accessories/publish-eyebrows-eyelashes.md).
136+
Face accessories, such as hair, eyebrows, and eyelashes are unique accessories that you can bundle with an avatar body upload. At this time, eyebrows and eyelashes can not be uploaded as standalone accessories and must be bundled with avatar bodies. For more information on bundling your face accessories with avatar models, see [Publishing bodies with eyelashes and eyebrows](../accessories/publish-eyebrows-eyelashes.md).
137137

138138
- **Naming Convention when bundled** - When including these assets with an avatar body upload, the accessory objects must use the following name conventions:
139139
- `EyebrowAccessory`
@@ -169,13 +169,7 @@ For more information on basic skinning in third-party modeling software, such as
169169
**Cage meshes**, or **cages**, are invisible meshes that define the inner and outer surfaces of your asset and are fundamental to the layerable properties of clothing items. The inner cage determines the inside surface of a clothing item while the outer cage determines the outside surface of a clothing item.
170170

171171
<Alert severity = 'error'>
172-
Assets with invalid cage configurations may fail validation and are subject to moderation. This includes, but is not limited to:
173-
174-
<ul>
175-
<li>**No difference between the two cages** - The outer cage needs to envelope the layered clothing item as much as possible. If the inner and outer cages are exactly the same, the layered accessory behaves like a rigid accessory and doesn't deform.</li>
176-
<li>**Extreme space between the two cages** - Large spaces between the inner and outer cages can make the accessory look unrealistic puffy or excessively large.</li>
177-
<li>**Outer cage is within the inner cage** - The outer cage needs to be outside the inner cage otherwise the asset will fail validation.</li>
178-
</ul>
172+
Assets with invalid cage configurations may fail validation and are subject to moderation. See [Caging best practices](./caging-best-practices.md) for examples and instructions.
179173
</Alert>
180174

181175
For a basic overview on caging, see the [Basic Clothing Tutorial](../accessories/creating/caging-setup.md) and the relevant section of the tutorial video at [8:32](https://www.youtube.com/watch?v=C-DwGRBHvmE&t=512s):

content/en-us/art/accessories/import-clothing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ After successful import, your model object should populate in your project as a
6464

6565
With the `Class.Model` in your project, the last step in the process of clothing creation requires you to use the Accessory Fitting Tool to convert this object to a standard `Class.Accessory` that avatar characters can equip.
6666

67+
<Alert severity = 'warning'>
68+
For shoes, you must convert the left shoe and the right shoe as separate accessories. Use the following instructions for each shoe before grouping both shoe accessories as a `Class.Model` when [saving to Roblox](../../marketplace/publish-to-marketplace.md#upload-an-asset).
69+
</Alert>
70+
6771
To generate the accessory object:
6872

6973
1. In the Avatar tab, select the [**Accessory Fitting Tool**](../accessories/accessory-fitting-tool.md). The Accessory Fitting Tool panel displays on the left side of the workspace.

content/en-us/art/characters/creating/export-character.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To export your character:
2424
<img src="../../../assets/art/avatar/basic-creation/Export-Settings.png" width = "60%" />
2525

2626
<Alert severity = 'warning'>
27-
After exporting your .fbx file, see [Test characters](../../../art/characters/testing/index.md) In Studio for steps on importing your character model into a test place and verifying your avatar and related components.
27+
After exporting your .fbx file, see [Test characters](../../../art/characters/testing/index.md) for steps on importing your character model into a test place and verifying your avatar and related components.
2828
</Alert>
2929

3030
<Alert severity = 'success'>

content/en-us/art/characters/export-settings.md

Lines changed: 45 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Character body export settings
33
description: Use the appropriate export settings in Maya and Blender to generate Studio-ready .fbx files.
44
---
55

6+
<Alert severity = 'warning'>
7+
It's important to test your assets multiple times at every point of the asset creation process, whether it is within your modeling application or after importing into Studio. See [Test characters](../../art/characters/testing/index.md) for more information.
8+
</Alert>
9+
610
Export your model as a `.fbx` or `.gltf` to take advantage of all of Studio's 3D import features. When rigging or skinning a layerable model, these file types contains all the mesh and texture data, including the rig and influence data, you need to later [import](../../art/modeling/3d-importer.md) into Studio.
711

812
Check that your model meets Roblox's [avatar character specifications](../../art/characters/specifications.md) before exporting to ensure Studio compatibility.
@@ -15,33 +19,47 @@ Check that your model meets Roblox's [avatar character specifications](../../art
1519
If you are using Roblox's avatar template files, you must perform the [cleanup steps](../../art/characters/creating/combine-head-geometry.md) in order for the assets to properly validate.
1620
</Alert>
1721

18-
<Tabs>
19-
<TabItem label="Blender">
22+
## Before exporting
2023

21-
Before exporting a mesh from Blender, make sure either your **Scene Properties** > **Unit Scale** to `.01` or your export **Transform** > **Scale** is set to `.01` (step 4) to ensure similar `.fbx` scaling within Studio.
24+
Before exporting, ensure that you are only exporting the Roblox supported objects related to your model. If you have any modifiers to your mesh or project objects, make sure to apply or delete them before export.
2225

23-
To export the `.fbx` file in Blender:
26+
Use the following guidance before exporting:
2427

25-
1. In the topbar, click **File**. A pop-up menu displays.
26-
2. Select **Export**, then **FBX (.fbx)**. The **Blender File View** window displays.
27-
3. On the right-hand side, change the **Path Mode** property to **Copy**, then toggle the **Embed Textures** button.
28+
- While your mesh objects must be parented within an armature object, you can also parent your outer cage objects to a single empty object to simplify your workspace.
29+
30+
<img src="../../assets/art/avatar/Character-Data-Model-Collapsed.png" width = "60%" />
31+
32+
- In the cage parent object, ensure you have an [outer cage](../characters/specifications.md#outer-cages) for each of your 15 body parts with appropriate naming affix.
33+
34+
<img src="../../assets/art/avatar/Character-Data-Model-Cages.png" width = "60%" />
2835

29-
<img src="../../assets/modeling/skinned-meshes/Blender-Export-Settings-1.png" width="320" />
36+
- In the armature object, ensure that you include the all [15 mesh objects](../characters/specifications.md#body-parts) and [19 attachments](../characters/specifications.md#attachments) with the appropriate naming affix.
3037

31-
4. If your project doesn't already have .01 scene unit scaling, set the **Transform** > **Scale** to `.01`.
38+
<img src="../../assets/art/avatar/Character-Data-Model-Joints.png" width = "60%" />
3239

33-
<img src="../../assets/modeling/skinned-meshes/Blender-Export-Settings-2.png" width="320" />
40+
<Alert severity = 'info'>
41+
For more information on supported modeling objects and proper configuration, see [Character specifications](../characters/specifications.md).
42+
</Alert>
43+
44+
## Software specific export settings
3445

35-
5. Under the **Armature** section, disable **Add Leaf Bones**.
46+
Whether you are exporting your character for testing, or are performing a final export out of Blender, you must apply the appropriate export settings to ensure that Blender exports the proper character data.
3647

37-
<img src="../../assets/modeling/skinned-meshes/Blender-Export-Settings-3.png" width="320" />
48+
<Tabs>
49+
<TabItem label="Blender">
3850

39-
6. Enable **Bake Animation**. Avatar characters with [facial animation data](../../art/characters/facial-animation/index.md) require animation data.
51+
Before exporting a mesh from Blender, make sure either your **Scene Properties** > **Unit Scale** to `.01` or your export settings **Transform** > **Scale** is set to `.01` to ensure similar `.fbx` scaling within Studio.
4052

41-
<img src="../../assets/modeling/skinned-meshes/Blender-Export-Settings-4.png" width="320" /> <br />
53+
1. In the topbar, click **File** > **Export** > **FBX (.fbx)**. The Blender file browser window displays.
54+
2. Set **Path Mode** to **Copy** and enable the **Embed Textures** icon.
55+
3. In the Include section, enable **Custom Properties**.
56+
4. Expand the Armature section and uncheck **Add Leaf Bones**.
57+
5. Enable **Bake Animation**.
58+
6. Expand Bake Animation and **uncheck NLA Strips**, **All Actions**, and **Force Start/End Keyframes**.
59+
7. In Bake Animation, set **Simplify** to **0.0**.
60+
8. Click the **Export FBX** button. Save the `.fbx` to the directory of your choice.
4261

43-
7. Click the **Export FBX** button.
44-
8. After exporting, use Studio's [3D importer](../../art/modeling/3d-importer.md) to import your model. See [Test characters in Studio](../../art/characters/testing/studio.md) for additional importing and testing information
62+
<img src="../../assets/art/avatar/basic-creation/Export-Settings.png" width = "60%" />
4563

4664
</TabItem>
4765
<TabItem label="Maya">
@@ -57,10 +75,20 @@ To export a mesh in Maya as a `.fbx` file:
5775
8. In the **Advanced Options** section,
5876
- Navigate to **Units**, then enable **Automatic**.
5977
- Navigate to **Axis Conversion**, then set the **Up Axis** property to **Y**.
60-
- Navigate to **FBX File Format**, then set the **Type** property to **Binary**, and the **Version** property to **FBX 2020**.
78+
- If you have issues importing your model, navigate to **FBX File Format**, then set the **Type** property to **Binary**, and the **Version** property to **FBX 2020**.
6179
9. Click the **Export All** button.
6280
<img src="../../assets/accessories/lc-requirements-maya-settings.png" />
6381
10. After exporting, use Studio's [3D importer](../../art/modeling/3d-importer.md) to import your model. See [Test characters in Studio](../../art/characters/testing/studio.md) for additional importing and testing information.
6482

6583
</TabItem>
6684
</Tabs>
85+
86+
<Alert severity = 'success'>
87+
After importing the `Class.Model` character to Studio, you can now perform the following with this asset:
88+
89+
- [Test your character model](../../art/characters/testing/index.md) in Studio using various tools and workflows.
90+
- [Upload the character](../../art/accessories/creating-rigid/publishing.md) to the Marketplace.
91+
- Use the humanoid character on an existing experience by applying a [HumanoidDescription](../../characters/appearance.md#humanoiddescription)to the `Class.Model` object.
92+
- Save the asset to your [Toolbox](../../projects/assets/toolbox.md) to share or use within any of your experiences.
93+
94+
</Alert>

content/en-us/art/characters/testing/studio.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22
title: Test in Studio
33
comments:
44
description: Verify the important aspects of your character model in a custom Studio test experience.
5-
prev: /art/avatar/testing/blender
65
---
76

8-
Test your character model in Studio to understand how it looks and feels within a Roblox experience.
7+
Test your character model in Studio to understand how it looks and feels within a Roblox experience. To test your custom character in Studio, first [import the character model](../../characters/import.md) into your Studio project.
98

10-
Roblox provides an [Avatar Test experience](https://www.roblox.com/games/13176231501/Avatar-Test-Place) that you can open in Studio and import your character model in. This experience provides a wide variety of environmental and clothing tests to ensure that your character model and related components work as expected.
9+
You can test in Studio using the [Avatar Setup tool](../../modeling/avatar-setup.md) to preview and test various components of your avatar character.
10+
11+
You can also playtest your character in the [Avatar Test experience](https://www.roblox.com/games/13176231501/Avatar-Test-Place). This experience provides a wide variety of environmental and clothing tests to ensure that your character model and related components work as expected.
1112

1213
## Set up test experience
1314

Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)