Frictional Game Wiki

<h3>Materials</h3> <div class="level3"> <hr /> </div> <h3>General</h3> <div class="level3"> <p> The size of texture simply means in relation to other textures of the material. 100% means that it is max size (which is normal whatever size diffuse) has, while 50% means half of the max, size and so on. This information just general outlines though. It is nothing that needs to be followed, but is good for optimization needs. </p> <p> File format is also just a guideline, although some formats like 3DC (for luminence-alpha), are almost requirements. </p> <p> The suffix means how the file name should be. The base for the name should always be the name of the mat file if possible (unless shared). Then prefix means: basename_[prefix].ext, for example: "mytexture_nrm.dds". </p> <hr /> </div> <h3>Optimizing</h3> <div class="level3"> <p> The engine works by having many different hard-coded material types, that are changed by setting different textures and changing variables. Depending on this, the engine will generate a fitting shader to do the job. Because of this, artists do not have to worry about optimizing their materials as much as if another system would be used. However, there are still optimizations needed. Here is a few basic guidelines: </p> <ul> <li class="level1"> Never add a texture unless it adds to the final material. For example, do not use black specular, flat blue normal maps, and so on. It is almost always better to just not set the texture at all.</li> <li class="level1"> For textures that only use alpha, it is a good idea to embed it in the alpha of a texture. That way a single texture can fill up two texture slots. However, take note that if a texture with alpha is used in many materials and/or can have a lower resolution than the one it is part of, it might be good to keep it separate. </li> </ul> <hr /> </div> <h3>Solid diffuse</h3> <div class="level3"> </div> <h4>Overview</h4> <div class="level4"> <p> This is the most common material used and is basically an all-round solid (as in non-transparent) surface shader. It works nicely for metals, plastics, wood, organic (that do not require anything special), etc. </p> <p> Important Notes:<br/> </p> <ul> <li class="level1"> A material having alpha and parallax on a mesh that where IsOccluder is true, will NOT be displayed correctly.</li> <li class="level1"> An mesh MUST be set with IsOccluder=true for the dissolve effect to work!</li> </ul> </div> <h4>Blend Modes</h4> <div class="level4"> <p> Not used. </p> </div> <h4>Variables</h4> <div class="level4"> <p> <b>HeightMapScale</b> | This controls the amount how much the max depth (pure white) will offset the pixel.<br/> <b>HeightMapBias</b> | Currently not used.<br/> </p> <p> <b>FrenselBias</b> | Bias for Fresnel term. values: 0-1. Higher means that more of reflection is seen when looking straight at object.<br/> <b>FrenselPow</b> | The higher the 'sharper' the reflection is, meaning that it is only clearly seen at sharp angles.<br/> </p> <p> <b>AlphaDissolveFilter</b>| Currently not used. </p> <p> <b>DetailUvMul</b> | The amount the UV maps are multiplied with. The higer the more the detail maps are repeated<br/> <b>DetailWeight_Diffuse</b> | Weight for the diffuse detail. Valid values: 0 - 2.0<br/> <b>DetailWeight_Specular</b> | Weight for the specular detail. Valid values: 0 - 2.0<br/> <b>DetailWeight_Normal</b> | Weight for the normalmap detail. Valid values: 0 - 2.0 (inf really, but not recommended)<br/> <b>DetailFadeStart</b> | When the details start fading out <b>DetailFadeEnd</b> | When details have completely faded out </p> <p> <b>SwayActive</b> | If the model should sway according to wind properties. NOTE: Heightmap must be used to set the sway amount for each model part.<br/> <b>SwayForceFieldAffected</b> | If the model is affected by force fields<br/> <b>SwayFreq</b> | The frequency of the sway movement.<br/> <b>SwayAmplitude</b> | How much the sway offsets the model at maximum (in meters).<br/> <b>SwaySpeed</b> | The speed of the sway<br/> <b>SwayOctaveMuls</b> | The sway consists of the three (high - low) different freq movements, this is the factor for each.<br/> <b>SwayYFreqMul</b> | This can be used so that sway changes along the y-axis. The higher value the more change. 0=off<br/> <b>SwayForceFieldMul</b> | Factor for the force field induced sway.<br/> <b>SwayForceFieldMax</b> | The max offset (after adding factor) can that be added from a force field.<br/> </p> <p> <b>IlluminationBrightness</b> | The brightness of the illumination texture. Multiplies with the illumination map, used to make the illumination brighter than 1.0 <br/> </p> </div> <h4>Diffuse</h4> <div class="level4"> <p> <b>Size:</b> 100%<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, dxt1 or dxt5. (use dxt1 if it looks okay!)<br/> <b>Suffix:</b> None.<br/> This is simply the color and is needed for as good as all materials.<br/> Note that diffuse is a perfect texture for adding some other map (that only use alpha) in the Alpha channel. For example: Alpha, Height and Translucency map. </p> </div> <h4>Normal map</h4> <div class="level4"> <p> <b>Size:</b> 100% (50% possible for very large and blurry features)<br/> <b>Channels:</b> G and Alpha (must use special exporter for this!)<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, 3dc.<br/> <b>Suffix:</b> “nrm”.<br/> The normal map for the material and uses the standard format rgb = xyz and is in tangent space. Note that this needs to be converted to a format of XY only though! </p> </div> <h4>Specular map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50% (50% should work in most cases, but 100% might be needed for slimy objects and similar)<br/> <b>Channels:</b> RGBA<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, dxt5.<br/> <b>Suffix:</b> “spec”.<br/> The specular map handles the specular intensity and power for each pixel. The intensity uses the R,G and B channel and the power in the Alpha channel.<br/> Intensity sets the amount of specularity (for each color channel) applied to a pixel, the higher value of the channel, the higher intensity.<br/> Power sets the sharpness of the specular highlight, a low value give a dull and diffuse look, while a high value give a wet/shiny look. </p> </div> <h4>Alpha</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50% (the smaller version only if alpha features are very large)<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel<br/> <b>Suffix:</b> “alpha”.<br/> Sets the alpha for each texture and for any lit surface this is a simply 0 or 1 decision per pixel since a lit pixel can never be half transparent, only fully visible or invisible. <br/> Note that because of this, it is okay to use the Alpha channel of a DXT1 texture for this! </p> </div> <h4>Height map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50% (depends on the amount of small details needed)<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale).<br/> <b>Suffix:</b> “height”. ("sway" when used for sway)<br/> Height map is more like a depth map actually. White = largest depth, Black = no depth and this is important to remember when creating it. <br/> This map is also used for sway, so when sway is active, normal parallax does NOT work. During sway it act has a factor for the sway. Black = no sway, White = full sway and all inbetween for greyscale of course. So if doing a swaying plant, make it black at the base of the plant and whiter as it comes nearer the top. </p> </div> <h4>Illumination map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50% (only use 100% if very sharp features are required. Most illumination then to be blurry)<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, dxt1. (dxt5 if alpha is required for extra map)<br/> <b>Suffix:</b> “illum”.<br/> This map will be added additively on top of the model when rendering and will not be affected by lighting. It is useful for creating glowing surfaces such as lightbulb, ember, etc.<br/> Like diffuse, Illumination is a perfect texture for adding some other map (that only use alpha) in the Alpha channel. For example: Alpha, Height and Translucency map. Especially so if the size of the other map is 50% or so (as this is normally what the illumination map is). </p> </div> <h4>Dissolve Alpha Map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50%<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale).<br/> <b>Suffix:</b> “diss_alpha”.<br/> When dissolving a mesh, this map sets how fast each part of the mesh does this. White = fastest, Black = slowest<br/> Because of the way rendering works, it is almost always best to have this as separate texture (and as alpha inside another) </p> </div> <h4>Environment Map (CubeMap)</h4> <div class="level4"> <p> <b>Size:</b> NA, cubemaps take a lot of memory, so try and keep them small. Usually they are blurry and can be kept very small.<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> CubeMap<br/> <b>File format:</b> dds, dxt1 or dxt5 cube (as the map is usually blurry and distorted, dx1 should work fine in most cases)<br/> <b>Suffix:</b> “env”.<br/> This will apply a cube to the mesh as if it is was reflecting it (hence called "environment map"). </p> </div> <h4>Environment Alpha Map (CubeMapAlpha)</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50%<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale).<br/> <b>Suffix:</b> “env_alpha”.<br/> Determines how much of each pixel on mesh should reflect. White=max reflection, Black = no reflection. </p> </div> <h4>Detail Diffuse Map</h4> <div class="level4"> <p> <b>Size:</b> NA, this is entirely up to how the texture is repeated<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale). (or dxt5 if mipmaps are needed!!)<br/> <b>Suffix:</b> “detail_diff”.<br/> A detail map is special in that it uses differnt UV coordinates from the rest of the textures (see variables). This map blends with the diffuse and specular (each according to weights, see variables section). The way it mixes, Grey (127) means that nothing is changed, darker (126 or below) makes the result darker, and brighter (128 or above) makes the result brighter).<br/> There is a variable for fading this out at a distance, but in some special cases this might not look good. In that case use dxt5 and have custom mipmaps that fade to gray in an appropriate way. Only use this if really needed though! </p> </div> <h4>Detail Normal Map</h4> <div class="level4"> <p> <b>Size:</b> NA, this is entirely up to how the texture is repeated<br/> <b>Channels:</b> G and Alpha (must use special exporter for this!)<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, 3dc.<br/> <b>Suffix:</b> “detail_nrm”.<br/> Detail normal works basically like the diffuse version, but on the normal map. </p> </div> <h4>Translucency Map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50%<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale).<br/> <b>Suffix:</b> “trans”.<br/> This allows part of the texture to shine through to the backside when lit. This is good for thin organic shapes like nose-wings, leaves and fish-fins. Note that for this to work, the mesh must not cast a shadow or it must be thin enough (how thin depends on shadow settings). White means that all light from the front comes out back and black means that no light does. </p> <hr /> </div> <h3>Translucent</h3> <div class="level3"> </div> <h4>Overview</h4> <div class="level4"> <p> This material is used for any transparent surface, such as glass, some forms of water, etc. It is generally not affected by lighting and when, only mildly so by setting the variable AffectedByLightLevel to true (more on that below). </p> </div> <h4>Blend Modes</h4> <div class="level4"> <p> All available blend modes work for Translucent. </p> </div> <h4>Variables</h4> <div class="level4"> <p> <b>Refraction</b> | If the material has refraction (distortion of bg). Uses NMap and/or normals of mesh.<br/> <b>RefractionEdgeCheck</b> | If true, there is no bleeding with foreground objects, but takes some extra power. This usually makes object look a lot better so should generally be used, but have in mind that removing it when there are several object with refraction, it can speed things up quite a bit.<br/> <b>RefractionNormals</b> | If normals should be used when refracting. If no NMap is set this is forced true!<br/> If this is false (and NMap is set), then the material will only read from the NMap and use that as distortion. This can be quite nice fort certain effects such as animated water, magical portals and the like.<br/> <b>RefractionScale</b> | The amount refraction offsets the background.<br/> </p> <p> <b>FrenselBias</b> | Bias for Fresnel term. values: 0-1. Higher means that more of reflection is seen when looking straight at the surface.<br/> <b>FrenselPow</b> | The higher the 'sharper' the reflection is, meaning that it is only clearly seen at sharp angles.<br/> <b>RimLightMul</b> | The amount of rim light based on the reflection. This gives an edge to the object. Values: 0 - inf (although 1.0f should be used for max.<br/> <b>RimLightPow</b> | The sharpness of the rim lighting.<br/> </p> <p> <b>AffectedByLightLevel</b> | The the material alpha is affected by the light level. This is especially useful for objects that are in an environment where the lightlevel changes.<br/> How this works that for each light that intersect the Bounding box of the mesh, a light level variable is increased (according to color and attenuation). The final light level variable is then used to control the alpha.<br/> </p> <p> <b>SwayActive</b> | If the model should sway according to wind properties. NOTE: Heightmap must be used to set the sway amount for each model part.<br/> <b>SwayForceFieldAffected</b> | If the model is affected by force fields<br/> <b>SwayFreq</b> | The frequency of the sway movement.<br/> <b>SwayAmplitude</b> | How much the sway offsets the model at maximum (in meters).<br/> <b>SwaySpeed</b> | The speed of the sway<br/> <b>SwayOctaveMuls</b> | The sway consists of the three (high - low) different freq movements, this is the factor for each.<br/> <b>SwayYFreqMul</b> | This can be used so that sway changes along the y-axis. The higher value the more change. 0=off<br/> <b>SwayForceFieldMul</b> | Factor for the force field induced sway.<br/> <b>SwayForceFieldMax</b> | The max offset (after adding factor) can that be added from a force field.<br/> </p> </div> <h4>Diffuse Map</h4> <div class="level4"> <p> <b>Size:</b> 100%<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, dxt1 or dxt5. (use dxt1 if it looks okay!)<br/> <b>Suffix:</b> None.<br/> This is simply the color and is needed for as good as all materials.<br/> Note that diffuse is a perfect texture for adding some other map (that only use alpha) in the Alpha channel. For example: Cube Alpha map.. </p> </div> <h4>Normal Map</h4> <div class="level4"> <p> <b>Size:</b> 100% (50% possible for very large and blurry features)<br/> <b>Channels:</b> G and Alpha (must use special exporter for this!)<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, 3dc.<br/> <b>Suffix:</b> “nrm”.<br/> Instead of changing the way light is shaded (like with solid material), here the normal map is used to distort the background (if refraction is set to true) and/or to change the way reflection is calculated.<br/> The normal map for the material and uses the standard format rgb = xyz and is in tangent space. Note that this needs to be converted to a format of XY only though! <br/> </p> </div> <h4>Environment Map (CubeMap)</h4> <div class="level4"> <p> <b>Size:</b> NA, cubemaps take a lot of memory, so try and keep them small. Usually they are blurry and can be kept very small.<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> CubeMap<br/> <b>File format:</b> dds, dxt1 or dxt5 cube (as the map is usually blurry and distorted, dx1 should work fine in most cases)<br/> <b>Suffix:</b> “env”.<br/> This will apply a cube to the mesh as if it is was reflecting it (hence called "environment map"). </p> </div> <h4>Environment Alpha Map (CubeMapAlpha)</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50%<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale).<br/> <b>Suffix:</b> “env_alpha”.<br/> Determines how much of each pixel on mesh should reflect. White=max reflection, Black = no reflection. </p> </div> <h4>Height map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50% (depends on the amount of small details needed)<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale).<br/> <b>Suffix:</b> “sway” (do NOT use "height").<br/> This map is used for sway, so when sway is active and NOT for any parallax stuff. It act as a factor for the sway. Black = no sway, White = full sway and all in between for greyscale of course. So if doing a swaying plant, make it black at the base of the plant and whiter as it comes nearer the top. </p> <hr /> <hr /> </div> <h3>Decal</h3> <div class="level3"> </div> <h4>Overview</h4> <div class="level4"> <p> Decals work a bit different from other materials in that they never write to the Z-buffer. Instead they simply write to the renderers G-buffer directly and what this means is that they need have have some solid geometry behind them to be visible. This make them useful as a sort clutter to add to add extra details. As the resulting image is affected by lighting it can be easily used to add dirt to floor, blood stainds, etc. </p> <p> Important notes: </p> <ul> <li class="level1"> The material require Alpha blend mode if normalmaps shall work!</li> </ul> </div> <h4>Blend Modes</h4> <div class="level4"> <p> All available blend modes work for Decal. However, alpha blending mode is best (if not needed!) to use if anything else but diffuse map is in the material. </p> </div> <h4>Variables</h4> <div class="level4"> <p> <b>HeightMapScale</b><br/> The scale of the height map. </p> <p> <b>HeightMapBias</b><br/> Not used. </p> <p> <b>FrenselBias</b><br/> Not used. </p> <p> <b>FrenselPow</b><br/> Not used. </p> </div> <h4>Diffuse Map</h4> <div class="level4"> <p> <b>Size:</b> 100%<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, dxt1 or dxt5. (use dxt1 if it looks okay!)<br/> <b>Suffix:</b> None.<br/> This is simply the color and is needed for as good as all materials.<br/> Note that diffuse is a perfect texture for adding some other map (that only use alpha) in the Alpha channel. For example: Cube Alpha map.. </p> </div> <h4>Normal Map</h4> <div class="level4"> <p> <b>Size:</b> 100% (50% possible for very large and blurry features)<br/> <b>Channels:</b> G and Alpha (must use special exporter for this!)<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, 3dc.<br/> <b>Suffix:</b> “nrm”.<br/> Instead of changing the way light is shaded (like with solid material), here the normal map is used to distort the background (if refraction is set to true) and/or to change the way reflection is calculated.<br/> The normal map for the material and uses the standard format rgb = xyz and is in tangent space. Note that this needs to be converted to a format of XY only though! <br/> </p> </div> <h4>Specular Map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50% (50% should almost always work)<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, dxt1 or dxt5<br/> <b>Suffix:</b> “spec”.<br/> This will only apply the specular color/intensity and NOT the power. Because of this only 3 channels are needed! </p> </div> <h4>Height Map</h4> <div class="level4"> <p> <b>Size:</b> 100% - 50% (depends on the amount of small details needed)<br/> <b>Channels:</b> Alpha<br/> <b>Type:</b> 2D<br/> <b>File format:</b> tga, single channel (greyscale).<br/> <b>Suffix:</b> “height”.<br/> Height map is more like a depth map actually. White = largest depth, Black = no depth and this is important to remember when creating it. </p> <hr /> </div> <h3>Water</h3> <div class="level3"> </div> <h4>Overview</h4> <div class="level4"> <p> Water is a special shader that not only can render the world reflection, but also contain a special algorithm to simulate ripples. </p> <p> Important notes:<br/> </p> <ul> <li class="level1"> When using world refection, it is extremely demanding, so make sure there is not more than one visible at any time.</li> <li class="level1"> Must be applied to a flat (or at least almost completely flat) and one-sided mesh.</li> </ul> </div> <h4>Variables</h4> <div class="level4"> <p> <b>RefractionScale</b><br/> The amount reflection and refraction is offset by ripples in water. </p> <p> <b>FrenselBias</b><br/> Bias for Fresnel term. values: 0-1. Higher means that more of reflection is seen when looking straight at object. </p> <p> <b>FrenselPow</b><br/> The higher the 'sharper' the reflection is, meaning that it is only clearly seen at sharp angles. </p> <p> <b>WaveSpeed</b><br/> The speed of the waves. </p> <p> <b>WaveAmplitude</b><br/> The size of the waves. </p> <p> <b>WaveFreq</b><br/> The frequency of the waves. </p> <p> <b>ReflectionFadeStart</b><br/> Where the reflection starts fading. </p> <p> <b>ReflectionFadeEnd</b><br/> Where the reflection stops fading. 0 or less means no fading. </p> <p> <b>HasReflection</b><br/> If a reflection should be shown or not. </p> <p> <b>OcclusionCullWorldReflection</b><br/> If occlusion culling should be used on reflection. </p> <p> <b>LargeSurface</b><br/> If the water will cover a large surface and will need special sorting when rendering other transperant objects </p> </div> <h4>Blend Modes</h4> <div class="level4"> <p> A modulative blend mode is forced. </p> </div> <h4>Diffuse Map</h4> <div class="level4"> <p> <b>Size:</b> 100%<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, dxt1 or dxt5. (use dxt1 if it looks okay!)<br/> <b>Suffix:</b> None.<br/> This is the basic texture that act as a base for the water surface. It is always modulatively blended with the background. </p> </div> <h4>Normal Map</h4> <div class="level4"> <p> <b>Size:</b> 100% (50% possible for very large and blurry features)<br/> <b>Channels:</b> G and Alpha (must use special exporter for this!)<br/> <b>Type:</b> 2D<br/> <b>File format:</b> dds, 3dc.<br/> <b>Suffix:</b> “nrm”.<br/> Instead of changing the way light is shaded (like with solid material), here the normal map is used to distort the background (if refraction is set to true) and/or to change the way reflection is calculated.<br/> The normal map for the material and uses the standard format rgb = xyz and is in tangent space. Note that this needs to be converted to a format of XY only though! </p> </div> <h4>Environment Map (CubeMap)</h4> <div class="level4"> <p> <b>Size:</b> NA, cubemaps take a lot of memory, so try and keep them small. Usually they are blurry and can be kept very small.<br/> <b>Channels:</b> RGB<br/> <b>Type:</b> CubeMap<br/> <b>File format:</b> dds, dxt1 or dxt5 cube (as the map is usually blurry and distorted, dx1 should work fine in most cases)<br/> <b>Suffix:</b> “env”.<br/> This will apply a cube to the mesh as if it is was reflecting it (hence called “environment map”). It will be used instead of the world reflection, thus making the water rendering ALOT faster! </p> </div>