Search Results

Plugin Reference

Clayground provides a modular plugin system. Each plugin focuses on specific functionality that you can mix and match.

Foundation Plugins

Essential utilities and data management.

  • Common - Essential utilities, timing tools, and the Clayground singleton
  • Storage - Persistent key-value storage for game data and settings
  • Text - CSV parsing, JSON transformations, and text highlighting
  • SVG - Read/write SVG files and use SVG elements as image sources
  • Algorithm - Algorithm components for games and simulations, with no Clayground dependencies

Rendering Plugins

Visual presentation for 2D and 3D games.

  • Canvas - 2D world coordinate system with camera and viewport management
  • Canvas3D - 3D primitives with toon shading and voxel maps
  • Character3D - Parametric 3D characters: a shader face, articulated hands, gaits, gestures, move sets and speech

Game System Plugins

Core gameplay mechanics and world management.

  • Physics - Box2D-based 2D physics simulation
  • World - Complete game world management for 2D and 3D
  • Behavior - Entity behaviors: movement, triggers, and path following

Input/Output Plugins

User interaction and communication.

  • GameController - Unified input for keyboard, gamepad, and touch
  • Network - P2P multiplayer and HTTP client
  • Sound - Synth, sampler and tracker audio, with Sound and Music for existing assets

Lab Plugin

Simulation, learning and research spaces.

  • Lab - The lab kernel: clock, scenarios, probes, flows, instruments and the board layer

AI Plugin

  • AI - Client-side LLM inference (runs locally)

Using Plugins

Import plugins in your QML files:

import Clayground.Common
import Clayground.Canvas
import Clayground.Physics

Plugin Dependencies

Some plugins build on others:

  • World requires Canvas (2D) or Canvas3D (3D) and Physics
  • Behavior works best with World and Physics
  • Most plugins use Common for utilities

API Reference

For detailed type documentation, see the API Reference.