BasedDecorPlacement

[v81] Overhauls build mode controls and fixes annoyances with unlockables

By mr_hat

https://discord.com/channels/1168655651455639582/1435970978797584405

Date uploaded	4 days ago
Version	0.0.7
Download link	mr_hat-BasedDecorPlacement-0.0.7.zip
Downloads	2566
Dependency string	mr_hat-BasedDecorPlacement-0.0.7

This mod requires the following mods to function

BepInEx-BepInExPack

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

Preferred version: 5.4.2305

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

BasedDecorPlacements

Overhauls build mode controls with some QoL and fixes for unlockables and meant as a replacement for mods that are similar.

Clientside
Better and less frustrating controls for build mode, scroll down to Rotation Mode/Control Scheme for more info
Has rotation snap that's quick and easy to swap about in-game
Restores items on appropriate unlockables on lobby load with a configurable blacklist
Reasonable range of selection/placement for unlockables in build mode
Disregards collision completely during build mode for a far less frustrating experience trying to line stuff up
Prevents accidental enabling/triggering of a multitude of things during build mode, e.g. activating an item or trigger with no hold time

More yap

Does not and will not allow unlockable placement whilst the ship is in motion
- This is to prevent loading your game one day and seeing your unlockables 10 metres in the sky above or below the ship
Does not and will not allow unlockable placement outside of the ship. Pocket Rooms count as part of the ship
- Unlockables are parented to the ship - this means where ever the ship goes, the unlockables go with you, including floating in air when you go to the next moon at an unreachable height
- Makes it more difficult to grief games as well
Fixes broken unlockable prefabs - this is only for unlockables that store items
Lets you customise the valid/invalid placement ghost colour

Dev yap

This mod logs broken/incorrectly set up unlockable prefabs and their potential issues after loading into the main menu - note that this is only for unlockables that store items
Has some API elements in regards to custom PlaceableObjectsSurface script registration for unlockable item reparenting and custom build mode bounds registration but nothing I'd recommend to other devs right now. This was and is more so made for personal use at the moment
Use Pocket Room Library MelanieMelicious instead, since this registers custom ship bound colliders as well as build mode bounds

Config

Build Mode

Build Mode Overhaul

If true, enables build mode overhaul
- If disabled, build mode will be vanilla and not run compatibility unpatches for other mods

Full Ship Coverage

If true, extends build mode bounds to the rails outside of the ship
- HAS NETWORKING | Everyone in the lobby has to have this option enabled to be able to play

Rotation Mode/Control Scheme

Sets the controls for rotating unlockables:
- Mouse Control Scheme (Default)
  - Enter Build Mode (Replace furniture in InputUtils) B
  - Store Unlockable (Store furniture in InputUtils) X
  - Exit Build Mode Esc
  - Place Unlockable Left Click
  - Rotate Left/Right HOLD Left Click + Move Mouse
    - The player camera no longer moves whilst you are rotating the unlockable
  - Decrease Snap Degrees Q /// Increase Snap Degrees E
- Keys Control Scheme
  - Enter Build Mode (Replace furniture in InputUtils) B
  - Store Unlockable (Store furniture in InputUtils) X
  - Exit Build Mode Esc
  - Place Unlockable Left Click
  - Rotate Left Q OR HOLD Q to rotate fast /// Rotate Right E OR HOLD E to rotate fast
  - Decrease Snap Degrees HOLD Left Click + Q /// Increase Snap Degrees HOLD Left Click + E

Default Rotation Snap

Sets the starting snap rotation degrees:
- 0° (Default)
- 5°
- 15°
- 30°
- 45°

Selection/Placement Range

How far away ship decor can be selected/placed whilst in build mode
- Ranges between a minimum of 3 and a maximum of 10, with the default being 5

Show Current Rotation

Adds an extra line on the tooltip to show the current rotation of the selected unlockable

Placeable/Blocked Ghost Colour

Allows customisation of the ghost colour for valid/invalid unlockable placements

Unlockable Item Reparenting

Reparent Items To Unlockables

If true, reparent items back onto unlockable surfaces after loading the game

Unlockable Surface Offset

Max distance allowed when matching an item back to a unlockable surface

Unlockable Blacklist

Unlockable names that item reparenting should ignore entirely

Fix Broken Unlockable Prefabs

If true, diagnoses issues in unlockable prefabs and tries to repair them. This can resolve items falling through some modded unlockables. Only valid for unlockables that store items
- For devs, this can help diagnose incorrectly setup unlockable prefabs that store items, log runs at round when you get into the main menu

Compatibility

BetterDecorPlacement
- Unpatches conflicting patches, meaning mod will do nothing and should be uninstalled
SnapRotateFurniture
- Unpatches conflicting patches, meaning mod will do nothing and should be uninstalled
GeneralImprovements
- Unpatches conflicting patches, meaning Save ship furniture places, Ship placeables collide and Snap objects by degrees will do nothing - the rest of the mod works as normal
Pocket Room Library MelanieMelicious
- Works out of the box
FurnitureLock
- Works out of the box
ScienceBird Tweaks
- Compatibility unknown with their unlockable tweaks due to no v81 update as of upload of BasedDecorPlacements

Known Issues

None I'm aware of, but feel free to report them to me in the LC modding discord

Future Plans

Sound or visual feedback for some aspects, e.g. small satisfying noise when changing snap degrees, etc.
Some sort of grid snapping on a certain axis to help align stuff, maybe
Some form of more useful logging in other aspects

Credits

giaganticevan for his opinion on the controls, helping me decide what to do

CHANGELOG

0.0.7

Store tool tip no longer shows on unstorable unlockables, e.g. Terminal, Denomination Analyzer, etc.
Massively increased width and length of the ship's OutOfBounds collider, and now properly teleports the player back when clipping out of the ship using the terminal

0.0.6

Now shows Store and the respective hotkey on build mode tooltip for storing unlockables
Blocked more interactions that could cancel build mode preemptively
Added soft compatibility with ReservedItemSlotCore to prevent preemptive cancellation of build mode

0.0.5

Fixed selection range not being applied for realsies this time

0.0.4

Fixed mistitled config in README
Fixed build ghost going through the cat walk on the vanilla ship by swapping the layer from Default to Room when using Full ship coverage
Removed custom Enter Build Mode input as my blind ass did not see Replace furniture in control settings

0.0.3

Now uses LethalCompany InputUtils to allow the following keys to be remapped:
- Enter Build Mode
- Confirm Placement
- Cancel Placement
- Decrease Snap / Rotate Left
- Increase Snap / Rotate Right
Prevented placement of unlockables behind the ship wall monitors and inside of the charging station
Fixed selection range not being applied
Added Full ship coverage config to extend the build area to the rails. This adds networking, meaning everyone in the lobby has to have this option enabled

0.0.2

Fixed being unable to enter build mode when at the company
General project cleanup

0.0.1

Release

Get the Thunderstore App