FurnitureGrid

# Grid Snap

A mod for Lethal Company that enhances the ship's build mode by adding a configurable grid and rotation snapping system for placing furniture. Organize your ship with precision and ease!

## Features

- **Position Snapping:** Snaps furniture to a configurable grid on the floor.

- **Rotation Snapping:** Snaps furniture rotation to specific angles (e.g., 45°, 90°).

- **Visual Grid Overlay:** Displays a customizable grid on the ship's floor to aid in placement.

- **On-the-Fly Adjustments:** Change grid size and rotation angles in real-time while in build mode.

- **In-Game HUD Integration:** The build mode tooltip is updated to show the current status of the grid and rotation snap.

- **Highly Configurable:** Almost every feature can be tweaked through the BepInEx configuration file.

## Installation

It is highly recommended to use a mod manager like the **Thunderstore Mod Manager** for easy installation.

1. Install **BepInEx**.

2. Install the required dependency: **LethalCompany_InputUtils**.

3. Install this mod, **GridSnap**.

## Dependencies

- **Required:** [LethalCompany_InputUtils](https://thunderstore.io/c/lethal-company/p/Rune580/LethalCompany_InputUtils/) by Rune580. This mod is necessary for the keybinds to work.

## Controls

These keybinds are active while in the ship's build mode. They can be reconfigured in-game via the LethalCompany_InputUtils settings menu.

| Action | Default Keybind | Description |

| -------------------------- | --------------- | --------------------------------------------- |

| Toggle Grid Snap | Z | Enables or disables position snapping. |

| Increase Grid Size | = (Equals) | Makes the grid cells larger. |

| Decrease Grid Size | - (Minus) | Makes the grid cells smaller. |

| Toggle Rotation Snap | C | Enables or disables rotation snapping. |

| Increase Rotation Angle | F1 | Increases the angle for rotation snapping. |

| Decrease Rotation Angle | F2 | Decreases the angle for rotation snapping. |

## Configuration

You can edit the configuration file located at BepInEx/config/Grid\_Snap.cfg after running the game with the mod once.

### [Grid]

| Key | Default Value | Description |

| ------------- | ------------- | ---------------------------------------------------- |

| Enabled | true | Enable grid snapping in ship build mode. |

| Size | 0.5 | Grid cell size in meters. |

| SizeStep | 0.05 | The increment for increasing/decreasing grid size. |

| SnapOnWalls | false | Enable grid snapping for items placed on walls. |

### [Rotation]

| Key | Default Value | Description |

| -------------------- | ------------- | ------------------------------------------------------- |

| Enabled | true | Enable rotation snapping. |

| AngleStep | 45 | The angle to snap to, in degrees. |

| AngleStepIncrement | 15 | The increment for increasing/decreasing the snap angle. |

### [Display]

These settings control the visual grid overlay.

| Key | Default Value | Description |

| ---------------- | -------------------- | ------------------------------------------------- |

| ShowOverlay | true | Show the visual grid overlay in build mode. |

| Extent | 15 | The grid's display radius in meters. |

| LineColor | 0, 1, 1, 0.4 | The color of the grid lines (R, G, B, A). |

| MinorLineWidth | 0.01 | The thickness of the minor grid lines. |

| MajorLineWidth | 0.03 | The thickness of the major grid lines. |

| MajorLineEvery | 4 | How often a major line appears (e.g., every 4th line). |