Skip to content

Commit 7908de7

Browse files
update Open Source Docs from Roblox internal teams
1 parent d2ee7d9 commit 7908de7

File tree

7 files changed

+45
-26
lines changed

7 files changed

+45
-26
lines changed

content/common/navigation/cloud/legacy.yaml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,26 @@ navigation:
2828
versions:
2929
- name: v1
3030
path: /cloud/legacy/assetdelivery/v1
31-
- title: Auth v2
31+
- title: Authentication v3
32+
type: cloudapi
33+
versions:
34+
- name: v3
35+
path: /cloud/legacy/auth/v3
36+
- title: Authentication v2
3237
type: cloudapi
3338
versions:
3439
- name: v2
3540
path: /cloud/legacy/auth/v2
36-
- title: Auth v1
41+
- title: Authentication v1
3742
type: cloudapi
3843
versions:
3944
- name: v1
4045
path: /cloud/legacy/auth/v1
46+
- title: Avatar v3
47+
type: cloudapi
48+
versions:
49+
- name: v3
50+
path: /cloud/legacy/avatar/v3
4151
- title: Avatar v2
4252
type: cloudapi
4353
versions:

content/common/navigation/engine/art.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,6 @@ navigation:
3838
path: /art/characters/exporting-avatar-animations-from-maya
3939
- title: Animating Heads
4040
path: /art/characters/facial-animation/animating-heads
41-
- heading: Environment and Lighting
42-
- title: Assembling Modular Environments
43-
path: /tutorials/use-case-tutorials/modeling/assembling-modular-environments
44-
- title: Enhancing Outdoor Environments with Future Lighting
45-
path: /tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting
4641

4742
- heading: Example Projects
4843
path:

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

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,21 @@ For more information on basic skinning in third-party modeling software, such as
166166

167167
### Cage Meshes
168168

169-
**Cage meshes**, or **cages**, are invisible meshes that define the inner and outer surfaces of your asset. Similar to collision boxes, these surfaces prevent other accessories or bodies from clipping or breaking and allow other accessory items with cages to layer on top of the previous object.
169+
**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.
170+
171+
<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>
179+
</Alert>
180+
181+
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):
182+
183+
<iframe width="800" height="450" src="https://www.youtube-nocookie.com/embed/C-DwGRBHvmE" title="YouTube video player" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
170184

171185
#### Inner Cage
172186

@@ -191,8 +205,7 @@ The outer cage mesh object must have the same name as the accessory model append
191205
<img src="../../assets/accessories/lc-requirements-outercage-outliner.png" width="60%" />
192206

193207
<Alert severity="warning">
194-
The vertexes and UVs of the inner and outer cage meshes should not be altered, as they are used to match coordinates between other cages.
195-
You can complete the UV texturing of the actual accessory mesh layer (not the \_InnerCage or \_OuterCage objects) at your discretion.
208+
The vertexes and UVs of the inner and outer cage meshes should not be deleted or removed, as they are used to match coordinates between other cages.
196209
</Alert>
197210

198211
## Marketplace Requirements

content/en-us/art/accessories/creating/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ description: This tutorial covers the basic steps required in Blender to Studio-
44
next: /art/accessories/creating/modeling-setup
55
---
66

7+
<iframe width="800" height="450" src="https://www.youtube-nocookie.com/embed/C-DwGRBHvmE" title="YouTube video player" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
8+
<br /><br />
9+
710
You can create your own custom avatar clothing using Blender and Roblox's downloadable project templates. These project templates include [components required for layered clothing](../../../art/accessories/layered-clothing.md#components-of-a-layered-clothing-accessory), and can double as a mannequin to quickly begin shaping and sculpting your clothing assets. By the end of this tutorial, you will have a clothing asset that contains all the required components for a layered clothing accessory on the Marketplace.
811

912
<Alert severity ='info'>

content/en-us/art/characters/specifications.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Avatar character models are made up of 15 separate mesh objects and require addi
2424
- **No N-gons** - Model your assets in quads where possible.
2525
- **Transformations** - All translation, rotation, and scale values must be frozen and pivots set to `0`, `0`, `0`.
2626
- **Orientation** - Characters must face positive Z and stand up in positive Y.
27-
- **Pose** - Before exporting, set your character to an I-Pose when possible.
27+
- **Pose** - Before exporting, set your character to an I-Pose, A-Pose, or T-Pose when possible.
2828

2929
### Body Scale
3030

@@ -471,14 +471,10 @@ To ensure that avatar sizes are visually consistent, you must standardize body p
471471

472472
Attachments are points on the humanoid model where rigid accessories attach. Like many [character components](./index.md#components-of-an-avatar), attachment points are set up in third-party modeling software and imported as `Class.Attachment` objects.
473473

474-
The 3D Importer automatically recognizes and converts mesh objects as attachment points if the objects include the affix `\_Att` and follow the naming conventions below. This only applies when importing meshes with caging data, such bodies. Check out examples of this implementation in any of the [downloadable reference models](../../avatar/resources.md#references).
474+
The 3D Importer automatically recognizes and converts mesh objects as attachment points if the objects include the affix `\_Att` and follow the naming conventions below. This only applies when importing meshes with caging data, such as bodies (accessory attachment points are created using the Accessory Fitting Tool). Check out examples of this implementation in any of the [downloadable reference models](../../avatar/resources.md#references).
475475

476476
Generally, when placing attachment points, position them so they overlap halfway with the character model's mesh part.
477477

478-
<Alert severity = 'info'>
479-
480-
</Alert>
481-
482478
<GridContainer numColumns="2">
483479
<figure>
484480
<img src="../../assets/modeling/meshes/Collar-Attachment-1.png" />
@@ -564,7 +560,7 @@ Attachments must follow a specific naming convention and positional consistency:
564560
<tr>
565561
<td>RightHand</td>
566562
<td>RightGrip_Att</td>
567-
<td>Anywhere in mesh bounding box, must set the rotation of the RightGrip_Att to `90`, `0`, `0`</td>
563+
<td>Anywhere in mesh bounding box. <br/><br/>Orient grip attachments **perpendicular** to the lower arm bone. For example, for I-Pose (arms pointing down), set the grip attachment to `90`, `0`, `0` (grip attachment pointing forward).<br/><br/><img src="../../assets/modeling/meshes/Grip_Attachments.png" width="250" /></td>
568564
</tr>
569565
<tr>
570566
<td>LeftUpperArm</td>
@@ -574,7 +570,7 @@ Attachments must follow a specific naming convention and positional consistency:
574570
<tr>
575571
<td>LeftHand</td>
576572
<td>LeftGrip_Att</td>
577-
<td>Anywhere in mesh bounding box, must set the rotation of the LeftGrip_Att to `90`, `0`, `0`</td>
573+
<td>Anywhere in mesh bounding box. <br/><br/>Orient grip attachments **perpendicular** to the lower arm bone. For example, for I-Pose (arms pointing down), set the grip attachment to `90`, `0`, `0` (grip attachment pointing forward).<br/><br/><img src="../../assets/modeling/meshes/Grip_Attachments.png" width="250" /></td>
578574
</tr>
579575
<tr>
580576
<td>RightFoot</td>
@@ -638,7 +634,7 @@ See the following requirements for humanoid rigging:
638634
</GridContainer>
639635

640636
- **LowerTorso and Root** - The LowerTorso and Root bone or joint position must be set to `0`, `0`, `0`.
641-
- **Pose** - Export your character model in an I-Pose for the best Studio compatibility. The LeftUpperArm and RightUpperArm bones can be exported with rotation values to meet this requirement.
637+
- **Pose** - Export your character model in an I-Pose, A-Pose, or T-Pose for the best Studio compatibility. The LeftUpperArm and RightUpperArm bones can be exported with rotation values to meet this requirement.
642638

643639
## Skinning
644640

@@ -717,15 +713,12 @@ The following are examples of skin tone shading for the face, and you can apply
717713

718714
## Outer Cages
719715

720-
Outer cages are non-rendered meshes that Roblox uses to define the outer surfaces of a body part using a `Class.WrapTarget` instance. Outer cages on your character model allow your character to wear layerable accessories, such as clothing.
721-
722-
For general use, see the following requirements for adding inner and outer cage meshes to your model:
723-
724-
- **Naming Conventions** - The inner and outer cage must be named after the primary mesh object with **\_InnerCage** and **\_OuterCage** affixed.
716+
Outer cages on your character model allow your character to wear layerable accessories, such as clothing. Models, such as an avatar character, that are the target of meshes that will stretch over it, only require an outer cage, but meshes that deform, like [layered clothing](../accessories/clothing-specifications.md#cage-meshes), require an inner and outer cage.
725717

726-
<img src="../../assets/accessories/lc-blender-selecting-cage-in-outlier.png" />
718+
For general use, see the following requirements for adding outer cage meshes to your model:
727719

728-
- **Outer Cage** - Models, such as a playable character, that aren't expected deform but are the target of meshes that will stretch over it, only require an Outer Cage.
720+
- Use Roblox's [Body Cage templates](../../avatar/resources.md#project-files) to ensure naming convention and other configurations are correct.
721+
- **Naming Conventions** - The outer cage of a body part must be named after the primary mesh object with **\_OuterCage** affixed, for example `LeftUpperArm_OuterCage`.
729722
- **Vertices and UV Map** - Don't delete vertices or alter the UVs on the Outer Cages as this can cause errors when importing in Studio or when equipping onto a character. Use the Roblox provided templates for the cage meshes to ensure compatibility with other layered assets.
730723
- **Symmetry and consistency** - Keep each face (the space between vertices) consistently sized and retain symmetry wherever possible. Use symmetry tools in your modeling software whenever possible.
731724

Lines changed: 3 additions & 0 deletions
Loading

tools/checks/utils/allowedHttpLinks.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,8 @@ https://www.youtube-nocookie.com/embed/llR_pNlJDQw
499499
https://youtu.be/OEmFocfE0Xs
500500
https://www.youtube.com/watch?v=SgPU84AqpkY&t=74s
501501
https://www.youtube.com/watch?v=9mXvhYSv7fc&t=96s
502+
https://www.youtube.com/watch?v=C-DwGRBHvmE&t=512s
503+
https://www.youtube-nocookie.com/embed/C-DwGRBHvmE
502504
https://en.wikipedia.org/wiki/Exponential_backoff
503505
https://en.wikipedia.org/wiki/Moment_of_inertia
504506
https://en.wikipedia.org/wiki/Shard_(database_architecture)

0 commit comments

Comments
 (0)