👋 Welcome

Getting Started

Sign Up & Add Games

SDK Setup & Updates

Sharing & Permissions

Products

Popmall (Catalog)

Popmall – free catalog and avatar editor

Help your players express themselves, get them to play longer, and improve you monetization.

• Beautifully designed catalog with automatically curated categories
• Powerful avatar editor and camera mode
• Outfit feed that lets players discover and share outfits
• Quick setup in only a few minutes
• Discuss Dev Forum

Setup

Before you start:

1. Create a Super Biz account

2. Set up your BloxbizSDK

1. Enable the catalog in your BloxbizConfig

1. Open your "BloxbizConfig" in your Replicated Storage
2. Copy and paste the following code:

local BloxbizConfig = {}

BloxbizConfig.AccountID = Account ID

BloxbizConfig.CatalogEnabled = true

-- Display a button for the catalog in the top right toolbar
BloxbizConfig.CatalogShowToolbarButton = true

-- Controls if players wear their tried on items outside of the catalog
BloxbizConfig.CatalogPersistentWear = true

-- When true, limits the number of clothing items allowed using Roblox's defaults
BloxbizConfig.CatalogClothingLimits = true

-- When true, adjusts the toolbar so content doesn't overlap the voice chat beta icon
BloxbizConfig.IsGameVoiceChatEnabled = false

return BloxbizConfig

1. Replace Account ID with your Super Biz Account ID

2**. Test and publish your game**

First test that the catalog is working when you run your game in Roblox Studio. If everything looks good, you are finished setting up your game and ready to publish!

To get even more value out of the catalog consider marketing the catalog as an update and reviewing your catalog analytics.

Additional Functionality

Open the Catalog with Custom Triggers

You can create a variety of interactions that open the catalog using custom triggers.

Example: Clothing Rack Model

Drag-and-drop this clothing rack model into your workspace, run your game, and interact with the prompt to open the Catalog.

Popmall Clothing Rack.rbxm.zip

A clothing rack that opens the catalog.

Using Custom Triggers

You can open or close the catalog programmatically with custom triggers.

Use the following code to open the catalog in a LocalScript:

local PlayerScripts = game.Players.LocalPlayer.PlayerScripts
local BloxbizAPI = require(PlayerScripts:WaitForChild('BloxbizSDK').PublicAPI)

-- Call to open the catalog
BloxbizAPI.openCatalog()

Use the following code to close the catalog in a LocalScript:

local PlayerScripts = game.Players.LocalPlayer.PlayerScripts
local BloxbizAPI = require(PlayerScripts:WaitForChild('BloxbizSDK').PublicAPI)

-- Call to close the catalog
BloxbizAPI.closeCatalog()

Directly Open a Category

You can open the catalog to a specific category to create unique experiences like a themed store.

To open a specific category, you can call openCatalog(”term”). If that category exists, the catalog will open to that category. If the category doesn’t exist, the catalog will open and search the term.

Here’s an example that opens the Halloween category:

local Players = game:GetService("Players")
local player = Players.LocalPlayer

local function openHalloweenCategory()
	  local BloxbizSDK = player.PlayerScripts.BloxbizSDK
	  local API = require(BloxbizSDK.PublicAPI)
	  API.openCatalog("Halloween")
end

local button =  -- reference your GUI button here
button.Activated:Connect(openHalloweenCategory)

Popmall also supports user a group filtering via search. To open the catalog directly to items you or your group created, call API.openCatalog with a user: or group: filter:

local Players = game:GetService("Players")
local player = Players.LocalPlayer

local function openHalloweenCategory()
	  local BloxbizSDK = player.PlayerScripts.BloxbizSDK
	  local API = require(BloxbizSDK.PublicAPI)

		-- show items made by a group:
    API.openCatalog("group:8668664")  -- group:<group ID>

    -- show items made by a user:
    API.openCatalog("user:roblox")  -- user:<username OR user ID>
end

local button =  -- reference your GUI button here
button.Activated:Connect(openHalloweenCategory)

Trigger Outfit Purchase Prompt

You can use Popmall’s “Buy Outfit” feature to prompt users to purchase the items currently on their avatar. Users are shown the items they don’t own and can tap on each item to purchase.

This prompt can be opened directly from outside the catalog:

local Players = game:GetService("Players")

local function purchaseOutfit()
	local PublicAPI = require(Players.LocalPlayer.PlayerScripts:WaitForChild("BloxbizSDK").PublicAPI)
	-- this will open Popmall and immediately open the Buy Outfit modal
	PublicAPI.promptBuyOutfit()
end 

local button =  -- reference your GUI button here
button.Activated:Connect(purchaseOutfit)

Purchase Block List for Free Limiteds

You may want to prevent specific items from being purchased from the catalog like free Limited UGC Items that you’re giving away or rewarding to players. You can prevent the purchase of these from the catalog by adding a block list to your BloxbizConfig:

local BloxbizConfig = {}

...

-- List asset IDs to block the purchase of items in the catalog
-- Use IDs from the URL on the Roblox marketplace
BloxbizConfig.CatalogPurchaseBlockList = {
	1010101010,
	2121212121,
}

...

return BloxbizConfig

Customize Toolbar Button

If you have the toolbar button enabled, you can customize the label on the button. The toolbar button defaults to “Avatar”, but you change it in your BloxbizConfig:

local BloxbizConfig = {}

...

-- Display a button for the catalog in the top right toolbar
BloxbizConfig.CatalogShowToolbarButton = true

-- Use "Catalog" for the toolbar button instead of "Avatar":
BloxbizConfig.CatalogToolbarButtonLabel = "Catalog"

-- Hide text completely & just show the Popmall icon:
BloxbizConfig.CatalogToolbarButtonLabel = ""

...

return BloxbizConfig

Marketing

Sharing that you’ve added a catalog to your game can be an effective way to attract new players to your game and helps educate your existing players about the new feature.

You can market the catalog as an update to your game in a few ways:

• Add “[Catalog 🛍]” to your game’s title
• Add a “Catalog” label to your game’s thumbnail
• Add a note about the catalog in your game’s description
• Add a note about the catalog in your game

If you’re looking for other ideas on how to market the catalog, you can join our Discord and chat with others in #superbiz-catalog.

Analytics

You can monitor the performance of the catalog and your revenue in the Dev Portal.

Dashboard

Use the Sales Revenue chart in the dashboard to easily visualize your sales revenue trends. To drill into the performance of the catalog, look at Asset sales.

To access your Sales Revenue chart, log in to the Dev Portal, click on “Dashboard” in the left-hand navigation and scroll down to the “Sales Revenue” chart.

Reports

Use the Sales Revenue reports in the dashboard to dive deeper into your sales metrics and customize the report with what matters to you.

To access your Sales Revenue reports, log in to the Dev Portal, click on “Reports” in the menu and scroll down until you see “Sales Revenue”. When expanded, you will see all the available reports related to your game’s sales revenue.

Note: Data is generated every night at 1am EST.