baer1-ShipSort icon

ShipSort

Highly customizable mod that sorts and organizes all items on your ship

Last updated 2 days ago
Total downloads 1171
Total rating 2 
Categories Mods Tools Misc BepInEx Client-side Items Tweaks & Quality Of Life
Dependency string baer1-ShipSort-2.1.2
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

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

Preferred version: 5.4.2100
baer1-ChatCommandAPI-0.1.4 icon
baer1-ChatCommandAPI

A Lethal Company modding API for easy creation of Minecraft-style Chat Commands

Preferred version: 0.1.4

README

Usage

While in orbit, simply enter /sort in the game chat. This will sort all items.

By default, scrap is sorted into two piles of two- and one-handed items (with some exceptions, like the whoopie cushion, football, apparatus and beehive), tools are sorted into the cupboard.

If you don't have the cupboard on the ship, you can return it with the cup terminal command. Otherwise, all your items will just disappear.

By default, all tools on the cruiser are ignored, you can force include them by running /sort -a.

Configuring custom positions

This mod can be configured to place any item anywhere, however this process may require some technical knowledge and a lot of patience.

You can change the default positions of one- and two-handed items, as well as tools, by changing the default... config values. They use the same format as described below

For vanilla items

For any item in the vanilla game, you can simply open the config file and edit the corresponding config value.

The value is formatted as follows:

parent:x,y,z or x,y,z

The parent is the object relative to which the position is interpreted as. If the parent is the storage closet, items will actually be put in the closet.

The parent object is specified as a path to the object based on the scene root (for example Environment/HangarShip/StorageCloset, use UnityExplorer to find this for any object).

Alternatively, there are a couple keywords for common parent objects:

  • closet or cupboard for the storage closet (Environment/HangarShip/StorageCloset)
  • file or filecabinet for the file cabinet (Environment/HangarShip/FileCabinet)
  • none or environment for the world root (Environment)
  • ship for the ship (Environment/HangarShip), but you can also just not specify a parent since this is the default (ship:0,0,0=0,0,0)

For modded/other items

The customItemPositions config value contains a list of other item positions by name. This can be used to sort mod items, or items from future updates.

Format: itemname:parent:x,y,z;itemname:parent:x,y,z

Raycasting

By default, all positions will trace a line downwards to find the closest spot on the ground (or any ship objects), and the items will be put there. That way, no items will be floating mid-air.

However, if you prefer your items to be at the exact position you specified, you can disable this with the UseRaycast config value.

Delayed sorting

If you like the visual effect of items flying to their positions one by one, you can set the SortDelay config value to add an interval between moving items.

Setting this to 250ms means, that only about 4 items will be sorted per second. This makes the sorting process slower, but adds the satisfying visual effect.

Autosorting

If you enable the AutoSort config value or use the chat command /autosort to toggle it, all items will be automatically sorted when you leave a moon.

This only activates when you are the host