# Well

> Stone well with a dark pool, posts, a little pyramid roof, and a bucket on a rope.

## Add it

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

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

## Use it

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

<Well 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": "Well", "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. |
| `radius` | `number` | `0.7` | Radius, in units. |
| `wallHeight` | `number` | `0.8` |  |
| `color` | `color` | palette `stone` | Stone color; defaults to the world palette's `stone` slot. |
| `roofColor` | `color` | palette `wood` | Roof + frame color; defaults to the world palette's `wood` slot. |

## Registry manifest

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

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