https://github.com/recastnavigation/recastnavigation

Industry-standard navigation-mesh toolset for games
https://github.com/recastnavigation/recastnavigation

ai crowd-simulation game game-ai game-dev game-development game-tool gamedev navigation navmesh navmesh-generation pathfinding pathfinding-library

Last synced: 3 days ago
JSON representation

Industry-standard navigation-mesh toolset for games

• Host: GitHub
• URL: https://github.com/recastnavigation/recastnavigation
• Owner: recastnavigation
• License: zlib
• Created: 2013-09-15T18:12:45.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-08-11T12:30:42.000Z (4 months ago)
• Last Synced: 2024-12-02T19:11:29.667Z (10 days ago)
• Topics: ai, crowd-simulation, game, game-ai, game-dev, game-development, game-tool, gamedev, navigation, navmesh, navmesh-generation, pathfinding, pathfinding-library
• Language: C++
• Homepage: http://recastnav.com/
• Size: 21.6 MB
• Stars: 6,629
• Watchers: 384
• Forks: 1,628
• Open Issues: 99
• Metadata Files:
  • Readme: Docs/Readme.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: License.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-game-engine-dev - Recast & Detour - Navigation-mesh toolset for games. (Libraries / C++)
• AwesomeCppGameDev - recastnavigation - mesh Toolset for Games (AI)

README

        
This directory contains source files for the documentation as well as the generated doxygen output.

# Directory Layout

`. (Docs root)` High level content and format files. (E.g. css, header, footer.)

`./Extern` API documentation that is located outside the source files.  When the API documentation gets too big or complex for the header and source files, it goes in this directory.

`./Images` Images related to the documentation.

`./html` The target for the Doxygen build.  (Created during the build process.)

    

# Documentation Style

One of the requirements for the API documentation is that it

has the minimum possible impact on the declarations in the

header files.  So, in general, the header file declarations only

contain summary documentation.  The detail documentation

is placed as follows:

1.  If an element is defined in a cpp file, then place

    the detail documentation in the source file.

2.  If an element does not have an associated cpp file, then

    place the detail documentation at the end of the header file.

3.  If there is a lot of detail documentation cluttering up

    the end of a header file, then the content is moved to 

	a separate file in the Extern directory.

# Building the Documentation

1.  Download and install the appropriate Doxygen version.  (See the first line in the Doxyfile for the current version.)

2.  Run "doxygen" in the project root directory. (The location of the Doxyfile.)  No arguments are required.

The generated html files will be located in the /Docs/html directory.