CUSTOM SNAP

by Lievven

Version tested here: 1.2.6

Custom Snap gives you the ability to customize your grid. You can set:

  • Custom snap values (row and colums of pixels that assets will align with)

  • A grid matching your snap values

  • Various grid shapes (square, hex, triangle, isometric)

BASIC KNOWLEDGE

In , the grid is set to 256x256 pixels. You can snap to each grid cell or to each half-cell, but there's nothing more.

This mod adds a new tool in the Settings Tab, called Custom Snap Settings.

By clicking on it, you will display a new tab where you'll be able to tweak the snap and grid settings.

Enabling/Disabling the Mod

By default, both the Custom Snap and its Custom Grid are enabled, set to 1/4th of the default grid (64px instead of 256). You can disable the mod by pressing the Enabled toggle button. You can also turn off both Custom Snap and Default Snap by pressing S on your keyboard.

You can also just disable the Custom Grid by pressing the Custom Grid toggle button. This won't disable the default grid. If you want to hide the custom grid without disabling it, press G on your keyboard.

The Custom Grid will always adapts to your Custom Snap settings, you can't have a Custom Grid with different values.

Understanding the Different Grids

There are a few grid/snap shape options:

  • Square (regular grid)

  • Horizontal Hex (allowing horizontal lines)

  • Vertical Hex (allowing vertical lines)

  • Isometric (for isometric perspective)

This is represented by these four shapes you can click on:

Square

Horizontal Hex

Vertical Hex

Isometric

Depending on the shape you chose, you might get two more options:

  • Corner/Edge will define if the amount of pixels you've set is measured from the center to the corner or from the center the edge of the Hex shape. The Corner option will always result in a smaller grid than the Edge option.

  • Triangle/Hex is only useful when you choose to display the grid. Hex will display regular Hex shapes while Triangle will display lines between all the corners of the Hex shape, visually resulting in triangles. This will appear only with the two Hex shapes.

Regular Hex
Triangle

Presets

In the Presets dropdown menu, you can select between several snap presets (and grid presets, if that option is enabled).

There are a few options:

  • 1/4th (64 px)

  • 1/8th (32 px)

  • Large Horizontal Hex (128x128 px)

  • Small Horizontal Hex (64x64 px)

  • Large Vertical Hex (128x128 px)

  • Small Vertical Hex (64x64 px)

  • Roll20 Horizontal (128x128 Horizontal Hex)

  • Roll20 Vertical (128x128 Vertical Hex)

For a standard battlemap with a square grid, using either 1/4th (64 pixels) or 1/8th (32 pixels) should be more than enough for most cases. Some people like to use 1/16th (16px), which can be achieved in the Advanced Settings.

ADVANCED SETTINGS

You can display more controls by clicking the Enable Advance toggle button.

Scaling

In Advanced mode, you can now choose your own values. There's a slider for the horizontal scaling and one for the vertical scaling. Values go from 1 to 256 and represent the gap in pixels between two snapping points (and the size of a grid cell when Custom Grid is enabled).

By default, both sliders are working together to keep the same ratio, but you can move them separately by pressing the Lock Aspect Ratio toggle button.

Offset

In Advanced mode, you can offset the snapping points (and the grid when Custom Grid is enabled).

You can offset the snapping points/grid up to 256 pixels right and down with two sliders.

By default, both sliders are working together, but, as for Scaling, you can choose to move them separately by pressing the Lock Aspect Ratio toggle button.

SNAP SELECTION

In the selection tool, you can now see a Snap Selection button. Clicking on it after selecting a asset will bring it to the closest snapping point.

Snapping a Multiple Selection

When you select and move multiple assets, doesn't work correctly. This can be especially frustrating when you copy some assets that were snapped but you need to snap back each copied asset manually, one by one.

The Snap Selection feature fixes that issue.

When multiple assets are selected, clicking on Snap Selection several times will cycle through several reference points to snap to the grid.

It will either align the center of the selection’s bounding box to the nearest snapping point or the different assets in the selection.

Unsnapped selection
Click #1: Snapping the selection box's center
Click #2: Snapping the right asset
Click #3: Snapping the left asset


KNOWN BUGS



Last updated