Skip to content

Commit d04b862

Browse files
update Open Source Docs from Roblox internal teams
1 parent e9513c4 commit d04b862

File tree

8 files changed

+101
-44
lines changed

8 files changed

+101
-44
lines changed

content/common/navigation/engine/guides.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -601,6 +601,8 @@ navigation:
601601
path: /production/promotion/experience-notifications
602602
- title: Social media links
603603
path: /production/promotion/social-media-links
604+
- title: Share links
605+
path: /production/promotion/share-links
604606
- title: Player invite prompts
605607
path: /production/promotion/invite-prompts
606608
- title: Friend invite reward system
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/production/analytics/acquisition.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ Here's a list of all the available acquisition sources:
6464
</tr>
6565
<tr>
6666
<td>Sponsored ads</td>
67-
<td>Acquisition from [Sponsored Experiences](../promotion/ads-manager.md#sponsored-experiences) and **Sponsored Takeovers** on **Home**</td>
67+
<td>Acquisition from [sponsored experiences](../promotion/ads-manager.md#sponsored-experiences) and **Sponsored Takeovers** on **Home**</td>
6868
</tr>
6969
<tr>
7070
<td>Search ads</td>
71-
<td>Acquisition from [Search Ads](../promotion/search-ads.md)</td>
71+
<td>Acquisition from [search ads](../promotion/search-ads.md)</td>
7272
</tr>
7373
<tr>
7474
<td>Portal ads</td>
75-
<td>Acquisition from [Portal Ads](../promotion/ads-manager.md#portal-ads)</td>
75+
<td>Acquisition from [portal ads](../promotion/ads-manager.md#portal-ads)</td>
7676
</tr>
7777
<tr>
7878
<td>Teleport</td>
@@ -86,7 +86,7 @@ Here's a list of all the available acquisition sources:
8686

8787
## Acquisition attribution
8888

89-
The dashboard categorizes results for each acquisition source as follows:
89+
You can view the acquisition dashboard by [acquisition source](#acquisition-sources) or by [share links](../promotion/share-links.md). The dashboard categorizes results for both views as follows:
9090

9191
<table>
9292
<tr>
@@ -119,7 +119,7 @@ The dashboard categorizes results for each acquisition source as follows:
119119
</tr>
120120
</table>
121121

122-
<img src="../../assets/analytics/acquisition/New-Users-Funnel.png" width= "100%" alt="Chart indicating new users funnel."/>
122+
<img src="../../assets/analytics/acquisition/New-Users-Funnel.png" width= "100%" alt="Chart indicating new users funnel by acquisition source."/>
123123

124124
## Improve acquisition
125125

@@ -161,3 +161,10 @@ Here are some tips to get users to visit your experience from external sources:
161161
1. **Create social accounts and post regularly**: Add social accounts such as Twitter, YouTube, and Instagram to your Roblox Experience Detail Page. Share regular updates, teasers, and screenshots to build buzz for your experience. Reply to other large social accounts to grow your following.
162162
2. **Create a user community**: Users in your community can share feedback, suggestions, bug reports, fan art, and more. Engage with your community regularly by hosting events and replying to comments and suggestions.
163163
3. **Partner with other creators and influencers**: You can partner with other creators who make similar experiences to grow together. You can also reach out to influencers who have large followings on platforms like YouTube or Twitch to see if they're willing to use or review your experience.
164+
4. **Create [share links](../promotion/share-links.md)**: Track your off-platform user acquisition and use the **New users funnel** table to understand:
165+
- **Users with qualified plays**: How many new users are joining from each link?
166+
- **7-day playtime per user**: Which links are bringing in users who engage the most?
167+
- **D7 retention**: Which platforms drive users that keep coming back?
168+
- **30-day revenue per user**: Which channels are attracting users who spend in-experience?
169+
170+
<img src="../../assets/analytics/acquisition/Share-Link-Acquisition-Dashboard.png" width= "100%" alt="Chart indicating new users funnel by share links."/>

content/en-us/production/analytics/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ Your similar experience benchmarks are updated daily. Roblox does not use these
7171

7272
- Monitor the analytics of multiple experiences at once
7373
- Track avatar item sales and revenue
74+
- Track user acquisition through off-platform share links
7475

7576
### Monitor experiences
7677

@@ -112,6 +113,10 @@ Avatar items you've sold automatically appear within the **Avatar Items** tab. H
112113
<figcaption>Avatar Items on Analytics Home.</figcaption>
113114
</figure>
114115

116+
### Track user acquisition
117+
118+
The **Share Links** tab provides information about the **Link Visits** metric, which tracks how many users have arrived on your experience details page by clicking on the share link you created.
119+
115120
## Analytics insights
116121

117122
In each experience's overview page, there are insights that highlight major weekly changes in key metrics and areas of improvement.

content/en-us/production/promotion/index.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,13 @@ The following table details promotional methods for experiences on the platform.
4040
<td>**Player invite prompts**</td>
4141
<td>[Player invite prompts](../../production/promotion/invite-prompts.md), implemented directly inside your experience, encourage players to invite their friends and increase co‑experience gameplay.</td>
4242
</tr>
43+
<tr>
44+
<td>**Friend invite reward system**</td>
45+
<td>The [friend reward invite system](../../production/promotion/referral-system.md) rewards existing users for bringing in new users to your experiences.</td>
46+
</tr>
4347
<tr>
4448
<td>**Experience notifications**</td>
45-
<td>[Experience Notifications](../../production/promotion/experience-notifications.md) are a way for 13+ users to keep up with their favorite experiences through timely, personalized notifications. As the developer, you can determine what kinds of in‑experience activities are most important to notify your users about, as well as define the notification content.</td>
49+
<td>[Notifications](../../production/promotion/experience-notifications.md) are a way for 13+ users to keep up with their favorite experiences through timely, personalized notifications. As the developer, you can determine what kinds of in‑experience activities are most important to notify your users about, as well as define the notification content.</td>
4650
</tr>
4751
<tr>
4852
<td>**Special sort categories on Roblox channels**</td>
@@ -72,10 +76,16 @@ The following table details promotional methods for avatar items on the platform
7276

7377
## Social media
7478

75-
You can direct users to follow you on social media by embedding social media links on your experience's main details page. Social media links connect your audience over the age of 13 to your social media outside of Roblox, which you can use to market updates, monitor community feedback, and promote your experiences. For more information, see [Social media links](../../production/promotion/social-media-links.md).
79+
[Social media links](./social-media-links.md) are links to your social media channels. Use social media links to promote your social media presence by embedding these links on your experience details page.
7680

7781
<img src="../../assets/promotion/misc/Social-Links-Example.png" width="540" />
7882

83+
## Share links
84+
85+
[Share links](./share-links.md) are links to your Roblox experiences. Use share links on your social media to promote your Roblox experiences and to track metrics for acquisition through off-platform channels.
86+
87+
Unlike social media links, which direct users to your social media channels, share links promote and direct users to your Roblox experiences.
88+
7989
## Communities
8090

8191
[Communities](../../projects/groups.md) can serve as a form of marketing for the experiences that you publish through them. Users playing an experience often engage with the creator of the experience, which in this case is the group page. Here, users can find social links, follow related communities for new content, and post on comment boards.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Share links
3+
description: How to create and use share links to promote your experiences and track acquisition metrics.
4+
---
5+
6+
Share links are unique and trackable links that generate metrics that allow you to track and grow your off-platform user acquisition. You can also use custom `Class.Player:GetJoinData()|LaunchData` to provide in-experience perks to users that join through your share link.
7+
8+
The analytics available for share links include metrics like how many new users have arrived at the experience details page through a share link, and which off-platform channel has brought in the most engaged users. There is no limit to how many share links you can create per experience; creating different links for different channels can help you keep better track of acquisition metrics.
9+
10+
For more information on the analytics for share links, see the [Acquisition](../analytics/acquisition.md) page.
11+
12+
## Create a share link
13+
14+
<Alert severity="warning">
15+
You can only create share links for experiences you own. For group-owned experiences, you must be a member of the group and the share link must be created from the group account.
16+
</Alert>
17+
18+
To create a share link:
19+
20+
1. In the Creator Hub, go to **Creations** and select the **Share Links** tab.
21+
2. Click **Create link**.
22+
3. Enter a unique campaign name and select the experience you want to create a share link for.
23+
<img src="../../assets/promotion/Share-Link-Creation.png" width="540" />
24+
4. Click **Generate link**.
25+
26+
The new share link generates instantly and is ready to be shared.

content/en-us/reference/engine/enums/KeyCode.yaml

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,20 @@
11
name: KeyCode
22
type: enum
33
summary: |
4-
A physical button that a user is pressing.
4+
Byte keycodes that represent the key or button involved in user input.
55
description: |
6-
The KeyCode Enum contains a list of Byte keycodes that represent the button
7-
used in a user input.
6+
The `KeyCode` enum contains a list of byte keycodes that represent the key or
7+
button involved in user input. This enum also includes buttons and axes
8+
present on gamepads, and 96 `World[]` values for non-standard buttons.
89
9-
Note, KeyCode keyboard values refer to the physical position of buttons on a
10-
standard QWERTY keyboard. This means that, provided the user's system is
11-
configured correctly, the location of keys (such as `WASD`) will remain the
12-
same on other keyboard types, such as Dvorak keyboards (where it would map to
13-
`,AOE`).
10+
Note that keyboard values refer to the physical position of buttons on a
11+
standard QWERTY keyboard. Provided the user's system is configured correctly,
12+
the location of keys (such as
13+
<kbd>W</kbd><kbd>A</kbd><kbd>S</kbd><kbd>D</kbd>) will remain the same on
14+
other keyboard types such as Dvorak keyboards where it would map to
15+
<kbd>,</kbd><kbd>A</kbd><kbd>O</kbd><kbd>E</kbd>.
1416
15-
This enum also includes buttons and axes present on gamepads, and 96 `World``
16-
values for non-standard buttons.
17-
18-
The keypad is a cluster of keys that is present on many desktop keyboards, but
19-
is rare for laptops to have.
20-
21-
See also:
22-
23-
- `Class.InputObject` - used for keyboard and gamepad input.
17+
See also `Class.InputObject`, used for keyboard and gamepad input.
2418
code_samples:
2519
tags: []
2620
deprecation_message: ''
@@ -51,7 +45,7 @@ items:
5145
deprecation_message: ''
5246
- name: Return
5347
summary: |
54-
Better known as enter.
48+
Frequently known as **Enter**.
5549
value: 13
5650
tags: []
5751
deprecation_message: ''
@@ -1443,73 +1437,73 @@ items:
14431437
deprecation_message: ''
14441438
- name: ButtonX
14451439
summary: |
1446-
Gamepad X button.
1440+
Gamepad `X` button.
14471441
value: 1000
14481442
tags: []
14491443
deprecation_message: ''
14501444
- name: ButtonY
14511445
summary: |
1452-
Gamepad Y button.
1446+
Gamepad `Y` button.
14531447
value: 1001
14541448
tags: []
14551449
deprecation_message: ''
14561450
- name: ButtonA
14571451
summary: |
1458-
Gamepad A button.
1452+
Gamepad `A` button.
14591453
value: 1002
14601454
tags: []
14611455
deprecation_message: ''
14621456
- name: ButtonB
14631457
summary: |
1464-
Gamepad B button.
1458+
Gamepad `B` button.
14651459
value: 1003
14661460
tags: []
14671461
deprecation_message: ''
14681462
- name: ButtonR1
14691463
summary: |
1470-
Gamepad R1 button.
1464+
Gamepad `R1` button.
14711465
value: 1004
14721466
tags: []
14731467
deprecation_message: ''
14741468
- name: ButtonL1
14751469
summary: |
1476-
Gamepad L1 button.
1470+
Gamepad `L1` button.
14771471
value: 1005
14781472
tags: []
14791473
deprecation_message: ''
14801474
- name: ButtonR2
14811475
summary: |
1482-
Gamepad R2 button.
1476+
Gamepad `R2` button.
14831477
value: 1006
14841478
tags: []
14851479
deprecation_message: ''
14861480
- name: ButtonL2
14871481
summary: |
1488-
Gamepad L2 button.
1482+
Gamepad `L2` button.
14891483
value: 1007
14901484
tags: []
14911485
deprecation_message: ''
14921486
- name: ButtonR3
14931487
summary: |
1494-
Gamepad R3 button.
1488+
Gamepad `R3` button.
14951489
value: 1008
14961490
tags: []
14971491
deprecation_message: ''
14981492
- name: ButtonL3
14991493
summary: |
1500-
Gamepad L3 button.
1494+
Gamepad `L3` button.
15011495
value: 1009
15021496
tags: []
15031497
deprecation_message: ''
15041498
- name: ButtonStart
15051499
summary: |
1506-
Gamepad Start button.
1500+
Gamepad `Start` button.
15071501
value: 1010
15081502
tags: []
15091503
deprecation_message: ''
15101504
- name: ButtonSelect
15111505
summary: |
1512-
Gamepad Select button.
1506+
Gamepad `Select` button.
15131507
value: 1011
15141508
tags: []
15151509
deprecation_message: ''
@@ -1553,34 +1547,41 @@ items:
15531547
summary: ''
15541548
value: 1018
15551549
tags: []
1556-
deprecation_message: ''
1550+
deprecation_message: |
1551+
This enum is deprecated and flagged for removal.
15571552
- name: MouseRightButton
15581553
summary: ''
15591554
value: 1019
15601555
tags: []
1561-
deprecation_message: ''
1556+
deprecation_message: |
1557+
This enum is deprecated and flagged for removal.
15621558
- name: MouseMiddleButton
15631559
summary: ''
15641560
value: 1020
15651561
tags: []
1566-
deprecation_message: ''
1562+
deprecation_message: |
1563+
This enum is deprecated and flagged for removal.
15671564
- name: MouseBackButton
15681565
summary: ''
15691566
value: 1021
15701567
tags: []
1571-
deprecation_message: ''
1568+
deprecation_message: |
1569+
This enum is deprecated and flagged for removal.
15721570
- name: MouseNoButton
15731571
summary: ''
15741572
value: 1022
15751573
tags: []
1576-
deprecation_message: ''
1574+
deprecation_message: |
1575+
This enum is deprecated and flagged for removal.
15771576
- name: MouseX
15781577
summary: ''
15791578
value: 1023
15801579
tags: []
1581-
deprecation_message: ''
1580+
deprecation_message: |
1581+
This enum is deprecated and flagged for removal.
15821582
- name: MouseY
15831583
summary: ''
15841584
value: 1024
15851585
tags: []
1586-
deprecation_message: ''
1586+
deprecation_message: |
1587+
This enum is deprecated and flagged for removal.

0 commit comments

Comments
 (0)