README.md

This three.js template allows multiplayer three.js scenes with integrated audio/video capabilities. It uses a node server running socket.io to provide multiplayer functionality as well as WebRTC signaling.

Quickstart:

1. Download the repository to your computer:

   $ git clone https://github.com/AidanNelson/threejs-webrtc.git

2. Navigate into the local folder and install Node dependencies:

   $ cd threejs-webrtc
   $ npm install

3. Start the server:

   $ npm start

4. Navigate to http://localhost:8080 on your browser.

Technology:

This space is built using a number of technologies, including:

• three.js provides rendering / 3D environment interaction
• socket.io provides the three.js multiplayer functionality, and acts as a WebRTC signaling server
• WebRTC provides video / audio chat functionality
• Simple Peer provides a friendlier API for WebRTC

Credits:

This template uses code from a number of sources, including:

• Or Fleisher - THREE.Multiplayer server and client setup using socket.io with three.js
• Mikołaj Wargowski - Simple Chat App using WebRTC with three.js
• Zachary Stenger - Three.js Video Chat using WebRTC