Template:Archived Page History/Cubemaps/en: Difference between revisions
m (→Portal 2) |
|||
| Line 87: | Line 87: | ||
=== Source Filmmaker === | === Source Filmmaker === | ||
[[Image:Cubemap_bug_sfm.jpg|thumb|right|300px|Improper rendering of an HDR cubemap's face in Source Filmmaker.]] | [[Image:Cubemap_bug_sfm.jpg|thumb|right|300px|Improper rendering of an HDR cubemap's face in Source Filmmaker.]] | ||
{{ModernBug|'''HDR''' cubemaps sizing lower than | {{ModernBug|'''HDR''' cubemaps sizing lower than 128x128 built in {{tf2}}'''Team Fortress 2''' and some other games usually display graphical artifacts on reflections due to the last face of each cubemap not rendering properly in {{sfm}}'''Source Filmmaker'''. While rebuilding cubemaps in it would normally fix the issue, it is currently not possible to do so as '''Source Filmmaker''' generates blank textures. | ||
{{ModernWorkaround|If recompiling a special version of an affected map with '''env_cubemaps''' now sizing | {{ModernWorkaround|If recompiling a special version of an affected map with '''env_cubemaps''' now sizing 128x128 is not an option, move the map file into {{as}}'''Alien Swarm'''<nowiki>'</nowiki>s "maps" folder, build its cubemaps in that game, then move the file back into '''Source Filmmaker'''<nowiki>'</nowiki>s folder.}}}} | ||
{{ModernNote|'''Alien Swarm'''<nowiki>'</nowiki>s "gameinfo.txt" file needs to be edited for this procedure so that the game can have access to assets used by other games' maps not to build cubemaps with missing textures or models. The file's "SearchPaths" section should be like this:}} | {{ModernNote|'''Alien Swarm'''<nowiki>'</nowiki>s "gameinfo.txt" file needs to be edited for this procedure so that the game can have access to assets used by other games' maps not to build cubemaps with missing textures or models. The file's "SearchPaths" section should be like this:}} | ||
"SearchPaths" | "SearchPaths" | ||
Revision as of 16:47, 30 August 2023
A cubemap is a texture that represents a three-dimensional rendering of an area. The Source Engine uses env_cubemap entities as sampling points to generate these textures, which are then automatically embedded into the map file. Cubemaps, when built, are reflected on surfaces that use the $envmap parameter (with env_cubemap as its value).
Building cubemaps
Building cubemaps is the process of generating their textures to then use them as reflections. For technical reasons, this process is not automated and is up to the user to do so; until then, existing env_cubemaps will remain unused and the map, depending on the game, will display either generic or "missing" textures as reflections due to nonexistent cubemaps. Template:ModernWarning Template:ModernNote Template:ModernNote Template:ModernTip Template:ModernTip Template:ModernWarning Template:ModernWarning
Before building
LDR
Template:ModernNote Building cubemaps on a map compiled in LDR (Low Dynamic Range) mode will generate textures only for that mode, regardless of your game's High Dynamic Range video setting. To build the cubemaps, submit the following commands into the game's console:
| Command | Description |
|---|---|
mat_specular 0 |
Disables reflections. Required to properly build cubemaps |
map cs_mymap |
Loads a map; replace "cs_mymap" with the map's actual name |
sv_cheats 1 |
Enables the use of cheat commands. Required to build cubemaps |
buildcubemaps |
Starts building cubemaps. Optionally, specify the number of iterations (default is 1) |
disconnect |
Unloads the map, returning you to the main menu |
mat_specular 1 |
Enables reflections |
quit |
(optional) Closes the game. Relaunching it is required to display newly-built cubemaps |
HDR
Building cubemaps on a map compiled with HDR support needs to be done twice - once for each mode (HDR and LDR). As opposed to a LDR map's case, your game's High Dynamic Range video setting has to be set to "Full" to build HDR cubemaps, and to "None" to build LDR ones. To build the cubemaps, submit the following commands into the game's console:
| Command | Description |
|---|---|
mat_specular 0 |
Disables reflections. Required to properly build cubemaps |
map cs_mymap |
Loads a map; replace "cs_mymap" with the map's actual name |
sv_cheats 1 |
Enables the use of cheat commands. Required to build cubemaps |
buildcubemaps |
Starts building cubemaps. Optionally, specify the number of iterations (default is 1) |
disconnect |
Unloads the map, returning you to the main menu |
sv_cheats 0 |
Disables cheat commands. Prevents command mat_reloadallmaterials from unnecessarily self-executing and briefly freezing the game
|
mat_hdr_level 0 |
Switches to LDR mode (from HDR); submit mat_hdr_level 2 instead if LDR cubemaps were built first
|
map cs_mymap |
Loads the map again to build cubemaps for the new mode |
sv_cheats 1 |
|
buildcubemaps |
Starts building cubemaps for the new mode. Optionally, specify the number of iterations (default is 1) |
disconnect |
|
mat_specular 1 |
Enables reflections |
mat_hdr_level 0/1/2 |
If necessary, switches back to the mode it was before having submitted mat_hdr_level 0/2
|
quit |
(optional) Closes the game. Relaunching it is required to display newly-built cubemaps |
Half-Life: Source
Portal 2
Source Filmmaker
Template:ModernBug Template:ModernNote
"SearchPaths"
{
"Game" "|gameinfo_path|."
"Game" "swarm_base"
"Game" "platform"
"Game" "..\SourceFilmmaker\game\usermod"
"Game" "..\SourceFilmmaker\game\tf_movies"
"Game" "..\SourceFilmmaker\game\tf"
"Game" "..\SourceFilmmaker\game\hl2"
}
Deleting cubemaps
Several tools make it possible to delete unnecessary or outdated cubemaps; of them all, BSPZIP not only is an official one, but is also the easiest and safest option for this procedure without potentially corrupting the map. To delete the cubemaps, execute the following command within the "maps" folder:
..\..\bin\bspzip -deletecubemaps mapname.bsp
Note:Replace "mapname" with the map's actual name.Template:ModernWarning Template:ModernBug
Confirm:Deleting 
cubemapdefault.vtf and cubemapdefault.hdr.vtf might mess building the other cubemaps....Extracting cubemaps
In cases where a map has to be recompiled with minor changes and its built cubemaps vanish as a result, extracting them beforehand will make it not necessary to go through the whole cubemap-building process again until it actually becomes so. To extract its cubemaps with BSPZIP, create a folder that will contain the extracted cubemaps inside the "maps" one, then execute the following command:
..\..\bin\bspzip -extractcubemaps mapname.bsp "foldername"
Embedding cubemaps
To make a map use extracted cubemaps, create a text file that will be used by BSPZIP - the file should be created inside the "maps" folder, and will contain paths to the files to embed into the map file. The file's content should be like this:
materials/maps/mapname/c-128_384_64.hdr.vtf foldername\materials\maps\mapname\c-128_384_64.hdr.vtf materials/maps/mapname/c-128_384_64.vtf foldername\materials\maps\mapname\c-128_384_64.vtf materials/maps/mapname/c448_-256_64.hdr.vtf foldername\materials\maps\mapname\c448_-256_64.hdr.vtf materials/maps/mapname/c448_-256_64.vtf foldername\materials\maps\mapname\c448_-256_64.vtf materials/maps/mapname/cubemapdefault.vtf foldername\materials\maps\mapname\cubemapdefault.vtf
Template:ModernNote A file requires two dedicated lines (paths): the first line represents the path it will use within the map file, while the second one is the actual location of the file to embed into the map file. Relative location paths were used for the example, but they can also be absolute. Once the text file is ready, execute the following command:
..\..\bin\bspzip -addlist mapname.bsp textfile.txt newmapname.bsp
Renaming a map
Built cubemaps are saved into a folder within the map file that uses its name; renaming it will cause the cubemaps not to load alongside the map, and therefore it will act as if there were none. To fix that, either delete then rebuild the cubemaps, or extract then embed them back (with their folder's name matching that of the map).
See also
- env_cubemap
- $envmap
- parallax_obb - For Parallax Corrected Cubemaps.