Skip to content

Commit

Permalink
DOCS: updated configuration vars
Browse files Browse the repository at this point in the history
  • Loading branch information
@mgerhardy
mgerhardy committed Jan 8, 2025
1 parent 3c6aed5 commit 3c5a490
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,20 @@ Some of these settings are only for voxel format, others are only for the mesh f
| Name | Description | Example |
| ----------------------------- | ---------------------------------------------------------------------------------------- | ------------ |
| `core_colorreduction` | This can be used to tweak the color reduction by switching to a different algorithm. Possible values are `Octree`, `Wu`, `NeuQuant`, `KMeans` and `MedianCut`. This is useful for mesh based formats or RGBA based formats like e.g. AceOfSpades vxl. | Octree |
| `palformat_maxsize` | The maximum size of an image in x and y direction to quantize to a palette | 512 |
| `palformat_rgb6bit` | Use 6 bit color values for the palette (0-63) - used e.g. in C&C pal files | true/false |
| `voxel_meshmode` | Set to 1 to use the marching cubes algorithm to produce the mesh | 0/1 |
| `voxformat_ambientocclusion` | Don't export extra quads for ambient occlusion voxels | true/false |
| `voxformat_colorasfloat` | Export the vertex colors as float or - if set to false - as byte values (GLTF/Unreal) | true/false |
| `voxformat_createpalette` | Setting this to false will use use the palette configured by `palette` cvar and use those colors as a target. This is mostly useful for meshes with either texture or vertex colors or when importing rgba colors. This is not used for palette based formats - but also for RGBA based formats. | true/false |
| `voxformat_emptypaletteindex` | By default this is `-1` which means that no color is skipped. Pick 0-255 to remove that palette index from the final saved file. **NOTE**: this only works for formats that don't force the empty voxel to be `0` or `255` (or any other index) already |
| `voxformat_fillhollow` | Fill the inner parts of completely close objects, when voxelizing a mesh format. To fill the inner parts for non mesh formats, you can use the fillhollow.lua script. | true/false |
| `voxformat_gltf_khr_materials_pbrspecularglossiness` | Apply KHR_materials_pbrSpecularGlossiness extension on saving gltf files | true/false |
| `voxformat_gltf_khr_materials_specular` | Apply KHR_materials_specular extension on saving gltf files | true/false |
| `voxformat_gltf_khr_materials_pbrspecularglossiness` | Apply KHR_materials_pbrSpecularGlossiness extension on saving gltf files | true/false |
| `voxformat_gltf_khr_materials_specular` | Apply KHR_materials_specular extension on saving gltf files | true/false |
| `voxformat_imageheightmapminheight` | The minimum height of the heightmap when importing an image as heightmap | 0 |
| `voxformat_imageimporttype` | 0 = plane, 1 = heightmap, 2 = volume | 0 |
| `voxformat_imagevolumemaxdepth` | The maximum depth of the volume when importing an image as volume | 1 |
| `voxformat_imagevolumebothsides` | Import the image as volume for both sides | true/false |
| `voxformat_mergequads` | Merge similar quads to optimize the mesh | true/false |
| `voxformat_merge` | Merge all models into one object | true/false |
| `voxformat_optimize` | Apply mesh optimizations when saving mesh based formats | true/false |
Expand All @@ -105,20 +111,21 @@ Some of these settings are only for voxel format, others are only for the mesh f
| `voxformat_qbtmergecompounds` | Merge compounds in qbt export | true/false |
| `voxformat_qbsavelefthanded` | Save qubicle format as left handed | true/false |
| `voxformat_qbsavecompressed` | Save qubicle with RLE compression | true/false |
| `voxformat_quads` | Export to quads | true/false |
| `voxformat_reusevertices` | Reuse vertices or always create new ones | true/false |
| `voxformat_rgbflattenfactor` | To flatten the RGB colors when importing volumes (0-255) from RGBA or mesh based formats | 1 |
| `voxformat_rgbweightedaverage`| If multiple triangles contribute to the same voxel the color values are averaged based on their area contribution | true/false |
| `voxformat_scale` | Scale the vertices for voxelization on all axis by the given factor | 1.0 |
| `voxformat_scale_x` | Scale the vertices for voxelization on X axis by the given factor | 1.0 |
| `voxformat_scale_y` | Scale the vertices for voxelization on Y axis by the given factor | 1.0 |
| `voxformat_scale_z` | Scale the vertices for voxelization on Z axis by the given factor | 1.0 |
| `voxformat_withmaterials` | Export [material](Material.md) properties for formats that supports this | true/false |
| `voxformat_texturepath` | Additional search path for textures when importing mesh formats | |
| `voxformat_transform_mesh` | Apply the keyframe transform to the mesh | true/false |
| `voxformat_quads` | Export to quads | true/false |
| `voxformat_voxcreategroups` | Magicavoxel vox groups | true/false |
| `voxformat_voxcreatelayers` | Magicavoxel vox layers | true/false |
| `voxformat_voxelizemode` | `0` = high quality, `1` = faster and less memory | 0/1 |
| `voxformat_vxlnormaltype` | Normal type for VXL format - 2 (TS) or 4 (RedAlert2) | 2/4 |
| `voxformat_withcolor` | Export vertex colors | true/false |
| `voxformat_withmaterials` | Export [material](Material.md) properties for formats that supports this | true/false |
| `voxformat_withnormals` | Export smoothed normals for cubic surface meshes (marching cubes always uses normals) | true/false |
| `voxformat_withtexcoords` | Export texture coordinates | true/false |

0 comments on commit 3c5a490

Please sign in to comment.