Mugsy33-GridLock icon

GridLock

Align your settlement to a global grid. Structures and terrain fields snap in the build preview - position and rotation - so everything lines up. Hold Shift to place off-grid.

By Mugsy33
Last updated 10 hours ago
Total downloads 7
Total rating 0 
Categories
Dependency string Mugsy33-GridLock-1.0.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_IL2CPP-6.0.755 icon
BepInEx-BepInExPack_IL2CPP

BepInEx pack for IL2CPP x64 Unity games. Preconfigured and ready to use.

Preferred version: 6.0.755

README

Grid Lock

Align your whole settlement to a single global grid. Grid Lock snaps the building placement preview — both position and rotation — so what you see is exactly what you place, and every structure lines up with the next.

It also snaps the Terrain Level Field and farm-field start point, so the ground you flatten lines up with the buildings you put on it. When you want to break the grid, hold a key to place freely and let go to snap back.

Features

  • Snaps structure placement to a global grid — position and rotation — in the live preview.
  • Snaps the Terrain Level Field / farm-field start point so leveled ground aligns with your builds.
  • Hold Shift to place freely off the grid.
  • Configurable grid spacing and rotation increment.

Usage

Build as normal. The placement ghost steps to the grid in both position and rotation. Hold Shift (default) to move off-grid freely, then release to snap to the nearest grid pose. For terrain, place the Terrain Level Field's start point — it snaps, and the field extends from there on the grid.

Configuration

After first launch, edit BepInEx\config\mugsy33.gridlock.cfg, section [Grid], with the game closed:

Setting Default Description
Enabled true Master switch. When false the mod snaps nothing.
SnapTerrain true Snap the Terrain Level Field start point to the grid.
Spacing 0.5 Snap increment in terraforming squares. One square is 2 world units, so 0.5 = a 1.0-unit step.
RotationStep 15 Rotation snap increment, in degrees.
FreeMoveKey LeftShift Hold to move the ghost freely off the grid.

Requirements

  • BepInEx (IL2CPP build) — install it into the game folder first. Follow the official BepInEx installation guide (use the IL2CPP build for this game).

Installation

  1. Install BepInEx (IL2CPP) first, if you haven't already.
  2. Extract this mod into your Aska game folder (the same folder as Aska.exe), so the DLL ends up at BepInEx\plugins\GridLock\GridLock.dll.
  3. Launch the game.

Known issues

Fences and gates are not snapped. Fences and gates have peculiar placement logic because they lock to each other. I haven't worked out how to make them work with snapping yet, so they are excluded.

Incompatible with GridSnap. Grid Lock was specifically created to replace GridSnap (apologies to guilhermu) to work with my other mod Tidy Terrain. Grid Lock and GridSnap are incompatible, as they do mostly the same thing using different internal mechanics.

Grymm's Builder Buddy — the Shift key overlaps. Grid Lock uses Shift for free placement (turn snapping off in game). Builder Buddy uses Shift as its slow-rotation modifier. If both mods are active, holding Shift triggers both features at once. You can disable the modifier in Builder Buddy's config or change the key for Grid Lock in this config.

Footprint Grid Snapping clashes. The footprint mod overrides Grid Lock's snapping. Though I think rotation still works. They are mostly redundant anyway.

Farm and terrain field rotation does not snap yet. Farm fields and the Terrain Level Field snap their position to the grid, but not their rotation. This is planned for a later update.

Multiplayer

Treat multiplayer as untested.