Skip to content

Installation

Purse is available on the Creator Store, Wally, and GitHub Releases.

Tip

While Purse can run anywhere because it uses RunContext, it is recommeneded parent Purse to ReplicatedStorage for best practices and organizational reasons.

Creator Store recommended

  1. Get the Purse model from the 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 Purse model and click it, or drag-and-drop it into the 3D view.

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

GitHub Releases

  1. Download the Purse.rbxm or Purse.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.

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

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

    Contextual menu

  4. Select the Purse model file you downloaded from GitHub and click Open.

Wally

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

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

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

    wally.toml
    1
    2
    [dependencies]
    purse = "ryanlua/[email protected]"
    
  3. Install Purse from Wally by running wally install.