Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanlua/satchel
A modern 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.
https://github.com/ryanlua/satchel
backpack collaborate github gui inventory lua luau open-source roblox system tool ui utility works-with-codespaces
Last synced: 2 months ago
JSON representation
A modern 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.
- Host: GitHub
- URL: https://github.com/ryanlua/satchel
- Owner: RyanLua
- License: mpl-2.0
- Created: 2023-05-28T21:41:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-20T03:32:51.000Z (3 months ago)
- Last Synced: 2024-11-09T04:03:16.149Z (2 months ago)
- Topics: backpack, collaborate, github, gui, inventory, lua, luau, open-source, roblox, system, tool, ui, utility, works-with-codespaces
- Language: Luau
- Homepage: http://satchel.ryanluu.dev
- Size: 16.6 MB
- Stars: 35
- Watchers: 3
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Governance: .github/GOVERNANCE.md
Awesome Lists containing this project
README
[](../../releases)
[](../../search?l=lua)
[](LICENSE.txt)
[](https://discord.gg/N2KEnHzrsW)
[](https://github.com/RyanLua/Satchel/releases/latest/download/Satchel.rbxm)
[](https://codespaces.new/RyanLua/Satchel?quickstart=1)
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.
## ⭐ 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](https://github.com/1ForeverHD/TopbarPlus) to allow users to easily and more quickly open the inventory.
## 🛝 Playground
> [!TIP]
> [Satchel Playground](https://www.roblox.com/games/13592168150) 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](https://www.roblox.com/games/13592168150) on Roblox. Feel free to use the playground as a reference for how to use Satchel. Please download and modify it to your liking.
[](https://www.roblox.com/games/13592168150)
## 🔽 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](https://create.roblox.com/marketplace/asset/13947506401).
2. Open Roblox Studio and create a new place or open an existing place.
3. Open or locate the [Toolbox](https://create.roblox.com/docs/studio/toolbox).
4. Open your [Inventory](https://create.roblox.com/docs/studio/toolbox#inventory) from the [Toolbox](https://create.roblox.com/docs/studio/toolbox).
5. Search for `Satchel` created by `WinnersTakesAll` and click on it.
6. Insert `Satchel` into the [Explorer](https://create.roblox.com/docs/studio/explorer) and drag it into [StarterPlayerScripts](https://create.roblox.com/docs/reference/engine/classes/StarterPlayerScripts).
Install from GitHub Releases
1. Download the `Satchel.rbxmx` file from [Releases](../../releases).
2. Open Roblox Studio and create a new place or open an existing place.
3. Go to [Explorer](https://create.roblox.com/docs/studio/explorer) and right click on [`StarterPlayerScripts`](https://create.roblox.com/docs/reference/engine/classes/StarterPlayerScripts) and click on `Insert from file...`.
4. Select the `Satchel.rbxmx` you downloaded from GitHub and click `Open`.
5. Ensure that `Satchel`is in [StarterPlayerScripts](https://create.roblox.com/docs/reference/engine/classes/StarterPlayerScripts).
## 👤 Acknowledgements
A special thanks to the following people for their contributions to Satchel.
| Roblox Username | Contribution |
| --- | --- |
| [@OnlyTwentyCharacters](https://www.roblox.com/users/28969907), [@SolarCrane](https://www.roblox.com/users/29373363) | Creating the original CoreGui script |
| [@thebrickplanetboy](https://www.roblox.com/users/525495863) | Allowing me to republish & modify his fork of the backpack system |
| [@ForeverHD](https://www.roblox.com/users/82347291) | 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](.github/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](https://ryanluu.dev/Satchel) to learn about Satchel.
Satchel has it's very own [documentation site](https://ryanluu.dev/Satchel) 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`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the background color of the default inventory window and slots. | `[25, 27, 29]` |
| BackgroundTransparency: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the background transparency of the default inventory window and slots. | 0.3 |
| CornerRadius: [`UDim`](https://create.roblox.com/docs/reference/engine/datatypes/UDim) | Determines the radius, in pixels, of the default inventory window and slots. | `0, 8` |
| EquipBorderColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the equip border when a slot is equipped. | `[255, 255, 255]` |
| EquipBorderSizePixel: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the pixel width of the equip border when a slot is equipped. | `5` |
| FontFace: [`Font`](https://create.roblox.com/docs/reference/engine/enums/Font) | Determines the font of the default inventory window and slots. | `Builder Sans` |
| InsetIconPadding: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | Determines whether or not the tool icon is padded in the default inventory window and slots. | True |
| OutlineEquipBorder: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | Determines whether or not the equip border is outline or inset when a slot is equipped. | True |
| TextColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the text in default inventory window and slots. | `[255, 255, 255]` |
| TextSize: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the size of the text in the default inventory window and slots. | `14` |
| TextStrokeColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the text stroke of text in default inventory window and slots. | `[0, 0, 0]` |
| TextStrokeTransparency: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | 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`](https://create.roblox.com/docs/scripting/luau/booleans) |
| :--- |
| Returns whether the inventory is opened or not. |
| SetBackpackEnabled(enabled: boolean): `void` |
| :--- |
| Sets whether the backpack gui is enabled or disabled. |
| GetBackpackEnabled(): [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) |
| :--- |
| Returns whether the backpack gui is enabled or disabled. |
| GetStateChangedEvent(): [`RBXScriptSignal`](https://create.roblox.com/docs/reference/engine/datatypes/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](.github/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](http://mozilla.org/MPL/2.0/). See [LICENSE.txt](LICENSE.txt) for details.