module Lapis::Docs

Overview

The Lapis::Docs module is the authoritative technical reference, API manual, and learning system for this project.

Learning Tracks & Topic Index

The documentation is paced into 1 distinct tracks:

1. General (GENERAL)

Submodule Title Description
OVERVIEW Diorite Overview & Getting Started Diorite is a high-performance 2D and 3D debug drawing plugin and frame DSL for Godot Engine 4.8+ powered by the Lapis Crystal toolchain.
PRIMITIVES Diorite Primitives Reference Complete guide to all 26 procedural 2D and 3D debug drawing primitives supported by Diorite.
NODES Diorite Scene Node System Using Diorite's exported Node3D and Node2D classes for in-editor placement and persistent hierarchy visualization.
CHARTING Data Visualization and Charting Complete guide to 2D and 3D Pie charts, Bar charts, Radial gauges, and multi-series telemetry graphs.
GAME_HELPERS Game Spatial Helpers and UX Controls Comprehensive guide to swept shape casts, splines, actor cards, channels, transform stacks, and freeze mode.
PIPELINE Diorite Render Architecture & Zero-Alloc Pipeline Architecture of Diorite's batch renderer, priority layering, immediate meshes, and zero-allocation memory recycling.

Defined in:

docs.cr
docs/general/charting.cr
docs/general/game_helpers.cr
docs/general/nodes.cr
docs/general/overview.cr
docs/general/pipeline.cr
docs/general/primitives.cr

Class Method Summary

Class Method Detail

def self.topic_01_quick_start : Nil #

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

Lapis Quick Start:

lapis doctor     # Diagnose developer environment & dependencies
lapis new game   # Scaffold brand new Crystal Godot game
make all         # Compile bridge, test suites, examples, and sync
make test        # Execute specs, in-editor tool tests, and runtime suites
make editor      # Launch test project in Godot Editor
make docs        # Build offline HTML documentation site in docs/

[View source]
def self.topic_02_reading_paths : Nil #

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

Structured Learning Tracks

1. General (GENERAL)
  • GENERAL::OVERVIEW: **Diorite Overview & Getting Started** — Diorite is a high-performance 2D and 3D debug drawing plugin and frame DSL for Godot Engine 4.8+ powered by the Lapis Crystal toolchain.
  • GENERAL::PRIMITIVES: Diorite Primitives Reference — Complete guide to all 26 procedural 2D and 3D debug drawing primitives supported by Diorite.
  • GENERAL::NODES: Diorite Scene Node System — Using Diorite's exported Node3D and Node2D classes for in-editor placement and persistent hierarchy visualization.
  • GENERAL::CHARTING: Data Visualization and Charting — Complete guide to 2D and 3D Pie charts, Bar charts, Radial gauges, and multi-series telemetry graphs.
  • GENERAL::GAME_HELPERS: Game Spatial Helpers and UX Controls — Comprehensive guide to swept shape casts, splines, actor cards, channels, transform stacks, and freeze mode.
  • GENERAL::PIPELINE: **Diorite Render Architecture & Zero-Alloc Pipeline** — Architecture of Diorite's batch renderer, priority layering, immediate meshes, and zero-allocation memory recycling.

[View source]
def self.topic_03_table_of_contents : Nil #

Master Table of Contents: Complete hierarchical topic index.

Complete Documentation Index

GENERAL
  • GENERAL::OVERVIEW: **Diorite Overview & Getting Started** — Diorite is a high-performance 2D and 3D debug drawing plugin and frame DSL for Godot Engine 4.8+ powered by the Lapis Crystal toolchain.
  • GENERAL::PRIMITIVES: Diorite Primitives Reference — Complete guide to all 26 procedural 2D and 3D debug drawing primitives supported by Diorite.
  • GENERAL::NODES: Diorite Scene Node System — Using Diorite's exported Node3D and Node2D classes for in-editor placement and persistent hierarchy visualization.
  • GENERAL::CHARTING: Data Visualization and Charting — Complete guide to 2D and 3D Pie charts, Bar charts, Radial gauges, and multi-series telemetry graphs.
  • GENERAL::GAME_HELPERS: Game Spatial Helpers and UX Controls — Comprehensive guide to swept shape casts, splines, actor cards, channels, transform stacks, and freeze mode.
  • GENERAL::PIPELINE: **Diorite Render Architecture & Zero-Alloc Pipeline** — Architecture of Diorite's batch renderer, priority layering, immediate meshes, and zero-allocation memory recycling.

[View source]