https://github.com/pmndrs/viverse
⟁ Build 3D web games with threejs and viverse
https://github.com/pmndrs/viverse
Last synced: 6 months ago
JSON representation
⟁ Build 3D web games with threejs and viverse
- Host: GitHub
- URL: https://github.com/pmndrs/viverse
- Owner: pmndrs
- License: other
- Created: 2025-07-17T19:39:17.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-07-17T23:01:46.000Z (6 months ago)
- Last Synced: 2025-07-17T23:08:46.796Z (6 months ago)
- Language: TypeScript
- Homepage: https://pmndrs.github.io/viverse/
- Size: 10.6 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
@react-three/viverse
Build 3D web games with threejs and viverse.
```bash
npm install three @react-three/fiber @react-three/viverse
```
### What does it look like?
| A prototype map with the `` component and its default model. |  |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------- |
```jsx
import { createRoot } from 'react-dom/client'
import { Sky } from '@react-three/drei'
import { Canvas } from '@react-three/fiber'
import { Viverse, SimpleCharacter, FixedBvhPhysicsBody, PrototypeBox } from '@react-three/viverse'
createRoot(document.getElementById('root')!).render(
,
)
```
## How to get started
> Some familiarity with
> react, threejs, and @react-three/fiber, is recommended.
Get started with **[building a simple game](https://docs.pmnd.rs/viverse/tutorials/simple-game)**, take a look at our **[examples](https://docs.pmnd.rs/viverse/getting-started/examples)**, or follow one of our **tutorials**:
- [First person controls](https://docs.pmnd.rs/viverse/tutorials/first-person)
- [Augmented and virtual reality](https://docs.pmnd.rs/viverse/tutorials/augmented-and-virtual-reality)
- [Accessing avatar and profile](https://docs.pmnd.rs/viverse/tutorials/access-avatar-and-profile)
- [Using custom animations and models](https://docs.pmnd.rs/viverse/tutorials/custom-models-and-animations)
- [How to remove the viverse integrations](https://docs.pmnd.rs/viverse/tutorials/remove-viverse-integrations)
- [Publish to Viverse](https://docs.pmnd.rs/viverse/tutorials/publish-to-viverse)
- Building your own character controller - _Coming Soon_
## Not into react?
> No Problem
Check out how to build games using @pmndrs/viverse and only [vanilla three.js](https://docs.pmnd.rs/viverse/without-react).