Self Sorting Storage

Adds a new unlockable ship ugrade to the game : the Smart Cupboard!

This storage container who looks a lot like the vanilla Cupboard furniture, has the effect to automatically sorts equipment items that you store in.

The Smart Cupboard can be acquired by spending 20 credits in the store.

Compatible with v69 of Lethal Company.

How to use

On the side of this special Cupboard, you can find a storage box where players can dump their tools like flashlights, walkie-talkies, shovels, spray paints and even scrap items.

The storage will then sort these tools and put them on display in specific sections. Then all items will be organized and ready for players to grab and go!

Multiple copies of one item

• If you dump multiples copies of the same item, the storage will have them all 'visually' stacked on top of each other.
• In vanilla, having a lot of items in the ship can sometimes cause some lags. But with this mod installed, all subsequent copies of the same item are going to be stored in the Cupboard's memory. So, you will no longer have lag issues for buying 30+ shovels!

Other features

• All items stored in the Smart Cupboard are saved in the host player's current save file.
• If you dump a big item in the box, it will be rescaled to fit nicely in the storage!
• You can customize a lot of things in the config file (such as the price and the color of the cupboard).
• Some optional upgrades can be activated in the configs.

Compatibility notes

• GeneralImprovements
  • GeneralImprovements is a required dependency because I'm rotating items based on the FixItemsLoadingSameRotation + FixItemsFallingThrough configs. This is needed for items to face the correct direction when stored.
  • ShipPlaceablesCollide config in GeneralImprovements NEEDS to be activated (at least from my personnal observations).
• Matty_Fixes
  • If you have Matty_Fixes installed, you need to disable either FixItemsFallingThrough in GeneralImprovements OR disable OutOfBounds.Enabled in Matty_Fixes, because these mods do the same thing.
  • For people that don't want or need GeneralImprovements, it is considered as a soft dependency in the code so you can remove it safely. But if you remove it then you'll need to install Matty_Fixes instead.
• CruiserImproved and custom ships
  • If you have a custom ship mod AND CruiserImproved installed, reloading a save when the SSS is already unlocked will break it until a complete reset. Please wait for this mod to be updated to support custom ships.

How to add custom item condition

For items developers! By default, every items are allowed in the storage but if you want to add a custom "condition" to your scraps and tools, so the Smart Cupboard will not accept them, you can do so easily by adding this mod as a soft dependency and then write this code :

public static void AddValidation()
{
    SelfSortingStorage.Cupboard.SmartCupboard.AddTriggerValidation(MyCustomValidation, "[Your custom message]");
    // the custom message is displayed when a player tries to store something checked by your condition
}

private static bool MyCustomValidation(PlayerControllerB player)
{
    var item = player.currentlyHeldObjectServer;
    if (item is MyCustomItem)  // check your item
        return false;  // don't store the item
    return true;  // allow the item to be stored
}

Contact & Feedback

If you want to suggest new features or contact me please go to the mod release page in the modding discord or as a github issue.

Credits

• Thanks Xu Xiaolan for helping with some parts of the code, and also for suggesting good things!

• Thanks A Glitched Npc for the initial idea and for testing!

• Thanks ScienceBird for the help on the 1.0.4 update!

• Some parts ot the code is based on the ShipInventory implementation by WarperSan, such as the items data structure which has been modified to better fit the SelfSortingStorage mod.

• Cupboard asset is ripped from Lethal Company.

• "vent_chute" by jazz-the-giraffe is a free 3D model licensed under Creative Commons Attribution.

1.0.5

• Added the Reset Button and Cozy Lights upgrades that can be activated in the config
• Added a scan node to the storage box, can be removed in the config

1.0.4

• Smart Cupboard is now parented to the ship when spawned, this change allows the following:
  • Fixed items retrieved from the storage while the ship is moving to "jitter" in player hands
  • Stored items will now be recognized by mods like ShipLoot
• Updated compatibility notes in the README

1.0.3

• Added the S4 Upgrade Wide Cupboard that can be activated in the config

1.0.2

• Added a new config Rows order that allows to customize the order of items placement in the storage

1.0.1

• Fixed items sometimes floating above shelves if they are rescaled
• Placed items will now be correctly parented to the cupboard upon reloading the lobby, and same thing for late join players

1.0.0

• Initial release