Skip to content

Commit eedf084

Browse files
update Open Source Docs from Roblox internal teams
1 parent 92221de commit eedf084

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1528
-937
lines changed

content/common/navigation/assets.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ navigation:
4949
path: /art/modeling/export-requirements
5050
- title: 3D Importer
5151
path: /art/modeling/3d-importer
52+
- title: glTF Export
53+
path: /art/modeling/gltf-export
5254
- title: Roblox Blender plugin
5355
path: /art/modeling/roblox-blender-plugin
5456

content/en-us/art/accessories/creating-rigid/modeling-setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ Create the rounded lid shape using segmentation:
3737

3838
1. Near the Edit mode dropdown, select the Line selection.
3939
2. Holding <kbd>Shift</kbd>, click the top front and back lines of your chest.
40-
3. With both lines selected, press <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>B</kbd> to Bevel.
40+
3. With both lines selected, press <kbd>Ctrl</kbd><kbd>B</kbd>/<kbd></kbd><kbd>B</kbd> to bevel.
4141
4. In the context menu at the bottom right, set the number of segments to `6` and enable **Clamp Overlap**.
4242

4343
### Merge vertices
4444

45-
Sometimes tools like the Bevel tool may move vertices very close to each other without merging them. Use the Merge Vertices function to ensure that your object shares vertices wherever possible.
45+
Sometimes tools like the **Bevel** tool may move vertices very close to each other without merging them. Use the Merge Vertices function to ensure that your object shares vertices wherever possible.
4646

4747
1. Near the Edit mode dropdown, select the Vertices selection.
4848
2. Press <kbd>A</kbd> to select all vertices.
@@ -74,7 +74,7 @@ To create your vertical loop cuts:
7474

7575
1. Near the Edit mode dropdown, select the Line selection.
7676
2. Press <kbd>A</kbd> to select the entire chest.
77-
3. Use <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>R</kbd> to create a Loop Cut.
77+
3. Use <kbd>Ctrl</kbd><kbd>R</kbd>/<kbd></kbd><kbd>R</kbd> to create a loop cut.
7878
4. Using your mouse, hover over the object until the highlighted cut is vertical. Click to confirm.
7979
5. In the context menu, set the number of cuts to `2`.
8080
6. With the new lines selected, press <kbd>S</kbd> to scale and <kbd>Y</kbd> to scale within the y-axis.
@@ -86,7 +86,7 @@ To create your vertical loop cuts:
8686

8787
To create your horizontal loop cuts:
8888

89-
1. Select the chest, and press <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>R</kbd> to loop cut.
89+
1. Select the chest, and press <kbd>Ctrl</kbd><kbd>R</kbd>/<kbd></kbd><kbd>R</kbd> to loop cut.
9090
2. Using the mouse, click to confirm a horizontal cut.
9191
3. Using the context menu, set the number of cuts to `2`.
9292
4. To straighten each line across your object, select the one of your new lines:
@@ -103,7 +103,7 @@ To create your horizontal loop cuts:
103103
Create the extrusions for the front, top, and back of the chest.
104104

105105
1. Near the Edit mode dropdown, select the Face selection.
106-
2. Hold <kbd>Alt</kbd>/<kbd>Option</kbd> and click on your front faces to select the front, top, and back faces.
106+
2. Hold <kbd>Alt</kbd>/<kbd></kbd> and click on your front faces to select the front, top, and back faces.
107107
3. With the faces selected, hold <kbd>Shift</kbd> and click on the metal borders to deselect them. The front and back faces, and the top segmentations, should remain selected.
108108
4. Right click and select **Extrude Faces Along Normals**. Drag the mouse to extrude the faces about the same width as the metal borders.
109109

content/en-us/art/accessories/creating-rigid/texturing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Switch to Texture Paint mode and use the paintbrush to track the "wood" parts of
5959
2. Switch to **Texture Paint** mode. A side-by-side panel displays with your 2D atlas on the left and the 3D object on the right.
6060
3. Expand the Tool submenu in the top-right of either window.
6161
4. Select your brush settings and mark the wooden areas of your chest.
62-
1. Use <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>Z</kbd> to undo any accidental brushes on the metal border.
62+
1. Use <kbd>Ctrl</kbd><kbd>Z</kbd>/<kbd></kbd><kbd>Z</kbd> to undo any accidental brushes on the metal border.
6363
2. Hold <kbd>F</kbd> and drag the mouse to adjust brush size.
6464

6565
### Paint 2D map
@@ -72,7 +72,7 @@ With all of the wooden areas of your chest marked, you can now quickly texture y
7272
1. Set the **Falloff** shape to the flattest icon to ensure the edges are sharp.
7373
2. Set the color or any other brush settings here.
7474
2. In the left window, begin coloring in each island of your texture. You can quickly preview the changes on your 3D object on the right side.
75-
1. Use <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>Z</kbd> to undo any accidental brushes on the metal border.
75+
1. Use <kbd>Ctrl</kbd><kbd>Z</kbd>/<kbd></kbd><kbd>Z</kbd> to undo any accidental brushes on the metal border.
7676
2. Hold <kbd>F</kbd> and drag the mouse to adjust brush size.
7777
3. After completion, navigate to **Image** > **Save** to save your image file.
7878

content/en-us/art/blender.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ The **Grab** tool lets you move objects, vertices, edges, and faces from the 3D
395395
To use the Grab tool:
396396

397397
1. In either **Object** or **Edit** mode, select one or multiple objects, vertices, edges, or faces.
398-
1. Press the <kbd>G</kbd> hotkey to activate the tool.
398+
1. Press <kbd>G</kbd> to activate the tool.
399399
1. Move the mouse to reposition your selection. For further precision:
400400
- Press <kbd>X</kbd>, <kbd>Y</kbd>, or <kbd>Z</kbd> after you press <kbd>G</kbd> to constrain movement to the **X**, **Y**, or **Z** axis, respectively.
401401
- Double-press an axis key to slide vertices or edges along their natural path.
@@ -437,7 +437,7 @@ To use the Snap tool:
437437
- **Move** - Snaps while moving the selection.
438438
- **Rotate** - Snaps while rotating the selection.
439439
- **Scale** - Snaps while scaling the selection.
440-
1. Press <kbd>Shift</kbd> + <kbd>Tab</kbd> to activate the tool.
440+
1. Press <kbd>Shift</kbd><kbd>Tab</kbd> to activate the tool.
441441
1. For further precision, hold <kbd>Shift</kbd> to snap the selection in finer increments.
442442
1. Move, rotate, or scale an object or mesh element according to your settings.
443443

@@ -454,7 +454,7 @@ The **Inset** tool lets you create an inset with adjustable thickness and depth
454454
To use the Inset tool:
455455

456456
1. In **Edit** mode, select one or multiple faces.
457-
1. Press the <kbd>I</kbd> hotkey to activate the tool.
457+
1. Press <kbd>I</kbd> to activate the tool.
458458
1. Move the mouse to adjust your inset's size. For further precision:
459459
- Hold <kbd>Ctrl</kbd> to adjust the depth of the inset.
460460
- Hold <kbd>Shift</kbd> while moving your mouse to slow down movement for fine adjustments.
@@ -474,7 +474,7 @@ The **Extrude** tool lets you create new geometry by pulling out new faces, edge
474474
To use the Extrude tool:
475475

476476
1. In **Edit** mode, select one or multiple vertices, edges, or faces.
477-
1. Press the <kbd>E</kbd> hotkey to activate the tool.
477+
1. Press <kbd>E</kbd> to activate the tool.
478478
1. Move the mouse to adjust your extrusion's length. For further precision, press <kbd>X</kbd>, <kbd>Y</kbd>, or <kbd>Z</kbd> after you press <kbd>E</kbd> to constrain movement to the **X**, **Y**, or **Z** axis, respectively.
479479
1. Left-click or press <kbd>Enter</kbd> to confirm your extrusion(s).
480480

@@ -515,7 +515,7 @@ The **Bridge Edge Loops** tool lets you connect multiple edge loops with faces.
515515
To use the Bridge Edge Loops tool:
516516

517517
1. In **Edit** mode, select two or more edge loops that you want to connect.
518-
1. Press the <kbd>Ctrl</kbd> + <kbd>E</kbd> hotkey to display a contextual menu for your active edge loops, then select **Bridge Edge Loops** to activate the tool.The **Bridge Edge Loops** panel displays.
518+
1. Press <kbd>Ctrl</kbd><kbd>E</kbd>/<kbd>⌘</kbd><kbd>E</kbd> to display a contextual menu for your active edge loops, then select **Bridge Edge Loops** to activate the tool.The **Bridge Edge Loops** panel displays.
519519
1. Set **Number of Cuts** to the number of subdivisions you want for your new bridge.
520520
1. **(Optional)** For further precision for curved bridges, increase **Smoothness** to create a more rounded bridge.
521521
1. Left-click to confirm your bridge.
@@ -533,7 +533,7 @@ The **Fill** tool lets you create triangular faces between any active edges or v
533533
To use the Fill tool:
534534

535535
1. In **Edit** mode, select at least three vertices or two or more edges that form at least one complete perimeter.
536-
1. Press <kbd>Alt</kbd> + <kbd>F</kbd> to activate the tool.
536+
1. Press <kbd>Alt</kbd><kbd>F</kbd>/<kbd>⌥</kbd><kbd>F</kbd> to activate the tool.
537537
1. **(Optional)** In the **Fill** panel, enable **Beauty** to arrange the triangles nicely.
538538
1. Left-click to confirm your new face.
539539

@@ -550,7 +550,7 @@ The **New Faces from Edges** tool lets you either create an edge if only two ver
550550
To use the New Faces from Edges tool:
551551

552552
1. In **Edit** mode, select at least three vertices, or two or more edges that form one or more complete perimeters.
553-
1. Press the <kbd>F</kbd> hotkey to activate the tool.
553+
1. Press <kbd>F</kbd> to activate the tool.
554554
1. Left-click to confirm your new face.
555555

556556
<Alert severity="info">
@@ -584,7 +584,7 @@ The **Delete** tool lets you completely remove geometry from your meshes, leavin
584584
To use the Delete tool:
585585

586586
1. In **Edit** mode, select the vertices, edges, or faces that you want to remove from your mesh.
587-
1. Press the <kbd>X</kbd> hotkey to display a contextual menu for your selection.
587+
1. Press <kbd>X</kbd> to display a contextual menu for your selection.
588588
1. Choose one of the following menu items:
589589
1. Select **Vertices** to delete all active vertices, removing any faces or edges they are connected to.
590590
1. Select **Edges** to delete all active edges, removing any faces that the edge shares with it.
@@ -698,7 +698,7 @@ To use the Mark Seam tool:
698698

699699
1. Open the **UV Editing** workspace. The UV Editor displays on the lefthand side of the screen, and the 3D viewport displays on the righthand side of the screen in Edit mode.
700700
1. In the **3D Viewport**, navigate to your 3D object, then select the edges where you want to create seams.
701-
1. Press the <kbd>Ctrl</kbd> + <kbd>E</kbd> hotkey to open the **Edge** contextual menu.
701+
1. Press <kbd>Ctrl</kbd><kbd>E</kbd>/<kbd>⌘</kbd><kbd>E</kbd> to open the **Edge** contextual menu.
702702
1. Select **Mark Seam**. The seam turns red and is ready for the Unwrap tool.
703703

704704
When you are ready to unwrap your object, Blender will unwrap the enclosed faces of the seam as its own island.
@@ -728,7 +728,7 @@ To use the Unwrap tool:
728728

729729
1. Open the **UV Editing** workspace. The UV Editor displays on the lefthand side of the screen, and the 3D viewport displays on the righthand side of the screen in Edit mode.
730730
1. In the **3D Viewport**, navigate to your 3D object, then either use the **Mark Seam** tool to create seams, and/or select the specific faces you want to texture.
731-
1. Press the <kbd>U</kbd> hotkey to open the **UV Mapping** contextual menu.
731+
1. Press <kbd>U</kbd> to open the **UV Mapping** contextual menu.
732732
1. Select **Unwrap**. Your selection's UV islands display neatly in the UV Editor.
733733
1. In the **UV Editor**, move, scale, or rotate UV islands to the appropriate position, orientation, and scale on your texture.
734734

@@ -749,11 +749,11 @@ To use the Follow Active Quads tool:
749749
1. Open the **UV Editing** workspace. The UV Editor displays on the lefthand side of the screen, and the 3D viewport displays on the righthand side of the screen in Edit mode.
750750
1. In the **3D Viewport**, navigate to your 3D object, then unwrap every face you want to texture using an active face.
751751
1. **(Optional)** Configure your active face.
752-
1. In the **UV Editor**, select the face you want to be your active face, then press <kbd>Option</kbd> + <kbd>M</kbd> hotkey to open the **Split** contextual menu.
752+
1. In the **UV Editor**, select the face you want to be your active face, then press <kbd>Alt</kbd><kbd>M</kbd>/<kbd>⌥</kbd><kbd>M</kbd> to open the **Split** contextual menu.
753753
1. Select **Selection**. The active face separates from the UV island.
754754
1. Move, scale, or rotate your active face to the appropriate position, orientation, and scale that you want other faces in the UV map to follow.
755755
1. In the **UV Editor**, select all faces you want to follow the active face. Make sure to select your active face last so that Blender knows to use its layout as the guide.
756-
1. Press the <kbd>U</kbd> hotkey to open the **Unwrap** contextual menu, then select **Follow Active Quads**. Blender aligns your selection's UV coordinates to match the active face's shape and orientation.
756+
1. Press <kbd>U</kbd> to open the **Unwrap** contextual menu, then select **Follow Active Quads**. Blender aligns your selection's UV coordinates to match the active face's shape and orientation.
757757

758758
<Alert severity="info">
759759
For more information on this tool, see Blender's official [UV Operators - Follow Active Quads](https://docs.blender.org/manual/en/latest/modeling/meshes/editing/uv.html#follow-active-quads) documentation.
@@ -786,7 +786,7 @@ To use a projection tool:
786786

787787
1. Open the **UV Editing** workspace. The UV Editor displays on the lefthand side of the screen, and the 3D viewport displays on the righthand side of the screen in Edit mode.
788788
1. In the **3D Viewport**, navigate to your 3D object, then select every face.
789-
1. Press the <kbd>U</kbd> hotkey to open the **UV Mapping** contextual menu, then select one of the following options:
789+
1. Press <kbd>U</kbd> to open the **UV Mapping** contextual menu, then select one of the following options:
790790
- **Cube Projection**
791791
- **Sphere Projection**
792792
- **Cylinder Projection**
@@ -855,10 +855,10 @@ To vertex paint:
855855
1. Apply color to your object.
856856
1. To apply color to individual vertices:
857857
1. In the **3D Viewport**, click and drag over your object's vertices to apply your color with a smooth gradient.
858-
1. For further precision, press the <kbd>[</kbd> or <kbd>]</kbd> hotkey to increase or decrease the brush size, respectively.
858+
1. For further precision, press <kbd>[</kbd> or <kbd>]</kbd> to increase or decrease the brush size, respectively.
859859
1. To flood fill your color,
860860
1. In **Edit** mode, select the vertices or faces that you want to apply your color.
861-
1. In **Vertex Paint** mode, press the <kbd>Ctrl</kbd> + <kbd>X</kbd> hotkey. Your selected vertices or faces display the new color.
861+
1. In **Vertex Paint** mode, press <kbd>Ctrl</kbd><kbd>X</kbd>/<kbd>⌘</kbd><kbd>X</kbd>. Your selected vertices or faces display the new color.
862862

863863
<Alert severity="info">
864864
For more information on this process, see Blender's official [Vertex Paint](https://docs.blender.org/manual/en/latest/sculpt_paint/vertex_paint/index.html) documentation.
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: 3D Export
3+
description: 3D Importer imports third-party .fbx, .gltf, and .obj 3D model assets into Studio.
4+
---
5+
6+
import BetaAlert from '../../includes/beta-features/beta-alert.md'
7+
8+
<BetaAlert betaName="glTF Export" leadIn="This feature is currently in beta. Enable it through " leadOut="." components={props.components} />
9+
10+
You can export your 3D Roblox assets as a **.glTF** ([GL Transmission Format](https://en.wikipedia.org/wiki/GlTF)) file format. This open standard format allows for efficient transfer of 3D assets and associated data between Studio and other software, such as Blender or Maya.
11+
12+
<br />
13+
Some common use cases for .glTF export includes:
14+
15+
- Running [Avatar auto setup](../../avatar-setup/index.md#auto-setup), exporting the output and finalizing the meshes, cages, or rigging in a third-party tool.
16+
- Exporting your entire place for high-fidelity scene renders in another 3D application.
17+
- Creating 3D content in Studio, such as part-based models or editable meshes and making modifications in an external application.
18+
19+
Keep in mind that glTF supports specific 3D [components](#supported-components), has some [limitations](#limitations), and requires correct [permissions](#limitations) to export assets from Studio. Some of these specifications may change over the course of the beta.
20+
21+
## Supported components
22+
23+
glTF export supports the following types of 3D data:
24+
25+
- Meshes
26+
- Textures
27+
- Rigging and skinning data
28+
- Vertex colors
29+
- Cages
30+
- Dynamic head FACS data.
31+
32+
## Limitations
33+
34+
<Alert severity = 'warning'>
35+
See the beta announcement for the latest information on limitations and currently known bugs.
36+
</Alert>
37+
38+
At this time, glTF has the following limitations:
39+
40+
- Does not support animation data.
41+
- Inconsistent support for layered clothing — clothing accessories may not always position correctly and won't deform to avatar bodies outside of Roblox.
42+
43+
## Permissions
44+
45+
<Alert severity = 'warning'>
46+
See the beta announcement for the latest information on permissions and upcoming changes.
47+
</Alert>
48+
49+
You must have the correct permissions to export assets as .glTF. When exporting .glTF, Studio verifies that you have permissions to export that asset and may warn you if there are any conflicts.
50+
51+
<br />
52+
You can export the following assets:
53+
54+
- Assets directly uploaded to your account
55+
- Assets directly uploaded to one of your group accounts
56+
- Mesh and image assets that have been explicitly shared with you or your group
57+
58+
You cannot export the following assets:
59+
60+
- Avatar Marketplace assets
61+
- Acquired Creator Store assets
62+
- Shared collaborator assets where the underlying meshes/images have not been explicitly shared
63+
- Other `Open Use` (public) assets that have not been explicitly shared with you or your group
64+
65+
## How to use .glTF export
66+
67+
<BetaAlert betaName="glTF Export" leadIn="This feature is currently in beta. Enable it through " leadOut="." components={props.components} />
68+
69+
You can export selected items from the Explorer, or export the entire place.
70+
71+
<br />
72+
To export from the Explorer:
73+
74+
1. Select the items you intend to export.
75+
2. Right-click and navigate to **Save / Export** > **Export as glTF**.
76+
3. Follow the prompts on screen to fine-tune your export components. Click **Export** when ready.
77+
1. After clicking Export, Studio runs a permission check. If there are any permission conflicts, a permission prompt appears with additional details.
78+
4. In the file browser, select a location to save the .glTF file.
79+
80+
To export an entire place:
81+
82+
1. Navigate to **File** > **Export as glTF**.
83+
2. Follow the prompts on screen to fine-tune your export components. Click **Export** when ready.
84+
1. After clicking Export, Studio runs a permission check. If there are any permission conflicts, a permission prompt appears with additional details.
85+
3. In the file browser, select a location to save the .glTF file.

content/en-us/art/test-classic-clothing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Classic clothing
3-
description: Classic clothing are decals you can apply to a classic character model's surface. You can create classic clothing items on Roblox and upload them to the Marketplace.
2+
title: Test classic clothing
3+
description: How to test your classic clothing items before uploading them to the Marketplace.
44
---
55

66
<Alert severity="warning">

content/en-us/art/upload-classic-clothing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Classic clothing
3-
description: Classic clothing are decals you can apply to a classic character model's surface. You can create classic clothing items on Roblox and upload them to the Marketplace.
2+
title: Upload classic clothing
3+
description: How to upload your classic clothing to the Marketplace and check moderation status.
44
---
55

66
<Alert severity="warning">
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)