Documentation

Using the library

• Getting started: requirements, building, installing, the samples, and the rules every part of the API follows.
• Baking: defs, input, many tiles, the report, obstacles through the tile cache.
• The navmesh: loading, streaming, ids, tiers, off-mesh links and link generation.
• Paths and queries: nearest points, path searches, filters, sliced and hierarchical searches, spatial queries, grids, corridors and steering.
• Crowds and avoidance: avoidance alone, a crowd on a navmesh, fliers.
• Flow fields: over grids and over the navmesh.
• Flight volumes: baking, loading and querying space for fliers.
• Debug drawing.
• Troubleshooting: what each result means, and common surprises.
• API reference, generated from the headers.

How it works

• Overview: the library profile and how the parts fit.
• Glossary.
• Determinism.
• Bake, Navmesh, Queries, Hierarchy, Flow fields, Avoidance, Flight volumes.
• Maul conventions: the rules every Maul library follows.

Maintaining it

• Development: toolchain, build options, running tests, fuzzing, the differential harness, benchmarks.
• Checks: what verifies a change, locally and in CI.
• Release.