# Shore

> Sloped beach/shore strip to meet a Lake.

## Add it

```bash
npx @runek/cli add shore
```

Pulls `@react-three/rapier@^2.2.0`, `@runek/core@^0.15.0`.

## Use it

```tsx
import { Shore } from './runek/Shore'

<Shore position={[0, 0, 0]} />
```

Or as a node in a world file ([worlds as data](https://runek.nullorder.org/docs/worlds-as-data.md)):

```json
{ "type": "Shore", "props": { "position": [0, 0, 0] } }
```

## Props

| Prop | Type | Default | Description |
|---|---|---|---|
| `position` | `[x, y, z]` | `[0, 0, 0]` | Position [x, y, z] in units (1 unit = 1 m, Y-up). |
| `rotation` | `[x, y, z]` | `[0, 0, 0]` | Euler rotation [x, y, z] in radians. |
| `seed` | `number` |  | Accepted for the component contract; this component has no seeded variation yet. |
| `size` | `[number, number]` | `[24, 24]` | `[width, depth]` in units. The sandy top sits at the component origin. |
| `thickness` | `number` | `0.3` | Thickness, in units. |
| `color` | `color` | palette `sand` | Defaults to the world palette's `sand` slot. |

## Registry manifest

[https://runek.nullorder.org/r/components/shore.json](https://runek.nullorder.org/r/components/shore.json): Self-contained JSON: inlined source plus resolved dependencies, exactly what `runek add shore` fetches.

Browse the whole catalog in the **[gallery →](https://runek.nullorder.org/gallery)**.