RUST Recycle Manager v2.1.0

Video tutorial​

Features​

• Allows customizing recycler speed globally, in safe zones, per item, and according to permission
• Allows preventing specific items from being recycled
• Allows multiplying recycler output (can use 0 to disable outputting specific items)
• Allows fully customizing recycler output
• Allows recycling custom items
• Allows outputting custom items
• Administration panel allows previewing and editing recycler outputs in-game

Permissions​

This plugin uses the permission system. To assign a permission, use oxide.grant <user or group> <name or steam id> <permission>. To remove a permission, use oxide.revoke <user or group> <name or steam id> <permission>.

• recyclemanager.admin -- Allows all commands, and allows using the administration panel while viewing a recycler.

Speed permissions​

The following permissions come with this plugin's default configuration. Granting one to a player alters the speed of recyclers they use.

• recyclemanager.speed.fast -- Recycles 5x as fast.
• recyclemanager.speed.instant -- Recycles instantly.

You can add more speed configurations in the plugin configuration (Custom recycle speed > Speeds requiring permission), and the plugin will automatically generate permissions of the format recyclemanager.speed.<suffix> when reloaded. If a player has permission to multiple presets, only the last one will apply (based on the order in the config).

Commands​

This plugin provides both chat and console commands using the same syntax. When using a command in chat, prefix it with a forward slash: `/`.

• recyclemanager.add <item id or short name> -- Adds the specified item to the Override output section of the config.
• recyclemanager.reset <item id or short name> -- Adds or updates the specified item in the Override output section of the config.

Configuration​

The settings and options can be configured in the RecycleManager file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.
Default configuration:

Edit UI​

• Edit UI
  • Enabled (true or false) -- While true, players with the recyclemanager.admin permission will have access to the administration panel to preview and edit the recycle output of items. Set this to false if you don't intend on using the administration panel, to save a tiny bit on performance.

Recycler speed​

• Custom recycle speed -- This section allows you to optionally customize recycler speed.
  • Enabled (true or false) -- While true, this plugin will override the recycling speed on all recyclers. While false, this plugin will not affect recycler speed. Default: false.
    • Note: If other plugins want to cooperate with or override this behavior for specific recyclers or players, they can use the OnRecycleManagerSpeed hook.
  • Default recycle time (seconds) -- This value determines how long (in seconds) recyclers will take to process each item. Vanilla equivalent is 5.0 seconds. Default: 5.0.
  • Recycle time multiplier while in safe zone -- When a player starts a recycler while in a safe zone, recycle time will be multiplied by this value.
    • Example: 0.5 to double recycling speed in safe zones. Default: 1.0.
  • Recycle time multiplier by item short name (item: multiplier) -- This section allows you to speed up or slow down recycling for specific input items, using multipliers.
    • Example: { "gears": 0.5, "metalpipe": 0.25 } will make gears recycle in half the time (2x as fast), and metalpipe recycle in 1/4 the time (4x as fast).
  • Recycle time multiplier by permission -- This list allows you to speed up or slow down recycling for specific players according to their permission. Each entry in this list will generate a permission of the format recyclemanager.speed.<suffix>. Granting that permission to a player assigns the corresponding multiplier to them.
    • Permission suffix -- This is used to generate a permission of the format recyclemanager.speed.<suffix>. For example, if you set this to "fast", the plugin will generate the permission recyclemanager.speed.fast.
    • Recycle time multiplier -- The time the recycler takes to process input items will be multiplied by this value.

Recycle time multiplier examples:

• 0.5 = 2x speed
• 0.25 = 4x speed
• 0.2 = 5x speed
• 0.1 = 10x speed
• 0.0 = instant

Recycler efficiency​

• Custom recycle efficiency -- This section allows you to override the efficiency of recyclers.
  • Enabled (true or false) -- While true, this plugin will override the efficiency of all recyclers. While false, this plugin will use vanilla logic to determine recycler efficiency. Default: false.
    • Note: If other plugins want to cooperate with or override this behavior for specific recyclers or players, they can use the OnRecycleManagerEfficiency hook, or set the vanilla safezoneRecycleEfficiency and radtownRecycleEfficiency properties of individual recyclers.
  • Default recycle efficiency -- This value determines how efficient recyclers will be when processing items. For example, 1.0 will cause recyclers to output the full amount of ingredients used to craft them. Default: 0.6.
  • Recycle efficiency while in safe zone -- This value overrides Default recycle efficiency for recyclers that are in safe zones.

Item restrictions​

• Restricted input items -- This section allows you to designate specific items as notrecyclable. Other plugins can use the OnRecycleManagerItemRecyclable hook to override this behavior for specific items.
  • Item short names -- Items with these short names cannot be recycled.
    • Example: ["rope", "sewingkit"]
  • Item skin IDs -- Items with these skin IDs cannot be recycled.
    • Example: [1234567890, 4567891230]
  • Item display names (custom items) -- Items with these custom display names cannot be recycled. The name comparison is case-insensitive.
    • Example: ["Portable Minicopter", "Ultimate Fridge"]

Recycle stack speed​

• Max items per recycle -- This section allows you to configure the max number of items that can be recycled at a time within a given stack of items. In vanilla, at most 10% of the max stack size of an item can be recycled at a time. For example, if the techparts item has a max stack size of 50, only 5 can be recycled at a time in vanilla.
  • Default percent -- This percentage applies to all items, except those that match one of the below short names, skin IDs, or display names. If you want to allow all items to be recycled while at max stack size, set this value to 100.0 and leave the other Percent by ... options blank ({}).
  • Percent by input item short name -- This section allows you to override the percentage for specific items by item short name.
    • Example: { "gears": 100.0, "metalpipe": 100.0 }
  • Percent by input item skin ID -- This section allows you to override the percentage for specific items by item skin ID.
    • Example: { "1234567890": 20.0, "0987654321": 20.0 }
  • Percent by input item display name (custom items) -- This section allows you to override the percentage for specific items by item display name.
    • Example: { "Portable Car": 50.0, "Portable RHIB": 50.0 }

Output multipliers​

• Output multipliers -- This section allows you to increase or decrease the output of specific items. For example, if you set scrap to 2.0, all scrap output will be doubled.
  • Default multiplier -- This multipler applies to all items, except for those overriden in Multiplier by output item short name.
  • Multiplier by output item short name -- This section allows you to override the default multiplier for items by short name.
    • Example: { "scrap": 2.0, "metal.fragments": 0.0 }

Custom output / custom recyclables​

• Override output -- This section allows you to override the output of specific items. This can be used to replace the output of items that are already recyclable in vanilla, as well as to allow custom items to be recycled. The output that you configure here will be subject to item condition, but not subject to recycler efficiency nor Output multipliers.
  • Override output by input item short name -- This section allows you to define what the recycler will output for specific items by item short name. The output includes the following options.
    • Item short name -- The short name name of the output item.
    • Item skin ID -- The optional skin ID of the output item.
    • Display name -- The optional display name of the output item.
    • Amount -- The amount of the output item.
  • Override output by input item skin ID -- This section allows you to define what the recycler will output for specific items by item skin ID. Each entry here has the same options as Override output by input item short name.
  • Override output by input item display name (custom items) -- This section allows you to define what the recycler will output for specific items by item display name. Each entry here has the same options as Override output by input item short name.

Example configuration​

Localization​

The default messages are in the RecycleManager file under the lang/en directory. To add support for another language, create a new language folder (e.g. de for German) if not already created, copy the default language file to the new folder and then customize the messages.

FAQ​

How can I spawn recyclers at monuments?​

Use the plugin Monument Addons.

How can I allow players to place recyclers?​

There are many plugins that allow that use case, including Extended Recycler, Portable Recycler and Home Recycler.

Developer Hooks​

OnRecycleManagerItemRecyclable​

• Called when this plugin is about to forcibly dictate whether an item is recyclable
• Returning false will prevent this plugin from dictating whether the item can be recycled
• Returning null will result in the default behavior
• This hook will not be called when this plugin aligns with vanilla on whether the item should be recyclable, because this plugin does not intervene in that situation

OnRecycleManagerSpeed​

• Called after the player has toggled on the recycler
• Returning false will prevent this plugin from altering the recycler speed
• Returning null will result in the default behavior
• This hook will not be called when Custom recycle speed -> Enabled is false
• The recycleTime array has one item (at position 0)
  • After this hook has been called on all subscribed plugins, if all plugins returned null, Recycle Manager will change the recycler time to recycleTime[0]
  • If you want to alter the recycle time, consider the current value, change it if necessary, then return null

OnRecycleManagerEfficiency​

• Called when an item is about to be recycled
• The recycleEfficiency array has one item (at position 0)
  • The initial value will be from the Custom recycler efficiency section of the config if enabled, or else determined according to vanilla logic and the recycler location (0.4 in safe zones, 0.6 outside)
  • After this hook has been called on all subscribed plugins, Recycle Manager will use the recycler efficiency value in recycleEfficiency[0]
  • If you want to alter the recycle efficiency, consider the current value and change it only if necessary
• The BasePlayer argument is the last known player to have started the recycler, and may be null in some cases, especially if the recycler was started by another plugin

OnRecycleManagerRecycle​

• Called when this plugin is about to recycle the item
• Returning false will prevent this plugin from controlling how the item is recycled
• Returning null will result in the default behavior