module

PatternMaterialAddon::Docs

The PatternMaterialAddon::Docs module is the authoritative technical reference and documentation guide.

Learning Tracks & Topic Index

The documentation is paced into 3 distinct tracks:

1. Getting started (A_GETTING_STARTED)

Submodule Title Description
A_OVERVIEW Overview & Addon Architecture How pattern_material brings multi-channel pattern replacement, 88 SVG textures, and 14 procedural pattern generators to Godot 4 and Lapis.
B_UNIVERSAL_MATERIAL UniversalMaterial & PatternShaderMaterial Creating multi-channel pattern-replacement materials with triplanar mapping, UV transforms, and lighting presets.

2. Generators (B_GENERATORS)

Submodule Title Description
A_PROCEDURAL_GENERATORS 14 Procedural Pattern Generators Generating crisp, seamless repeating patterns at runtime with PatternGenerator < ImageTexture subclasses.
B_EDITOR_TOOL_NODE Visual PatternGeneratorTool Node Interactive in-editor pattern customization, 2D/3D live preview, and SVG/PNG baking.

3. Palettes and atlases (C_PALETTES_AND_ATLASES)

Submodule Title Description
A_PALETTES_AND_PATTERNS Palettes & 88 Built-In Patterns Accessing the 32-color palette and 88 seamless Hero Patterns SVG textures.
B_SPRITESHEETS Spritesheet Atlas & SVG Builders Packing SVG directories into AtlasTexture grids and building procedural face/icon atlases.

Class methods

topic_01_quick_start

Quick-Start Commands: Essential commands for building, running, and testing.

PatternMaterialAddon Quick Start:

make docs        # Build offline HTML documentation site in docs/
make test        # Execute specifications and test suites
make all         # Build and verify all targets
Source
topic_02_reading_paths

Learning Tracks & Reading Paths: Curated reading order from beginner to advanced.

Structured Learning Tracks

1. Getting started (A_GETTING_STARTED)
  • A_GETTING_STARTED::A_OVERVIEW: **Overview & Addon Architecture** &mdash; How pattern_material brings multi-channel pattern replacement, 88 SVG textures, and 14 procedural pattern generators to Godot 4 and Lapis.
  • A_GETTING_STARTED::B_UNIVERSAL_MATERIAL: **UniversalMaterial & PatternShaderMaterial** &mdash; Creating multi-channel pattern-replacement materials with triplanar mapping, UV transforms, and lighting presets.
2. Generators (B_GENERATORS)
  • B_GENERATORS::A_PROCEDURAL_GENERATORS: 14 Procedural Pattern Generators — Generating crisp, seamless repeating patterns at runtime with PatternGenerator < ImageTexture subclasses.
  • B_GENERATORS::B_EDITOR_TOOL_NODE: Visual PatternGeneratorTool Node — Interactive in-editor pattern customization, 2D/3D live preview, and SVG/PNG baking.
3. Palettes and atlases (C_PALETTES_AND_ATLASES)
  • C_PALETTES_AND_ATLASES::A_PALETTES_AND_PATTERNS: **Palettes & 88 Built-In Patterns** &mdash; Accessing the 32-color palette and 88 seamless Hero Patterns SVG textures.
  • C_PALETTES_AND_ATLASES::B_SPRITESHEETS: **Spritesheet Atlas & SVG Builders** &mdash; Packing SVG directories into AtlasTexture grids and building procedural face/icon atlases.
Source
topic_03_table_of_contents

Master Table of Contents: Complete hierarchical topic index.

Complete Documentation Index

A_GETTING_STARTED
  • A_GETTING_STARTED::A_OVERVIEW: **Overview & Addon Architecture** &mdash; How pattern_material brings multi-channel pattern replacement, 88 SVG textures, and 14 procedural pattern generators to Godot 4 and Lapis.
  • A_GETTING_STARTED::B_UNIVERSAL_MATERIAL: **UniversalMaterial & PatternShaderMaterial** &mdash; Creating multi-channel pattern-replacement materials with triplanar mapping, UV transforms, and lighting presets.
B_GENERATORS
  • B_GENERATORS::A_PROCEDURAL_GENERATORS: 14 Procedural Pattern Generators — Generating crisp, seamless repeating patterns at runtime with PatternGenerator < ImageTexture subclasses.
  • B_GENERATORS::B_EDITOR_TOOL_NODE: Visual PatternGeneratorTool Node — Interactive in-editor pattern customization, 2D/3D live preview, and SVG/PNG baking.
C_PALETTES_AND_ATLASES
  • C_PALETTES_AND_ATLASES::A_PALETTES_AND_PATTERNS: **Palettes & 88 Built-In Patterns** &mdash; Accessing the 32-color palette and 88 seamless Hero Patterns SVG textures.
  • C_PALETTES_AND_ATLASES::B_SPRITESHEETS: **Spritesheet Atlas & SVG Builders** &mdash; Packing SVG directories into AtlasTexture grids and building procedural face/icon atlases.
Source

Nested types