Routinglib is a library module that offers pathfinding capabilities to other modules. The code for this library was initially written for the Drag Ruler module and has been extracted into a library to open up the opportunity of using pathfinding to all modules.
Should I install this module?
This module does not provide any user-facing features on it's own. Only install this module either if another module you're using has declared this module as a dependency or if another module you're using indicates that it will unlock specific features if routinglib is installed. If neihter of those apply to you, there is nothing to gain by installing routinglib.
Capabilities
The following table lists the capabilities and limitations of routinglib with respect to grid types and difficult terrain. Note that you need to install Terrain Ruler if you would like routinglib to take difficult terrain into account.
Using routinglib in a moduleDocumentation on how to use routinglib in your module can be found in the README
| Square or Hex grids | Gridless | |
|---|---|---|
| Without difficult terrain |
|
|
| With difficult terrain |
|
Currently unsupported, terrain will be ignored on gridless scenes |
Using routinglib in a module
Details on how to use routinglib's pathfinding capabilities in your own module can be fond in the README