Skip to content

Usage

Use of Satchel after installation very easy. Just publish your experience to Roblox and see Satchel live in action.

To learn how to install Satchel, see Installation.

Note

Please see API Reference for more details on attributes, methods, and events for Satchel and how to use Satchel to it's full potential.

Customization

Satchel is highly customizable & adjustable with instance attributes support allowing you to customize the behavior and appearance of over 10+ attributes.

Some of the attributes include:

  • Text Color, Size, Stroke Color & Transparency
  • Background Color & Transparency
  • Equip Border Color & Thickness
  • Corner Radius
  • Font

More attributes can be found in the API Reference. The list above is not exhaustive and there are may more attributes available for customization.

Instance Attributes

Example of customization using instance attributes

Scripting

Satchel offers methods and events for scripting purposes. In the below code example we will use the SetBackpackEnabled method to disable the Satchel. The script expects the Satchel module to be in ReplicatedStorage.

Disable Backpack
1
2
3
4
5
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local Satchel = require(ReplicatedStorage.Satchel)

Satchel.SetBackpackEnabled(false)

For the full API reference, see API Reference for more details on attributes, methods, and events for Satchel and how to use Satchel to it's full potential.

Favorites System

Satchel includes a built-in favorites system that allows players to protect important items from being accidentally sold or discarded. This feature is particularly useful for games with collectible items, trading systems, or inventory management.

Player Experience

Players can favorite items using:

  • Desktop: Right-click on any item
  • Mobile/Touch: Long-press (0.5 seconds) on any item

Favorited items are marked with a gold star ⭐ in the bottom-right corner and automatically sort to the top of the inventory.

Visual Features

  • Golden Background: Items that can be favorited have a distinctive golden/bronze background
  • Favorites Control Panel: A dedicated panel above the inventory with:
  • Helper text explaining how to favorite items
  • Futuristic animated toggle switch to filter inventory (show all / favorites only)
  • Auto-Sorting: Favorited items automatically appear first, sorted by most recently favorited
  • Real-time Updates: The filter updates immediately when items are favorited/unfavorited

Developer Setup

To enable favorites for specific items, set the CanBeFavorited attribute:

Make Items Favoritable
1
2
local tool = game.ServerStorage.SpecialSword
tool:SetAttribute("CanBeFavorited", true)

Persistence (Optional)

Favorites can optionally persist across game sessions using Roblox DataStore. When enabled:

  • Player favorites are automatically saved when toggled
  • Favorites are restored when the player rejoins the game
  • Works seamlessly across all devices

Requirements:

  • The BackpackFavorites.model.json must be synced to ReplicatedStorage via your Rojo project
  • The ServerFavorites.server.luau script must be running on the server
  • DataStore API must be enabled in your game

Note

Persistence is optional. Without the server-side components, favorites will still work during the play session but won't persist after leaving.

For integration with sell/trade systems, see the Favorites System section in the API Reference.