Skip to content

Commit 60e8f6b

Browse files
update Open Source Docs from Roblox internal teams
1 parent 5b53694 commit 60e8f6b

File tree

10 files changed

+119
-0
lines changed

10 files changed

+119
-0
lines changed

content/common/navigation/avatar/guides.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ navigation:
7171
path: /marketplace/publishing-to-marketplace
7272
- title: Marketplace Fees and Commissions
7373
path: /marketplace/marketplace-fees-and-commissions
74+
- title: UGC Homestore
75+
path: /marketplace/homestore
7476
- title: Frequently Asked Questions
7577
path: /marketplace/frequently-asked-questions
7678

Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/cloud/legacy.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@ This page summarizes the available operations and authentication types.
125125
| UpdateGroupNotificationPreference | `PATCH v1/groups/{groupId}/notification-preference` | `legacy-user:manage` |
126126
| UpdateGroupDescription | `PATCH v1/groups/{groupId}/description` | `legacy-group:manage` |
127127
| GetPendingGroupJoins | `GET v1/user/groups/pending` | `legacy-group:manage` |
128+
| GetGroupBans | `GET v1/groups/{groupId}/bans` | `legacy-group:manage` |
129+
| BanUserFromGroup | `POST v1/groups/{groupId}/bans/{userId}` | `legacy-group:manage` |
130+
| UnbanUserFromGroup | `DELETE v1/groups/{groupId}/bans/{userId}` | `legacy-group:manage` |
131+
| GetUserGroupBan | `GET v1/groups/{groupId}/bans/{userId}` | `legacy-group:manage` |
128132

129133
## Localization Tables API
130134

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: UGC Homestore
3+
description: Showcase and sell your published avatar items in a easily customizable shop template.
4+
---
5+
6+
<iframe width="800" height="450" src="https://www.youtube-nocookie.com/embed/6MPWLQmIKLk" title="YouTube video player" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> <br />
7+
8+
The **UGC Homestore** is a user-friendly template that avatar item creators can use to showcase and sell their marketplace items. This template is ideal for creators with an existing UGC catalog who want a dedicated space to promote their assets. Creators who sell their own avatar items from their own experience also benefit from a [larger commission split](../marketplace/marketplace-fees-and-commissions.md#commissions).
9+
10+
The homestore template provides the following features that you can quickly customize with minimal scripting:
11+
12+
- **Mannequins** — 3D displays that can showcase avatar items. Users can interact with mannequins and purchase the showcased items.
13+
- **Integrated shop** — Conveniently located shop button at the bottom of the screen opens a catalog where users can view and purchase items.
14+
- **Modular Building Parts** — Customizable building components for creating a unique and personalized shopfront.
15+
16+
You can find the UGC Homestore Template in Roblox Studio's start screen. To access Studio's provided templates at any time, select **File** > **Open from Roblox** and select **Templates**.
17+
18+
## Customizing Homestore
19+
20+
You can modify the features of the homestore to showcase and sell your assets as well as add your own distinct theme and design. If the place is unpublished, the homestore showcases Roblox-created assets on the mannequins and shop as reference.
21+
22+
### Mannequins
23+
24+
Each mannequin includes custom attributes that allow you to add avatar items, display different poses, use different skin tones, and more.
25+
26+
<GridContainer numColumns='2'>
27+
<figure><img src="../assets/publishing/marketplace/Mannequin-Example.png" alt="A store mannequin wearing a custom hair, sweater, skirt, and shoes"/>
28+
<figcaption>When playtesting, the mannequin loads all the accessories and settings defined in its Attributes properties.</figcaption>
29+
</figure>
30+
<figure><img src="../assets/publishing/marketplace/Mannequin-Explorer.png" alt="The Properties window with the Attributes tab expanded - various components of the mannequin are added as property fields"/>
31+
<figcaption>Custom Attributes properties allow you to edit accessories, body types, and other configurations.</figcaption>
32+
</figure>
33+
</GridContainer> <br/>
34+
35+
To customize a mannequin:
36+
37+
1. Select an existing mannequin object.
38+
2. In **Properties Panel** > **Attributes**, modify the following fields:
39+
1. `accessoryIds` — Comma separated list of accessory IDs that display on mannequin.
40+
2. `bundleIds` — Comma separated list of bundle IDs that display on the mannequin.
41+
1. To add shoes, you must set them as a bundle to include the right and left shoe.
42+
3. `poseAnimation` — Animation ID for the mannequin, can be still or looped.
43+
4. `skinColor` — Sets color tone for the surface skin of the mannequin.
44+
45+
<Alert severity = 'info'>
46+
If scripting mannequin behavior, each mannequin includes the <code>Mannequin</code> tag for easy referencing.
47+
</Alert>
48+
49+
### Shop
50+
51+
The template includes a shop button at the bottom of the screen visible for all users. When selected, a catalog interface opens displaying all available catalog items from the creator.
52+
53+
<img src="../assets/publishing/marketplace/Catalog-Example.png" alt="Catalog interface with the default Roblox marketplace items" width = "50%"/><br />
54+
55+
By default, the catalog applies the following behavior:
56+
57+
- If the place is unpublished, such as during initial playtesting, the catalog displays Roblox's marketplace items as reference.
58+
- If the place is published, the catalog automatically displays the current experience owner's available marketplace items.
59+
- If the current experience owner doesn't have any available marketplace items, the catalog doesn't display any items.
60+
- You can [set a different creator's catalog](#specifying-another-creators-catalog) as the default by modifying `ReplicatedStorage.Settings`.
61+
62+
#### Specifying Another Creator's Catalog
63+
64+
To set the catalog to use another creator's marketplace items:
65+
66+
1. In **File** > **Game Settings** > **Security**, enable **Allow Third Party Sales**.
67+
68+
<img src="../assets/publishing/marketplace/Enable-Third-Party-Sales.png" alt="Section of the Explorer window highlighting the Settings file in Replicated Storage." width = "70%"/>
69+
70+
2. Ensure that the marketplace items have their sale location set to `Marketplace and All Experiences` or have specified this specific experience as a valid [sale location](../marketplace/publishing-to-marketplace.md#sale-location).
71+
72+
1. If the experience is added as a unique sale location, the experience owner [must enable the specific asset for sale using the Creator Dashboard](../production/monetization/avatar-items.md#adding-items-to-experience).
73+
74+
<Alert severity = 'warning'>
75+
Failure to properly link and enable a third-party asset means that users can only see the added items, but can't purchase them.
76+
</Alert>
77+
78+
3. In **ReplicatedStorage**, open the **Settings** ModuleScript object.
79+
80+
<img src="../assets/publishing/marketplace/ReplicatedStorage-Settings.png" alt="Section of the Explorer window highlighting the Settings file in Replicated Storage."/>
81+
82+
4. Modify **DEFAULT_CREATOR_NAME** to the name of the creator.
83+
1. If empty, the shop displays the entire Marketplace catalog from all creators.
84+
5. Set **FETCH_CREATOR_NAME** to `false`. This sets the catalog to always reference the **DEFAULT_CREATOR_NAME** instead of the experience owner.
85+
86+
### Building
87+
88+
Each building component is designed to be modular and extendible. You can quickly duplicate pieces, rotate, and rearrange them to create larger and more intricate structures. For more information on working with modular environments, see [Assembling Modular Environments](../tutorials/use-case-tutorials/modeling/assembling-modular-environments.md).
89+
90+
### Advanced Customizations
91+
92+
For an advanced technical breakdown of the template project, including descriptions of various scripts, components, and behaviors, navigate to `ServerScriptService` and open the `README` ModuleScript. This content is intended for creators who intend to modify the underlying scripts and behaviors of the template project.
93+
94+
<img src="../assets/publishing/marketplace/ServerScriptStorage-Readme.png" alt="Section of the Explorer window highlighting the README file in ServerScriptService."/>

tools/checks/utils/allowedHttpLinks.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,7 @@ https://www.youtube.com/watch?v=iHJ49zbGOW8&
508508
https://www.youtube.com/watch?v=j918PoWWaB0
509509
https://www.youtube-nocookie.com/embed/eqW9SINYeWg
510510
https://www.youtube-nocookie.com/embed/llR_pNlJDQw
511+
https://www.youtube-nocookie.com/embed/6MPWLQmIKLk
511512
https://youtu.be/OEmFocfE0Xs
512513
https://www.youtube.com/watch?v=SgPU84AqpkY&t=74s
513514
https://www.youtube.com/watch?v=9mXvhYSv7fc&t=96s

0 commit comments

Comments
 (0)