Skip to content

Installation

Installing Satchel is easy and painless. Satchel is a drag-and-drop module that works out of the box and with no configuration needed.

Satchel uses RunContext to run anywhere, so you do not need to move it from Workspace, though it is recommeneded to parent to ReplicatedStorage for best practices and organizational reasons.

Danger

Do not parent the Satchel to any starter containers or it will run multiple times. Older versions of Satchel required you to do this but it is no longer needed in versions v1.4.0 and newer.

Creator Store recommended

The Creator Store is the easiest way to install Satchel. It is a one-click installation and requires no downloads.

Example

Below is a video on how to install Satchel from the Creator Store.

  1. Get the Satchel model from the Creator Store.

    Creator Store

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

  3. From the View tab, open the Toolbox and select the Inventory tab.

    View Tab Toolbox

    Inventory Tab

  4. Locate the Satchel model and click it, or drag-and-drop it into the 3D view.

    Toolbox

  5. In the Explorer window, move the Satchel model into ReplicatedStorage.

GitHub Releases

  1. Download the Satchel.rbxm or Satchel.rbxmx model file from GitHub Releases.

    Info

    Binary (.rbxm) and XML (.rbxmx) model files contain the exact same model. .rbxm is a smaller file size to download.

    GitHub Release

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

  3. In the Explorer window, insert Satchel into ReplicatedStorage.

    Contextual menu

  4. Select the Satchel model file you downloaded from GitHub.

Wally

You are expected to already have Wally setup in your Rojo project and basic knowledge on how to use Wally packages.

Warning

Wally does not include the loader script so you need to require() Satchel to run:

Satchel Loader
1
require(script.Satchel)

  1. Open your Rojo project in the code editor of your choice.

  2. In the wally.toml file, add the latest Wally version for Satchel. Your dependencies should look similar to this:

    wally.toml
    1
2
    [dependencies]
satchel = "ryanlua/[email protected]"

  3. Install Satchel from Wally by running wally install.