Backpacks

Allows using all admin commands, and allows editing other players' backpacks.

Allows using the viewbackpack command to view other players' backpacks, without necessarily providing access to edit them.

Allows using the viewbackpack command to edit other players' backpacks.

Allows using the backpack.addsize and backpack.setsize commands.

Allows using the backpack.debug.size and backpack.debug.gather commands.

Protects your backpack from being viewed or edited by other administrators via the viewbackpack command.

Required to open your own backpack.

Required to see the GUI button.

Required to use the backpack.fetch command.

Exempts you from having your backpack erased or dropped on death.

Prevents food items in your backpack from spoiling, as though your backpack is a powered fridge.

Allows you to enable gather mode per backpack page, which automatically transfers newly acquired inventory items to your backpack.Note: When you disconnect from the server and reconnect some time later, gather mode will not be activated until you open your backpack at least once.

Allows you to enable retrieve mode per backpack page. When retrieve mode is enabled, you can build, craft and more using items from your designated backpack pages. Requires the Item Retriever plugin.Note: When you disconnect from the server and reconnect some time later, retrieve mode will not be activated until you open your backpack at least once. Additionally, reloading weapon ammo, switching weapon ammo, purchasing items from vending machines, and purchasing vehicles from NPC vendors will not be able to pull items from pages until you access those specific pages at least once after (re)connecting to the server.

Note: When you disconnect from the server and reconnect some time later, gather mode will not be activated until you open your backpack at least once.

Note: When you disconnect from the server and reconnect some time later, retrieve mode will not be activated until you open your backpack at least once. Additionally, reloading weapon ammo, switching weapon ammo, purchasing items from vending machines, and purchasing vehicles from NPC vendors will not be able to pull items from pages until you access those specific pages at least once after (re)connecting to the server.

If you want to grant specific players or groups more backpack capacity than the default (Backpack size -> Default size), then you may do so via permissions. Each number present in the Backpack size -> Permission sizes config option will cause the plugin to generate a permission of the format backpacks.size.<number>, which assigns the corresponding players or groups that much capacity. For example, backpacks.size.18 would assign 18 slots of capacity (3 rows).

The following permissions come with the plugin's default configuration.

1 rows

2 rows

3 rows

4 rows

5 rows

6 rows

7 rows

8 rows

16 rows (2 pages)

24 rows (3 pages)

Additional permissions may be defined by simply adding them to the Backpack size -> Permission sizes config option and reloading the plugin.

Note: If a player is granted multiple size permissions, the highest will apply.

If you want to allow players to upgrade the size of their backpack, it is possible to do so via the backpacks.size.* permissions above, by simply granting higher permissions as the player makes purchases or performs actions to earn the bigger size (you are responsible for using other plugins to grant and/or revoke permissions at the appropriate time). However, using permissions to determine backpack size is not the best fit for all types of servers, resulting in some example problems below.

If you want backpack size to be reset at the beginning of each wipe, you would need another plugin to reset permissions at that time.

If you want to allow players to increase their backpack size multiple ways, such as via a skill tree, via store purchases, via consumable items found and/or traded amongst players, that combination simply wouldn't be feasible because each upgrade source could override the others or have no effect if the permission granted corresponded to a smaller size than the player currently has.

Dynamic backpack size attempts to solve these problems. Using dynamic size, you can define size profiles, which declare an initial size and max size. You assign size profiles to players via permissions. At the beginning of each wipe, each player's backpack size is optionally reset to the initial size of their profile. Throughout a wipe, players can acquire size upgrades from various sources (i.e., other plugins) up to the max size declared in their profile. For example, if a player's size profile declared an initial size of 6, and a max size of 48, the player could incrementally acquire upgrades until they reach a size of 48, at which point, the backpack could no longer be upgraded.

In order to get started with dynamic backpack size, set the Dynamic Size (EXPERIMENTAL) -> Enabled config option to true and reload the plugin. Then, grant one of the below permissions (or a new one that you define in the config)

The following permissions come with the plugin's default configuration. Additional size profiles can be defined in the config, which will generate additional permissions.

6 to 48 slots

6 to 96 slots

6 to 144 slots

Important notes:

If a player is granted multiple backpacks.size.profile.* permissions, the initial size and max size will be the highest of all profiles they have access to (Changed in v3.14.0).

If a player is granted any backpacks.size.profile.* permissions, it will override the default backpack size from the config, as well as any backpacks.size.<number> permissions they have been granted because size profiles take priority over all other configuration/permissions.

The plugin keeps track of the bonus size the player has received, not the exact size. This means that you can generally switch a player from one profile to another without losing earned capacity. For example, if the player starts with a profile of 6-48 and upgrades the capacity to 24 (6 18) and then receives permission to a profile of 48-96, they will have a capacity of 66 (48 18).

This plugin does not currently offer built-in features to upgrade backpack capacity, so other plugins must be used for such use cases. Plugin developers can reference the API documentation below for details on how to query and modify backpack capacity. The notable API method names are below.API_IsDynamicCapacityEnabledAPI_GetBackpackCapacityAPI_GetBackpackInitialCapacityAPI_GetBackpackMaxCapacityAPI_AddBackpackCapacityAPI_SetBackpackCapacity

Other plugins can use the backpack.addsize and backpack.setsize commands, but depending on your exact setup, that could allow for situations where players can effectively waste resources to purchase upgrades when already at max capacity. More precise integrations using the APIs are recommended because other plugins can query the Backpacks plugin to determine whether an upgrade is possible before charging the player.

API_IsDynamicCapacityEnabled

API_GetBackpackCapacity

API_GetBackpackInitialCapacity

API_GetBackpackMaxCapacity

API_AddBackpackCapacity

API_SetBackpackCapacity

If you want to allow backpacks of specific players or groups to accept different items than the default (Item restrictions -> Default ruleset), then you may do so via permissions. Each ruleset defined in the Item restrictions -> Rulesets by permission config option will cause the plugin to generate a permission of the format backpacks.restrictions.<name>. Granting that permission assigns that ruleset to the corresponding players or groups.

The following permissions come with the plugin's default configuration. Additional item restriction rulesets can be defined in the config, which will generate additional permissions.

Allows all items in the player's backpack. Only useful if you have customized the default ruleset to restrict items.

Note: If a player is granted multiple backpacks.restrictions.* permissions, the last will apply, according to the ruleset order in the config.

If you want to allow backpacks of specific players or groups to retain different items across wipes than the default (Clear on wipe > Default ruleset), then you may do so via permissions. Each ruleset defined in the Clear on wipe > Rulesets by permission config option will cause the plugin to generate a permission of the format backpacks.keeponwipe.<name>. Granting that permission assigns that ruleset to the corresponding players or groups.

The following permissions come with the plugin's default configuration. Additional keep-on-wipe rulesets can be defined in the config, which will generate additional permissions..

Allows all items to be kept across wipes.

Note: If a player is granted multiple backpacks.keeponwipe.* permissions, the last will apply, according to the ruleset order in the config.

The following permissions are still supported by the plugin for backwards compatibility, but you are advised to use newer permissions instead.

Like backpacks.size.* but assigns the specified number of rows rather than number of slots.These permissions will be generated when the "Backpack size" > "Enable legacy backpacks.use.1-8 row permissions": true config option is set, which will be automatically added to your config when upgrading from a previous version of the plugin, if you have the "Backpack Size (1-8 Rows)" config option set at that time.Recommended alternative: backpacks.size.6 through backpacks.size.48 (present in the default configuration, but might not exist depending on how you have modified the config)

Exempts players from item restrictions, allowing any item to be placed in their backpack.This permission is present when the "Item restrictions" > "Enable legacy noblacklist permission": true config option is set, which will be automatically added to your config when upgrading from a previous version of the plugin, if you have the "Use Whitelist (true/false)": true or "Use Blacklist (true/false)": true config options set at that time.Recommended alternative: backpacks.restrictions.allowall (present in the default configuration, but might not exist depending on how you have modified the config)

Exempts players from having their backpack content erased on map wipe.This permission is present when the "Clear on wipe" > "Enable legacy keeponwipe permission": true config option is set, which will be automatically added to your config when upgrading from a previous version of the plugin, if you have the "Clear Backpacks on Map-Wipe (true/false)": true config option set at that time.Recommended alternative: backpacks.keeponwipe.all (present in the default configuration, but might not exist depending on how you have modified the config)

These permissions will be generated when the "Backpack size" > "Enable legacy backpacks.use.1-8 row permissions": true config option is set, which will be automatically added to your config when upgrading from a previous version of the plugin, if you have the "Backpack Size (1-8 Rows)" config option set at that time.

Recommended alternative: backpacks.size.6 through backpacks.size.48 (present in the default configuration, but might not exist depending on how you have modified the config)

This permission is present when the "Item restrictions" > "Enable legacy noblacklist permission": true config option is set, which will be automatically added to your config when upgrading from a previous version of the plugin, if you have the "Use Whitelist (true/false)": true or "Use Blacklist (true/false)": true config options set at that time.

Recommended alternative: backpacks.restrictions.allowall (present in the default configuration, but might not exist depending on how you have modified the config)

This permission is present when the "Clear on wipe" > "Enable legacy keeponwipe permission": true config option is set, which will be automatically added to your config when upgrading from a previous version of the plugin, if you have the "Clear Backpacks on Map-Wipe (true/false)": true config option set at that time.

Recommended alternative: backpacks.keeponwipe.all (present in the default configuration, but might not exist depending on how you have modified the config)

Opens another player's backpack (requires backpacks.admin permission)

Attempts to change the size of the specified player's backpack by the specified amount, without going outside the bounds of the player's size profile. This can be used to decrease capacity by providing a negative number. Requires the experimental dynamic size feature to be enabled in the config.

Attempts to set the size of the player's backpack to the specified amount, without going outside the bounds of the player's size profile. Requires the experimental dynamic size feature to be enabled in the config.

Prints diagnostic information about the specified player's backpack size. Use this command to debug why a player's backpack isn't the expected size. Note: This command always outputs English so that it can be shared easily with the developer.

Prints diagnostic information about the gather mode feature of the specified player's backpack. Use this command to debug why gather mode isn't working for a player's backpack. Note: This command always outputs English so that it can be shared easily with the developer.

Opens your own backpack. Requires the backpacks.use permission. If the backpack is already open, this will advance to the next page, or will close the player inventory if there are no more pages.

Fetches an item from your backpack.

Toggles whether you can see the backpack GUI button.

Sets gather mode for the specified backpack page. If the page number is not specified, this applies to the first page. This command is useful for quickly changing gather mode via a key bind without opening your backpack. Note: If you want to consistently receive feedback for this command via chat instead of via console, you should bind it like bind <key> chat.say "/backpack.setgathermode All" instead of bind <key> backpack.setgathermode All.

Wipes dynamic backpack size data and backpack contents for all players according to the configured wipe rulesets, the same as when the server wipes. You can use this command to test what would happen on a server wipe, or to forcibly trigger a wipe if something went wrong (e.g., if the Backpacks plugin was not loaded when the new map save file was created, then Backpacks could not have detected the wipe event, so you would need to run this manually).

Forcibly erases all the contents of a specific player's backpack, even if they have backpack.keeponwipe.* permissions that would normally exempt them.

Default configuration:

{ "Backpack size": { "Default size": 6, "Max size per page": 48, "Enable legacy backpacks.use.1-8 row permissions": false, "Permission sizes": [ 6, 12, 18, 24, 30, 36, 42, 48, 96, 144 ], "Dynamic Size (EXPERIMENTAL)": { "Enabled": false, "Reset dynamic size on wipe": { "Enabled": true }, "Size profiles": [ { "Permission suffix": "6-48", "Initial size": 6, "Max size": 48 }, { "Permission suffix": "6-96", "Initial size": 6, "Max size": 96 }, { "Permission suffix": "6-144", "Initial size": 6, "Max size": 144 } ] } }, "Drop on Death (true/false)": true, "Erase on Death (true/false)": false, "Minimum Despawn Time (Seconds)": 300.0, "GUI Button": { "Enabled": true, "Enabled by default (for players with permission)": true, "Skin Id": 3050418770, "Image": "", "Background Color": "0.969 0.922 0.882 0.035", "GUI Button Position": { "Anchors Min": "0.5 0.0", "Anchors Max": "0.5 0.0", "Offsets Min": "185 18", "Offsets Max": "245 78" } }, "Container UI": { "Show page buttons on container bar": false, "Max page buttons to show": 8 }, "Softcore": { "Reclaim Fraction": 0.5 }, "Item restrictions": { "Enabled": false, "Enable legacy noblacklist permission": false, "Feedback effect": "assets/prefabs/locks/keypad/effects/lock.code.denied.prefab", "Default ruleset": { "Allowed item categories": [ "All" ], "Disallowed item categories": [], "Allowed item short names": [], "Disallowed item short names": [], "Allowed skin IDs": [], "Disallowed skin IDs": [] }, "Rulesets by permission": [ { "Name": "allowall", "Allowed item categories": [ "All" ], "Disallowed item categories": [], "Allowed item short names": [], "Disallowed item short names": [], "Allowed skin IDs": [], "Disallowed skin IDs": [] } ] }, "Clear on wipe": { "Enabled": false, "Enable legacy keeponwipe permission": false, "Default ruleset": { "Max slots to keep": 0, "Allowed item categories": [], "Disallowed item categories": [], "Allowed item short names": [], "Disallowed item short names": [], "Allowed skin IDs": [], "Disallowed skin IDs": [] }, "Rulesets by permission": [ { "Name": "all", "Max slots to keep": -1, "Allowed item categories": [ "All" ], "Disallowed item categories": [], "Allowed item short names": [], "Disallowed item short names": [], "Allowed skin IDs": [], "Disallowed skin IDs": [] } ] }, }

Backpack sizeDefault size (Default: 6) -- Determines the capacity (in slots) of backpacks for players who have the backpacks.use permission.Note: Players who have backpacks.size.<number> permissions may have greater capacity.Note: Players who have backpacks.size.profile.* permissions may have different capacity.Max size per page (Default: 48, Max: 48) -- Determines the capacity (in slots) per backpack page. For example, if you grant a player 60 backpack capacity, and set the max size per page to 48, their backpack will have two pages: one page with 48 capacity, and another page with 12 capacity.Enable legacy backpacks.use.1-8 row permissions (true or false; Default: false) -- Determines whether the backpacks.use.1-8 permissions are registered by the plugin. When upgrading the plugin to 3.9 , if you have the "Backpack Size (1-8 Rows)" config option set, this option will be automatically enabled for backwards compatibility. Even if you are installing the plugin for the first time, there are valid uses cases to enable this option, such as if you use another plugin that manages those permissions. As of this writing, the XPerience and Backpack Upgrader plugins both use these permissions to allow players to increase capacity through a progression system, but that might have changed by the time you read this.Permission sizes -- Each number in this list generates a permission of the format backpacks.size.<number>. Granting that permission to a player or group assigns that much capacity to their backpack. This is useful if you want some players to have more capacity than the above default. Note: If a player is granted multiple size permissions, the highest will apply.Note: These permissions are ignored for players who have backpacks.size.profile.* permissions.Dynamic Size (EXPERIMENTAL) -- Advanced feature for integration with other plugins. Note: This feature is subject to change in future updates. If you like the idea of this feature, please provide feedback on the uMod forums (click the "Help" button on the sidebar to access the Backpacks forums).Enabled (true or false; Default: false) -- While true, dynamic size is enabled, meaning any backpacks.size.profile.* permissions will be generated from the config and will take effect. While false, dynamic size options are disabled, meaning backpacks.size.profile.* permissions will not be generated and will have no effect if previously granted to players.Reset dynamic size on wipeEnabled (true or false; Default: true) -- While true, dynamic size will be reset on wipe. This means all backpacks using dynamic size will revert to initial size.Size profiles -- Each entry in this list defines a size profile. When a size profile is assigned to a player via permissions, that player's backpack size is determined by the profile, overriding the default backpack size from the config and any backpacks.size.<number> permissions the player has been assigned.Permission suffix -- Determines the generated permission of format backpacks.restrictions.<suffix>.Initial size -- The initial size of the backpack. Other plugins can use the API to change the backpack's size, but not below this amount. The size is automatically reset to this value when the server is wiped.Max size -- The max size of the backpack. Other plugins can use the API to increase the backpack's size up to this amount.

Default size (Default: 6) -- Determines the capacity (in slots) of backpacks for players who have the backpacks.use permission.Note: Players who have backpacks.size.<number> permissions may have greater capacity.Note: Players who have backpacks.size.profile.* permissions may have different capacity.

Max size per page (Default: 48, Max: 48) -- Determines the capacity (in slots) per backpack page. For example, if you grant a player 60 backpack capacity, and set the max size per page to 48, their backpack will have two pages: one page with 48 capacity, and another page with 12 capacity.

Determines whether the backpacks.use.1-8 permissions are registered by the plugin. When upgrading the plugin to 3.9 , if you have the "Backpack Size (1-8 Rows)" config option set, this option will be automatically enabled for backwards compatibility. Even if you are installing the plugin for the first time, there are valid uses cases to enable this option, such as if you use another plugin that manages those permissions. As of this writing, the XPerience and Backpack Upgrader plugins both use these permissions to allow players to increase capacity through a progression system, but that might have changed by the time you read this.

Each number in this list generates a permission of the format backpacks.size.<number>. Granting that permission to a player or group assigns that much capacity to their backpack. This is useful if you want some players to have more capacity than the above default. Note: If a player is granted multiple size permissions, the highest will apply.Note: These permissions are ignored for players who have backpacks.size.profile.* permissions.

Dynamic Size (EXPERIMENTAL) -- Advanced feature for integration with other plugins. Note: This feature is subject to change in future updates. If you like the idea of this feature, please provide feedback on the uMod forums (click the "Help" button on the sidebar to access the Backpacks forums).Enabled (true or false; Default: false) -- While true, dynamic size is enabled, meaning any backpacks.size.profile.* permissions will be generated from the config and will take effect. While false, dynamic size options are disabled, meaning backpacks.size.profile.* permissions will not be generated and will have no effect if previously granted to players.Reset dynamic size on wipeEnabled (true or false; Default: true) -- While true, dynamic size will be reset on wipe. This means all backpacks using dynamic size will revert to initial size.Size profiles -- Each entry in this list defines a size profile. When a size profile is assigned to a player via permissions, that player's backpack size is determined by the profile, overriding the default backpack size from the config and any backpacks.size.<number> permissions the player has been assigned.Permission suffix -- Determines the generated permission of format backpacks.restrictions.<suffix>.Initial size -- The initial size of the backpack. Other plugins can use the API to change the backpack's size, but not below this amount. The size is automatically reset to this value when the server is wiped.Max size -- The max size of the backpack. Other plugins can use the API to increase the backpack's size up to this amount.

Note: Players who have backpacks.size.<number> permissions may have greater capacity.

Note: Players who have backpacks.size.profile.* permissions may have different capacity.

Note: These permissions are ignored for players who have backpacks.size.profile.* permissions.

Enabled (true or false; Default: false) -- While true, dynamic size is enabled, meaning any backpacks.size.profile.* permissions will be generated from the config and will take effect. While false, dynamic size options are disabled, meaning backpacks.size.profile.* permissions will not be generated and will have no effect if previously granted to players.

Reset dynamic size on wipeEnabled (true or false; Default: true) -- While true, dynamic size will be reset on wipe. This means all backpacks using dynamic size will revert to initial size.

Each entry in this list defines a size profile. When a size profile is assigned to a player via permissions, that player's backpack size is determined by the profile, overriding the default backpack size from the config and any backpacks.size.<number> permissions the player has been assigned.Permission suffix -- Determines the generated permission of format backpacks.restrictions.<suffix>.Initial size -- The initial size of the backpack. Other plugins can use the API to change the backpack's size, but not below this amount. The size is automatically reset to this value when the server is wiped.Max size -- The max size of the backpack. Other plugins can use the API to increase the backpack's size up to this amount.

Enabled (true or false; Default: true) -- While true, dynamic size will be reset on wipe. This means all backpacks using dynamic size will revert to initial size.

Determines the generated permission of format backpacks.restrictions.<suffix>.

The initial size of the backpack. Other plugins can use the API to change the backpack's size, but not below this amount. The size is automatically reset to this value when the server is wiped.

The max size of the backpack. Other plugins can use the API to increase the backpack's size up to this amount.

Determines the display of the GUI button which players can click on to open and close their backpack.Enabled (true or false; Default: true) -- Determines whether the GUI button is enabled. If you don't intend to show the GUI button to any players, set this to false to improve performance. Disabling this will also unregister the backpackgui command so that another plugin can use it.Enabled by default (for players with permission) (true or false; Default: true) -- Determines whether the GUI button is shown for new players by default, if they have the backpacks.gui permission. Note: Players can use the backpackgui command to personally toggle it on/off if they don't agree with the default you chose.Skin Id (Default: 3050418770) -- Determines the skin ID used to display the GUI button, as an alternative to the Image URL. While 0, this has no effect. Note: Users may see the saddle bag item icon briefly while the skin icon is downloaded to their computer.Image (Default: "") -- Determines the URL of the image to display on the GUI button, as an alternative to Skin Id.Background Color -- Default: "0.969 0.922 0.882 0.035".GUI Button Position -- Determines the position and size of the button.Anchors Min -- Default: "0.5 0.0" (bottom center of screen). Don't change this unless you know what you are doing.Anchors Max -- Default: "0.5 0.0" (bottom center of screen). Don't change this unless you know what you are doing.Offsets Min -- Determines the bottom-left position of the button. Default: "185 18" (right side of belt).Offsets Max -- Determines the top-right position of the button. Default: "245 78" (right side of belt).

Enabled (true or false; Default: true) -- Determines whether the GUI button is enabled. If you don't intend to show the GUI button to any players, set this to false to improve performance. Disabling this will also unregister the backpackgui command so that another plugin can use it.

Enabled by default (for players with permission) (true or false; Default: true) -- Determines whether the GUI button is shown for new players by default, if they have the backpacks.gui permission. Note: Players can use the backpackgui command to personally toggle it on/off if they don't agree with the default you chose.

Skin Id (Default: 3050418770) -- Determines the skin ID used to display the GUI button, as an alternative to the Image URL. While 0, this has no effect. Note: Users may see the saddle bag item icon briefly while the skin icon is downloaded to their computer.

Image (Default: "") -- Determines the URL of the image to display on the GUI button, as an alternative to Skin Id.

Default: "0.969 0.922 0.882 0.035".

Determines the position and size of the button.Anchors Min -- Default: "0.5 0.0" (bottom center of screen). Don't change this unless you know what you are doing.Anchors Max -- Default: "0.5 0.0" (bottom center of screen). Don't change this unless you know what you are doing.Offsets Min -- Determines the bottom-left position of the button. Default: "185 18" (right side of belt).Offsets Max -- Determines the top-right position of the button. Default: "245 78" (right side of belt).