You are viewing a potentially older version of this package. View all versions.
Yakka_Productions-ShipCleaner-1.0.0 icon

ShipCleaner

Automatically sorts your ship's scrap and equipment with a single hotkey press.

Date uploaded 2 weeks ago
Version 1.0.0
Download link Yakka_Productions-ShipCleaner-1.0.0.zip
Downloads 1387
Dependency string Yakka_Productions-ShipCleaner-1.0.0

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2305 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2305
Rune580-LethalCompany_InputUtils-0.7.13 icon
Rune580-LethalCompany_InputUtils

API/Library for creating Unity InputActions with in-game re-binding support. Provides an alternative UI that allows for supporting mods to have in-game re-bindable keybinds.

Preferred version: 0.7.13

README

ShipCleaner

Automatically sorts your ship's scrap and equipment with a single hotkey press.

Tired of wading through a pile of loot after every run? ShipCleaner organizes everything on the ship into a clean, value-sorted grid — so you always know where your most valuable scrap is, and your tools are always where you left them.


Features

  • One (configurable) hotkey sorts everything — Press , (comma) by default to sort the entire ship instantly. Rebind it anytime from the controls menu.
  • Scrap sorted by value — Most valuable items are placed first so you can find them at a glance.
  • Tools sorted into the Storage Closet — Flashlights, keys, weapons, consumables, and the shovel each go to their own shelf.
  • Two-handed items get their own zone — Large scrap (engines, axles, etc.) is placed near the ship doors, separate from one-handed scrap.
  • Same-type items stack — Duplicate scrap occupies the same grid cell with a slight random rotation so you can tell them apart.
  • Dynamic furniture avoidance — Sorted items will not be placed on top of or inside your purchased furniture, regardless of where you've moved it.
  • Closet-relative shelf layout — Tools and equipment will always find their way into the Storage Closet regardless of where it has been moved on the ship.
  • Special item handling — Yield signs and Stop signs get their own dedicated column out of the way. Certain crew-use items are intentionally left in place and not sorted. Most items from other mods should be compatible automatically.
  • Host-only — Only the host needs to press the hotkey. Clients will see the sorted layout automatically via normal game sync.

Installation

Install via r2modman or the Thunderstore app. All dependencies are handled automatically.

Manual install: Drop ShipCleaner.dll into BepInEx/plugins/ShipCleaner/.


Usage

  1. Load into a game as host.
  2. Press , (comma) to sort the ship.
  3. All scrap and tools will be arranged automatically.

The hotkey can be rebound in-game via the controls menu (requires LethalCompanyInputUtils).


Configuration

ShipCleaner can be configured externally by config file, or in-game with LethalConfig (optional).

Sorting Mode — Scrap, Tools & Equipment / Scrap Only / Tools & Equipment Only. Controls what gets sorted when the hotkey is pressed.

Storage Closet Usage — Enabled / Disabled. When disabled, tools are placed on the floor along the closet's default wall instead of inside it. Useful for players who prefer floor-only organisation.


Scrap Grid Layout

  Ship Doors Side
  |______==______|
  |              |
  |   2H Zone    |
  |--------------|
  |              |
  |              |
  |   1H Zone    |
  |              |
  |______________|
  Ship Controls Side

Known Limitations

  • Host only — Clients cannot trigger the sort. The host's sorted layout syncs to all players automatically.
  • Modded items — Unrecognised modded tools will sort as scrap unless their name contains a known keyword.

Credits

Developed by Yakka_ProductionsGitHub Built with BepInEx and LethalCompanyInputUtils.

Inspired by mods such as:


Changelog

1.0.0

  • Initial release.