Difference between revisions of "Uberlod Vegetation Documentation"

From Nexus Mods Wiki
Jump to: navigation, search
Line 22: Line 22:
 
Open Data\Levels\_art\tree_uberlod_texture_baking\tree_uberlod_texture_baking.cry in editor. Unhide and unlock appropriate layer and you will see some trees here. These are base for the texture. You can arrange any trees or bushes here in trees layer. You should maintain square ratio of the bounding box of all the trees there as they will be baked to a square texture and we want to use the space as effectively as possible. 
 
Open Data\Levels\_art\tree_uberlod_texture_baking\tree_uberlod_texture_baking.cry in editor. Unhide and unlock appropriate layer and you will see some trees here. These are base for the texture. You can arrange any trees or bushes here in trees layer. You should maintain square ratio of the bounding box of all the trees there as they will be baked to a square texture and we want to use the space as effectively as possible. 
  
<span class="wikiexternallink"></span>
+
[[File:Uberlod Vegetation Documentation image1.png]]
  
 
Search for cvar WH_Commandexecutor_File and put there text value "render_vegetation_lod_atlas" – for more info, read bellow
 
Search for cvar WH_Commandexecutor_File and put there text value "render_vegetation_lod_atlas" – for more info, read bellow
Line 28: Line 28:
 
Change viewport resolution to 2048x2048.
 
Change viewport resolution to 2048x2048.
  
<span class="wikiexternallink"></span>
+
[[File:Uberlod Vegetation Documentation image2.png]]
 
<div class="wikimodel-emptyline">&nbsp;</div>  
 
<div class="wikimodel-emptyline">&nbsp;</div>  
 
Make sure you have on your harddrive script file W:\WH\Editor\Scripts\WH\get_cgf_and_positions.py
 
Make sure you have on your harddrive script file W:\WH\Editor\Scripts\WH\get_cgf_and_positions.py
Line 83: Line 83:
 
This is what you need to do in 3ds Max so this system works for you. Bake lod0 into plane using CryENGINE's LOD Generator:
 
This is what you need to do in 3ds Max so this system works for you. Bake lod0 into plane using CryENGINE's LOD Generator:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/1.jpg?width=577&height=483
+
[[File:Uberlod Vegetation Documentation image5.jpg]]
  
 
Do that for all the trees that shares the same lod material:
 
Do that for all the trees that shares the same lod material:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/2.jpg?width=651&height=309
+
[[File:Uberlod Vegetation Documentation image6.jpg]]
  
 
Once you have it, create second UVs for all of them together:
 
Once you have it, create second UVs for all of them together:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/3.jpg?width=740&height=582
+
[[File:Uberlod Vegetation Documentation image7.jpg]]
  
 
The vertex shader will expand the vertices by the value measured from the center of the uv space with y axis flipped. So first of all mirror everything horizontaly and place it so it is centered on the drawn X axis with bottoms aligned on the Y axis. The uvs for the largest tree of those should touch the bottom of the uv space. Just like on the picture.
 
The vertex shader will expand the vertices by the value measured from the center of the uv space with y axis flipped. So first of all mirror everything horizontaly and place it so it is centered on the drawn X axis with bottoms aligned on the Y axis. The uvs for the largest tree of those should touch the bottom of the uv space. Just like on the picture.
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/4.jpg?width=658&height=645
+
[[File:Uberlod Vegetation Documentation image8.jpg]]
  
 
Now that we have the position and size data safely stored in second UV channel, we can discard it from the geometry. Just shrink the geometry to the tiny rectangle:
 
Now that we have the position and size data safely stored in second UV channel, we can discard it from the geometry. Just shrink the geometry to the tiny rectangle:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/5.jpg?width=547&height=569
+
[[File:Uberlod Vegetation Documentation image9.jpg]]
  
 
Make sure that it sits in correct relation to the pivot:
 
Make sure that it sits in correct relation to the pivot:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/6.jpg?width=705&height=469
+
[[File:Uberlod Vegetation Documentation image10.jpg]]
  
 
And you should end up with something like that:
 
And you should end up with something like that:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/7.jpg?width=765&height=525
+
[[File:Uberlod Vegetation Documentation image11.jpg]]
  
 
Just export it and remember to check Additional UVs channel 2 in exporter.
 
Just export it and remember to check Additional UVs channel 2 in exporter.
Line 115: Line 115:
 
Now in the engine it's pretty simple. Just set the material vertex deform correctly and you're good to go.
 
Now in the engine it's pretty simple. Just set the material vertex deform correctly and you're good to go.
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/8.jpg
+
[[File:Uberlod Vegetation Documentation image12.jpg]]
  
 
== &nbsp; ==
 
== &nbsp; ==
Line 123: Line 123:
 
Run script ''WH Tools -> Misc -> UberlodImport''
 
Run script ''WH Tools -> Misc -> UberlodImport''
  
''http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/panel01.jpg''
+
[[File:Uberlod Vegetation Documentation image13.jpg]]
  
 
=== <span>'''Export uberlods from folder and sub'''</span> ===
 
=== <span>'''Export uberlods from folder and sub'''</span> ===
Line 143: Line 143:
 
In Editor, run console command ''wh_veg_ExportUberlods Foldername'', where Foldername is path relative to WH ("testfolder" represents path "WH/testfolder")
 
In Editor, run console command ''wh_veg_ExportUberlods Foldername'', where Foldername is path relative to WH ("testfolder" represents path "WH/testfolder")
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/03.jpg
+
[[File:Uberlod Vegetation Documentation image14.jpg]]
  
 
Generated XML files have name in the format:
 
Generated XML files have name in the format:
Line 167: Line 167:
 
If generation process gets frozen, there is probably problem with vegetation max files – there is missing GrowFX plugin. How to fix it: open "broken" max file and run script <span class="wikicreatelink">[http://xwiki.warhorse.local:8080/xwiki/bin/create/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/RemoveMissingPlugin/WebHome?parent=Teams.EnviroArt.Documentation.Assets.Uberlods.Vegetation+uberlods.WebHome http://www.scriptspot.com/3ds-max/scripts/removemissingplugins]</span> and then save max file.
 
If generation process gets frozen, there is probably problem with vegetation max files – there is missing GrowFX plugin. How to fix it: open "broken" max file and run script <span class="wikicreatelink">[http://xwiki.warhorse.local:8080/xwiki/bin/create/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/RemoveMissingPlugin/WebHome?parent=Teams.EnviroArt.Documentation.Assets.Uberlods.Vegetation+uberlods.WebHome http://www.scriptspot.com/3ds-max/scripts/removemissingplugins]</span> and then save max file.
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/04.jpg
+
[[File:Uberlod Vegetation Documentation image15.jpg]]
 
<div class="wikimodel-emptyline">&nbsp;</div>  
 
<div class="wikimodel-emptyline">&nbsp;</div>  
 
== <span>Exporting uberlods into engine</span> ==
 
== <span>Exporting uberlods into engine</span> ==
Line 175: Line 175:
 
Export cgf files, make sure you check on Additional UVs: Channel 2:
 
Export cgf files, make sure you check on Additional UVs: Channel 2:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/05.jpg
+
[[File:Uberlod Vegetation Documentation image16.jpg]]
 
<div class="wikimodel-emptyline">&nbsp;</div>  
 
<div class="wikimodel-emptyline">&nbsp;</div>  
 
Select Scene node in 3ds Max:
 
Select Scene node in 3ds Max:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/06.jpg
+
[[File:Uberlod Vegetation Documentation image17.jpg]]
  
 
In property click to Export Scene:
 
In property click to Export Scene:
  
http://xwiki.warhorse.local:8080/xwiki/bin/download/Teams/EnviroArt/Documentation/Assets/Uberlods/Vegetation%20uberlods/WebHome/07.jpg
+
[[File:Uberlod Vegetation Documentation image18.jpg]]
 
</div> </div> </div> <div class="clearfloats">&nbsp;</div> </div> </div> </div> <div class="clearfloats">&nbsp;</div>   
 
</div> </div> </div> <div class="clearfloats">&nbsp;</div> </div> </div> </div> <div class="clearfloats">&nbsp;</div>   
 
[[Category:Documentation]] [[Category:Kingdom Come Deliverance]]
 
[[Category:Documentation]] [[Category:Kingdom Come Deliverance]]

Revision as of 14:22, 24 October 2019

This article is about our system for distant tree lods in general and especially how to create it. 

Vegetation BB LODs

Uberlod node for single vegetation has to be a BB LOD.

What does it do?

This system uses Vertex deformation of shader to expand small square into sizes of big trees and makes them face the camera. The usual billboarding solution wouldn't work because we need this to work and uberlods that has multiple elements that needs to face the camera separately. To achieve this we create tiny squares of geometry with the desired vertex position data in 2nd UV channel and then expand them in realtime in the engine by shifting vertices for the amount specified by 2nd UV position times per material constant.

Semi-automated pipeline

You have to do three things on:

  1. Editor side
  2. Photoshop side
  3. Max side

Editor side

Open Data\Levels\_art\tree_uberlod_texture_baking\tree_uberlod_texture_baking.cry in editor. Unhide and unlock appropriate layer and you will see some trees here. These are base for the texture. You can arrange any trees or bushes here in trees layer. You should maintain square ratio of the bounding box of all the trees there as they will be baked to a square texture and we want to use the space as effectively as possible. 

Uberlod Vegetation Documentation image1.png

Search for cvar WH_Commandexecutor_File and put there text value "render_vegetation_lod_atlas" – for more info, read bellow

Change viewport resolution to 2048x2048.

Uberlod Vegetation Documentation image2.png

 

Make sure you have on your harddrive script file W:\WH\Editor\Scripts\WH\get_cgf_and_positions.py

Start game mode (Ctrl+G) and you will see rotating trees and the process of making the screenshots. All the trees will be captured from 8 different angles covering 360° view, that makes 24 textures (8 diff, 8 normal, 8 height) . After it automatically finishes, exit game mode.

render_vegetation_lod_atlas.xml

This is the file which controls the process of making screenshots. All it does is to set some control variables, then set rotation of the trees, take screenshot, rotate tree, take screenshot etc. And at the end, it sets some cVars to default value.

   <Console command= "e_LodMin=2"/> - because the BB LOD comes after the LOD2, we should generate it based on LOD2

Generating good-looking height map could be tricky, you can add try this cVars at the beginning of xml file:

   <Console command= "e_lods=0"/>
   <Console command= "e_MaxViewDistance = 210"/>
   <Console command= "cl_DefaultNearPlane = 150"/>
   <Console command= "cl_nearPlane = 150"/>
   <Console command= "r_ShowDynTexturesFilter = $ZTarget"/>
   <Console command= "r_ShowDynTexturesMaxCount = 1"/>
   <Console command= "r_ShowDynTextures = 1"/>
 

To render SSDO:

  • Total Ilumination must by active, set Cone max length to 2 and Difufse Amplifier to 10 and Sky color multiplier to 32
  • set up SSDO cvars

Created screenshots to be found in "user_editor\screenshots\". Also needed is xml containing the positions of those trees and some other data regarding them, to be found in file "Data\Objects\vegetation\trees\tree_sprite_pos.xml". Only important thing in there is the MaxHeight attribute that tells you what to set later in material in editor.

Photoshop side

Textures used for tree uberlods are located in W:\WH\Engine\EngineAssets\Textures\BillboardAtlas

On normal map the green channel should be inverted so make sure the layer is under the adjustment layer called "invert green"

Just replace them with latest screenshots. You can also do some modification – for example emphatize spherical volume of the tree crown by overlaying spherical normal map over it. Add some shadow inside to tree in diffuse map (we tried to render SSDO, but the results were kind of poor).

MAX side

Open one of the max files with trees (you'll have to go through all of those that changed position inn the texture).

Open WH Tools/Model/Trees/ZSpriteCreator

Screenshot_5.png

 

You should see a rollout with list of all trees that were placed in editor when you executed the get_cgf_and_positions.

Screenshot_6.png

 

Now select the LOD object you want to remap in viewport (usually lod3 or uberlod) and the tree type in the list that corresponds to it and hit Process button.

The object should now be remapped to the new texture. Second UVs are remapped as well so the object will be rescaled properly in respect to all the other it was captured together with.  

That's all.

Manual approach (worse)

3DS MAX side

This is what you need to do in 3ds Max so this system works for you. Bake lod0 into plane using CryENGINE's LOD Generator:

Uberlod Vegetation Documentation image5.jpg

Do that for all the trees that shares the same lod material:

Uberlod Vegetation Documentation image6.jpg

Once you have it, create second UVs for all of them together:

Uberlod Vegetation Documentation image7.jpg

The vertex shader will expand the vertices by the value measured from the center of the uv space with y axis flipped. So first of all mirror everything horizontaly and place it so it is centered on the drawn X axis with bottoms aligned on the Y axis. The uvs for the largest tree of those should touch the bottom of the uv space. Just like on the picture.

Uberlod Vegetation Documentation image8.jpg

Now that we have the position and size data safely stored in second UV channel, we can discard it from the geometry. Just shrink the geometry to the tiny rectangle:

Uberlod Vegetation Documentation image9.jpg

Make sure that it sits in correct relation to the pivot:

Uberlod Vegetation Documentation image10.jpg

And you should end up with something like that:

Uberlod Vegetation Documentation image11.jpg

Just export it and remember to check Additional UVs channel 2 in exporter.

 

Engine side

Now in the engine it's pretty simple. Just set the material vertex deform correctly and you're good to go.

Uberlod Vegetation Documentation image12.jpg

 

Creating uberlods from BB LODs

Run script WH Tools -> Misc -> UberlodImport

Uberlod Vegetation Documentation image13.jpg

Export uberlods from folder and sub

Path From – path including subfolders where to search for max files in order to export them into FBX

Path To – Where to put exported FBX files

Import uberlods FBX

Directory from which to import FBX uberlods (same as "Path To"?)

XML direction

Path to the exported vegetation data XML. 

How to export vegetation data XML:

In Editor, run console command wh_veg_ExportUberlods Foldername, where Foldername is path relative to WH ("testfolder" represents path "WH/testfolder")

Uberlod Vegetation Documentation image14.jpg

Generated XML files have name in the format:

uberlod_node_<CELL_Y>_<CELL_X>_<BOUNDS_MIN_X>_<BOUNDS_MIN_Y>_<BOUNDS_MAX_X>_<BOUNDS_MAX_Y>.xml, where:

  • CELL_Y, CELL_X - coordinates of vegetation cell
  • BOUNDS_MIN_X, BOUNDS_MIN_Y, BOUNDS_MAX_X, BOUNDS_MAX_Y - axis-aligned bounding box of vegetation cell

Vegetation cell index could be calculated: VegetationCell = (CELL_Y * (TerrainSize / wh_e_vegetationCellSize)) + CELL_X, where

  • TerrainSize is 4096 for Rataje
  • wh_e_vegetationCellSize is cvar with defaul value of 64 (i.e. TerrainSize / wh_e_vegetationCellSize = 64)

Process

From, To - pick square between coordinates

Save Frequency - how often to autosave (every nth square)

Troubleshooting

If generation process gets frozen, there is probably problem with vegetation max files – there is missing GrowFX plugin. How to fix it: open "broken" max file and run script http://www.scriptspot.com/3ds-max/scripts/removemissingplugins and then save max file.

Uberlod Vegetation Documentation image15.jpg

 

Exporting uberlods into engine

Sync and assign material \Objects\vegetation\trees\uberlod_veg.mtl

Export cgf files, make sure you check on Additional UVs: Channel 2:

Uberlod Vegetation Documentation image16.jpg

 

Select Scene node in 3ds Max:

Uberlod Vegetation Documentation image17.jpg

In property click to Export Scene:

Uberlod Vegetation Documentation image18.jpg