Skip to content

Latest commit

 

History

History
339 lines (250 loc) · 33 KB

README.md

File metadata and controls

339 lines (250 loc) · 33 KB

Awesome WebXR Development Awesome

Contents

Engine / Framework

General 3D Rendering Engine

  • Three.js - An easy to use, lightweight, cross-browser, general purpose 3D library. The current builds only include a WebGL renderer but WebGPU (experimental), SVG and CSS3D renderers are also available as addons
  • React Three Fiber (R3F) - A React renderer for three.js. Build your scene declaratively with re-usable, self-contained components that react to state, are readily interactive and can participate in React's ecosystem
  • Use.GPU - A set of declarative, reactive WebGPU legos. A stand-alone Typescript+Rust/WASM library with its own React-like run-time
  • Simple-GPU - Functional WebGPU. Replaces the WebGPU API with two fundamental abstractions, resources and commands

Three.js Boilerplates:

Three.js + Vite Boilerplates:

General 3D App Framework

  • React Three - A vibrant and extensive eco system around three-fiber, full of libraries, helpers and abstractions
  • Babylon.js - A powerful, beautiful, simple, and open game and rendering engine packed into a friendly JavaScript framework
  • A-Frame - A web framework for building 3D/AR/VR experiences. Make 3D worlds with HTML and Entity-Component On any headset, mobile and desktop
  • ion Engine - A Javascript library for building 3D websites and virtual reality experiences. Supports creating interactive user interfaces for WebGL and WebXR projects using HTML/CSS/JS
  • Elixr - A lightweight and flexible framework for building WebXR experiences. Built on top of three.js, Rapier physics engine and ECSY

React Three + Next.js Boilerplates:

  • React Three Next - A minimalist starter for Next.js, React Three Fiber and Three.js (and Tailwind and Styled-components)

React Three Boilerplates:

A-Frame Boilerplates:

3D Game Engine

  • PlayCanvas - The web-first game engine. A visual development platform for interactive web content
  • Wonderland Engine - Development Platform for VR & AR Web Apps
  • Ethereal Engine - Metaverse infrastructure for everyone. Everything you need to build and deploy scalable realtime 3D social apps and more
  • Phy - Phy simplify creation of game, is like a bridge between three.js and physics. Phy support last version of Oimo and Ammo. Now full support of two best engine Physx and Havok
  • Lattice - A lightweight, modular, and extendable 3D game engine built for the web. The engine is also highly performant, with speed gains from the ECS architecture and multi-threading via WebWorkers that would be difficult to achieve when using these libraries individually

Visual Editor

  • Polygon.js - Node-Based Design & Animation Tool for the Web
  • Rogue Engine - A Unity3D-like environment to create WebXR enabled apps and games for the browser with three.js
  • Needle Engine - Needle Engine is a web-based runtime for 3D apps. Needle Exporter for Unity bridges the Unity Editor and the web runtime. Together, they enable incredible iteration speeds and help you to bring your content to the web
  • Triplex - Visually edit React Three Fiber components where code is source of truth
  • react-three-editor - A one of a kind scene editor that writes changes back into your code, and you don't need to change your code at all for it to to work!
  • Babylon.js Editor - Provide community-driven powerful and simple tools that help Babylon.JS users to create beautiful, awesome 3D games / applications
  • Theatre.js - Most of its users are using it as a visual editor now, than an animation editor
  • Threed Studio - A 3D animation editor with a set of design, lighting and motion tools. It helps you create any 3D scene, from a simple product presentation to a complete game made with Three.js

State Management

  • bitECS - Functional, minimal, data-oriented, ultra-high performance ECS library written using JavaScript TypedArrays
  • Miniplex - A developer-friendly entity management system for games and similarly demanding applications, based on ECS architecture
  • Becsy - Multi-threaded ECS for TypeScript and JavaScript
  • XState - JavaScript and TypeScript finite state machines and statecharts for the modern web
  • Zustand - A small, fast and scalable bearbones state-management solution using simplified flux principles. Has a comfy API based on hooks, isn't boilerplatey or opinionated
  • Jotai - Primitive and flexible state management for React. Scales from a simple useState replacement to an enterprise TypeScript application
  • Valtio - Makes proxy-state simple for React and Vanilla

Utilities

  • three-stdlib - Stand-alone version of threejs/examples/jsm written in Typescript & built for ESM & CJS. Designed to run without transpilation in node & browser
  • Drei - A growing collection of useful helpers and fully functional, ready-made abstractions for @react-three/fiber

Interaction

XR Interaction

  • @coconut-xr/natuerlich - WebXR Interaction library. Deliver composable and extensible interactions for immersive experiences
  • @react-three/xr - React components and hooks for creating VR/AR applications with @react-three/fiber
  • Reality Accelerator Toolkit (RATK) - A WebXR utilities library designed to simplify the integration of Mixed Reality features in WebXR apps. It is currently compatible with the three.js 3D library and aims to bridge the gap between low-level WebXR APIs and higher-level APIs provided by three.js
  • XRKeys - A highly performant and plug-and-play WebXR keyboard library for Three.js applications
  • Handy.js - Makes defining and recognizing custom hand poses in WebXR a snap

Desktop Interaction

Mobile Interaction

  • NippleJS - A vanilla virtual joystick for touch capable interfaces
  • MeshWalk.js - A JS library which helps your TPS game development with three.js

2D GUI

Layout

  • three-mesh-ui - A small library for building VR user interfaces. The objects it creates are three.object3Ds, usable directly in a three.js scene like any other Object3D. It is not a framework, but a minimalist library
  • @coconut-xr/koestlich - Builds on yoga (flexbox implementation), Three.js to deliver compatible and performant 3D UIs with out-of-the-box animations
  • @react-three/flex - Brings the webs flexbox spec to react-three-fiber. It is based on Yoga, Facebook's open source layout engine for react-native

HTML Layout

  • @etherealengine/xrui - XRUI provides functionlity for using DOM elements to construct a user interface for XR applications
  • Satori - Enlightened library to convert HTML and CSS to SVG
  • html2canvas - JavaScript HTML renderer. Allows you to take "screenshots" of webpages or parts of it, directly on the users browser
  • HTMLMesh - demo

Form

  • r3f-form - A webGL form component for use with React Three Fiber. Ultimately, the goal is to have fully functioning HTML <form>s -- with all viable input types -- rendered in webGL
  • @coconut-xr/input - input fields for 3D UIs with @coconut-xr/koestlich

Image & Text

  • Drei - Image - A shader-based image component with auto-cover (similar to css/background: cover)
  • Drei - Text - Hi-quality text rendering w/ signed distance fields (SDF) and antialiasing, using troika-3d-text. All of troikas props are valid! Text is suspense-based!
  • troika-three-text - Provides high quality text rendering in Three.js scenes, using signed distance fields (SDF) and antialiasing using standard derivatives
  • troika-3d-text - Provides high quality text rendering in the Troika scene management framework, using signed distance fields (SDF) and antialiasing using standard derivatives. It is based on troika-three-text

Animation

  • React Spring + R3F - A spring-physics first animation library. It works perfectly with React Three Fiber as it comes from the same maintainers and it also has exports created specifically for use with React Three Fiber
  • Drei - useAnimations - A hook that abstracts Three.js's AnimationMixer (a player for animations on a particular object in the scene)
  • Framer Motion 3D - A simple yet powerful animation library for React Three Fiber. It offers most of the same functionality as Framer Motion for declarative 3D scenes

Skeleton Animation

  • ossos - A complete character skinning & animation library for the web (with the IK Rig & IK Animations type system)

Visual Animation Editor

  • Theatre.js - A javascript animation library with a professional motion design toolset. It helps you create any animation, from cinematic scenes in THREE.js, to delightful UI interactions

Particle System

  • Three Quarks - The Fastest Real-Time Particle VFX Engine for Web Experiences For Games, VR, AR, and UX
  • Three Nebula - A WebGL based 3D particle system engine for Three.js
  • r3f-effekseer - Provide React bindings for the WebGL + WASM runtime of Effekseer. Effekseer is a mature Particle Effect Creation Tool, which supports major game engines, is used in many commercial games, and includes its own free to use editor

Physics Engine

  • @react-three/rapier (Rapier ) - A wrapper library around the Rapier (Fast 2D and 3D physics engine for the Rust) WASM-based physics engine, designed to slot seamlessly into a @react-three/fiber pipeline
  • PhysX (physx-js-webidl) - Javascript/WASM bindings for Nvidia PhysX based on emscripten/WebIDL
  • Havok (@babylonjs/havok) - Havok is now available for the web, using a WebAssembly version of the engine. It is available, free to use, under the MIT license
  • Jolt (JoltPhysics.js) - Port of JoltPhysics to JavaScript using emscripten. Jolt Physics is a multi core friendly rigid body physics and collision detection library suitable for games and VR applications, used by Horizon Forbidden West
  • use-cannon (cannon-es) - React hooks for cannon-es (A lightweight 3D physics engine written in JavaScript). Use this in combination with @react-three/fiber
  • Oimo.js - A lightweight 3d physics engine for JavaScript. It's a full javascript conversion of OimoPhysics (A lightweight 3D physics engine originally created for ActionScript 3.0)
  • Enable3d - Written in TypeScript, uses three.js and ammo.js, brings physics to your three.js project and the third dimension to your Phaser 3 game

Gameplay

  • three-pathfinding - Navigation mesh toolkit for ThreeJS, based on PatrolJS (helps your AI agents navigate around your world. It uses the A* and Funnel algorithms to calculate a path on a navigation mesh)
  • recast-navigation-js - A WebAssembly port of Recast Navigation (state of the art navigation mesh construction toolset for games)
  • Yuka - A JavaScript library for developing Game AI

Graphics

  • three-mesh-bvh - A BVH implementation to speed up raycasting and enable spatial queries against three.js meshes
  • three-bvh-csg - A flexible, memory compact, fast and dynamic CSG implementation on top of three-mesh-bvh
  • @react-three/csg - Constructive solid geometry for React, a small abstraction around three-bvh-csg
  • THREE.MeshLine - Mesh replacement for THREE.Line. Instead of using GL_LINE, it uses a strip of triangles billboarded

Optimization

Post Processing

  • @react-three/postprocessing - A postprocessing wrapper for @react-three/fiber. Save you hundreds of LOC for a straight forward effects-chain. It is faster than three/examples/jsm/effectcomposer, actively maintained, has better effects
  • three.js Realism Effects - A collection of the following effects for three.js (SSGI, Motion Blur, TRAA, TAA, SVGF)
  • three.js Screen Space Reflections - Implements performant Screen Space Reflections in three.js
  • N8AO (SSAO) - An efficient and visually pleasing implementation of SSAO with an emphasis on temporal stability and artist control
  • R3F-Ultimate-Lens-Flare - A EffectComposer Effect (Lens Flare) for React Three Post Processing. Adds the optical aberration caused by the dispersion of light entering the lens through its edges

Material / Shader

  • Drei - Shader - Easily add reflections and/or blur to any mesh. It takes surface roughness into account for a more realistic effect. This material extends from THREE.MeshStandardMaterial and accepts all its props
  • enhanceShaderLighting - Better lighting in three.js. Make your PBR material look more realistic. Give the user a lot of options to tweak lighting so that a certain combination of settings will give a decent looking result
  • Custom Shader Material (CSM) - Extend Three.js standard materials with your own shaders! It Supports both Vanilla and React!
  • Three Landscape - A growing collection of React-three-fiber compatible abstractions for rendering high quality, large scale landscapes scenes. I've been researching how AAA games render terrain and am replicating any browser compatible techniques here
  • Shader Composer - A library for authoring Three.js shaders with JavaScript. It offers a lean, functional API that makes shader composition straight-forward and fun, while allowing for simple, low-friction reusability of your favorite shader functions

Visual Shader Editor

  • NodeToy - The most powerful material editor on the web. Built for ThreeJS & React-Three-Fiber. Create, fork and publish shader graphs with the world using an intuitive and easy to use tool built for all
  • Babylon NME (Node Material Editor) - Shader-based materials editor for Babylon.js
  • lamina - An extensible, layer based shader material for ThreeJS. Built on top of three-custom-shader-material (CSM) and any effects that are achieved by lamina can be done with CSM in a predictable and performant manner albeit at a lower level
  • Alma - Generative Graphics Creator

Assets

GLTF & KTX2

  • Drei - GLTF - A convenience component that will load a gltf file and clone the scene using drei/Clone. That means you can re-use and mount the same gltf file multiple times
  • gltfjsx - A small command-line tool that turns GLTF assets into declarative and re-usable react-three-fiber JSX components
  • glTF-Transform - glTF 2.0 SDK for JavaScript and TypeScript, on Web and Node.js. Provides fast, reproducible, and lossless control of the low-level details in a 3D model
  • glTFast - Enables use of glTF asset files in Unity (import / export)
  • gltfpack - A tool that can automatically optimize glTF files to reduce the download size and improve loading and rendering speed
  • glTF Pipeline - Content pipeline tools for optimizing glTF assets by the Cesium team

USD

  • Asset Explorer - Contains glTF models and their USDZ counterparts. This page is targeted at implementers, developers, and designers working with these file formats. A clear goal is to allow you to download files for a specific usecase and check if your target viewer/platform supports what you want it to support

Avatar

  • three-vrm - Use VRM (a file format for handling 3D humanoid avatar data for VR applications. It is based on glTF2.0) on three.js

Audio

  • Howler.js - Audio library for the modern web. It defaults to Web Audio API and falls back to HTML5 Audio. This makes working with audio in JavaScript easy and reliable across all platforms
  • Tone.js - A Web Audio framework for creating interactive music in the browser. Aims to be familiar to both musicians and audio programmers creating web-based audio applications. Offers common DAW (digital audio workstation) features. Provides high-performance building blocks to create your own synthesizers, effects, and complex control signals

Debug

  • Immersive Web Emulator - A browser extension that assists WebXR content creation. It enables developers to responsively run WebXR apps on a desktop browser without the need of an XR device. Inspired by the official WebXR Emulator Extension by Mozilla Reality and our previous efforts of extending it for better functionality, designed and rebuilt from the ground up
  • LogXR - A debugging utility that makes it easy to view console logs in WebXR experiences. Currently, LogXR only supports Three.js, with support for Babylon.js coming soon
  • Spector.js - A complete engine agnostic JavaScript framework for exploring and troubleshooting your WebGL scenes with ease
  • R3F-Perf - Easily monitor the performances of your @react-three/fiber application
  • three-perf - Vanilla Three.js port of r3f-perf(opens in a new tab)
  • stats-gl - WebGL Performance Monitor tool
  • stats.js - JavaScript Performance Monitor. Provides a simple info box that will help you monitor your code performance
  • Drei - PerformanceMonitor - Collect the average fps over time
  • webgpu-avoid-redundant-state-setting - Check for and avoid redundant state setting
  • @react-three/test-renderer - A React testing renderer for threejs in node

Learning Resources

WebXR

  • MDN Tutorials - A great resource to learn how to comprehend WebXR and the underlying 3D and VR/AR graphics concepts
  • WebXR Samples - Created to give developers a set of simple, fun, readable apps that demonstrate various aspects of using the WebXR API. Designed to focus on API use rather than the details of how the WebGL rendering is done
  • W3C standards and explainers

Case Studies

  • Project Flowerbed: A WebXR Case Study - At Connect ‘22, Meta unveiled Project Flowerbed to demonstrate best practices for developers building high-quality WebXR experiences. Now, as an open source project, it’s even easier for developers to learn about our architecture, asset pipeline, and game mechanics
  • Slow Roads - How Slow Roads intrigues gamers and developers alike, spotlighting the surprising capabilities of 3D in the browser. Discover the potential of WebGL with the infinite, procedurally-generated scenery of this casual driving game. Slow Roads is a casual driving game with an emphasis on endlessly procedurally generated scenery, all hosted in the browser as a WebGL application.
  • SUMMER AFTERNOON - The memories of those summer days in our childhood when time seemed to pass slowly often evoke a strong sense of nostalgia for many of us. Summer Afternoon is a personal project in which my initial goal was to practice creating 3D environments like those found in video games and other immersive experiences. Shortly after starting to work on it, I realized that my true goal with the experiment had transformed and was no longer just to practice a specific technical area, but also to convey a feeling of calmness and nostalgia to visitors
  • Above Paradowski WebXR Mini-Golf - Taking WebXR putt putt from prototype to polished product on par with native Quest 2 games
  • Making PuttClub.io - Social WebXR Games in Full Body VR. The VR game was developed to showcase the capabilities of Ethereal Engine, and serves as a key driving force in developing what we believe to be the most powerful web based immersive engine available today
  • Building with WebXR at the Presence Platform Hackathon - Five of these developer teams built WebXR apps that ran directly inside the Meta Quest Browser, without having to install anything

Performance Optimization

3D Engine / Framework

  • R3F Journey
  • Three.js Journey - The Best Way to Learn Three.js. In 71 hours of video, this course will teach you the secrets to create the coolest WebGL websites with Three.js whether you are a beginner or an advanced developer
  • Discover three.js - A complete introduction to the web as a platform for 3D graphics using the three.js WebGL library, from one of the core three.js developers. Designed to get you started on your journey of creating modern, professional-quality 3D web applications in the shortest time possible
  • Threejs 零基础入门

Graphics API, Computer Graphics

  • LearnOpenGL - Show you all there is to modern OpenGL in an easy-to-understand fashion with clear examples, while also providing a useful reference for later studies
  • Web3D Survey - Solves a common problem that 3D graphics web developers face: which API features can I use reliably? We solve this problem by collecting web graphics API capabilities and features widely across the web and then presenting that data back on this website so 3D graphics web developers can make informed decisions and reliable experiences.
  • WebGL2 Fundamentals - WebGL2 from the ground up. No magic. Entirely new, discarding the old out of date ideas and bringing you to a full understanding of what WebGL really is and how it really works
  • Introduction to WebGPU - CIS 565 GPU Programming Fall 2022 - Covering the WebGPU graphics API. Covers a wide range of WebGPU topics, including API overview, comparison with WebGL, best practices, and more
  • WebGPU — All of the cores, none of the canvas
  • MDN - WebGPU API
  • WebGPU Explainer
  • WebGPU Fundamentals - Teach you the very fundamentals of WebGPU
  • WebGPU Samples - A set of samples demonstrating the use of the WebGPU API
  • WebGPU Best Practices - Focused on the most effective patterns for working with specific parts of the API, especially if you are a developer that’s familiar with WebGL or one of the native APIs
  • The Book of Shaders - A gentle step-by-step guide through the abstract and complex universe of Fragment Shaders
  • Shader School - An introduction to GLSL shaders and graphics programming that runs in your web browser
  • GAMES101: 现代计算机图形学入门

Game

  • Web Game Dev - A work-in-progress collection of resources on techniques and tools around JavaScript game development, which apply to 2D and 3D games, and to visual experiences that are not games
  • Red Blob Games - I make interactive visual explanations of math and algorithms, using motivating examples from computer games