# Stipple

> Dithered UI for Compose Multiplatform: a dither engine, modifiers and ready-made components.

## Docs

- [Introduction](https://stipple-docs.vercel.app/): A dither engine and dithered UI components for Compose Multiplatform.
- [Getting started](https://stipple-docs.vercel.app/getting-started): Add Stipple to a Compose Multiplatform project and draw a first dither.
- [Prior art](https://stipple-docs.vercel.app/prior-art): What exists already, what Stipple learned from it and where it differs.
- [Changelog](https://stipple-docs.vercel.app/changelog): Every release of Stipple, newest first.

## Guides

- [Theming](https://stipple-docs.vercel.app/guides/theming): StippleTheme holds ink, paper, an optional palette, the cell size and the cell shape.
- [Patterns and fields](https://stipple-docs.vercel.app/guides/patterns-and-fields): How a field and a pattern turn into dots, and the built-in ones.
- [Writing your own dither](https://stipple-docs.vercel.app/guides/writing-your-own): Implement DitherField for any shape you can describe with maths, then make it fast with a shader.
- [Choosing a renderer](https://stipple-docs.vercel.app/guides/renderers): The cell renderer works everywhere. The shader renderer is faster on large surfaces. Which devices have it and what it can draw.
- [Performance](https://stipple-docs.vercel.app/guides/performance): What a dither costs per frame, and how to keep it out of composition.
- [Accessibility](https://stipple-docs.vercel.app/guides/accessibility): Reduced motion, contrast for dithered text, and the semantics of each component.
- [Agent skill](https://stipple-docs.vercel.app/guides/agent-skill): A skill file that teaches a coding agent to build with Stipple, and to write new dithers.

## Reference

- [Modifiers](https://stipple-docs.vercel.app/reference/modifiers): dither, ditherProgress, ditherImage, ditherFill and ditherMask.
- [Components](https://stipple-docs.vercel.app/reference/components): The eleven components in stipple-components.
- [Types](https://stipple-docs.vercel.app/reference/types): DitherField, DitherPattern, StippleTheme and the other public types.

## Agent skills

- [stipple](https://stipple-docs.vercel.app/.well-known/agent-skills/stipple/SKILL.md): Build dithered UI in Compose Multiplatform with Stipple (io.github.jantursky:stipple). Use it when a user wants a dithered background, button, chart, gauge, progress bar, text or image in Compose, or wants to write a new dither field, pattern or component on Android, iOS, desktop or web.

## Agent resources

- [llms-full.txt](https://stipple-docs.vercel.app/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://stipple-docs.vercel.app/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://stipple-docs.vercel.app/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://stipple-docs.vercel.app/openapi.json.
- [Agent skills](https://stipple-docs.vercel.app/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://stipple-docs.vercel.app/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://stipple-docs.vercel.app/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://stipple-docs.vercel.app/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://stipple-docs.vercel.app/sitemap.xml): Every indexable page URL with its last-modified date.