Skip to content

Commit 48f8abf

Browse files
authored
Merge branch 'main' into audioanalyzer-empty-array
2 parents 57a390e + d95caa4 commit 48f8abf

File tree

14 files changed

+388
-259
lines changed

14 files changed

+388
-259
lines changed

content/common/navigation/engine/guides.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,8 @@ navigation:
428428
section:
429429
- title: Overview
430430
path: /chat/in-experience-text-chat
431+
- title: Guidelines
432+
path: /chat/guidelines
431433
- title: Customization
432434
path: /chat/customizing-in-experience-text-chat
433435
- title: Bubble Chat
@@ -508,7 +510,7 @@ navigation:
508510
- title: Experience Icons
509511
path: /production/publishing/experience-icons
510512
- title: Experience Thumbnails
511-
path: /production/promotion/thumbnails
513+
path: /production/publishing/thumbnails
512514
- title: Badges
513515
path: /production/publishing/badges
514516
# - title: Accessories
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/assistant/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ As a result, Assistant can act directly on your data model, such as inserting an
2323

2424
For a more in-depth look at what Assistant can do and how to use it, see the [Prompt Guide and Examples](prompt-engineering.md) and the following Roblox Staff livestream for tips, tricks, and inspiration.
2525

26-
<iframe width="640" height="360" src="https://www.youtube.com/embed/vMaOGgeuR4Y?si=fuX-80mMMzhQB6sn&amp;start=240" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
26+
<iframe width="640" height="360" src="https://www.youtube-nocookie.com/embed/vMaOGgeuR4Y?si=fuX-80mMMzhQB6sn&amp;start=240" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
2727

2828
### Insert and Modify Scripts
2929

content/en-us/chat/guidelines.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Usage Guidelines
3+
description: Important guidelines for using the in-experience text chat feature.
4+
comments: Eventually fold the key points of this page into other pages and remove.
5+
---
6+
7+
In-experience text chat is any message created within your experience that originated from one user and is delivered to one or more other users, including:
8+
9+
- Chat bubbles over an avatar's head
10+
- Direct messages between users
11+
- Chat window communication between users
12+
- Team-specific messages
13+
14+
For sending and delivery, these types of communications must each go through a `Class.TextChannel` instance. This ensures messages respect privacy settings, are visible to moderators, and are properly text filtered.
15+
16+
Certain text is **not** considered chat:
17+
18+
- Text on menus created by developers (for example, "Press any button to continue.")
19+
- Status updates from the experience (for example, "Two minutes remaining!")
20+
- Announcements from admin commands
21+
- A user renaming their pet dog
22+
- A user writing on a sign
23+
- Moderation audit logs or messages
24+
- Comments on posts in an experience
25+
26+
<Alert severity="info">
27+
If the comments support a reply feature, these replies would be considered a conversation and thus subject to this policy.
28+
</Alert>
29+
30+
- Writing a post on a bulletin board
31+
- Any user-generated text unrelated to a conversation
32+
33+
For communication shared by users that can be seen by other users, even if it doesn't need to go through `Class.TextChatService`, you must ensure it goes through a [text filter](../ui/text-filtering.md).
34+
35+
## Requirements
36+
37+
- All experiences that offer in-experience text chat for users must integrate `Class.TextChatService`, per the [Misusing Roblox Systems Community Standard](https://en.help.roblox.com/hc/en-us/articles/203313410-Roblox-Community-Standards).
38+
- Between 30 December 2024 and 30 April 2025, creators that use a custom chat solution not powered by `Class.TextChatService` or a modified or forked [Legacy Chat](legacy/legacy-chat-system.md) can continue to use their existing feature, but must also deploy the `Class.TextChatService:CanUserChatAsync()|CanUserChatAsync()` and `Class.TextChatService:CanUserDirectChatAsync()|CanUserDirectChatAsync()` methods in their experiences.
39+
- After 30 April 2025, all creators must use the `Class.TextChatService` API.
40+
- For more information on migrating, see the [Roblox developer forums](https://devforum.roblox.com/t/migrate-to-textchatservice-removing-support-for-legacy-chat-and-custom-chat-systems/3237100).
41+
- All incoming text that originates from another user must first use [Text Filtering](../ui/text-filtering.md) before your experience displays it.
42+
- Communication between users must respect user privacy settings.
43+
- `Class.TextChannel:SendAsync` handles basic privacy and parental settings automatically.
44+
- `Class.TextChannel:SetDirectChatRequester` must be used to mark `TextChannels` created for direct chat.
45+
- In-experience communication should be [reportable for abuse](https://en.help.roblox.com/hc/en-us/articles/203312410-How-to-Report-Rule-Violations). `TextChannels` handle this automatically.

content/en-us/cloud/legacy.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,32 @@ description: Lists legacy REST APIs for Open Cloud.
55

66
This section contains documentation for Roblox's many legacy APIs.
77

8-
Roblox offers API key and/or OAuth 2.0 support **for the select legacy APIs listed on this page**. Instead of sharing cookies, you can grant access to specific permissions and use these more secure authentication methods. These APIs might change without notice and break your application and do not have the stability guarantees of the newer Open Cloud APIs.
8+
Roblox offers API key and/or OAuth 2.0 support **for the select legacy API endpoints listed on this page**. Instead of sharing cookies, you can grant access to specific permissions and use these more secure authentication methods. These APIs might change without notice and break your application and do not have the stability guarantees of the newer Open Cloud APIs.
99

10-
This page summarizes the available operations and authentication types, but you might find the legacy API documentation useful, as well:
11-
12-
- [Badges API](/cloud/legacy/badges/v1)
13-
- [Develop API](/cloud/legacy/develop/v1)
14-
- [Followings API](/cloud/legacy/followings/v1)
15-
- [Game Internationalization API](/cloud/legacy/gameinternationalization/v1)
16-
- [Groups API](/cloud/legacy/groups/v1)
17-
- [Localization Tables API](/cloud/legacy/localizationtables/v1)
18-
- [Publish API](/cloud/legacy/publish/v1)
10+
This page summarizes the available operations and authentication types.
1911

2012
<Alert severity="warning">
2113
Refer to the left navigation for documentation of legacy APIs that only support cookie authentication and **not** API key and/or OAuth 2.0 authentication.
22-
14+
2315
Just like the legacy APIs listed on this page, those APIs might change without notice. We do not recommend depending on those APIs as they rely on needing to share cookies with application code that interacts with these endpoints.
2416
</Alert>
2517

2618
## Badges API
2719

2820
- Base URL: `https://apis.roblox.com/legacy-badges`
2921
- Authentication types: OAuth 2.0 and API key
30-
22+
- Additional Badges API endpoints without Open Cloud authentication support can be found [here](/cloud/legacy/badges/v1).
23+
- Robux might be required to create a badge. To identify the number of remaining free badges you can create in the specified universe for the current UTC day, use the `/v1/universes/{universeId}/free-badges-quota` endpoint.
3124
| **API** | **Path** | **Scope** |
3225
| :---------- | :-------------------------- | :---------------------------- |
3326
| UpdateBadge | `PATCH v1/badges/{badgeId}` | `legacy-universe.badge:write` |
27+
| CreateBadge | `POST v1/universes/{universeId}/badges` | `legacy-universe.badge:manage-and-spend-robux` |
3428

3529
## Develop API
3630

3731
- Base URL: `https://apis.roblox.com/legacy-develop`
3832
- Authentication types: OAuth 2.0 and API key
33+
- Additional Develop API endpoints without Open Cloud authentication support can be found [here](/cloud/legacy/develop/v1).
3934

4035
| **API** | **Path** | **Scope** |
4136
| :----------------------------------- | :---------------------------------------------------------- | :--------------------------------- |
@@ -48,11 +43,14 @@ This page summarizes the available operations and authentication types, but you
4843
| GetGroupsWithEditGroupGamePermission | `GET v1/user/groups/canmanage` | `legacy-group:manage` |
4944
| ActivateUniverse | `POST v1/universes/{universeId}/activate` | `legacy-universe:manage` |
5045
| DeactivateUniverse | `POST v1/universes/{universeId}/deactivate` | `legacy-universe:manage` |
46+
| GetUniversePermissions | `GET v1/universes/{universeId}/permissions` | `legacy-universe:manage` |
47+
| MultiGetUniversePermissions | `GET v1/universes/multiget/permissions` | `legacy-universe:manage` |
5148

5249
## Followings API
5350

5451
- Base URL: `https://apis.roblox.com/legacy-followings`
5552
- Authentication types: OAuth 2.0 and API key
53+
- Additional Followings API endpoints without Open Cloud authentication support can be found [here](/cloud/legacy/followings/v1).
5654

5755
| **API** | **Path** | **Scope** |
5856
| :----------------- | :---------------------------------------------------- | :-------------------------------- |
@@ -66,6 +64,7 @@ This page summarizes the available operations and authentication types, but you
6664

6765
- Base URL: `https://apis.roblox.com/legacy-game-internationalization`
6866
- Authentication types: OAuth 2.0 and API key
67+
- Additional Game Internationalization API endpoints without Open Cloud authentication support can be found [here](/cloud/legacy/gameinternationalization/v1).
6968

7069
| **API** | **Path** | **Scope** |
7170
| :------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- | :-------------------------------- |
@@ -113,6 +112,7 @@ This page summarizes the available operations and authentication types, but you
113112

114113
- Base URL: `https://apis.roblox.com/legacy-groups`
115114
- Authentication types: OAuth 2.0 and API key
115+
- Additional Groups API endpoints without Open Cloud authentication support can be found [here](/cloud/legacy/groups/v1).
116116

117117
| **API** | **Path** | **Scope** |
118118
| :-------------------------------- | :-------------------------------------------------- | :-------------------- |
@@ -129,6 +129,7 @@ This page summarizes the available operations and authentication types, but you
129129

130130
- Base URL: `https://apis.roblox.com/legacy-localization-tables`
131131
- Authentication types: OAuth 2.0 and API key
132+
- Additional Localization Tables API endpoints without Open Cloud authentication support can be found [here](/cloud/legacy/localizationtables/v1).
132133

133134
| **API** | **Path** | **Scope** |
134135
| :-------------------------------------- | :------------------------------------------------------------------------ | :----------------------- |
@@ -147,6 +148,7 @@ This page summarizes the available operations and authentication types, but you
147148

148149
- Base URL: `https://apis.roblox.com/legacy-publish`
149150
- Authentication types: OAuth 2.0 and API key
151+
- Additional Publish API endpoints without Open Cloud authentication support can be found [here](/cloud/legacy/publish/v1).
150152

151153
| **API** | **Path** | **Scope** |
152154
| :-------------------------------------- | :------------------------------------------------------------------------ | :----------------------- |

content/en-us/production/promotion/referral-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Use referral links to track and reward players that have successful
44
---
55

66
<Alert severity="info">
7-
This feature is still in beta. If you'd like to provide Roblox with feedback about this feature, join the [User Acquisition Referrals](https://www.guilded.gg/i/kbQ4Po42) Guilded group.
7+
This feature is still in beta. If you'd like to provide Roblox with feedback about this feature, join the [User Acquisition Referrals](https://www.guilded.gg/i/EwKQPZWE) Guilded group.
88
</Alert>
99

1010
The friend referral system encourages existing players to bring new players into your experience, increasing player retention and overall engagement. Players can access and share referral links from [player invite prompts](./invite-prompts.md) or directly from the default in-experience invite menu.

0 commit comments

Comments
 (0)