Skip to content

Commit 116a5b8

Browse files
update Open Source Docs from Roblox internal teams
1 parent 3998372 commit 116a5b8

File tree

108 files changed

+1200
-1058
lines changed

Some content is hidden

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

108 files changed

+1200
-1058
lines changed

.github/actions/quality-checks/action.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ inputs:
55
description: Base branch
66
CHECK_LOCALIZED_CONTENT:
77
description: Whether to check localized content
8+
DELETE_MDX_MISMATCHED_ERROR_ON_FAIL:
9+
description: Whether to delete localized files with MDX mismatched errors
810
CHECK_MARKDOWN_LINT:
911
description: Whether to check markdown lint
1012
CHECK_PROTECTED_FIELDS:
@@ -56,6 +58,7 @@ runs:
5658
CHECK_RELATIVE_LINKS: ${{ inputs.CHECK_RELATIVE_LINKS }}
5759
CHECK_RETEXT_ANALYSIS: ${{ inputs.CHECK_RETEXT_ANALYSIS }}
5860
CHECK_UNUSED_ASSETS: ${{ inputs.CHECK_UNUSED_ASSETS }}
61+
DELETE_MDX_MISMATCHED_ERROR_ON_FAIL: ${{ inputs.DELETE_MDX_MISMATCHED_ERROR_ON_FAIL }}
5962
COMMIT_HASH: ${{ inputs.COMMIT_HASH }}
6063
POST_PULL_REQUEST_COMMENTS: ${{ inputs.POST_PULL_REQUEST_COMMENTS }}
6164
PULL_REQUEST_NUMBER: ${{ inputs.PULL_REQUEST_NUMBER }}

CODEOWNERS

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
* @Roblox/creator-knowledge
22

3-
/content/ @Roblox/documentation
4-
/STYLE.md @Roblox/documentation
5-
/content/en-us/education/ @Roblox/documentation @Roblox/education
3+
/content/common/ @Roblox/documentation @Roblox/creator-knowledge
4+
/content/en-us/ @Roblox/documentation
65
/content/en-us/assets/education/ @Roblox/documentation @Roblox/education
6+
/content/en-us/education/ @Roblox/documentation @Roblox/education
77
/tools/checks/utils/allowedHttpLinks.txt @Roblox/creator-knowledge @Roblox/documentation @Roblox/education
88
/tools/checks/utils/do-not-machine-translate.txt @Roblox/creator-knowledge @Roblox/documentation @Roblox/education
9+
/STYLE.md @Roblox/documentation

content/en-us/animation/capture.md

Lines changed: 14 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -7,73 +7,45 @@ import BetaAlert from '../includes/beta-features/beta-alert.md'
77

88
You can record or upload video content to the [Animation Editor](../animation/editor.md) to quickly capture movement and expressions as animation keyframes. These tools can create unique and realistic animations within minutes while providing access to the animation keyframes for additional adjustments.
99

10-
The Animation Capture tools allow you to:
10+
The animation capture tools allow you to:
1111

1212
- [Record your face](#face) with a webcam to puppeteer characters with [animation compatible heads](../art/characters/facial-animation/index.md).
1313
- [Upload full-body video content](#body) to generate high quality realistic animations for an entire character.
1414

1515
## Face
1616

17-
**Animation Capture - Face** allows you to use your camera to puppeteer rigs with [animation compatible heads](../art/characters/facial-animation/index.md) and generate corresponding keyframes to your movement.
17+
**Animation Capture - Face** allows you to use your webcam to puppeteer rigs with [animation compatible heads](../art/characters/facial-animation/index.md) and generate corresponding keyframes to your movement. With the ability to record up to 60‑second animations, you can quickly provide both your playable and nonplayable characters the means to realistically grin, raise their eyebrows, drop their jaw, or any other expression necessary for your experience.
1818

19-
With the ability to record up to 60-second animations, you can quickly provide both your playable and nonplayable characters the means to realistically grin, raise their eyebrows, drop their jaw, or any other expression necessary for your experience.
20-
21-
<video src="../assets/animation/face-recorder/Face-Recorder.mp4" controls width="100%"></video>
22-
23-
<BetaAlert betaName="Face Capture" leadIn="To ensure that you are able to utilize your camera to record and create facial animations, you must first enable the beta feature through " leadOut=". If you do not enable the beta, the Animation Editor only displays its default UI options without face recording functionality." components={props.components} />
24-
25-
### Record face animations
19+
<BetaAlert betaName="Face Capture" leadIn="To ensure that you're able to utilize your camera to record and create facial animations, you must first enable the beta feature through " leadOut="." components={props.components} />
2620

2721
Before you begin to record your face, ensure that you're in a well lit room close enough to your camera so that your face is in the center of your camera's recording frame. This increases your camera's ability to distinguish you from your surroundings so that you can accurately puppeteer your avatar and create high-quality animations.
2822

29-
To record your face and create an animation:
30-
3123
1. From the toolbar's **Avatar** tab, click **Animation**. The [Animation Editor](../animation/editor.md) window displays.
32-
2. In the **Explorer** window, select the rig you want your video to animate. A dialog displays.
33-
34-
<img src="../assets/animation/animation-editor/Create-Animation-Dialog.png"
35-
width="380" />
36-
37-
3. In the **Animation Name** field, enter a new animation name, then click the **Create** button. The **Animation Editor** window displays the media and playback controls, timeline, and track list.
38-
39-
4. Navigate to the **track list** and click the **Face Capture** button. A pop-up displays asking you to acknowledge that you consent to the collection of your facial movements to enable the feature and camera access.
24+
2. In the 3D viewport or the [Explorer](../studio/explorer.md) hierarchy, select the rig you want your video to animate. Enter a new animation name in the dialog window and click the **Create** button.
25+
3. Navigate to the **track list** and click the **Face Capture** button. A popup displays asking you to acknowledge that you consent to the collection of your facial movements to enable the feature and camera access.
4026

4127
<img src="../assets/animation/face-recorder/Face-Recorder-Button.jpg"
4228
width="80%" />
4329

44-
5. (Optional) If you have multiple cameras, choose which camera you want to use to record.
45-
46-
1. Select the **** button. The **Select a camera** dialog displays.
47-
48-
<img src="../assets/animation/face-recorder/Multiple-Cameras.jpg"
49-
width="80%" />
30+
4. <Chip label="OPTIONAL" size="small" variant="outlined" /> If you have multiple cameras, choose which camera you want to use to record.
5031

51-
1. Click the dropdown arrow and select a camera.
52-
1. Click the **Confirm** button.
53-
54-
6. Click the red circle. Your camera begins recording your facial movements.
32+
5. In the controls widget in the 3D viewport, click the red circle. Your camera begins recording your facial movements.
5533

5634
<img src="../assets/animation/face-recorder/Ready-Button.jpg" width="150" />
5735

58-
7. When you finish your recording, click either the red square or countdown timer. Keyframes that correspond to your facial movement display within the timeline.
36+
6. When you finish your recording, click either the red square or countdown timer. Keyframes that correspond to your facial movement display within the timeline.
5937

6038
<img src="../assets/animation/face-recorder/Countdown-Button.jpg" width="150" />
6139

62-
8. (Optional) If you'd like to delete that recording and try again, click the Re-Record button.
63-
64-
<img src="../assets/animation/face-recorder/Re-Record-Button.jpg" width="150" />
40+
7. <Chip label="OPTIONAL" size="small" variant="outlined" /> If you'd like to delete the recording and try again, click **Re‑Record**.
6541

6642
After you finish your recording, you can [fine-tune](../animation/editor.md#keyframes) the keyframes, [save](../animation/editor.md#save-an-animation) your animation, then [export](../animation/editor.md#export-an-animation) it to use across all of your experiences.
6743

6844
## Body
6945

7046
The **Animation Capture - Body** allows you to quickly generate high-quality, realistic full-body animations for your R15 rigs by uploading videos to use to track the body's movement and generate corresponding keyframes. This significantly speeds up the manual process of creating animations, and allows you to personalize your avatars and NPCs with life-like mannerisms in a few minutes.
7147

72-
<video src="../assets/animation/live-animation-creator/Live-Animation-Creator.mp4" controls width="100%"></video>
73-
74-
<BetaAlert betaName="Live Animation Creator" leadIn="To import a video for animation creation, you must first enable the beta feature through " leadOut=". If you do not enable the beta, the Animation Editor only displays its default UI options without live animation creation functionality." components={props.components} />
75-
76-
### Import videos for animation
48+
<BetaAlert betaName="Live Animation Creator" leadIn="To import a video for animation creation, you must first enable the beta feature through " leadOut="." components={props.components} />
7749

7850
Before you import a video to the **Animation Editor**, ensure the `.mp4` or `.mov` file meets the following requirements:
7951

@@ -84,21 +56,12 @@ Before you import a video to the **Animation Editor**, ensure the `.mp4` or `.mo
8456
To import a video to create an animation:
8557

8658
1. From the toolbar's **Avatar** tab, click **Animation**. The [Animation Editor](../animation/editor.md) window displays.
87-
2. In the **Explorer** window, select the R15 rig you want your video to animate. A dialog displays.
88-
89-
<img src="../assets/animation/animation-editor/Create-Animation-Dialog.png"
90-
width="380" />
91-
92-
3. In the **Animation Name** field, enter a new animation name, then click the **Create** button. The editor window displays the media and playback controls, timeline, and track list.
93-
4. Navigate to the **Media and Playback Controls** and click the **** button. A pop-up menu displays.
59+
2. In the 3D viewport or the [Explorer](../studio/explorer.md) hierarchy, select the R15 rig you want your video to animate. Enter a new animation name in the dialog window and click the **Create** button.
60+
3. Navigate to the **media and playback controls** and click the **&ctdot;** button, then navigate to **Import**&nbsp;**Live&nbsp;Animation&nbsp;Creator**.
9461

9562
<img src="../assets/animation/live-animation-creator/Media-Playback-Controls.jpg"width="330" />
9663

97-
5. Hover over **Import**, then click **Live Animation Creator** from the contextual menu. A contextual menu displays.
98-
99-
<img src="../assets/animation/live-animation-creator/Import-Contextual-Menu.jpg"width="60%" />
100-
101-
6. Click the **Choose Video** button.
102-
7. Select the video you want to import from your local machine, then click the **Open** button. After about a minute, keyframes that correspond to movement in your video display within the timeline.
64+
4. In the popup dialog, click the **Choose Video** button.
65+
5. Select the video you want to import from your local machine, then click the **Open** button. After about a minute, keyframes that correspond to movement in your video display within the timeline.
10366

10467
After your import is successful, you can [save](../animation/editor.md#save-an-animation) and [export](../animation/editor.md#export-an-animation) your animation to use across all of your experiences.

0 commit comments

Comments
 (0)