CMake: cleanup
[blender-staging.git] / extern / recastnavigation / Readme.txt
1
2 Recast & Detour Version 1.4
3
4
5 Recast
6
7 Recast is state of the art navigation mesh construction toolset for games.
8
9     * It is automatic, which means that you can throw any level geometry
10       at it and you will get robust mesh out
11     * It is fast which means swift turnaround times for level designers
12     * It is open source so it comes with full source and you can
13       customize it to your hearts content. 
14
15 The Recast process starts with constructing a voxel mold from a level geometry 
16 and then casting a navigation mesh over it. The process consists of three steps, 
17 building the voxel mold, partitioning the mold into simple regions, peeling off 
18 the regions as simple polygons.
19
20    1. The voxel mold is build from the input triangle mesh by rasterizing 
21       the triangles into a multi-layer heightfield. Some simple filters are 
22       then applied to the mold to prune out locations where the character 
23       would not be able to move.
24    2. The walkable areas described by the mold are divided into simple 
25       overlayed 2D regions. The resulting regions have only one non-overlapping 
26       contour, which simplifies the final step of the process tremendously.
27    3. The navigation polygons are peeled off from the regions by first tracing 
28       the boundaries and then simplifying them. The resulting polygons are 
29       finally converted to convex polygons which makes them perfect for 
30       pathfinding and spatial reasoning about the level. 
31
32 The toolset code is located in the Recast folder and demo application using the Recast
33 toolset is located in the RecastDemo folder.
34
35 The project files with this distribution can be compiled with Microsoft Visual C++ 2008
36 (you can download it for free) and XCode 3.1.
37
38
39 Detour
40
41 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.
42
43 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 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. 
44
45
46 Latest code available at http://code.google.com/p/recastnavigation/
47
48
49 --
50
51 Release Notes
52
53 ----------------
54 * Recast 1.4
55   Released August 24th, 2009
56
57 - Added detail height mesh generation (RecastDetailMesh.cpp) for single,
58   tiled statmeshes as well as tilemesh.
59 - Added feature to contour tracing which detects extra vertices along
60   tile edges which should be removed later.
61 - Changed the tiled stat mesh preprocess, so that it first generated
62   polymeshes per tile and finally combines them.
63 - Fixed bug in the GUI code where invisible buttons could be pressed.
64
65 ----------------
66 * Recast 1.31
67   Released July 24th, 2009
68
69 - Better cost and heuristic functions.
70 - Fixed tile navmesh raycast on tile borders.
71
72 ----------------
73 * Recast 1.3
74   Released July 14th, 2009
75
76 - Added dtTileNavMesh which allows to dynamically add and remove navmesh pieces at runtime.
77 - Renamed stat navmesh types to dtStat* (i.e. dtPoly is now dtStatPoly).
78 - Moved common code used by tile and stat navmesh to DetourNode.h/cpp and DetourCommon.h/cpp.
79 - Refactores the demo code.
80
81 ----------------
82 * Recast 1.2
83   Released June 17th, 2009
84
85 - Added tiled mesh generation. The tiled generation allows to generate navigation for
86   much larger worlds, it removes some of the artifacts that comes from distance fields
87   in open areas, and allows later streaming and dynamic runtime generation
88 - Improved and added some debug draw modes
89 - API change: The helper function rcBuildNavMesh does not exists anymore,
90   had to change few internal things to cope with the tiled processing,
91   similar API functionality will be added later once the tiled process matures
92 - The demo is getting way too complicated, need to split demos
93 - Fixed several filtering functions so that the mesh is tighter to the geometry,
94   sometimes there could be up error up to tow voxel units close to walls,
95   now it should be just one.
96
97 ----------------
98 * Recast 1.1
99   Released April 11th, 2009
100
101 This is the first release of Detour.
102
103 ----------------
104 * Recast 1.0
105   Released March 29th, 2009
106
107 This is the first release of Recast.
108
109 The process is not always as robust as I would wish. The watershed phase sometimes swallows tiny islands
110 which are close to edges. These droppings are handled in rcBuildContours, but the code is not
111 particularly robust either.
112
113 Another non-robust case is when portal contours (contours shared between two regions) are always
114 assumed to be straight. That can lead to overlapping contours specially when the level has
115 large open areas.
116
117
118
119 Mikko Mononen
120 memon@inside.org