include recast4j, reorg documentation
All checks were successful
studiorailgun/Renderer/pipeline/head This commit looks good

This commit is contained in:
austin 2024-02-29 13:20:10 -05:00
parent 9407c13217
commit 36e2563e03
26 changed files with 111 additions and 13 deletions

View File

@ -1,3 +1,3 @@
#maven.buildNumber.plugin properties file #maven.buildNumber.plugin properties file
#Wed Feb 28 20:29:21 EST 2024 #Thu Feb 29 11:18:06 EST 2024
buildNumber=26 buildNumber=29

View File

@ -0,0 +1 @@
@page architectureindex Engine Architecture

View File

@ -1,4 +1,4 @@
# Weaving Meshes @page WeavingMeshes Weaving Meshes

View File

@ -0,0 +1,4 @@
@page blenderindex Blender
[TOC]
- @subpage WeavingMeshes

View File

@ -1,3 +1,4 @@
@page codegen Internal Field Synchronization
## Behavior Trees ## Behavior Trees

View File

@ -0,0 +1,5 @@
@page codegenindex Internal Code Generation
[TOC]
- @subpage codegen

View File

@ -1,4 +1,4 @@
# Debug Loading Halting @page LoadingHalting Debug Loading Halting
A very common issue is that the loading for the client never completes for a certain gamemode. A very common issue is that the loading for the client never completes for a certain gamemode.
The goal of this doc is to track causes for this so that it can be debugged faster in the future. The goal of this doc is to track causes for this so that it can be debugged faster in the future.

View File

@ -0,0 +1,5 @@
@page indexdebug Debugging
[TOC]
- @subpage LoadingHalting

View File

@ -1,4 +1,4 @@
# Documentation System Explanation @page doxygen Documentation System Explanation
The engine uses doxygen to document its features, code, and organization. The engine uses doxygen to document its features, code, and organization.
## Building ## Building

View File

@ -0,0 +1,5 @@
@page indexdocumentation Documentation
[TOC]
- @subpage doxygen

View File

@ -0,0 +1,4 @@
@page entitytypesindex Entity Types
[TOC]
- @subpage treesystem

View File

@ -1,4 +1,4 @@
# Tree System @page treesystem Tree System
### The Concept ### The Concept

View File

@ -0,0 +1,4 @@
@page highleveldesignindex High Level Game Design
[TOC]
- @subpage macroWorldPartitioning

View File

@ -1,4 +1,4 @@
# Macro World Partitioning @page macroWorldPartitioning Macro World Partitioning

View File

@ -0,0 +1,4 @@
@page navmeshIndex Navigation Systems
[TOC]
- @subpage navmesh

View File

@ -0,0 +1,14 @@
@page navmesh Nav Mesh System
## High Level Overview
https://github.com/ppiastucki/recast4j
recast4j is a java lib that provides java version of recast and detour. Recast generates navmeshes, detour handles pathfinding through meshes generated with recast.
Goal is to eventually bake them into the engine.
## Future Goals
- Overhaul existing, broken navmesh logic to leverage recast and detour

View File

@ -1,4 +1,4 @@
# Collision Engine @page collision Collision Engine

View File

@ -0,0 +1,5 @@
@page physicsindex Physics and Collision Systems
[TOC]
- @subpage collision
- @subpage physics

View File

@ -1,4 +1,4 @@
# Physics Engine @page physics Physics Engine
## High Level Overview ## High Level Overview
The goal of the physics engine is to wrap around the collision engine to allow physics to occur within the game. The goal of the physics engine is to wrap around the collision engine to allow physics to occur within the game.

View File

@ -1,4 +1,4 @@
# Draw Cells @page DrawCell Draw Cells
TODO TODO

View File

@ -1,4 +1,4 @@
# Fonts @page Fonts Fonts

View File

@ -0,0 +1,7 @@
@page indexrendering Rendering
[TOC]
- @subpage DrawCell
- @subpage Fonts
- @subpage modelLoading

View File

@ -1,4 +1,4 @@
# Model Loading @page modelLoading Model Loading
TODO TODO

View File

@ -1,4 +1,4 @@
# Entity Spawning @page entitySpawning Entity Spawning
Recommended flow and tips for spawning entities from the server Recommended flow and tips for spawning entities from the server

View File

@ -0,0 +1,4 @@
@page servercommonindex Common Server Tasks
[TOC]
- @subpage entitySpawning

35
pom.xml
View File

@ -11,6 +11,7 @@
<maven.compiler.target>17</maven.compiler.target> <maven.compiler.target>17</maven.compiler.target>
<lwjgl.version>3.2.3</lwjgl.version> <lwjgl.version>3.2.3</lwjgl.version>
<joml.version>1.9.19</joml.version> <joml.version>1.9.19</joml.version>
<recast.version>1.5.7</recast.version>
</properties> </properties>
<!-- Used for build number plugin because it LITERALLY WONT LET YOU NOT HAVE SCM--> <!-- Used for build number plugin because it LITERALLY WONT LET YOU NOT HAVE SCM-->
@ -179,6 +180,40 @@
<version>1.9.0</version> <version>1.9.0</version>
</dependency> </dependency>
<!--recast4j-->
<!--License: zlib-->
<!-- https://mvnrepository.com/artifact/org.recast4j/recast -->
<dependency>
<groupId>org.recast4j</groupId>
<artifactId>recast</artifactId>
<version>${recast.version}</version>
</dependency>
<dependency>
<groupId>org.recast4j</groupId>
<artifactId>detour</artifactId>
<version>${recast.version}</version>
</dependency>
<dependency>
<groupId>org.recast4j</groupId>
<artifactId>detour-crowd</artifactId>
<version>${recast.version}</version>
</dependency>
<dependency>
<groupId>org.recast4j</groupId>
<artifactId>detour-tile-cache</artifactId>
<version>${recast.version}</version>
</dependency>
<dependency>
<groupId>org.recast4j</groupId>
<artifactId>detour-extras</artifactId>
<version>${recast.version}</version>
</dependency>
<dependency>
<groupId>org.recast4j</groupId>
<artifactId>detour-dynamic</artifactId>
<version>${recast.version}</version>
</dependency>
</dependencies> </dependencies>