# RageLayer

> RageLayer 2.1.3 is an MIT-licensed TypeScript library that turns a live web page into a destructible canvas with fifteen tools and integrations for React, Next.js, Vue, Nuxt, Svelte, SvelteKit, and framework-neutral browser applications.

Coding agents should read AGENTS.md first, inspect the host project's framework and package manager, and then fetch only the Markdown documentation relevant to the requested integration.

## Implement RageLayer

- [AGENTS.md](https://www.parthjadhav.com/products/ragelayer/AGENTS.md): Framework-aware installation workflow, required integration constraints, code examples, and verification checklist.
- [Product brief](https://www.parthjadhav.com/products/ragelayer/index.md): Capabilities, toolsets, supported integrations, package metadata, and primary sources.
- [Documentation index](https://www.parthjadhav.com/products/ragelayer/docs/index.md): Complete machine-readable documentation map.

## Start here

- [Getting started](https://www.parthjadhav.com/products/ragelayer/docs/getting-started/index.md): Install RageLayer, wire it up in React or vanilla JavaScript in 60 seconds, and meet the 15 built-in tools.
- [Framework integrations](https://www.parthjadhav.com/products/ragelayer/docs/integrations/index.md): React, Next.js, Vue, Svelte, Astro, Angular, Solid, the custom element, and the framework-neutral controller.
- [Compatibility](https://www.parthjadhav.com/products/ragelayer/docs/compatibility/index.md): Supported browsers and frameworks, SSR behaviour, ESM-only distribution, Content Security Policy, and cross-origin content.
- [Accessibility](https://www.parthjadhav.com/products/ragelayer/docs/accessibility/index.md): Keyboard operation, aiming mode, reduced motion, translation, and the host application's responsibilities.
- [Troubleshooting](https://www.parthjadhav.com/products/ragelayer/docs/troubleshooting/index.md): Fixes for capture failures, SSR errors, stacking contexts, sound, clipboard writes, and performance problems.

## Reference

- [API](https://www.parthjadhav.com/products/ragelayer/docs/api/index.md): Entry points, lifecycle helpers, engine options, the engine API, custom tools, low-level primitives, and fallback behaviour.
- [Tool gallery](https://www.parthjadhav.com/products/ragelayer/docs/tools/index.md): Screenshots and behaviour notes for all 15 built-in tools, from the hammer to the sticky bombs.
- [Toolbars, i18n & keyboard](https://www.parthjadhav.com/products/ragelayer/docs/toolbar/index.md): The React, Vue and custom-element toolbars, the framework-neutral ToolbarModel, keyboard shortcuts, aiming, and i18n.
- [Procedural 3D models](https://www.parthjadhav.com/products/ragelayer/docs/models/index.md): Model scale, measured toolbar icons, split tool entry points, on-demand loading, and custom art guidelines.
- [Advanced systems](https://www.parthjadhav.com/products/ragelayer/docs/advanced/index.md): Advanced tools, the fixed physical response, cross-tool combos, destruction history, and the custom tool SDK.
- [Performance](https://www.parthjadhav.com/products/ragelayer/docs/performance/index.md): Adaptive quality tiers, frame telemetry, repeatable Chrome DevTools Protocol benchmarks, and distribution budgets.
- [Architecture](https://www.parthjadhav.com/products/ragelayer/docs/architecture/index.md): The layer model, module map, per-engine tool state, the frame loop, the void, and the degradation ladder.
- [Versioning](https://www.parthjadhav.com/products/ragelayer/docs/versioning/index.md): The public API surface, what is explicitly not public, the change policy, and how to read releases.

## Primary sources

- [npm package](https://www.npmjs.com/package/ragelayer): Published package and current release metadata.
- [Source repository](https://github.com/ParthJadhav/RageLayer): Source, examples, changelog, releases, and issue tracker.