forked from mirror/DotRecast
for nuget readme
This commit is contained in:
ikpil
parent
d0bec3714e
commit
653a9e794b
|
|
@ -15,7 +15,7 @@ dotnet build -c Release
|
|||
3. Build: In the IDE menu, select "Build" > "Build Solution" or click the "Build" icon on the toolbar.
|
||||
|
||||
## ▶️ Run
|
||||
- To verify the run for all modules, run [DotRecast.Recast.Demo](src/DotRecast.Recast.Demo/DotRecast.Recast.Demo.csproj)
|
||||
- To verify the run for all modules, run [DotRecast.Recast.Demo](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast.Demo/DotRecast.Recast.Demo.csproj)
|
||||
- on windows requirement : install to [Microsoft Visual C++ Redistributable Package](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist)
|
||||
|
||||
### ▶️ Running With Command Prompt
|
||||
|
|
@ -30,17 +30,17 @@ dotnet run --project src/DotRecast.Recast.Demo --framework net8.0 -c Release
|
|||
2. Go to "File" in the menu.
|
||||
3. Choose "Open Project" or "Open Solution."
|
||||
4. Find and select [DotRecast.sln](DotRecast.sln), then click "Open."
|
||||
5. Run to [DotRecast.Recast.Demo](src/DotRecast.Recast.Demo/DotRecast.Recast.Demo.csproj)
|
||||
5. Run to [DotRecast.Recast.Demo](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast.Demo/DotRecast.Recast.Demo.csproj)
|
||||
|
||||
## 🧪 Running Unit Test
|
||||
|
||||
- [DotRecast.Core.Test](test/DotRecast.Core.Test) : ...
|
||||
- [DotRecast.Recast.Test](test/DotRecast.Recast.Test) : ...
|
||||
- [DotRecast.Detour.Test](test/DotRecast.Detour.Test) : ...
|
||||
- [DotRecast.Detour.TileCache.Test](test/DotRecast.Detour.TileCache.Test) : ...
|
||||
- [DotRecast.Detour.Crowd.Test](test/DotRecast.Detour.Crowd.Test) : ...
|
||||
- [DotRecast.Detour.Dynamic.Test](test/DotRecast.Detour.Dynamic.Test) : ...
|
||||
- [DotRecast.Detour.Extras.Test](test/DotRecast.Detour.Extras.Test) : ...
|
||||
- [DotRecast.Core.Test](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Core.Test) : ...
|
||||
- [DotRecast.Recast.Test](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Recast.Test) : ...
|
||||
- [DotRecast.Detour.Test](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Detour.Test) : ...
|
||||
- [DotRecast.Detour.TileCache.Test](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Detour.TileCache.Test) : ...
|
||||
- [DotRecast.Detour.Crowd.Test](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Detour.Crowd.Test) : ...
|
||||
- [DotRecast.Detour.Dynamic.Test](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Detour.Dynamic.Test) : ...
|
||||
- [DotRecast.Detour.Extras.Test](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Detour.Extras.Test) : ...
|
||||
|
||||
### 🧪 Testing With Command Prompt
|
||||
|
||||
|
|
@ -54,33 +54,33 @@ dotnet run --project src/DotRecast.Recast.Demo --framework net8.0 -c Release
|
|||
|
||||
## 🛠️ Integration
|
||||
|
||||
There are a few ways to integrate [DotRecast.Recast](src/DotRecast.Recast) and [DotRecast.Detour](src/DotRecast.Detour) into your project.
|
||||
There are a few ways to integrate [DotRecast.Recast](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast) and [DotRecast.Detour](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour) into your project.
|
||||
Source integration is the most popular and most flexible, and is what the project was designed for from the beginning.
|
||||
|
||||
### 🛠️ Source Integration
|
||||
|
||||
It is recommended to add the source directories
|
||||
[DotRecast.Core](src/DotRecast.Core),
|
||||
[DotRecast.Recast](src/DotRecast.Recast),
|
||||
[DotRecast.Detour](src/DotRecast.Detour),
|
||||
[DotRecast.Detour.Crowd](src/DotRecast.Detour.Crowd),
|
||||
[DotRecast.Detour.TileCache](src/DotRecast.Detour.TileCache)
|
||||
[DotRecast.Core](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Core),
|
||||
[DotRecast.Recast](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast),
|
||||
[DotRecast.Detour](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour),
|
||||
[DotRecast.Detour.Crowd](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.Crowd),
|
||||
[DotRecast.Detour.TileCache](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.TileCache)
|
||||
and directly into your project depending on which parts of the project you need.
|
||||
|
||||
For example your level building tool could include
|
||||
[DotRecast.Core](src/DotRecast.Core),
|
||||
[DotRecast.Recast](src/DotRecast.Recast),
|
||||
[DotRecast.Detour](src/DotRecast.Detour)
|
||||
[DotRecast.Core](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Core),
|
||||
[DotRecast.Recast](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast),
|
||||
[DotRecast.Detour](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour)
|
||||
and your game runtime could just include
|
||||
[DotRecast.Detour](src/DotRecast.Detour)
|
||||
[DotRecast.Detour](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour)
|
||||
|
||||
- [DotRecast.Core](src/DotRecast.Core) : Core Utils
|
||||
- [DotRecast.Recast](src/DotRecast.Recast) : Core navmesh building system.
|
||||
- [DotRecast.Detour](src/DotRecast.Detour) : Runtime navmesh interface and query system.
|
||||
- [DotRecast.Detour.TileCache](src/DotRecast.Detour.TileCache) : Runtime movement, obstacle avoidance, and crowd simulation systems.
|
||||
- [DotRecast.Detour.Crowd](src/DotRecast.Detour.Crowd) : Runtime navmesh dynamic obstacle and re-baking system.
|
||||
- [DotRecast.Detour.Dynamic](src/DotRecast.Detour.Dynamic) : robust support for dynamic nav meshes combining pre-built voxels with dynamic objects which can be freely added and removed
|
||||
- [DotRecast.Detour.Extras](src/DotRecast.Detour.Extras) : simple tool to import navmeshes created with [A* Pathfinding Project](https://arongranberg.com/astar/)
|
||||
- [DotRecast.Core](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Core) : Core Utils
|
||||
- [DotRecast.Recast](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast) : Core navmesh building system.
|
||||
- [DotRecast.Detour](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour) : Runtime navmesh interface and query system.
|
||||
- [DotRecast.Detour.TileCache](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.TileCache) : Runtime movement, obstacle avoidance, and crowd simulation systems.
|
||||
- [DotRecast.Detour.Crowd](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.Crowd) : Runtime navmesh dynamic obstacle and re-baking system.
|
||||
- [DotRecast.Detour.Dynamic](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.Dynamic) : robust support for dynamic nav meshes combining pre-built voxels with dynamic objects which can be freely added and removed
|
||||
- [DotRecast.Detour.Extras](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.Extras) : simple tool to import navmeshes created with [A* Pathfinding Project](https://arongranberg.com/astar/)
|
||||
|
||||
|
||||
### 🛠️ Installation through Nuget
|
||||
|
|
|
|||
34
README.md
34
README.md
|
|
@ -28,22 +28,22 @@ DotRecast is a port of [recastnavigation](https://github.com/recastnavigation/re
|
|||
|
||||
Recast Navigation is divided into multiple modules, each contained in its own folder:
|
||||
|
||||
- [DotRecast.Core](src/DotRecast.Core) : Core utils
|
||||
- [DotRecast.Recast](src/DotRecast.Recast) : Navmesh generation
|
||||
- [DotRecast.Detour](src/DotRecast.Detour) : Runtime loading of navmesh data, pathfinding, navmesh queries
|
||||
- [DotRecast.Detour.TileCache](src/DotRecast.Detour.TileCache) : Navmesh streaming. Useful for large levels and open-world games
|
||||
- [DotRecast.Detour.Crowd](src/DotRecast.Detour.Crowd) : Agent movement, collision avoidance, and crowd simulation
|
||||
- [DotRecast.Detour.Dynamic](src/DotRecast.Detour.Dynamic) : robust support for dynamic nav meshes combining pre-built voxels with dynamic objects which can be freely added and removed
|
||||
- [DotRecast.Detour.Extras](src/DotRecast.Detour.Extras) : simple tool to import navmeshes created with [A* Pathfinding Project](https://arongranberg.com/astar/)
|
||||
- [DotRecast.Recast.Toolset](src/DotRecast.Recast.Toolset) : all modules
|
||||
- [DotRecast.Recast.Demo](src/DotRecast.Recast.Demo) : Standalone, comprehensive demo app showcasing all aspects of Recast & Detour's functionality
|
||||
- [Tests](test) : Unit tests
|
||||
- [DotRecast.Core](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Core) : Core utils
|
||||
- [DotRecast.Recast](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast) : Navmesh generation
|
||||
- [DotRecast.Detour](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour) : Runtime loading of navmesh data, pathfinding, navmesh queries
|
||||
- [DotRecast.Detour.TileCache](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.TileCache) : Navmesh streaming. Useful for large levels and open-world games
|
||||
- [DotRecast.Detour.Crowd](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.Crowd) : Agent movement, collision avoidance, and crowd simulation
|
||||
- [DotRecast.Detour.Dynamic](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.Dynamic) : robust support for dynamic nav meshes combining pre-built voxels with dynamic objects which can be freely added and removed
|
||||
- [DotRecast.Detour.Extras](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Detour.Extras) : simple tool to import navmeshes created with [A* Pathfinding Project](https://arongranberg.com/astar/)
|
||||
- [DotRecast.Recast.Toolset](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast.Toolset) : all modules
|
||||
- [DotRecast.Recast.Demo](https://github.com/ikpil/DotRecast/tree/main/src/DotRecast.Recast.Demo) : Standalone, comprehensive demo app showcasing all aspects of Recast & Detour's functionality
|
||||
- [Tests](https://github.com/ikpil/DotRecast/tree/main/test) : Unit tests
|
||||
|
||||
## ⚡ Getting Started
|
||||
|
||||
- To build or integrate into your own project, please check out [BuildingAndIntegrating.md](BuildingAndIntegrating.md)
|
||||
- To create a NavMesh, please check out [RecastSoloMeshTest.cs](test/DotRecast.Recast.Test/RecastSoloMeshTest.cs)
|
||||
- To test pathfinding, please check out [FindPathTest.cs](test/DotRecast.Detour.Test/FindPathTest.cs)
|
||||
- To build or integrate into your own project, please check out [BuildingAndIntegrating.md](https://github.com/ikpil/DotRecast/tree/main/BuildingAndIntegrating.md)
|
||||
- To create a NavMesh, please check out [RecastSoloMeshTest.cs](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Recast.Test/RecastSoloMeshTest.cs)
|
||||
- To test pathfinding, please check out [FindPathTest.cs](https://github.com/ikpil/DotRecast/tree/main/test/DotRecast.Detour.Test/FindPathTest.cs)
|
||||
- To watch the demo play video, please check out [Demo Video](#-demo-video)
|
||||
|
||||
## ⚙ How it Works
|
||||
|
|
@ -62,15 +62,15 @@ Tiled navmeshes are more complex to work with but better support larger, more dy
|
|||
## 📚 Documentation & Links
|
||||
|
||||
- DotRecast Links
|
||||
- DotRecast issues: [DotRecast/issues](https://github.com/ikpil/DotRecast/issues)
|
||||
- [DotRecast/issues](https://github.com/ikpil/DotRecast/issues)
|
||||
|
||||
- Official Links
|
||||
- Official discussions: [recastnavigation/discussions](https://github.com/recastnavigation/recastnavigation/discussions)
|
||||
- Official documentation: [recastnav.com](https://recastnav.com)
|
||||
- [recastnavigation/discussions](https://github.com/recastnavigation/recastnavigation/discussions)
|
||||
- [recastnav.com](https://recastnav.com)
|
||||
|
||||
## 🅾 License
|
||||
|
||||
DotRecast is licensed under ZLib license, see [LICENSE.txt](LICENSE.txt) for more information.
|
||||
DotRecast is licensed under ZLib license, see [LICENSE.txt](https://github.com/ikpil/DotRecast/tree/main/LICENSE.txt) for more information.
|
||||
|
||||
## 📹 Demo Video
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue