92 lines
5.3 KiB
Markdown
92 lines
5.3 KiB
Markdown
|
|
Recast & Detour
|
|
===============
|
|
|
|
[](https://github.com/recastnavigation/recastnavigation/actions/workflows/Build.yaml)
|
|
[](https://github.com/recastnavigation/recastnavigation/actions/workflows/Tests.yaml)
|
|
|
|
|
|
|
|
## Recast
|
|
|
|
Recast is state of the art navigation mesh construction toolset for games.
|
|
|
|
* It is automatic, which means that you can throw any level geometry at it and you will get robust mesh out
|
|
* It is fast which means swift turnaround times for level designers
|
|
* It is open source so it comes with full source and you can customize it to your heart's content.
|
|
|
|
The Recast process starts with constructing a voxel mold from a level geometry
|
|
and then casting a navigation mesh over it. The process consists of three steps,
|
|
building the voxel mold, partitioning the mold into simple regions, peeling off
|
|
the regions as simple polygons.
|
|
|
|
1. The voxel mold is built from the input triangle mesh by rasterizing the triangles into a multi-layer heightfield. Some simple filters are then applied to the mold to prune out locations where the character would not be able to move.
|
|
2. The walkable areas described by the mold are divided into simple overlayed 2D regions. The resulting regions have only one non-overlapping contour, which simplifies the final step of the process tremendously.
|
|
3. The navigation polygons are peeled off from the regions by first tracing the boundaries and then simplifying them. The resulting polygons are finally converted to convex polygons which makes them perfect for pathfinding and spatial reasoning about the level.
|
|
|
|
## Detour
|
|
|
|
Recast is accompanied with Detour, path-finding and spatial reasoning toolkit. You can use any navigation mesh with Detour, but of course the data generated with Recast fits perfectly.
|
|
|
|
Detour offers simple static navigation mesh which is suitable for many simple cases, as well as tiled navigation mesh which allows you to plug in and out pieces of the mesh. The tiled mesh allows you to create systems where you stream new navigation data in and out as the player progresses the level, or you may regenerate tiles as the world changes.
|
|
|
|
## Recast Demo
|
|
|
|
You can find a comprehensive demo project in RecastDemo folder. It is a kitchen sink demo containing all the functionality of the library. If you are new to Recast & Detour, check out [Sample_SoloMesh.cpp](/RecastDemo/Source/Sample_SoloMesh.cpp) to get started with building navmeshes and [NavMeshTesterTool.cpp](/RecastDemo/Source/NavMeshTesterTool.cpp) to see how Detour can be used to find paths.
|
|
|
|
### Building RecastDemo
|
|
|
|
RecastDemo uses [premake5](http://premake.github.io/) to build platform specific projects. Download it and make sure it's available on your path, or specify the path to it.
|
|
|
|
#### Linux
|
|
|
|
- Install SDL2 and its dependencies according to your distro's guidelines.
|
|
- Navigate to the `RecastDemo` folder and run `premake5 gmake2`
|
|
- Navigate to `RecastDemo/Build/gmake2` and run `make`
|
|
- Navigate to `RecastDemo/Bin` and run `./RecastDemo`
|
|
|
|
#### macOS
|
|
|
|
- Grab the latest SDL2 development library dmg from [here](https://github.com/libsdl-org/SDL) and place `SDL2.framework` in `RecastDemo/Bin`
|
|
- Navigate to the `RecastDemo` folder and run `premake5 xcode4`
|
|
- Open `Build/xcode4/recastnavigation.xcworkspace`
|
|
- Set the RecastDemo project as the target and build.
|
|
|
|
#### Windows
|
|
|
|
- Grab the latest SDL2 development library release from [here](https://github.com/libsdl-org/SDL) and unzip it `RecastDemo\Contrib`. Rename the SDL folder such that the path `RecastDemo\Contrib\SDL\lib\x86` is valid.
|
|
- Navigate to the `RecastDemo` folder and run `premake5 vs2022`
|
|
- Open `Build/vs2022/recastnavigation.sln`.
|
|
- Set `RecastDemo` as the startup project, build, and run.
|
|
|
|
### Running Unit tests
|
|
|
|
- Follow the instructions to build RecastDemo above. Premake should generate another build target called "Tests".
|
|
- Build the "Tests" project. This will generate an executable named "Tests" in `RecastDemo/Bin/`
|
|
- Run the "Tests" executable. It will execute all the unit tests, indicate those that failed, and display a count of those that succeeded.
|
|
|
|
## Integrating with your own project
|
|
|
|
It is recommended to add the source directories `DebugUtils`, `Detour`, `DetourCrowd`, `DetourTileCache`, and `Recast` into your own project depending on which parts of the project you need. For example your level building tool could include `DebugUtils`, `Recast`, and `Detour`, and your game runtime could just include `Detour`.
|
|
|
|
### Installation through vcpkg
|
|
|
|
If you are using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager you can download and install Recast with:
|
|
|
|
```
|
|
vcpkg install recast
|
|
```
|
|
|
|
## Contribute
|
|
|
|
Check out the [Project Roadmap](Roadmap.md) to see what features and functionality you might be able to help with, and the [Contributing doc](CONTRIBUTING.md) for guidance on making contributions.
|
|
|
|
## Discuss
|
|
|
|
- Discuss Recast & Detour: http://groups.google.com/group/recastnavigation
|
|
- Development blog: http://digestingduck.blogspot.com/
|
|
|
|
## License
|
|
|
|
Recast & Detour is licensed under ZLib license, see License.txt for more information.
|