README.md

 

Satchel is a modern open-source alternative to Roblox's default backpack. Satchel aims to be more customizable and easier to use than the default backpack while still having a "vanilla" feel. Installation of Satchel is as simple as dropping the module into your game and setting up a few properties if you like to customize it. It has a familiar feel and structure as to the default backpack for ease of use for both developers and players.

Satchel.Demo.mp4

⭐ Features

Satchel comes packed with much-needed features and changes that the default backpack doesn't have.

Modernized Familiar Feel

Satchel completely remakes the backpack's UI to a uniform and vanilla feeling UI, blending in with other elements designed by Roblox.

Highly Customizable & Versatile

Satchel is highly customizable & adjustable with instance attributes support allowing you to customize the behavior and appearance of over 10+ attributes. Change the color, transparency, behavior, and more of it's elegantly designed UI.

Improved Mobile Experience

Satchel expands on the mobile experience doubling the number of slots allowing players on mobile to not be at a disadvantage.

Topbar Plus Support

Satchel supports Topbar Plus by 1ForeverHD to allow users to easily and more quickly open the inventory.

🛝 Playground

Tip

Satchel Playground has place copying enabled, allowing you to edit your own copy from the Roblox website by clicking the ellipsis (...) and selecting Edit.

We provide an open-source playground of Satchel where you can test and play with Satchel before deciding to use it. See Satchel Playground on Roblox. Feel free to use the playground as a reference for how to use Satchel. Please download and modify it to your liking.

🔽 Installation

Installation of Satchel is easy and painless. Satchel is a drag-and-drop module that works out of the box and with easy customization. Below are different ways to get you to download and install Satchel.

Install from Creator Marketplace

1. Get the Satchel module from the Creator Marketplace.

2. Open Roblox Studio and create a new place or open an existing place.

3. Open or locate the Toolbox.

4. Open your Inventory from the Toolbox.

5. Search for Satchel created by WinnersTakesAll and click on it.

6. Insert Satchel into the Explorer and drag it into StarterPlayerScripts.

Install from GitHub Releases

1. Download the Satchel.rbxmx file from Releases.

2. Open Roblox Studio and create a new place or open an existing place.

3. Go to Explorer and right click on StarterPlayerScripts and click on Insert from file....

4. Select the Satchel.rbxmx you downloaded from GitHub and click Open.

5. Ensure that Satchelis in StarterPlayerScripts.

👤 Acknowledgements

A special thanks to the following people for their contributions to Satchel.

Roblox Username	Contribution
@OnlyTwentyCharacters, @SolarCrane	Creating the original CoreGui script
@thebrickplanetboy	Allowing me to republish & modify his fork of the backpack system
@ForeverHD	Making Topbar Plus and open-sourcing it for everyone to use

💖 Support

Note

If you see an issue with Satchel and would like to report it, see SUPPORT.md for additional information.

Satchel fully supports all platforms which includes computer, tablet, phone, console, and VR. Satchel is also fully compatible experiences using TopbarPlus by 1ForeverHD.

📖 Documentation

Note

Visit the Satchel documentation website to learn about Satchel.

Satchel has it's very own documentation site you can visit. Find guides on how to get started and documentation.

Attributes

Satchel supports instance attributes allowing you to change and customize many aspects including various behaviors in a friendly easy-to-use interface without having to touch any code. Below see all attributes.

Attribute	Description	Default
BackgroundColor3: Color3	Determines the background color of the default inventory window and slots.	[25, 27, 29]
BackgroundTransparency: number	Determines the background transparency of the default inventory window and slots.	0.3
CornerRadius: UDim	Determines the radius, in pixels, of the default inventory window and slots.	0, 8
EquipBorderColor3: Color3	Determines the color of the equip border when a slot is equipped.	[255, 255, 255]
EquipBorderSizePixel: number	Determines the pixel width of the equip border when a slot is equipped.	5
FontFace: Font	Determines the font of the default inventory window and slots.	Builder Sans
InsetIconPadding: boolean	Determines whether or not the tool icon is padded in the default inventory window and slots.	True
OutlineEquipBorder: boolean	Determines whether or not the equip border is outline or inset when a slot is equipped.	True
TextColor3: Color3	Determines the color of the text in default inventory window and slots.	[255, 255, 255]
TextSize: number	Determines the size of the text in the default inventory window and slots.	14
TextStrokeColor3: Color3	Determines the color of the text stroke of text in default inventory window and slots.	[0, 0, 0]
TextStrokeTransparency: number	Determines the transparency of the text stroke of text in default chat window and slots.	0.5

Methods

Satchel offers access to some of its internal methods and events for scripting purposes. Below see a table with all the methods available.

IsOpened(): boolean
Returns whether the inventory is opened or not.

SetBackpackEnabled(enabled: boolean): void
Sets whether the backpack gui is enabled or disabled.

GetBackpackEnabled(): boolean
Returns whether the backpack gui is enabled or disabled.

GetStateChangedEvent(): RBXScriptSignal
Returns a signal that fires when the inventory is opened or closed.

🙏 Contributing

We welcome all contributions from the community. If you would like to contribute, please see CONTRIBUTING.md to get started on how to contribute to Satchel.

When you contribute to Satchel you will be accredited for your contribution for everyone to see on this repository along with supporting the open-source community.

📃 License

Satchel is licensed under Mozilla Public License 2.0. See LICENSE.txt for details.