Skip to content

A plugin for Rust servers which allow configuring item stack sizes for every item up to the maximum Int32 value.

Notifications You must be signed in to change notification settings

WouayNote/StackSizeController

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 

Repository files navigation

Feature Highlights

  • Allows setting stack sizes for nearly every item in Rust.
  • Items are automatically populated in the configuration file.
  • Stacks can easily be modified globally, by category or individually in the configuration file.
  • Several quality of life commands allowing you to search all items and list categories.
  • Item search displays vanilla stack rate as well as custom stack rate after multipliers.

Quick Important Notes

  • Running the plugin once generates items in configuration for IndividualItemStackSize from vanilla defaults. This list is automatically updated when new items are detected, and a notification is put in the console.
  • Multipliers multiply IndividualItemStackSize definitions not vanilla stack size. Individual multipliers take priority over category stack multipliers.
  • Datafiles are no longer used. Editing vanilla-defaults does nothing but screw up stack sizes when unloading the plugin.
  • Stacking an item over 2,147,483,647 will cause an error when loaded and will not stack the item at that number. 2,147,483,647 is the max for stack sizes for all stack size plugins as it is a hardcoded limitation of Rust.

Installation Instructions

  • Put plugin in oxide/plugins.
  • Start server and wait for StackSizeController to be loaded.
  • Open the configuration and modify settings as needed. Setting individual stack sizes is done in the configuration NOT datafile in value IndividualItemStackSize which is generated on plugin load.
  • Run o.reload StackSizeController in console to set configured stack sizes.

Console Commands

stacksizecontroller.itemsearch

Permission: stacksizecontroller.itemsearch (Only needed if used in-game)
Usage: stacksizecontroller.itemsearch <full or partial item name>
Parameter #1: full or partial item name Can be any length, however I suggest you use 2, 3 or more characters to avoid potential slowdowns.
Usage Example: stacksizecontroller.itemsearch pic (Result pictured below)
Searches item display names, descriptions, and shortnames for all or partial results and returns them in an organized list.

itemsearch example


stacksizecontroller.listcategories

Permission: stacksizecontroller.listcategories (Only needed if used in-game)
Usage: stacksizecontroller.listcategories
Parameters: No Parameters
Usage Example: stacksizecontroller.listcategories (Result pictured below)

listcategories example


stacksizecontroller.listcategoryitems

Permission: stacksizecontroller.listcategoryitems (Only needed if used in-game)
Usage: stacksizecontroller.listcategoryitems <exact category name>
Parameter #1: exact category name Must be an exact category name. Use stacksizecontroller.listcategories for help.
Usage Example: stacksizecontroller.listcategoryitems Weapons
Output matches stacksizecontroller.listcategoryitems

stacksizecontroller.setstack

Permission: stacksizecontroller.setstack (Only needed if used in-game)
Usage: stacksizecontroller.setstack <item shortname or id> <stack limit or multiplier>
Parameter #1: Shortname or ID Use stacksizecontroller.itemsearch if you need help.
Parameter #2: Stack limit or multiplier Supplying just a number like "2000" sets that as the max stack limit. Supplying a number immediately followed by an x sets a multiplier, like "20x". Entering "20 x" would cause an error.
Usage Example: stacksizecontroller.setstack generator.wind.scrap 5 (Hard limit) or stacksizecontroller.setstack wood 20x (Multiplier)
Updates configuration file, adding or updating the hard limit list or the multiplier list.

stacksizecontroller.setstackcat

Permission: stacksizecontroller.setstackcat (Only needed if used in-game)
Usage: stacksizecontroller.setstackcat <category name> <stack multiplier>
Parameter #1: category name Use stacksizecontroller.listcategories if you need help. (Not case sensitive)
Parameter #2: Stack multiplier Unlike setstack this only accepts a multiplier, it does not require and will error if it's provided with a non-numeric character.
Usage Example: stacksizecontroller.setstackcat resources 20
Updates configuration file, changing the specified categories multiplier.

stacksizecontroller.setallstacks

Permission: stacksizecontroller.setallstacks (Only needed if used in-game)
Usage: stacksizecontroller.setallstacks <stack multiplier>
Parameter #1: Stack multiplier Unlike setstack this only accepts a multiplier, it does not require and will error if it's provided with a non-numeric character.
Usage Example: stacksizecontroller.setallstacks 10
Updates configuration file, changing every category to the defined multiplier.

Configuration

Default Configuration

{
  "RevertStackSizesToVanillaOnUnload": true,
  "AllowStackingItemsWithDurability": true,
  "HidePrefixWithPluginNameInMessages": false,
  "GlobalStackMultiplier": 1.0,
  "CategoryStackMultipliers": {
    "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": {},
  "IndividualItemStackSize": {},
  "VersionNumber": {
    "Major": 4,
    "Minor": 0,
    "Patch": 0
  }
}

Configuration Example

{
  "RevertStackSizesToVanillaOnUnload": true,
  "AllowStackingItemsWithDurability": true,
  "HidePrefixWithPluginNameInMessages": false,
  "GlobalStackMultiplier": 1.0,
  "CategoryStackMultipliers": {
    "Weapon": 1.0,
    "Construction": 5.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": 
  {
    "-586342290": 10,
    "ammo.pistol": 20
  },
  "IndividualItemStackSize": {
    "abovegroundpool": 1,
    "aiming.module.mlrs": 1,
    "ammo.grenadelauncher.buckshot": 24,
    "ammo.grenadelauncher.he": 12,
    "ammo.grenadelauncher.smoke": 12,
    "ammo.handmade.shell": 64,
    "ammo.nailgun.nails": 64,
    "ammo.pistol": 128,
    "ammo.pistol.fire": 128,
    "ammo.pistol.hv": 128,
    "ammo.rifle": 128,
    "ammo.rifle.explosive": 128,
    (... Continued)
  },
  "VersionNumber": {
    "Major": 4,
    "Minor": 0,
    "Patch": 0
  }
}
  • RevertStackSizesToVanillaOnUnload - If true; item stacksizes are returned to vanilla defaults on plugin unload.
  • AllowStackingItemsWithDurability - If enabled, items with durability such as weapons can be stacked if they are at full durability. If disabled items with durability can't be stacked at all. (Contents, attachments and ammo are all returned to the player)
  • HidePrefixWithPluginNameInMessages - Currently does nothing. Future version will hide the prefix from chat messages in-game.
  • GlobalStackMultiplier - Multiplies all item stacks by this value.
  • CategoryStackMultipliers - Each category will multiply stacks for those items by the defined amount.
  • IndividualItemStackMultipliers - Accepts "item_id": multiplier. Use stacksizecontroller.itemsearch to find the item id easily.
  • IndividualItemStackSize - Where you define specific stack sizes for each individual item.

Developer Hooks

OnVendorHeliFuelAdjust

  • Called when a heli has spawned at a vendor, and this plugin is about to reset its fuel amount to 100
  • Returning false will prevent the fuel from being adjusted
  • Returning null will result in the default behavior
bool? OnVendorHeliFuelAdjust(MiniCopter heli)

About

A plugin for Rust servers which allow configuring item stack sizes for every item up to the maximum Int32 value.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%