component

Person

A proportioned, clothed, articulated figure generated from a seed: style templates (anime by default, realistic as the alternate), role presets, gender/age/build silhouettes, hair, outfits, hats and accessories, swappable cosmetic skins (named presets or custom bundles), poses, idle breathing, and a head that turns to watch you. Place one at a spawn point, or use it as the Player's third-person body.

⌖ Explore the library in 3D →

Add it

npx @runek/cli add person

Pulls sign, @react-three/fiber@^9.6.1, @react-three/rapier@^2.2.0, @runek/core@^0.12.0, three@^0.184.0.

Use it

import { Person } from './runek/Person'

<Person position={[0, 0, 0]} />

Props

export interface PersonProps extends WorldComponentProps {
  /** Visual template: `anime` (default) has a bigger head, large lit eyes, a tapered chin,
   *  longer legs, and a chunky fringe; `realistic` keeps canonical human proportions. */
  style?: PersonStyle
  /** Role preset: fills `outfit`, `hat`, and `accessories` unless you set them. */
  kind?: PersonKind
  /** Silhouette cues only; every trait it influences stays overridable. Seeded when unset. */
  gender?: PersonGender
  /** Head-to-body ratio, stature, and (for `elder`) a stooped spine. */
  age?: PersonAge
  /** Standing height, in units. Every other measurement derives from it. */
  height?: number
  /** Limb thickness and torso depth. Seeded when unset. */
  build?: PersonBuild
  /** Skin color; seeded from a curated set of tones when unset. */
  skinTone?: string
  /** Cosmetic loadout: a preset name from `PERSON_SKINS` (e.g. `"winter"`) or a custom
   *  `PersonSkin` bundle. Individual props win over it. Plain JSON either way, so an editor
   *  or an in-world UI can swap a figure's whole look by writing this one prop. */
  skin?: PersonSkinName | PersonSkin
  hair?: PersonHair
  hairColor?: string
  facialHair?: PersonFacialHair
  outfit?: PersonOutfit
  /** Shirt/dress color; defaults to a seeded shade of the palette's `fabric`. */
  topColor?: string
  /** Trouser/skirt color; defaults to a seeded shade of the palette's `woodDark`. */
  bottomColor?: string
  /** Shoe color; defaults to the palette's `metal`. */
  shoeColor?: string
  hat?: PersonHat
  accessories?: PersonAccessory[]
  /** Static joint set. `wave` also animates the raised forearm. */
  pose?: PersonPose
  /** Breathing, weight shift, and blinking. */
  idle?: boolean
  /** Turn the head toward the camera when it comes within `lookRadius`. */
  lookAt?: boolean
  /** How close the camera must be for `lookAt` to engage, in units. */
  lookRadius?: number
  /** Floating name above the head. */
  label?: string
  /** Capsule collider, so the figure is something you bump into. */
  collider?: boolean
  /** Render as a bare visual with no `RigidBody` — for a parent that owns the physics
   *  (e.g. as `Player`'s third-person avatar). When false, `collider` is ignored. */
  physics?: boolean
  detail?: PersonDetail
}

Registry manifest

Browse the whole catalog in the gallery →.