What is the Stack Size Controller plugin?
Stack Size Controller (SSC) is a RUST plugin that allows administrators to customize, by item type, the maximum stack size for every entity on a server. Patched and supported by AnExiledDev, SSC is a free-to-use plugin available for download on uMod and a favorite amongst the RUST-modded community. SSC is especially used on servers that use multiplier features to increase resource collection and gathering rates.
Note: This mod will require the server status to be designated as Modded in the server listing. For more information on this, check out the Developers Guide on plugin use for RUST servers.
Potential reasons to use the Stack Size Controller plugin
The Stack Size Controller plugin takes what is regarded by many as an under-managed stack size management system and removes the limitations of vanilla gameplay. Additional features (permissions pending) include:
- Auto-populates all items into the config file for convenience
- Allows for categorical stack size changes
Installing the Stack Size Controller plugin
As with all uMod plugin installations, your server must have uMod/Oxide installed and running. For a step-by-step perspective on how to install this plugin, please reference the following list:
- First, you must have uMod/Oxide installed on your server. Use our Installing uMod (Oxide) on Your RUST server guide if you need help; otherwise, if you use a third-party hosting, their user interface will have instructions on how to get started. It may be tooled explicitly to their platform, so reach out to your host for details.
- Acquire the latest version of the plugin from uMod’s Stack Size Controller page, or download the CS file directly.
- Locate the downloaded
StackSizeController.csfile and install the plugin on your RUST server, or follow your host-specific instructions. - Once you have followed the above guide and positioned
StackSizeController.csinto your Oxide> plugins folder, the server will create an alternateStackSizeController.jsonfile immediately in your Oxide> config folder. It’s important to differentiate these files and not mistake them. Configuration changes mentioned later will need to be made to the .json file in the config folder.
Things to consider BEFORE using Stack Size Controller
This mod comes with several important running notes that may impact your server’s performance:
- Item lists are produced upon installation into the config file. New item additions are automatically detected and added when the developer incorporates them into the game. When this occurs, a readout will be displayed in the console, and these new items may have their stacks updated per usual.
- Individual multipliers used, such as 5x, are given precedence over categorical stack size multipliers. Multipliers are determined based on the config file’s
IndividualItemStackSizevalue, not the game’s vanilla value. - Do not exceed item stacks beyond the hardcoded limitation of 2,147,483,647.
Permissions
As with all uMod plugins, each has a small list of plugin-specific permissions. Make sure you reference our uMod Permissions Guide to better understand the Oxide.grant permission system. Specific permission command lines for the RUST Stack Size Controller plugin include:
| Command | Description |
| stacksizecontroller.itemsearch | Allows for the returning of concise, printable item display names, descriptions, and short names, searchable in-game |
| stacksizecontroller.listcategories | Allows for the returning of concise, printable category lists in-game |
| stacksizecontroller.listcategoryitems | Allows for the returning of concise, printable items within a specified list in-game |
| stacksizecontroller.setallstacks | Allows for the manual update of the config file for adding or updating the current limit or multiplier list for ALL in-game items Example: |
| stacksizecontroller.setstack | Allows for the manual update of the config file for adding or updating the current limit or multiplier list Example: |
| stacksizecontroller.setstackcat | Allows for the manual update of the config file for adding or updating the current limit or multiplier list for an entire category of items Example: |
Additional dependencies
Like many other uMod plugins, Stack Size Controller may work as a standalone mod or in conjunction with other select mods. A full list of such mods includes:
Activation
Once installed and permitted to use the mod, the server will generate and abide by the item limitation ruleset outlined in the config file.
Recommended plugin configuration
By default, the configuration of the StackSizeController.json file should be adequate for most server owners’ purposes. To better understand potential option changes, this guide will go through the configuration file line by line as it pertains to the most commonly changed settings:
This is an example configuration file for Stack Size Controller – It has been altered slightly to better explain setting change impact – DO NOT copy and paste this example into your configuration.
{ "RevertStackSizesToVanillaOnUnload": true, - By default, unloading the plugin or removing it completely will return stack sizes to default unless otherwise toggled to false. "AllowStackingItemsWithDurability": true, - Be warned, this is buggy - it allows items with durability to be stacked, regardless of the current condition. This can be used as an exploit to improve the durability of a worn-out item. It can also be used to duplicate the ammo of weapons. "HidePrefixWithPluginNameInMessages": false, - currently non-functional "GlobalStackMultiplier": 1.0, - can be used to do an across-the-board stack size multiplier "CategoryStackMultipliers": { - can be used to do an across-the-board stack size multiplier per category "Weapon": 1.0, "Construction": 1.0, "Items": 1.0, "Resources": 1.0, "Attire": 1.0, "Tool": 1.0, "Medical": 1.0, "Food": 1.0, "Ammunition": 1.0, "Traps": 1.0, "Misc": 1.0, "All": 1.0, "Common": 1.0, "Component": 1.0, "Search": 1.0, "Favourite": 1.0, "Electrical": 1.0, "Fun": 1.0 }, "IndividualItemStackMultipliers": {},- can be used to do an across-the-board stack size multiplier per item "IndividualItemStackSize": {}, - can be used to do an across the board stack size setting per item "VersionNumber": { "Major": 4, "Minor": 0, "Patch": 0 } }
How to update the Stack Size Controller plugin
Updating the Stack Size Controller plugin is simple and quick:
- Visit the uMod Stack Size Controller plugin page
- Download the latest version of the Stack Size Controller plugin
- Overwrite the existing
StackSizeController.csfile in your Oxide plugins folder.
It is best practice not to uninstall the mod, as you do not need to alter the JSON file. It will remain with your existing settings (unless the developer otherwise suggests a complete reinstall).
How to remove the Stack Size Controller plugin
Since the Stack Size Controller plugin does impact the player experience and game features, removing the plugin will take a few extra steps.
- Prepare and properly shut down the RUST server
- Open the Oxide plugins folder in your server directory
- Locate and delete the
StackSizeController.csfile - Open the Oxide config folder in your server directory
- Locate and delete the
StackSizeController.jsonconfiguration file - Restart the RUST server
Suppose you want to disable the Stack Size Controller plugin for a short period. You can use the Oxide.unload StackSizeController command, which you may also run in the F1 console, RCON, or Web Console.
Disclaimer and seeking plugin assistance
Corrosion Hour does not maintain the RUST Stack Size Controller plugin, nor do we assist with modifying the plugin outside the config scope. Visit the plugin’s uMod page to support the plugin creators, report bugs, or propose feature requests. Please get in touch with an admin in our Discord community for help with the steps and instructions in this guide.
