Skip to content

Commit

Permalink
Merge pull request #107 from Crowguard/main
Browse files Browse the repository at this point in the history
Documentation
  • Loading branch information
ironmonk88 authored Oct 13, 2022
2 parents 475c29d + 0e13602 commit a907712
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
Binary file added Documentation/TerrainLayerTools.webp
Binary file not shown.
Binary file added Documentation/TerrainTool.webp
Binary file not shown.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,20 @@ Simply use the install module screen within the FoundryVTT setup
Please note, this module by itself only records the difficult terrain. You'll need to use a ruler that accesses this module to see the changes when dragging a token.

## Usage & Current Features
Currently you can draw a polygon onto the map to represent the terrain at that location. This tool functions the same way you would use the polygon tool to draw polygons shapes to the scene. Left drag to start the shape, left click to add a point, right click to remove a point, and double-click to close the shape when you're done. You can also add a grid square by double-clicking on the canvas.

### Terrain Layer

<img align="left" src="Documentation/TerrainTool.webp" alt="TerrainTool">

<img align="left" src="Documentation/TerrainLayerTools.webp" alt="TerrainLayerTools">

The various drawing tools work identically to the core Drawings tools. Left drag to start the shape, left-click to add a point, right-click to remove a point, and double-click to close the shape when you're done. You can also add a grid square by double-clicking on the canvas.

You can then set how difficult that terrain is to move through, and what type of terrain it is, and if it affects ground based tokens or air based tokens.

Switching to the select tool you can resize an area or reposition the area as you would with most object in Foundry. You can also delete an area by pressing the delete key while the the area is selected.
Switching to the select tool you can resize an area or reposition the area as you would with most object in Foundry. You can also delete an area by pressing the delete key while the the area is selected.

The Terrain Layer will also let you assign difficulty to a measured templates. You can use this for spells that set difficult terrain.
The Terrain Layer will also let you assign difficulty to measured templates. You can use this for spells that set difficult terrain.

And it will also calculate other tokens so that when you're moving through another creatures square it will count as difficult terrain.

Expand All @@ -25,6 +32,10 @@ You can also set the environment that the difficult terrain represents. So if y

You can set the color of the terrain, on an individual basis, a default colour for that environment, a default for the scene, or a general color.

### Token Integration

In the module settings, you can set whether to include live or dead tokens of either friendly tokens, hostile tokens, or both as difficult terrain.

## Rulers and measuring distance

Enhanced Terrain Layer only records difficult terrain, it doesn't do any measuring based on that information. To get drag distances for Tokens I'd recommend using both Terrain Ruler and Drag Ruler. Terrain Ruler will calculate the correct distance based on difficult terrain, and Drag Ruler provides a more visual representation of drag distances.
Expand Down

0 comments on commit a907712

Please sign in to comment.