ShipMaid

v4.0.9·Updated 2024-06-05

On keypress or terminal command, within the ship, items in the ship or closet will be organized.

About this mod Author’s original text

LethalCompanyShipMaid

A mod where the ship and the storage closet is cleaned up when you press the associated keybinding within the ship or use the terminal command.

Usage

  • Activate the cleanup methods by using the terminal or keypresses
  • Terminal Commands
  • Type 'cleanup' to cleanup the ship and closet
  • Type 'cleanup storage' to cleanup the storage closet only
  • Keybinds
  • Press 'M' to cleanup the ship and closet
  • Press 'N' to cleanup the storage closet only
  • Press 'J' to set an objects placement location (if position overrides enabled)
  • Make sure that any players that you play with also have the mod installed for them to see the organized loot change positions.

Features

Basics

  • Either Keypresses or Terminal can activate the cleanup routines
  • Key Binds
  • Change these settings in the settings menu (InputUtils)
  • Ship cleanup default keybinding is 'M'
  • By default all objects not on the 'ClosetLocationOverride' list are organized
  • You can override specific items to not be sorted by adding them to the config setting 'SortingDisabledList'
  • Closet cleanup default keybinding is 'N'
  • Items in the closet will be staggered slightly to the right of the 'first' item
  • Can override which objects get automatically placed in the storage closet using Config setting 'ClosetLocationOverride'
  • Terminal Interface
  • Going to the terminal and entering either 'cleanup' or 'cleanup storage' will organize the ship or the storage closet.
  • Setting object locations
  • Set object location default keybinding is 'J'
  • If UseOneHandedPlacementOverrides / UseTwoHandedPlacementOverrides / UseItemTypePlacementOverrides is enabled, pressing this keybind will log the location of the given item for future organization requests
  • Object override locations are stored in the config file and will persist into other game files
  • Organization Methods
  • Placement position overrides (3 Config Options)
  • One-Handed Position Override
  • If enabled, all one-handed objects will be placed in a single location
  • Position is set either manually by the config file or by pressing J or whatever keybind you have set by 'SetObjectTypePositionKey'
  • Two-Handed Position Override
  • If enabled, all two-handed objects will be placed in a single location
  • Position is set either manually by the config file or by pressing J or whatever keybind you have set by 'SetObjectTypePositionKey'
  • Item Type Position Override
  • If enabled, all objects that have override locations will be placed in their designated location
  • Position is set either manually by the config file or by pressing J or whatever keybind you have set by 'SetObjectTypePositionKey'
  • [ItemPlacementOverrideOffsetRotation] and [ItemPlacementOverrideOffsetPosition] allows for items to not be directly placed on each other in PositionOverride modes
  • Randomized placement (Without position overrides)
  • Items now are organized by [Value] by default, the futher from the door, the higher the value. Can also be [Stack]-ed to place all objects of a type directly ontop of each other (See config setting 'ItemGrouping')
  • Items are grouped in two locations, front of ship and back of ship (See config setting 'TwoHandedItemLocation')
  • Items can be strewn accross the ship [Loose]-ly or [Tight]-ly packed on the wall opposite the default location of the Storage Closet (See config setting 'OrganizationTechniques')
  • Shotgun Organization
  • Shotguns can be organized into stacks by the amount of shells that are loaded into them using 'OrganizeShotgunByAmmo' config option.
  • Position is set either manually by the config file or by pressing J or whatever keybind you have set by 'SetObjectTypePositionKey'

Config File Parameters

  • Keybinds
  • Now handled in-game by using InputUtils
  • Ship Cleanup Configurations
  • UseOnlyTerminal
  • When set to [true] the cleanup keybinding system will not respond to keypresses and only the terminal can be used to activate the mods cleanup functions.
  • ItemGrouping
  • Wh

Install & use Install: BepInEx plugin

  1. The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
  2. Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
  3. Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
  4. Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.

Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPackRune580-LethalCompany_InputUtils

File & checksum

Filename
ShipMaid-4.0.9.zip
File size
68.1 KiB