Arma Reforger:Navmesh Tutorial - Revision history

Lou Montana: Some wiki formatting

2023-11-09T14:30:42Z

Some wiki formatting

← Older revision		Revision as of 16:30, 9 November 2023
Line 22:		Line 22:
	# In the default layer of the terrain, add {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab '''from Resource Browser'''<!--		# In the default layer of the terrain, add {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab '''from Resource Browser'''<!--
	--> which contains the {{Link/Enfusion\|armaR\|NavmeshWorldComponent}} component<!--		--> which contains the {{Link/Enfusion\|armaR\|NavmeshWorldComponent}} component<!--
	-->{{Feature\|informative\|the {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab holds '''three''' [enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c ~~NavmeshWorldComponent]~~, the second one (BTRLike) being disabled for now (0.9.8).}}		-->{{Feature\|informative\|the {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab holds '''three''' {{Link\|enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c}}, the second one (BTRLike) being disabled for now (0.9.8).}}
	# Let's now create a new navmesh to be set in the {{hl\|NavmeshFilesConfig}} entry:		# Let's now create a new navmesh to be set in the {{hl\|NavmeshFilesConfig}} entry:
	#* Open Navmesh Tool in the toolbar [[File:armareforger_worldeditor-navmeshtool-icon.png\|32px]] and select its {{hl\|Navmesh Tool}} tab		#* Open Navmesh Tool in the toolbar [[File:armareforger_worldeditor-navmeshtool-icon.png\|32px]] and select its {{hl\|Navmesh Tool}} tab

Lou Montana: Add LowRes definition and goals

2023-06-08T14:16:56Z

Add LowRes definition and goals

← Older revision		Revision as of 16:16, 8 June 2023
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}
	The goal of this document is to help understanding the navmesh system and modding flow.		The goal of this document is to help understanding the navmesh system and modding flow.


			== Definitions ==

			* '''Soldiers''' navmesh is is adapted to human navigation.
			* '''BTRLike''' navmesh is adapted to vehicle navigation. Its generation is disabled as of now (0.9.8) as AIs cannot drive yet.
			* '''LowRes''' navmesh is a low resolution navmesh used for navmesh streaming.

			=== Navmesh Streaming ===

			On large terrains, Using navmesh streaming and configuring a {{Link\|#LowRes Navmesh}} is recommended for RAM and performance reasons.
			When needed (on larg terrains) and configured properly (see {{Link\|#Usage}} below), this navmesh will be used to draw a rough path for the other, more precise navmesh to only use its tiles that are close to the LowRes' found path.
			This option saves a lot of RAM and calculations and should be used whenever possible, with the exception of small terrains.


Line 9:		Line 22:
	# In the default layer of the terrain, add {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab '''from Resource Browser'''<!--		# In the default layer of the terrain, add {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab '''from Resource Browser'''<!--
	--> which contains the {{Link/Enfusion\|armaR\|NavmeshWorldComponent}} component<!--		--> which contains the {{Link/Enfusion\|armaR\|NavmeshWorldComponent}} component<!--
	-->{{Feature\|informative\|the {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab holds '''~~two~~''' [enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c NavmeshWorldComponent], the second one being disabled.}}		-->{{Feature\|informative\|the {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab holds '''three''' [enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c NavmeshWorldComponent], the second one (BTRLike) being disabled for now (0.9.8).}}
	# Let's now create a new navmesh to be set in the {{hl\|NavmeshFilesConfig}} entry:		# Let's now create a new navmesh to be set in the {{hl\|NavmeshFilesConfig}} entry:
	#* Open Navmesh Tool in the toolbar [[File:armareforger_worldeditor-navmeshtool-icon.png\|32px]] and select its {{hl\|Navmesh Tool}} tab		#* Open Navmesh Tool in the toolbar [[File:armareforger_worldeditor-navmeshtool-icon.png\|32px]] and select its {{hl\|Navmesh Tool}} tab

Lou Montana: Add Usage section

2023-06-06T13:11:59Z

Add Usage section

← Older revision		Revision as of 15:11, 6 June 2023
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}
	The goal of this document is to help understanding the navmesh modding flow~~. There are two main areas which will be described~~.		The goal of this document is to help understanding the navmesh system and modding flow.


	== ~~Navmesh~~ Creation ==		== Creation ==

	This section is about creating a navmesh for an editable terrain (modded terrain or sub-scene of an existing terrain).		This section is about creating a navmesh for an editable terrain (modded terrain or sub-scene of an existing terrain).
Line 25:		Line 25:


	== ~~Navmesh~~ Modification ==		== Modification ==

	This section is about editing an existing navmesh for an editable terrain (modded terrain or sub-scene of an existing terrain).		This section is about editing an existing navmesh for an editable terrain (modded terrain or sub-scene of an existing terrain).
Line 76:		Line 76:


	== ~~Navmesh~~ Modding ==		== Modding ==

	Everything up to this point expected the map to be freely changeable. But what if we want to modify Everon's navmesh without copying whole world?		Everything up to this point expected the map to be freely changeable. But what if we want to modify Everon's navmesh without copying whole world?
Line 89:		Line 89:
	This creates an override file in the mod project, file that can now target {{hl\|GM_Eden.nmn}} and the future partial navmesh files we are about to generate.		This creates an override file in the mod project, file that can now target {{hl\|GM_Eden.nmn}} and the future partial navmesh files we are about to generate.

	=== Partial ~~Navmesh~~ Generation ===		=== Partial Generation ===

	Not unlike {{Link\|#Partial Regeneration}}, connect to the Navmesh server and generate only the area around which the modded terrain has been edited (a new house lot, another castle on the next hill?); then, save it ({{hl\|Save Generated}}/{{hl\|Save Marked}}).		Not unlike {{Link\|#Partial Regeneration}}, connect to the Navmesh server and generate only the area around which the modded terrain has been edited (a new house lot, another castle on the next hill?); then, save it ({{hl\|Save Generated}}/{{hl\|Save Marked}}).
Line 96:		Line 96:

	{{Feature\|important\|In order to see the changes, the terrain must be reloaded.}}		{{Feature\|important\|In order to see the changes, the terrain must be reloaded.}}


			== Usage ==

			Navmeshes can then be used in {{Link/Enfusion\|armaR\|SCR_AIWorld}}'s {{Link/Enfusion\|armaR\|NavmeshWorldComponent}} components:
			* Drag and drop a {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et}} Prefab '''if''' there are none in the world - only one per world can exist!
			** The first NavmeshWorldComponent is for '''Soldiers''' navmesh - required for on-foot AIs to navigate through the land
			** The second NavmeshWorldComponent is for '''BTRLike''' navmesh - disabled as of now (v0.9.8) as AIs do not drive yet
			** The third NavmeshWorldComponent is for '''LowRes''' navmesh - it is '''required''' and must be linked in the Soldiers navmesh as follows: in Soldier's {{Link/Enfusion\|armaR\|NavmeshWorldComponent}},
			*** check the '''Use Navmesh Streaming''' checkbox
			*** set the '''Low Resolution Navmesh''' that appeared to '''LowRes''' {{Feature\|important\|Do '''not''' check the '''Use Navmesh Streaming''' checkbox in the '''LowRes''' navmesh properties.}}
			* To setup a navmesh in a NavmeshWorldComponent, navigate to its '''Navmesh Settings > Navmesh Files Config'''. Here, two choices are offered:
			** click '''set class''' and fill the '''Navmesh File''' field with a navmesh file
			** drag and drop an existing {{hl\|BaseNavmeshFilesConfig}}, e.g {{Link\|enfusion://ResourceManager/~ArmaReforger:Configs/Navmesh/Navmesh_GM_Arland_Soldier.conf}}.


	{{GameCategory\|armaR\|Modding\|Tutorials}}		{{GameCategory\|armaR\|Modding\|Tutorials}}

Lou Montana: Text replacement - "\{\{Link\|enfusion.*\.c\|([A-Za-z0-9_]+)\}\}" to "{{Link/Enfusion|armaR|$1}}"

2023-01-05T11:03:48Z

Text replacement - "\{\{Link\|enfusion.*\.c\|([A-Za-z0-9_]+)\}\}" to "{{Link/Enfusion|armaR|$1}}"

← Older revision		Revision as of 13:03, 5 January 2023
Line 8:		Line 8:

	# In the default layer of the terrain, add {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab '''from Resource Browser'''<!--		# In the default layer of the terrain, add {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab '''from Resource Browser'''<!--
	--> which contains the {{Link\|~~enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c~~\|NavmeshWorldComponent}} component<!--		--> which contains the {{Link/Enfusion\|armaR\|NavmeshWorldComponent}} component<!--
	-->{{Feature\|informative\|the {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab holds '''two''' [enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c NavmeshWorldComponent], the second one being disabled.}}		-->{{Feature\|informative\|the {{Link\|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et\|SCR_AIWorld.et}} prefab holds '''two''' [enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c NavmeshWorldComponent], the second one being disabled.}}
	# Let's now create a new navmesh to be set in the {{hl\|NavmeshFilesConfig}} entry:		# Let's now create a new navmesh to be set in the {{hl\|NavmeshFilesConfig}} entry:

Lou Montana: Add Navmesh modding

2022-07-20T12:25:11Z

Add Navmesh modding

@@ Line 78: / Line 78: @@
 == Navmesh Modding ==
-{{Wiki|TODO}}
+Everything up to this point expected the map to be freely changeable. But what if we want to modify Everon's navmesh without copying whole world?
 {{GameCategory|armaR|Modding|Tutorials}}

Lou Montana: Page creation

2022-06-27T10:01:55Z

Page creation

New page

{{TOC|side}}
The goal of this document is to help understanding the navmesh modding flow. There are two main areas which will be described.

== Navmesh Creation ==

This section is about creating a navmesh for an editable terrain (modded terrain or sub-scene of an existing terrain).

# In the default layer of the terrain, add {{Link|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et|SCR_AIWorld.et}} prefab '''from Resource Browser''' which contains the {{Link|enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c|NavmeshWorldComponent}} component{{Feature|informative|the {{Link|enfusion://ResourceManager/~ArmaReforger:Prefabs/AI/SCR_AIWorld.et|SCR_AIWorld.et}} prefab holds '''two''' [enfusion://ScriptEditor/scripts/GameLib/generated/AI/NavmeshWorldComponent.c NavmeshWorldComponent], the second one being disabled.}}
# Let's now create a new navmesh to be set in the {{hl|NavmeshFilesConfig}} entry:
#* Open Navmesh Tool in the toolbar [[File:armareforger_worldeditor-navmeshtool-icon.png|32px]] and select its {{hl|Navmesh Tool}} tab
#* Set Navmesh to {{hl|Soldiers}} the same as in the NavmeshWorldComponent's {{hl|Navmesh Project}} property
#* Click Connect to open the {{hl|Connect}} window and select {{hl|Soldiers}} again - click OK to connect to the local navmesh server
#* Click Generate to open the {{hl|Recast params}} options window
#** Keep everything to default values and press OK to display then the {{hl|Generator area}} options window
#** Keep everything to default again (to cover the whole area) and press OK
#* The navmesh generation process has been started. This operation may take some time, the progress being displayed at the bottom of the Navmesh Tool tab
# Click the Save button to save the resulting navmesh to storage (in a {{hl|.nmn}} file).

The navmesh file can now be added to the Navmesh Settings/Navmesh File property in SCR_AIWorld's NavmeshWorldComponent

Select {{hl|Soldiers}} in {{hl|Navmesh Project}} combobox and in Navmesh Tool/Navmesh to display the created navmesh.

== Navmesh Modification ==

This section is about editing an existing navmesh for an editable terrain (modded terrain or sub-scene of an existing terrain).

Place e.g {{Link|enfusion://ResourceManager/~ArmaReforger:Prefabs/Structures/Industrial/Houses/Office_E_01/Office_E_01.et|Office_E_01.et}} - note how the navmesh is not impacted and does not adapt around/with the building.

Multiple solutions are available, described below.

=== Full Regeneration ===

A full navmesh regeneration has multiple problems:
* the generation time can be quite big
* the file size can grow quickly as well.
For instance, the {{Link|enfusion://ResourceManager/~ArmaReforger:worlds/MP/Navmeshes/CTI_Campaign_Eden.nmn|CTI_Campaign_Eden navmesh}} that is used on Everon for AI soldiers is over 1GB of size at the time of writing.
As such, generating a whole navmesh for a minor modification the mod that changes one navmesh tile of bigger maps is quite long (depending on the system the operation can take over an hour) and expensive in storage.

There is a better option for that.

=== Partial Regeneration ===

This option allows to only generate tiles that changed and "patch" the full navmesh.

==== Current Tile ====
The {{hl|Rebuild Tile}} button regenerates the tile over which the camera is; to use it, move the camera anywhere over the wanted tile, then press the button to regenerate that specific tile.

This is useful when only a small area has been modified (e.g a couple of buildings or an outpost placed).

{{Feature|important|Be wary that a wide composition (e.g outpost) can cover multiple tiles, therefore be sure to check the resulting output in order to avoid partially generated navmeshes.}}

==== Tile Range ====
The Tile Range regeneration option allows to regenerate a wanted rectangle of tiles, defined by its South-West/"bottom-left" and North-East/"top-right" points.

In order to do so, X and Y tiles indices can be used but these are not easily available - hopefully, their position value can also be used.
For that, it is important to keep track of min and max (South-West/"bottom-left" / North-East/"top-right") positions of the area to be regenerated;
these values can be obtained using the World Editor camera's position found at the bottom-left of World Editor.

* Open the Navmesh Tool
* Select {{hl|Soldiers}} navmesh
* Connect to the local server
* Click Generate
* Click OK in the {{hl|Recast params}} window
* Reaching the {{hl|Generator area}} options window, click on the {{hl|Position}} tab to input the area of generation - enter the min and max values from earlier in the Positions tab (From = min, To = max), then click OK.

The Tool then only generates the defined area and updates the current '''''memory''''' navmesh, and the map widget updates accordingly.

In order to save the updated navmesh, click {{hl|Save Generated}} and save where needed - overwriting the old navmesh being an option.

If the generated area generated more tiles than we need, we can mark only tiles that are actually needed to be saved by marking them on the map by leftclick drag,
right clicking and clicking mark tiles then we could use SaveMarked and save only those that we marked.

== Navmesh Modding ==

{{Wiki|TODO}}

{{GameCategory|armaR|Modding|Tutorials}}