Skip to content

Commit

Permalink
Tweaked README
Browse files Browse the repository at this point in the history
  • Loading branch information
grahamboree committed Dec 28, 2023
1 parent 886ec88 commit 95c7c60
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

* πŸ€– **Automatic** - Recast can generate a navmesh from any level geometry you throw at it
* 🏎️ **Fast** - swift turnaround times for level designers
* 🧘 **Flexible** - detailed customization options to suit your specific game's needs.
* 🧱 **Modular** - choose only the modules you need
* 🧘 **Flexible** - detailed customization options and modular design let you tailor functionality to your specific needs
* 🚫 **Depency-Free** - building Recast & Detour only requires a C++ compiler
* πŸ’ͺ **Industry Standard** - Recast powers AI navigation features in Unity, Unreal, Godot, O3DE and countless AAA and indie games and engines

Recast Navigation is divided into multiple modules, each contained in its own folder:

Expand All @@ -31,35 +31,40 @@ Recast Navigation is divided into multiple modules, each contained in its own fo

## ⚑ Getting Started

You can find a comprehensive demo project in the `RecastDemo` folder. Check out [Building.md](Docs/Building.md) for instructions on how to build it. RecastDemo is showcases 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.
You can find a comprehensive demo project in the `RecastDemo` folder. Check out [BuildingAndIntegrating.md](Docs/BuildingAndIntegrating.md) for instructions on how to build it.

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 to find paths with Detour.

## βš™ How it Works

Recast constructs a navmesh through a multi-step mesh rasterization process.
Recast constructs a navmesh through a multi-step mesh rasterization process.

1. First Recast rasterizes the input triangle meshes into voxels.
2. Voxels in areas where agents would not be able to move are filtered and removed.
3. The walkable areas described by the voxel grid are then divided into sets of 2D polygonal regions.
4. The navigation polygons are generated by re-triangulating the generated 2d polygonal regions into a navmesh.
3. The walkable areas described by the voxel grid are then divided into sets of polygonal regions.
4. The navigation polygons are generated by re-triangulating the generated polygonal regions into a navmesh.

You can use Recast to build a single navmesh, or a tiled navmesh. Single meshes are suitable for many simple cases and are easy to work with. Tiled navmeshes are more complex to work with but better support larger, more dynamic environments. Tiled meshes support features like re-baking, heirarchical path-planning, and navmesh data-streaming.
You can use Recast to build a single navmesh, or a tiled navmesh.
Single meshes are suitable for many simple, static cases and are easy to work with.
Tiled navmeshes are more complex to work with but better support larger, more dynamic environments. Tiled meshes enable advance Detour features like re-baking, heirarchical path-planning, and navmesh data-streaming.

## πŸ“š Documentation & Links

- [Building](Docs/Building.md)
- [Integrating](Docs/Integration.md)
- [Roadmap](Docs/Roadmap.md)
Official documentation is available at [recastnav.com](https://recastnav.com)

Docs are generated via [Doxygen](https://www.doxygen.nl/) from source file comments and from markdown files in the `Docs/` directory.

- [Development Roadmap](Docs/Roadmap.md)
- [Changelog](CHANGELOG.md)
- [Contributing](CONTRIBUTING.md)
- [Contribution Guidelines](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [API Reference](https://recastnav.com)
- [Project Github](https://github.com/recastnavigation/recastnavigation)
- [Github](https://github.com/recastnavigation/recastnavigation)

## ❀ Community

You can ask questions, voice ideas, or request new features through [Github Discussions](https://github.com/recastnavigation/recastnavigation/discussions) or our old [Google Group](http://groups.google.com/group/recastnavigation) list.
You can ask questions, voice ideas, or request new features through [Github Discussions](https://github.com/recastnavigation/recastnavigation/discussions) or on our old [Google Group](http://groups.google.com/group/recastnavigation) list.

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.
Check out the [Development Roadmap](Docs/Roadmap.md) to see what features and functionality you might be able to help with, and the [Contribution Guidelines](CONTRIBUTING.md) for information on how to make contributions.

Our [Code of Conduct](CODE_OF_CONDUCT.md) applies to all Recast Navigation community channels.

Expand Down

0 comments on commit 95c7c60

Please sign in to comment.