shaderLABS

https://shaderlabs.org/wiki
Admin
shaderLABS is a community wiki providing comprehensive documentation about Minecraft shaderpacks and...
Tokens:48,215
Snippets:777
Trust Score:7.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example Shaderpack Entry Configuration

Source: https://shaderlabs.org/wiki/Module%3AShaderpackListEntry

A complete example demonstrating the required arguments for a shaderpack entry, including performance levels, driver support, and loader compatibility.

```lua
{{#invoke:ShaderpackListEntry|Generic
|name=Example
|style=[https://www.example.com/ Realistic]
|performance_impact_level=1
|version=0.4.2
|last_update=1990-01-01
|links=[https://www.example.com/ Website]
|drivers=nvidia amd intel apple tux m1
|shader_loaders=iris of canvas vanilla focal
|author=[https://www.example.com Joe]
|min_mc_version=1.14.4
|max_mc_version=1.20.1
}}
```

--------------------------------

### Invoke ShaderpackListEntry Modrinth Template

Source: https://shaderlabs.org/wiki/Module%3AShaderpackListEntry

Example usage of the Modrinth function within a wiki template call.

```wikitext
{{#invoke:ShaderpackListEntry|Modrinth
|slug=example-pack
|name=Example
|style=[https://www.example.com/ Realistic]
|performance_impact_level=1
|links=[https://www.example.com/ Website]
|drivers=nvidia amd intel apple tux m1
|author=[https://www.example.com Joe]
}}
```

--------------------------------

### Constant Function Arguments

Source: https://shaderlabs.org/wiki/Compiler_Behavior_Notes

Example of function signature using constant arguments.

```GLSL
void blah(const int a, const float b)
```

--------------------------------

### Recursive Macro Restriction

Source: https://shaderlabs.org/wiki/Compiler_Behavior_Notes

Example of a recursive macro that is disallowed on Intel drivers.

```GLSL
#define smoothstep(x, low, high) smoothstep(low, high, x)
```

--------------------------------

### SystemReqBox Template Syntax

Source: https://shaderlabs.org/wiki/Template%3ASystemReqBox

Use this template to standardize the display of system requirements on wiki pages.

```wikitext
{{SystemReqBox
|BoxTitle=
|CPU=
|AllocatedMemory=
|GraphicsCard=
|Resolution=
|OperatingSystem=
}}
```

--------------------------------

### SystemReq Infobox Template Syntax

Source: https://shaderlabs.org/wiki/Template%3ASystemReq_Infobox

Use this template to define system requirements including CPU, memory, graphics, resolution, and operating system.

```wikitext
{{SystemReq_Infobox
|BoxTitle=
|CPU=
|AllocatedMemory=
|GraphicsCard=
|Resolution=
|OperatingSystem=
}}
```

--------------------------------

### Generic

Source: https://shaderlabs.org/wiki/Module%3AShaderpackListEntry/doc

Creates a shaderpack entry not backed by an external data source.

```APIDOC
## Generic

### Description
Creates a shaderpack entry for packs not backed by a data source.

### Arguments
- **name** (Text) - Required
- **style** (Text) - Required
- **performance_impact_level** (Number) - Required (0: Potato, 1: Low, 2: Medium, 3: High, 4: Extreme, 5: Screenshots)
- **version** (Text) - Required
- **last_update** (Text) - Required
- **links** (Text) - Required
- **drivers** (Text) - Required (Space-separated: nvidia, amd, intel, apple, tux, m1)
- **shader_loaders** (Text) - Required (Space-separated: iris, of, canvas, vanilla, focal)
- **author** (Text) - Required
- **min_mc_version** (Text) - Optional
- **max_mc_version** (Text) - Required

### Example
{{#invoke:ShaderpackListEntry|Generic|name=Example|style=[https://www.example.com/ Realistic]|performance_impact_level=1|version=0.4.2|last_update=1990-01-01|links=[https://www.example.com/ Website]|drivers=nvidia amd intel apple tux m1|shader_loaders=iris of canvas vanilla focal|author=[https://www.example.com Joe]|min_mc_version=1.14.4|max_mc_version=1.20.1}}
```

--------------------------------

### SystemReq_Combined Template Syntax

Source: https://shaderlabs.org/wiki/Template%3ASystemReq_Combined

Use this template to define system requirements including CPU, memory, graphics, resolution, and operating system.

```wikitext
{{SystemReq_Infobox
|BoxTitle=
|CPU0=
|AllocatedMemory0=
|GraphicsCard0=
|Resolution0=
|OperatingSystem0=
}}
```

--------------------------------

### Create a Modrinth-backed Shaderpack Entry

Source: https://shaderlabs.org/wiki/Module%3AShaderpackListEntry/doc

Use the Modrinth method to create an entry by referencing a project slug, which automatically pulls data from the Modrinth API.

```Lua
{{#invoke:ShaderpackListEntry|Modrinth
|arg1 = value1
|arg2 = value2
}}
```

```Lua
{{#invoke:ShaderpackListEntry|Modrinth
|slug=example-pack
|name=Example
|style=[https://www.example.com/ Realistic]
|performance_impact_level=1
|links=[https://www.example.com/ Website]
|drivers=nvidia amd intel apple tux m1
|author=[https://www.example.com Joe]
}}
```

--------------------------------

### Invoke LicenseNotice Template

Source: https://shaderlabs.org/wiki/Template%3ALicenseNotice

Use this syntax to include the license notice on a page, specifying the license type and URL.

```wikitext
{{LicenseNotice
|LicenseType=
|LicenseURL=
}}
```

--------------------------------

### Render shaderpack list via template invocation

Source: https://shaderlabs.org/wiki/Module%3AShaderpackList

Use this syntax within a wiki page to invoke the module and pass a JSON-encoded list of shaderpack entries.

```wikitext
{{#invoke:ShaderpackList|Render|data=[

{{#invoke:ShaderpackListEntry|Generic
|arg1 = value1
|arg2 = value2
}}

{{#invoke:ShaderpackListEntry|Generic
|arg1 = value1
|arg2 = value2
}}

{{#invoke:ShaderpackListEntry|Modrinth
|arg1 = value1
|arg2 = value2
}}

]}}
```

--------------------------------

### Manual Mix Implementation

Source: https://shaderlabs.org/wiki/Compiler_Behavior_Notes

Fallback implementation for mix() in constant expressions on older Nvidia hardware.

```GLSL
#define cmix(x, y, a) (y * a + x * (1.0 - a))
```

--------------------------------

### Invoke ShaderInfobox Template

Source: https://shaderlabs.org/wiki/Template%3AShaderInfobox

Use this syntax to include the ShaderInfobox template on a wiki page. Ensure all parameters are provided to correctly display project details.

```wikitext
{{ShaderInfobox
|BannerImage=
|ProjectPage=
|LatestVersion=
|LastUpdated=
|VisualStyle=
|PerformanceCost=
|LicenseType=
|LicenseURL=
}}
```

--------------------------------

### Create a Generic Shaderpack Entry

Source: https://shaderlabs.org/wiki/Module%3AShaderpackListEntry/doc

Use the Generic method to define a shaderpack entry manually when no external data source is available.

```Lua
{{#invoke:ShaderpackListEntry|Generic
|arg1 = value1
|arg2 = value2
}}
```

```Lua
{{#invoke:ShaderpackListEntry|Generic
|name=Example
|style=[https://www.example.com/ Realistic]
|performance_impact_level=1
|version=0.4.2
|last_update=1990-01-01
|links=[https://www.example.com/ Website]
|drivers=nvidia amd intel apple tux m1
|shader_loaders=iris of canvas vanilla focal
|author=[https://www.example.com Joe]
|min_mc_version=1.14.4
|max_mc_version=1.20.1
}}
```

--------------------------------

### Modrinth

Source: https://shaderlabs.org/wiki/Module%3AShaderpackListEntry/doc

Creates a shaderpack entry for packs available on Modrinth.

```APIDOC
## Modrinth

### Description
Creates a shaderpack entry for packs available on Modrinth using the project slug.

### Arguments
- **slug** (Text) - Required (Project ID/Slug from URL)
- **name** (Text) - Required
- **style** (Text) - Required
- **performance_impact_level** (Number) - Required (0: Potato, 1: Low, 2: Medium, 3: High, 4: Extreme, 5: Screenshots)
- **version** (Text) - Optional (Overrides API)
- **last_update** (Text) - Optional (Overrides API)
- **links** (Text) - Required
- **drivers** (Text) - Required (Space-separated: nvidia, amd, intel, apple, tux, m1)
- **shader_loaders** (Text) - Optional (Space-separated: iris, of, canvas, vanilla, focal; Overrides API)
- **author** (Text) - Required
- **min_mc_version** (Text) - Optional (Overrides API)
- **max_mc_version** (Text) - Optional (Overrides API)

### Example
{{#invoke:ShaderpackListEntry|Modrinth|slug=example-pack|name=Example|style=[https://www.example.com/ Realistic]|performance_impact_level=1|links=[https://www.example.com/ Website]|drivers=nvidia amd intel apple tux m1|author=[https://www.example.com Joe]}}
```

--------------------------------

### Declare Output Layout

Source: https://shaderlabs.org/wiki/Rendering_Pipeline_%28OptiFine%2C_ShadersMod%29

Use layout syntax to define output variables for framebuffer writing in modern GLSL.

```GLSL
layout(location = n) out vec4 <name>;
```

--------------------------------

### Concatenating Transformation Matrices

Source: https://shaderlabs.org/wiki/Coordinate_Spaces

Demonstrates how to combine multiple transformation matrices into a single model-view-projection matrix to optimize vertex calculations.

```pseudo-code
projectionMatrix * (viewMatrix * (modelMatrix * vertexPosition))
(projectionMatrix * viewMatrix * modelMatrix) * vertexPosition
modelViewProjectionMatrix * vertexPosition
```

--------------------------------

### Shaderpack Folder Structure

Source: https://shaderlabs.org/wiki/Shaderpack_Installation

The required directory structure for shaderpacks within the .minecraft/shaderpacks folder.

```text
- shaderpacks
    - [Shaderpack name]
         - shaders
```

--------------------------------

### Configure Framebuffer Format

Source: https://shaderlabs.org/wiki/Rendering_Pipeline_%28OptiFine%2C_ShadersMod%29

Use this constant directive syntax to specify the format for a framebuffer attachment.

```glsl
/*
const int <framebuffer>Format = <format>;
*/
```
Tokens:
Raw