BuildingAndIntegrating.md

🔨 Build

• Building requires only .NET 8 SDK.

🔨 Building with Command Prompt

dotnet build -c Release

🔨 Building with an IDE

1. Open IDE: Launch your C# IDE (e.g., Visual Studio).
2. Open Solution: Go to the "File" menu and select "Open Solution."
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
• on windows requirement : install to Microsoft Visual C++ Redistributable Package

▶️ Running With Command Prompt

dotnet run --project src/DotRecast.Recast.Demo --framework net8.0 -c Release

▶️ Running With IDE (ex. Visual Studio 2022 or Rider ...)

1. Open your C# IDE (like Visual Studio).
2. Go to "File" in the menu.
3. Choose "Open Project" or "Open Solution."
4. Find and select DotRecast.sln, then click "Open."
5. Run to DotRecast.Recast.Demo

🧪 Running Unit Test

• DotRecast.Core.Test : ...
• DotRecast.Recast.Test : ...
• DotRecast.Detour.Test : ...
• DotRecast.Detour.TileCache.Test : ...
• DotRecast.Detour.Crowd.Test : ...
• DotRecast.Detour.Dynamic.Test : ...
• DotRecast.Detour.Extras.Test : ...

🧪 Testing With Command Prompt

 dotnet test --framework net8.0 -c Release

🧪 Testing With IDE

• Refer to the manual for your IDE.

🛠️ Integration

There are a few ways to integrate DotRecast.Recast and 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, DotRecast.Recast, DotRecast.Detour, DotRecast.Detour.Crowd, 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, DotRecast.Recast, DotRecast.Detour and your game runtime could just include DotRecast.Detour

• DotRecast.Core : Core Utils
• DotRecast.Recast : Core navmesh building system.
• DotRecast.Detour : Runtime navmesh interface and query system.
• DotRecast.Detour.TileCache : Runtime movement, obstacle avoidance, and crowd simulation systems.
• DotRecast.Detour.Crowd : Runtime navmesh dynamic obstacle and re-baking system.
• 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 : simple tool to import navmeshes created with A* Pathfinding Project

🛠️ Installation through Nuget

• Nuget link : DotRecast.Core
• Nuget link : DotRecast.Recast
• Nuget link : DotRecast.Detour
• Nuget link : DotRecast.Detour.TileCache
• Nuget link : DotRecast.Detour.Crowd
• Nuget link : DotRecast.Detour.Dynamic
• Nuget link : DotRecast.Detour.Extras
• Nuget link : DotRecast.Recast.Toolset
• Nuget link : DotRecast.Recast.Demo