llms.txt

# SMNTC

> Semantic Engine for Motion, Animation, and Numerical Topographic Interactivity & Composition.
> Abstracts WebGL shader complexity into a Tokenized Intent Schema.
> Describe the *meaning* — the engine provides the *motion*.

SMNTC converts high-level semantic tokens into GPU-optimized GLSL shader programs for Three.js.
Instead of writing shader math, you declare intent using human-readable tokens like
`surface: 'fluid'`, `vibe: 'calm'`, `palette: 'arctic'`.

## Docs

- [README](https://github.com/NAME0x0/SMNTC/blob/main/README.md): Quick start, token tables, API reference
- [SMNTC-SPEC](https://github.com/NAME0x0/SMNTC/blob/main/SMNTC-SPEC.md): Full technical specification
- [LLMs Full Context](https://github.com/NAME0x0/SMNTC/blob/main/llms-full.txt): Complete API with all tokens, types, and examples

## Install

```bash
npm install smntc three
```

## Core Concept

All configuration uses a single `SMNTCConfig` object with five semantic token categories:

- **surface**: `'topographic'` | `'crystalline'` | `'fluid'` | `'glitch'` | `'organic'` | `'terrain'` | `'plasma'` | `'wave'`
- **vibe**: `'stable'` | `'calm'` | `'agitated'` | `'chaotic'` | `'breathing'` | `'pulse'` | `'drift'` | `'storm'` | `'cinematic'`
- **reactivity**: `'static'` | `'magnetic'` | `'repel'` | `'shockwave'`
- **fidelity**: `'low'` | `'medium'` | `'high'` | `'ultra'`
- **palette**: `'monochrome'` | `'ember'` | `'arctic'` | `'neon'` | `'phantom'` | `'ocean'` | `'sunset'` | `'matrix'` | `'vapor'` | `'gold'` | `'infrared'` | `'aurora'` | `'midnight'`

Plus numeric overrides: `intensity` (0-2), `speed` (0-5), `contourLines` (4-64).

Plus VFX post-processing: `angle` (0-360°), `grain` (0-1), `glow` (0-2), `chromatic` (0-1), `vignette` (0-1), `blur` (0-1).

## Minimal Example (Vanilla Three.js)

```typescript
import { SMNTCKernel } from 'smntc';
import * as THREE from 'three';

const geometry = new THREE.PlaneGeometry(4, 4, 128, 128);
const mesh = new THREE.Mesh(geometry);
scene.add(mesh);

const kernel = new SMNTCKernel({ surface: 'fluid', vibe: 'calm', palette: 'monochrome' });
kernel.apply(mesh, camera, renderer.domElement);
kernel.start(renderer, scene, camera);
```

## Minimal Example (React-Three-Fiber)

```tsx
import { Canvas } from '@react-three/fiber';
import { SMNTCSurface } from 'smntc/react';

function App() {
  return (
    <Canvas>
      <SMNTCSurface surface="topographic" vibe="calm" reactivity="magnetic" palette="arctic" />
    </Canvas>
  );
}
```

## R3F Material Element

```tsx
import React from 'react';
import { extend, useFrame } from '@react-three/fiber';
import { SMNTCMaterial } from 'smntc';

extend({ SMNTCMaterial });

function Surface() {
  const mat = React.useRef<SMNTCMaterial>(null);
  useFrame((_state, delta) => mat.current?.update(delta));

  return (
    <mesh>
      <planeGeometry args={[1, 1, 128, 128]} />
      <smntcMaterial ref={mat} surface="fluid" vibe="calm" palette="arctic" />
    </mesh>
  );
}
```

## Web Component (No Framework)

```html
<script type="module">
  import 'https://unpkg.com/smntc/dist/web/index.mjs';
</script>

<smntc-surface
  style="width: 100%; height: 60vh; display: block;"
  surface="topographic"
  vibe="calm"
  palette="monochrome"
  reactivity="magnetic"
></smntc-surface>
```

## CLI

```bash
npx smntc init
npx smntc add hero
npx smntc preview
```

## Key Methods

- `kernel.setVibe('agitated')` — Spring-animated vibe transition
- `kernel.setSurface('crystalline')` — Switch surface mode
- `kernel.setPalette('neon')` — Spring-animated color transition
- `kernel.setReactivity('shockwave')` — Change interaction model
- `kernel.setAngle(45)` — Rotate displacement field
- `kernel.setGrain(0.3)` — Add film grain
- `kernel.setGlow(1.0)` — Add bloom/glow
- `kernel.setChromatic(0.5)` — Chromatic aberration
- `kernel.setVignette(0.4)` — Edge darkening
- `kernel.setBlur(0.2)` — Depth blur
- `kernel.configure({ vibe: 'chaotic', palette: 'ember' })` — Bulk update
- `kernel.dispose()` — Clean up all GPU/DOM resources

## Optional

- [JSON Schema](https://github.com/NAME0x0/SMNTC/blob/main/smntc.schema.json): Machine-validatable config schema