Skip to content
← All documentation

/// SUPPORTED THIRD-PARTY PLUGIN

Backpacks

Free guide for configuring this third-party plugin in the Hub. Install the plugin separately from its official source.

Prepare your file

  1. Check the installed version

    This guide describes Backpacks 3.17.6. Use the same version in the configurator.

  2. Import your configuration

    Open the configurator and import your current JSON. For a new installation, you can start from the provided example.

  3. Edit and download

    Adjust the settings, fix reported errors, and download the JSON. Keep a copy of your old file before replacing it.

Your configuration is not saved on the site. Keep the exported file; you can import it again later.

Settings for this version

General 3
Drop on death
On / off · required

Drop the backpack into the world when the player dies. If erase-on-death is enabled, erasing takes priority and contents are lost.

JSON pathDrop on Death (true/false)
Erase on death
On / off · required

Erase backpack contents on every death. This is destructive and takes priority over dropping the backpack on death.

JSON pathErase on Death (true/false)
Minimum despawn time (seconds)
Number · required

Minimum time before a dropped backpack despawns, in seconds. It gives players time to recover contents after death.

JSON pathMinimum Despawn Time (Seconds)

Minimum : 0

Backpack size 4
Default slots
Whole number · required

Slots granted without a larger-size permission. Count individual slots, not rows of six.

JSON pathBackpack size → Default size

Minimum : 1

Maximum slots per page
Whole number · required

Maximum slots on each backpack page, up to 48. Larger backpacks use multiple pages rather than being reduced to this size.

JSON pathBackpack size → Max size per page

Minimum : 1 · Maximum : 48

Enable legacy row permissions
On / off · required

Recognize legacy backpacks.use.1 through .8 permissions measured in rows. Disable if using only current size permissions.

JSON pathBackpack size → Enable legacy backpacks.use.1-8 row permissions
Permission sizes
List · required

Each value generates a backpacks.size.<number> permission.

JSON pathBackpack size → Permission sizes
Clear on wipe 3
Enable wipe clearing
On / off · required

Apply backpack-cleanup rules on wipe. Review what is retained before enabling: cleanup can delete items.

JSON pathClear on wipe → Enabled
Enable legacy keeponwipe permission
On / off · required

Recognize the legacy backpacks.keeponwipe permission for preserving contents on wipe, alongside the current rules system.

JSON pathClear on wipe → Enable legacy keeponwipe permission
Keep-on-wipe permission rulesets
JSON value · required

Each entry generates a backpacks.keeponwipe.<name> permission.

JSON pathClear on wipe → Rulesets by permission
Container UI 2
Page buttons on container bar
On / off · required

Place page-navigation buttons on the backpack container bar instead of their alternate location.

JSON pathContainer UI → Show page buttons on container bar
Maximum visible page buttons
Whole number · required

Use 0 to hide page buttons, or a negative value to show every page.

JSON pathContainer UI → Max page buttons to show
GUI button 5
Enable button
On / off · required

Enable the backpack-opening UI button. Players still need the relevant permissions to use it.

JSON pathGUI Button → Enabled
Shown by default
On / off · required

Show the button by default for permitted players, before their personal visibility preference.

JSON pathGUI Button → Enabled by default (for players with permission)
Skin ID
Whole number · required

Skin ID used for the button icon by the plugin’s configuration. This is not a permission or backpack size.

JSON pathGUI Button → Skin Id

Minimum : 0

Image URL
Text · required

Direct address of the image to display, not its web page. Use an image players can access; prefer HTTPS.

JSON pathGUI Button → Image
Background color
Text · required

Rust color: red, green, blue and opacity from 0 to 1, separated by spaces. Example: 1 0.5 0 1 is opaque orange; opacity 0 makes the element invisible.

JSON pathGUI Button → Background Color
Item restrictions 4
Enable restrictions
On / off · required

Check rules allowing or denying items in backpacks. Disable to stop applying this filter.

JSON pathItem restrictions → Enabled
Enable legacy noblacklist permission
On / off · required

Recognize the legacy backpacks.noblacklist permission that bypasses item restrictions.

JSON pathItem restrictions → Enable legacy noblacklist permission
Denied-item effect
Text · required

Rust effect path played when an item is denied by restrictions. Use an existing game effect, not an image URL.

JSON pathItem restrictions → Feedback effect
Permission rulesets
JSON value · required

Each entry generates a backpacks.restrictions.<name> permission.

JSON pathItem restrictions → Rulesets by permission
Softcore mode 1
Reclaim fraction
Number · required

Fraction of contents reclaimable through Softcore after death. 0 = none, 0.5 = half, 1 = all; applies only to that game mode.

JSON pathSoftcore → Reclaim Fraction

Minimum : 0 · Maximum : 1

Dynamic size (experimental) 2
Enable dynamic size
On / off · required

Enable capacity profiles that can grow for each player. Experimental feature: earned capacity belongs to plugin data, not this JSON.

JSON pathBackpack size → Dynamic Size (EXPERIMENTAL) → Enabled
Size profiles
JSON value · required

Each profile creates a backpacks.size.profile.<suffix> permission. Earned capacity for each player is stored separately by the plugin.

JSON pathBackpack size → Dynamic Size (EXPERIMENTAL) → Size profiles
Default wipe rules 8
Permission suffix
Text

Name of this wipe-retention rule. Named rules also identify rule permissions.

JSON pathClear on wipe → Default ruleset → Name
Max slots to keep
Whole number · required

Maximum slots to retain after wipe cleanup. -1 means no limit; 0 retains no slots.

JSON pathClear on wipe → Default ruleset → Max slots to keep

Minimum : -1

Allowed categories
JSON value · required

Rust categories that may survive wipe cleanup. All allows every category subject to exclusions. An empty list admits no items by category: an item or skin allowance is then needed.

JSON pathClear on wipe → Default ruleset → Allowed item categories
Blocked categories
JSON value · required

Item categories removed on wipe by this rule. Use exact Rust category names.

JSON pathClear on wipe → Default ruleset → Disallowed item categories
Allowed item short names
List · required

Item short names admitted for wipe retention, such as wood. The list can supplement allowed categories.

JSON pathClear on wipe → Default ruleset → Allowed item short names
Disallowed item short names
List · required

Item short names excluded from wipe retention. Do not enter translated display names.

JSON pathClear on wipe → Default ruleset → Disallowed item short names
Allowed skin IDs
List · required

Skin IDs admitted by this rule. They concern items wearing those skins, not every item in the category.

JSON pathClear on wipe → Default ruleset → Allowed skin IDs
Disallowed skin IDs
List · required

Skin IDs denied by this rule. Leave empty if no skin variant should be excluded.

JSON pathClear on wipe → Default ruleset → Disallowed skin IDs
GUI Button Position 4
Anchors Min
Text · required

Bottom-left corner within the parent container, written as x y from 0 to 1. 0 0 means bottom-left. It must not exceed the maximum anchor; equal anchors may use pixel offsets.

JSON pathGUI Button → GUI Button Position → Anchors Min
Anchors Max
Text · required

Top-right corner within the parent container, written as x y from 0 to 1. 1 1 means top-right. It must not precede the minimum anchor; equal anchors may use pixel offsets.

JSON pathGUI Button → GUI Button Position → Anchors Max
Offsets Min
Text · required

Bottom-left offset, written as x y in pixels, added to the anchor. Negative values move this corner left or down.

JSON pathGUI Button → GUI Button Position → Offsets Min
Offsets Max
Text · required

Top-right offset, written as x y in pixels, added to the anchor. Positive values move this corner right or up.

JSON pathGUI Button → GUI Button Position → Offsets Max
Default item rules 7
Permission suffix
Text

Name of this storage rule. Named rules also identify rule permissions.

JSON pathItem restrictions → Default ruleset → Name
Allowed categories
JSON value · required

Rust categories admitted into the backpack. All allows every category subject to exclusions. An empty list admits no items by category: an item or skin allowance is then needed.

JSON pathItem restrictions → Default ruleset → Allowed item categories
Blocked categories
JSON value · required

Item categories denied in the backpack. Use exact Rust category names.

JSON pathItem restrictions → Default ruleset → Disallowed item categories
Allowed item short names
List · required

Item short names admitted into the backpack, such as wood. The list can supplement allowed categories.

JSON pathItem restrictions → Default ruleset → Allowed item short names
Disallowed item short names
List · required

Item short names denied in the backpack. Do not enter translated display names.

JSON pathItem restrictions → Default ruleset → Disallowed item short names
Allowed skin IDs
List · required

Skin IDs admitted by this rule. They concern items wearing those skins, not every item in the category.

JSON pathItem restrictions → Default ruleset → Allowed skin IDs
Disallowed skin IDs
List · required

Skin IDs denied by this rule. Leave empty if no skin variant should be excluded.

JSON pathItem restrictions → Default ruleset → Disallowed skin IDs
Reset dynamic size on wipe 1
Reset on wipe
On / off · required

Reset earned dynamic capacity on wipe. This affects earned size, independently of item-retention rules.

JSON pathBackpack size → Dynamic Size (EXPERIMENTAL) → Reset dynamic size on wipe → Enabled

Plugin instructions

Backpacks 3.17.6

Configure Backpacks for free under Oxide using oxide/config/Backpacks.json. This guide covers the official uMod version 3.17.6 observed on 2026-08-02, under the MIT license.

Backpack size

Backpack size contains Default size, Max size per page (maximum 48), the legacy row-permission toggle, and Permission sizes. Each permission-size value generates backpacks.size.<number>.

The advanced Dynamic Size (EXPERIMENTAL) group contains Enabled, Reset dynamic size on wipe > Enabled, and Size profiles. Every profile has Permission suffix, Initial size, and Max size, and generates backpacks.size.profile.<suffix>.

Death, UI, and Softcore

  • Drop on Death (true/false), Erase on Death (true/false), and Minimum Despawn Time (Seconds) control death handling.
  • GUI Button controls enablement, the new-player default, Skin Id, Image, Background Color, and the four anchor/offset strings under GUI Button Position.
  • Container UI controls whether page buttons share the container bar and how many page buttons are visible.
  • Softcore > Reclaim Fraction accepts values from 0 to 1.

These settings describe Backpacks’ own Rust interface. Edit them in the configurator, not in PimpMyCUI Editor; they are not in PimpMyCUI format.

Item restrictions

Item restrictions contains Enabled, the legacy noblacklist permission toggle, Feedback effect, Default ruleset, and Rulesets by permission. Each ruleset contains allowed/disallowed Rust categories, item short names, and skin IDs. Permission rulesets additionally require Name and generate backpacks.restrictions.<name>.

Clear on wipe

Clear on wipe contains Enabled, the legacy keeponwipe permission toggle, Default ruleset, and Rulesets by permission. Wipe rulesets add Max slots to keep; -1 means unlimited. Named entries generate backpacks.keeponwipe.<name>.

Configuration and player data

Permission sizes, size profiles, and named rulesets are variable-length configuration lists, but player data is not stored here. Backpack contents are stored per player under Oxide’s Backpacks data directory; interface preferences and earned dynamic capacity are also kept in separate files. The configurator edits only Backpacks.json, not player IDs, backpack contents, preferences, or earned capacity.

Official source: https://umod.org/plugins/backpacks

Migration

Keys from versions before 3.9 are accepted only when Backpacks migrates an older file. Version 3.17.6 no longer writes them to its configuration, so the configurator does not offer them.

Install the file

After keeping a copy of the previous file, place the exported JSON at this location on your server:

oxide/config/Backpacks.json

Follow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.