Skip to content

Commit e44e6fa

Browse files
update Open Source Docs from Roblox internal teams
1 parent b777ea9 commit e44e6fa

File tree

5 files changed

+26
-24
lines changed

5 files changed

+26
-24
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ To ensure that avatar sizes are visually consistent, you must standardize body p
455455
- **Opacity** - Body parts must be fully opaque.
456456
- **Bounding Boxes** - Body part assets must take up a significant visible portion of their bounding box in a front, side, and back view.
457457
- Body parts, such as Torso, Left Arm, Right Leg, must take up at least 50% of body part's bounding box.
458-
- The head part must take up at least 35% of the mesh's bounding box.
458+
- The head part must take up at least 50% of the mesh's bounding box.
459459
<GridContainer numColumns="2">
460460
<figure>
461461
<img src="../../assets/art/avatar/Valid-Visibility.png" />

content/en-us/cloud/auth/api-keys.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ authenticate to Open Cloud on your behalf.
1515
## Create API keys
1616

1717
You can create and configure API keys for your individually-owned
18-
experiences or group-owned experiences (A Roblox
19-
[group](../../projects/groups.md) allows multiple creators to work on the same
20-
experience, use the same assets, and share API keys).
18+
experiences or [group-owned](../../projects/groups.md) experiences.
2119

2220
You must be the group owner or assigned to a role within the group that has the
2321
API key admin permission in order to create an API key for your group. A group
@@ -29,36 +27,37 @@ To create an API key:
2927

3028
1. Navigate to the [Creator Dashboard](https://create.roblox.com/dashboard/creations).
3129
1. **(Optional)** Click the **Creator Hub** dropdown to select a group if you are creating the API key for a group.
32-
1. In the left navigation menu, select **Open Cloud** &rarr; **API Keys**.
30+
1. In the left navigation menu, select **Open Cloud** &rarr; [API Keys](https://create.roblox.com/dashboard/credentials?activeTab=ApiKeysTab).
3331
1. Click the **Create API Key** button.
3432
1. Enter a unique name for your API key. Use a name that can help you recall the
3533
purpose later, such as `PLACE_PUBLISHING_KEY` for publishing places to your
3634
experience.
3735
1. In the **Access Permissions** section, select an API from the **Select API
38-
System** menu and click the **Add API System** button. Repeat this step if
36+
System** menu. Repeat this step if
3937
you need to add multiple APIs to the key.
4038

4139
<Alert severity="info">
4240
Certain permissions, generally those with the `legacy` prefix, aren't available for group-owned API keys. To add those permissions and send requests to the associated endpoints, you must use a user-owned API key.
4341
</Alert>
4442

45-
1. Select the experience that you want to access with the API key.
46-
1. From the **Experience Operations** dropdown, select the operations that you
43+
1. If applicable, select the experience that you want to access with the API key.
44+
1. From the **Select Operations** dropdown, select the operations that you
4745
want to enable for the API key.
4846

49-
Many operations in the [API reference](../index.md) include the required permission scopes. For example, the [flush memory store](/cloud/reference/MemoryStore#Cloud_FlushMemoryStore) operation requires the `universe.memory-store:flush` permission.
47+
Most operations in the [API reference](../index.md) include the required permission scopes. For example, the [flush memory store](/cloud/reference/MemoryStore#Cloud_FlushMemoryStore) operation requires the `universe.memory-store:flush` permission.
48+
49+
For a list of all scopes and the APIs they support, see [Scopes](../reference/scopes.md).
5050

5151
<Alert severity="warning">
5252
For security reasons, give each API key the minimum number of required permissions. If an API key leaks, this principle of least privilege ensures that only a subset of your resources are compromised.
5353
</Alert>
5454

55-
1. In the **Security** section, explicitly set IP access to the key using [CIDR
56-
notation](#cidr-format), otherwise you can't use the API key. You can find
55+
1. (Optional) In the **Security** section, explicitly restrict IP access to the key using [CIDR
56+
notation](#cidr-format). You can find
5757
the IP address of your local machine and add it to the **Accepted IP
5858
Addresses** section along with additional IP addresses for those that need
5959
access. If you don't have a fixed IP, or you are using the API key only in a
60-
local environment, you can just add `0.0.0.0/0` to the **Accepted IP
61-
Addresses** section to allow any IPs to use your API key.
60+
local environment, you can leave the `Restrict IP addresses` toggle unchecked to allow any IP to use your API key.
6261

6362
1. **(Optional)**: To add additional protection for your resources, set an
6463
explicit expiration date so your key automatically stops working after that

content/en-us/performance-optimization/improve.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -379,8 +379,8 @@ same `MeshId` are handled in a single draw call when:
379379

380380
- **Excessive shadow casting** - Handling shadows is an expensive process, and
381381
maps that contain a high number and density of light objects that cast shadows
382-
(or a high number and density of small parts influenced by shadows) are likely to
383-
have performance issues.
382+
(or a high number and density of small parts influenced by shadows) can have
383+
performance issues.
384384

385385
- **High transparency overdraw** - Placing objects with partial transparency
386386
near each other forces the engine to render the overlapping pixels multiple
@@ -410,21 +410,24 @@ same `MeshId` are handled in a single draw call when:
410410
**Performance**. This allows meshes to fall back to less complex
411411
alternatives, which can reduce the number of polygons that need to be drawn.
412412
- **Disabling shadow casting on appropriate parts and light objects** - The
413-
complexity of the shadows in a scene can be reduced by selectively disabling
414-
shadow casting properties on light objects and parts. This can be done at edit
415-
time or dynamically at runtime. Some examples are:
413+
Roblox engine automatically degrades shadow quality as client graphics quality
414+
level decreases, eventually disabling shadows altogether at quality levels
415+
below 4. However, you can selectively disable shadow casting properties on
416+
light objects and parts to improve performance while shadows are enabled and
417+
increase the likelihood that shadows remain enabled. Some examples of
418+
optimizations you can make either at edit time or dynamically at runtime:
416419
- Use the `Class.BasePart.CastShadow` property to disable shadow casting on
417-
small parts where shadows are unlikely to be visible. This can be
418-
particularly effective when only applied to parts that are far away from the
420+
small parts where shadows are unlikely to be visible. This strategy is
421+
particularly effective when applied to parts that are far away from the
419422
user's camera.
420423

421424
<Alert severity="warning">
422425
This might result in visual artifacts on shadows.
423426
</Alert>
424427

425428
- Disable shadows on moving objects when possible.
426-
- Disable `Class.Light.Shadows` on light instances where the object does
427-
not need to cast shadows.
429+
- Disable `Class.Light.Shadows` on light instances where the object does not
430+
need to cast shadows.
428431
- Limit the range and angle of light instances.
429432
- Use fewer light instances.
430433
- Consider disabling lights that are outside of a specific range or on a

content/en-us/production/publishing/dmca-guidelines.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ The **Digital Millennium Copyright Act** ("DMCA") allows copyright holders or th
4949

5050
If you are a copyright owner or an agent of a copyright owner and believe that
5151
any content on Roblox infringes upon your copyrights, you may submit a
52-
notification pursuant to the DMCA by contacting our Copyright Agent at [email protected], or Legal, Roblox Corporation, 970 Park Place, Suite
53-
100, San Mateo, CA 94403. You may also contact us by phone at (888)&nbsp;858-2569.
52+
notification pursuant to the DMCA by contacting our [Copyright Agent](mailto:[email protected]), or Legal, Roblox Corporation, 3150 S. Delaware St. San Mateo, CA 94403. You may also contact us by phone at (888)&nbsp;858-2569.
5453

5554
- **What information must I provide when filing a DMCA claim?**
5655

tools/checks/utils/allowedHttpLinks.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -709,3 +709,4 @@ https://github.com/roblox/roact-performance-benchmarks
709709
https://github.com/roblox/graphql-lua
710710
https://github.com/roblox/graphql-tag-lua
711711
https://github.com/roblox/apollo-client-lua
712+
https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation

0 commit comments

Comments
 (0)