TypeScript icon, indicating that this package has built-in type declarations

2.12.2 • Public • Published



A standardized reality for the future of the 3D Web.

Version Downloads Discord Shield · demo · discord



The mission of spacesvr is to organize and implement the standards for experiencing 3D content on the web in the same way that there exists standards for experiencing 2D content with HTML/CSS/JS.

spacesvr is designed to empower the artist. Instead of worrying about file structures or basic functionality like cross-device compatability, artists should spend their time telling their story. As such, consumption is optimized for simplicity, and the organization provides a framework to tell stories.

spacesvr is actively maintained by Muse, a YC-backed startup that provides tooling for visually building worlds. Muse's mission is to accelerate the adoption of 3D websites by increasing their accessibility, both for the end user and for the creator. Muse is completely built on spacesvr.

Quick Start


You could set up the framework in your sleep. Just import the package

yarn add spacesvr #or npm install spacesvr

and copy/paste 9 lines of code

import { StandardReality, LostWorld } from "spacesvr";

function World() {
  return (
      <LostWorld /> // an example world with a floor, skybox, and fog

this is the starting point for this demo

From this point, your creations will be built by directly using the following technologies:

Under the hood and mostly abstracted away are the following technologies:

Folder Structure

the following are each a fundamental unit and their own folder at the top level of spacesvr, with the pattern recursively re-appearing throughout the repository

ideas are the fundamental building blocks of your world. They are the 3D the equivalent of HTML Elements. They are implemented as React components.

layers (of reality) offer new functionality to the world. They are implemented using a React container component, a context, and a corresponding hook.

logic offers functions to be used when composing your world. They are implemented as individually exported functions and hooks.

realities define how the player experiences your world. They are comparable in function to a browser. They are implemented as a React container component and composed of an ordering of layers.

tools offer the player affordances in your world. They are the 3D equivalent of a browser toolbar. They are implemented using a Layer for fundamental state a modifier for registry.

worlds are sets of ideas. They are the actual content of your site. They are implemented as compositions of ideas.


Standard Reality

The Standard Reality defines the standard experiencing the 3D web. The layers provided are, in order: Environment, Physics, Player, Toolbelt, Network, Visual. Additionally, it provides an infinite ground to walk on that can be disabled.

    environmentProps={{...}} // props to be passed to the environment layer
    physicsProps={{...}} // props to be passed to the physics layer
    playerProps={{...}} // props to be passed to the player layer
    networkProps={{...}} // props to be passed to network layer
    disableGround={true} // disable ground in case you want your own


Environment Layer

The base layer that abstracts away the DOM, allowing you to think only in 3D

type EnvironmentProps = {
  name?: string; // set the name of your environment, shows up in the pause menu
  pauseMenu?: ReactNode; // for you to provide a custom pause menu
  loadingScreen?: ReactNode; // for you to provide a custom loading screen
  dev?: boolean; // hides the pause menu, useful while switching between world and IDE
  canvasProps?: Partial<ContainerProps>; // to edit the r3f canvas props
const environmentState = useEnvironment();

type EnvironmentState = {
  name: string;
  paused: boolean;
  setPaused: (p: boolean) => void;
  device: DeviceState; // the current device being used by the player: xr, mobile, or desktop
  containerRef: MutableRefObject<HTMLDivElement | null>;

Physics Layer

Provides a default physics configuration

import { PhysicsProps as ProviderProps } from "@react-three/cannon";
type PhysicsProps = ProviderProps;

Player Layer

Provides a user-controlled entity with a standardized set of controls that work cross-platform (VR/Mobile/Desktop)

type PlayerProps = {
  pos?: number[]; // initial player position
  rot?: number; // initial player rotation (radians along Y axis)
  speed?: number; // player movement speed
  controls?: {
    disableGyro?: boolean; // used to disable gyroscope prompt on mobile
const playerState = usePlayer();

type PlayerState = {
  position: PlayerVec; //.get() and .set() for position
  velocity: PlayerVec; //.get() and .set() for velocity
  controls: PlayerControls; //.lock() and .unlock() for stopping player movement
  raycaster: Raycaster; // reference to player's raycaster

Toolbelt Layer

Provides a layer of UX to offer user interaction with the world.

type ToolbeltProps = {
  showOnSpawn?: boolean; // whether to show the toolbelt on spawn, default true
const toolbelt = useToolbelt();

type ToolbeltState = {
  tools: Tool[];
  activeTool?: Tool;
  hide: () => void;
  next: () => void;
  prev: () => void;
  show: () => void;
  activeIndex: number | undefined;
  setActiveIndex: (i: number) => void;
  direction: Direction;

Network Layer

Provides multiplayer out-of-the-box. Muse provides signalling servers and STUN/TURN servers for everyone :).

type NetworkProps = {
  autoconnect?: boolean; // whether to automatically attempt a p2p connection, false by default
  disableEntities?: boolean; // whether to hide users from seeing each other, in case you want to implement yourself
  iceServers?: RTCIceServer[]; // set of ice servers to use (recommended for production!!)
  host?: string; // signalling host url, uses Muse's servers by default
  sessionId?: string; // if you know the session id you want to use, enter it here
  worldName?: string; // the worldname to hash your signal peers by, by default set to the path name
  voice?: boolean; // whether to enable spatial voice chat, false by default
const networkState = useNetwork();

type NetworkState = {
  connected: boolean; // whether the user has established connection with signalling server
  connect: (config?: ConnectionConfig) => Promise<void>; // when autoconnect is off, use this to manually connect
  connections: Map<string, DataConnection>; // reference to active peer connections
  disconnect: () => void;
  voice: boolean; // whether voice is enabled
  setVoice: (v: boolean) => void; // enable/disable voice
  mediaConnections: Map<string, MediaConnection>; // reference to active media connections
  useChannel: <Data = any, State = any>(
    id: string,
    type: ChannelType,
    reducer: Reducer<Data, State>
  ) => Channel<Data, State>; // set up a data channel to standardize communication between peers


Camera Tool

A tool that gives the user a camera to take pictures with. To add to your toolbelt simply add it into the World.

  <Camera />

Walkie Talkie Tool

A tool to configure your microphone settings. Automatically added if voice chat is enabled in the network layer.


types of ideas

  • basis/ for visualizations of fundamental metaphysics
  • environment/ for setting up the environment
  • media/ for importing common media types
  • mediated/ for some basic art assets
  • modifiers/ for modifying other ideas. they don't render anything themselves
  • ui/ for guiding and interacting with the user



Visualize an Idea

<VisualIdea idea={new Idea()} />


Visualize a Site

<VisualSite idea={new Site()} />


Visualize a World

<VisualWorld idea={new World()} />



Set the background color of your space

<Background color="blue" />


Add fog to your scene.

<Fog color="white" near={10} far={100} />


Adds an infinite plane to walk on (added by default with the Environment Layer)

  height={-0.0001} // offset a slight amount
  size={[100, 100]}



A positional audio component that will play the passed in audio url. Handles media playback rules for Safari, iOS, etc.

  position={[0, 4, 0]}
  dCone={new Vector3(coneInnerAngle, coneOuterAngle, coneOuterGain)} // defaults should be fine


Set the scene background to an hdr file. You can find free hdr files here:

  disableBackground={false} // used to disable visual hdr (skybox)
  disableEnvironment={false} // used to disable environment map


Quickly add an image to your scene

  size={1} // size, default normalized to longest side = 1
  framed // adds a frame


Quickly add a GLTF/GLB model to your scene. Will handle Suspense, KTX2, Draco, Meshopt. Clones the gltf scene so the same file can be re-used.

  center // whether to center the model so its bounds are centered on its origin, default false
  normalize // whether to normalize the model to a height/width/depth of 1, default false


Add a video file to your space with positional audio. Handles media playback rules for Safari, iOS, etc.

  size={1} // size, default normalized to longest side = 1
  muted // mutes the video
  framed // adds a frame



Builds a frame to showcase media, especially images.

width: number; height: number; thickness?: number; material?: Material; innerFrameMaterial?: Material;

  thickness={0.1} // optional, default 0.1
  material={new MeshBasicMaterial({ color: "red" })} // optional, default is a black MeshStandardMaterial
  innerFrameMaterial={new MeshBasicMaterial({ color: "blue" })} // optional, default is no inner frame


An infinite floor styled to the Lost World.

<LostFloor />



Enables colliders for its children either by a named collider mesh or using all meshes and capping collective triangle count to triLimit prop.

  triLimit={1000} // max number of triangles before it uses bvh
  hideCollisionMeshes={false} // set visible to false on meshes used for collision


Makes its children react to onclick and on hover methods

  onClick={() => console.log("Ive been clicked!")}
  onHovered={() => console.log("Ive been hovered!")}
  onUnHovered={() => console.log("Ive been unhovered?")}
  <Stuff />


Turns its children into a tool, automatically registers it with the Tool Layer.

  name="My Tool" // name used for identification
  pos={[0, 0]} // where the tool should be positioned in screen space, x:[-1, 1], y:[-1, 1]
  face={true} // whether the tool should face the user, default true
  pinY={false} // whether the tool should be pinned on the screen space y so user can look up and down
  range={0} // how far from the cursor the tool will stay without moving left or ight, along the x screen space axis, measured in degrees
  orderIndex={0} // the order in which the tool should be rendered relative to other orders, default 0, sorts low to high
  onSwitch={(enabled: boolean) => {}} // callback for when active tool switches, passes whether the given tool is enabled
  <Stuff />


Makes its children link out to when clicked. handles leaving vr session.

  target="_blank" // optional, default is _self
  <Stuff />


Turns its children into a billboard, always facing the camera.

<FacePlayer enabled={true} lockX={false} lockY={false} lockZ={false} />


Lazily floats its children.

<Floating height={0.2} speed={1} />


Makes its children face the player, but with easing.

<LookAtPlayer enabled={true} />


Makes its children spin

<Spinning xSpeed={0} ySpeed={1} zSpeed={0} />

Visual Effect

Adds a render pass to the Visual Layer's render pipeline. Use to add postprocessing.

  index={1} // the order in which the effects are applied, sorts low to high
  <unrealBloomPass args={[new Vector2(256, 256), 0.1, 0.01, 0.95]} />



A text input component made to mimic an HTML input element. Supports all shortcuts, drag to select, shift click, double/triple click.

const [text, setText] = useState("");

  type="text" // text | password | number, default is text
  value={text} // control the input value
  onChange={setText} // optional onChange function
  onSubmit={(s: string) => console.log(s)} // optional onSubmit function, called when enter is pressed
  onFocus={() => console.log("focused")} // optional onFocus function
  onBlur={() => console.log("blurred")} // optional onBlur function
  font={"https://link-to-your-font.ttf"} // optional font
  fontSize={0.1} // font size, default 0.1
  width={1} // width, default 1
  placeholder="Enter your name" // optional placeholder text


An arrow icon

<Arrow dark={false} />


A simple button

  onClick={() => console.log("Ive been clicked!")}
  font="https://link-to-your-font.ttf" // optional font, default is Quicksand
  fontSize={0.1} // font size, default 0.05
  maxWidth={1} // max width, default no max width
  textColor="red" // text color, default black
  color="green" // button color, default white
  outline={false} // whether to show an outline, default true
  outlineColor="#9f9f9f" // outline color, default white
  Click me!


A Keyboard Key that responds to the corresponding key press. Useful for tutorials.

  keyPress={["a, A"]} // optional, default is keyCode, but in case there are multiple keys to look for
  onPressed={(evt) => console.log("Ive been pressed!")} // optional callback when key is pressed


A boolean switch

const [value, setValue] = useState(false);

  value={value} // control the switch value
  onChange={setValue} // optional onChange function

Package Sidebar


npm i spacesvr


Weekly Downloads






Unpacked Size

673 kB

Total Files


Last publish


  • alex_shortt