Zone Recycle Bin 2.0 addon

PURPOSE:

Why would you want something like this, if it can't get rid of stuck quest items?

• To get rid of trashed, field-stripped, or very powerful weapons you don't want NPCs picking up
• For roleplay or challenge purposes that require you to "sacrifice" or otherwise "spend" non-consumable items
• To eliminate general clutter
• To reduce inventory iteration lag
• Spite, because fsck that one item in particular

Inventory lag is the way that after a while, the sheer quantity of items in one place--like your home base--can start to significantly slow down inventory interacts, even cause the game to pause or freeze while it goes through the lists. That can get painful, especially if you're as much of a pack rat as I am.

NEW IN 2.0: OPEN THE BIN FROM INVENTORY

Don't want to go through the extra steps of placing and picking back up the bin every time you want to trash something? Just want to carry it with you as a portable trash can? Right-clicking on the inventory item now also offers the option to open the bin directly from there. Enjoy the QoL gain.

INSTALLATION:

Install using a mod organizer. You can manually move them over if you're more comfortable doing that, but there are a number of files in different places, and an organizer like MO2 is recommended. I can't support manual installs.

If you are manually upgrading to 2.0 from a previous version, you must ensure that all files from the previous version are deleted first. If you use MO2, you need only install the new archive.

A new game is not required, and removing the mod will not affect a game in progess--however, you should get rid of the placeable item first, as the existence of any item that is no longer in the config files can cause crashes.

UNINSTALLATION:

The "uninstall" option will delete any copies of the item in the player's inventory to avoid crashes.

If you have already spawned or used a Recycle Bin item, and have MCM, do the following:

1. Pick up any placed Zone Recycle Bin items and hold them in the player's inventory.
2. In MCM, check the "Uninstall ZRB" option and apply.
3. Save and exit.

If you don't have MCM, then:

1. Pick up any placed Zone Recycle Bin items and hold them in the player's inventory.
2. Save and exit the game
3. Open scripts\item_trashcan.script and change "uninstall = false" to true
4. Launch the game once, load your character, then save and exit

It is then safe to uninstall this addon.

To do so, use MO2 (recommended) or delete the files manually.

CONFLICTS:

If you install the Non-DLTX option, this mod uses the monkeypatch script workshop_autoinject.script to inject a new crafting recipe, a tool which is also used by various other mods. I am only using the basic unaltered functionality of adding or removing a recipe, so if you already have this file from another mod, you probably don't need to overwrite it with mine.

You also do not need--and should NOT install!--the Non-DLTX option if you are using the demonized modded exes or binaries based on them such as GAMMA, EFP, or Screen Space Shaders. Just install the base option.

If you install the 02 legacy option, this mod will conflict with any that modifies map_spots_relations.xml.

However, this conflict is extremely easy to resolve. Only a single "include" line needs to be added, and there are instructions in map_spots_zrb.xml.

It should be fairly simple, but this information is provided "as-is", and I cannot assist with troubleshooting merge issues.

If you already use a mod which includes demonized_time_events.script, it should not matter which one you use.

Everything else should get along fine; the scripting and assets are all self-contained.

KNOWN ISSUES:

If you spam a large number of items into the bin at once, some may not get deleted. Just remove and re-add the missed items.

There is an increasingly high likelihood that this addon won't work in 1.5.1, and I honestly don't care. Just upgrade already. In fact, please use the modded exes by demonized.

LOCALIZATION:

Thank you to Asametar for RUS and UKR translations!

CHANGE LOG:

2.0: Major overhaul, please perform a fresh reinstall of the mod. The ZRB can now be opened from the player's inventory, and items disposed of without having to place it first. Placing the ZRB no longer prompts for a name, and uses a standard one; most backpack code has been removed. If you have modded exes, mapspot files are no longer replaced, and the workshop autoinject is no longer needed--both are now handled by DXML and DLTX, respectively, and the GAMMA patch is no longer needed. Recipe option removed from MCM, since it is always added now. Fix for ZRB placement triggering when other items were used. Fix for custom search tip not appearing.

1.4: Significant internal changes to the way items are queued and tracked, including use of demonized's time events. All of this should be invisible to the player, but with a huge benefit: most issues with items not being deleted (especially when adding many items at once) should be resolved. Added garbage collection on map load so that any missed items get cleaned up--you may need to remove and re-add old missed items once. Changed the default use_mapspots to false, to reduce conflicts for players who don't need that option and have other mods changing mapspots files.

1.3: Fixed a bug that could result in duplicate crafting recipes being added. This was a harmless visual bug that will not persist through saves; Anomaly reloads recipes from its own files every game load. Fixed a crash that could happen if uninstall was checked but actor was not loaded.

1.2: Added an optional crafting recipe. This relies on workshop_autoinject.script, a monkeypatch from Outfit Parts Overhaul (and other mods as well). Also cleaned up the script and its comments a bit.

1.1: Added new option to aid in uninstalling the mod. Added RUS and UKR localization courtesy of Asametar. Updated the bin's world model with one that has cleaner surface smoothing, thanks to PYP.

1.0: Initial public release.