exokitxr / zeo

Multiplayer WebVR worlds made out of npm modules.

Multiplayer WebVR worlds, procedurally generated with hotloaded npm modules. 🌱🌳🌋🌲🐦🏃🎮

⚠️ Alpha. If you can't wait, join us on Slack or add your email here. ⚠️

Overview

Mods are plain hotloaded Javascript. Frontend API is plain THREE.js. Mods run on both frontend and backend, so they can do pretty much anything. Voxel-based world builder mods loaded by default.

Mouse + keyboard emulation; only requirement is a modern browser -- but it's more awesome with a headset.

Avatars and items persist across servers on a globally distributed blockchain. Buy, sell, trade, and own your items, skins and plugins using worthless virtual credits.

Mod API supports the usual suspects: position tracking, controller events, multiplayer avatars tracking, configurator menu rendering, positional audio, asset loader, and more. Normalized to work the same regardless of headset (or lack thereof).

The server also handles firewall routing, module hotloading, and world storage, so you don't have to worry about that nonsense.

Getting started

Node

npm i modulesio/zeo
cd node_modules/zeo
node index.js

Docker

docker run -p 8000:8000 modulesio/zeo

Windows

Download latest release

Cloud

Steam release

Coming soon 🦄

Controls

Plugins

• Procedural terrain w/ marching cubes
• Block building with tesselated meshes
• Voxel lighting system
• Avatar skins, compatible with Minecraft format
• Sword, bow, pickaxe
• Console emulation via RetroArch
• Tons more

Troubleshooting

General

Windows, OSX, and Linux are supported. node 8+ is required, but included if you use Docker or the Windows builds.

This project uses native modules, so if you're using node you'll need build tools and node-gyp configured or else you'll get an error on npm install.

OSX

• Make sure you have Xcode and Command Line Tools
• Check that node-gyp is in the PATH: node-gyp
• Check that Command Line Tools are installed: xcode-select --install
• Check that gcc is installed: gcc
• Point xcode-select to the developer directory: sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
• Make sure that ~/.node-gyp/<version>/include/node/config.gypi is correct (correct Xcode version, etc.)

Contact

Slack • Wiki • Twitter • Email

zeo's Issues

Add file tag open preview

Can steal the initial implementation from the viewer plugin, which is basically this.

Break out plugins into separate repos/npm modules

• QA all modules
• Break out into separate repos
• Break out into separate modules

Support media file type renderers

• image
• audio
• video
• model

Make headphones plugin

Would be awesome to equip it to your head, attach a file, and play music :).

Physics engine crashes

This is master.

Uncaught TypeError: Cannot read property 'id' of undefined
    at Box.setIgnoreCollisionCheck (https://insecure.zeovr.io:8000/archae/plugins/bullet/bullet.js:464:69)
    at gripdown (https://insecure.zeovr.io:8000/archae/plugins/mc/mc.js:670:41)
    at EventRouter.handle (https://insecure.zeovr.io:8000/archae/plugins/input/input.js:71:11)
    at Object._triggerEvent [as triggerEvent] (https://insecure.zeovr.io:8000/archae/plugins/input/input.js:151:21)
    at EVENT_SPECS.forEach (https://insecure.zeovr.io:8000/archae/plugins/webvr/webvr.js:8658:25)
    at Array.forEach (native)
    at SIDES.forEach.side (https://insecure.zeovr.io:8000/archae/plugins/webvr/webvr.js:8653:27)
    at Array.forEach (native)
    at WebvrInstance.updateStatus (https://insecure.zeovr.io:8000/archae/plugins/webvr/webvr.js:8647:19)
    at _requestAnimationFrame (https://insecure.zeovr.io:8000/archae/plugins/webvr/webvr.js:8393:45)

Server disconnect no longer working

Bullet physics build failing

debian jessie

https://gist.github.com/ibrahimduran/d06115880041762a0663c6406f86e03f

In file included from ../src/world.cpp:1:0:
../inc/helper.h:51:27: warning: backslash-newline at end of file
 #define MOXCHK(condition) \
 ^
  SOLINK_MODULE(target) Release/obj.target/physics.node
g++: error: /home/ibrah/Projects/vr/node_modules/zeo/core/engines/bullet/bullet3/build/src/BulletDynamics/libBulletDynamics.a: No such file or directory
g++: error: /home/ibrah/Projects/vr/node_modules/zeo/core/engines/bullet/bullet3/build/src/BulletCollision/libBulletCollision.a: No such file or directory
g++: error: /home/ibrah/Projects/vr/node_modules/zeo/core/engines/bullet/bullet3/build/src/LinearMath/libLinearMath.a: No such file or directory
physics.target.mk:134: recipe for target 'Release/obj.target/physics.node' failed
make: *** [Release/obj.target/physics.node] Error 1
make: Leaving directory '/home/ibrah/Projects/vr/node_modules/zeo/core/engines/bullet/build'
gyp ERR! build error 
gyp ERR! stack Error: `make` failed with exit code: 2
gyp ERR! stack     at ChildProcess.onExit (/home/ibrah/Projects/vr/node_modules/zeo/core/engines/bullet/node_modules/node-gyp/lib/build.js:276:23)
gyp ERR! stack     at emitTwo (events.js:106:13)
gyp ERR! stack     at ChildProcess.emit (events.js:192:7)
gyp ERR! stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:215:12)

Was ultimately fixed by going into core/engines/bullet/bullet3 and doing manual build.sh from there.

Bullet physics engine crash when demoing mc plugin

TypeError: Cannot set property 'matrix' of null                                            
    at WebSocket.c.on.s (/home/k/zeo/installed/plugins/node_modules/world/server.js:425:55)
    at emitTwo (events.js:106:13)                                                                                                                                                 
    at WebSocket.emit (events.js:192:7)                                                                                                                                           
    at Receiver._receiver.onmessage (/home/k/zeo/node_modules/ws/lib/WebSocket.js:143:54)                                                                                         
    at Receiver.dataMessage (/home/k/zeo/node_modules/ws/lib/Receiver.js:375:14)                                                                                                  
    at extension.decompress (/home/k/zeo/node_modules/ws/lib/Receiver.js:344:40)                                                                                                  
    at _inflate.flush (/home/k/zeo/node_modules/ws/lib/PerMessageDeflate.js:279:12)                                                                                               
    at afterWrite (_stream_writable.js:383:3)                                                                                                                                     
    at onwrite (_stream_writable.js:374:7)                                                                                                                                        
    at afterTransform (_stream_transform.js:79:3)                                                                                                                                 
    at TransformState.afterTransform (_stream_transform.js:54:12)

Looks like some object isn't being tracked on the backend correctly.

Add file download support

Probably just an anchored button the the file tag mesh.

Speed up World / npm tab initial render

Currently skipping too many frames, a bit of a jarring experience.

The tag renders can be batched and some of the processing work can be split to the backend, such as the image rendering.

Finish multiplayer tags reconciliation

• Commandize all tags actions
• Pipe, process, save, and broadcase commands on the backend
• Capture tags actions for self
• Capture tags actions for remote users/remote headset/controller meshes

Textures have non-integer heights

Due to how the constants are computed.

Per-world user position saving with the hub

Rename rend engine to menu

Since its main purpose is to be a menu hub now.

Keyboard input dynamic focus pop-in + API

Add video plugin

Similar to camera plugin, but for videos

Backpack is too eager

It opens when a controller is anywhere behind the camera, even at your sides.

It should only open when the controller is behind the head/over the shoulder.

Add module file attachment support

Demo ad plugin does not respect position

Make camera plugin generate file tags

Trash can / delete tag support

A place to drag tags from the world so you can delete them.

Performance regressions

Need to re-profile and see what's eating CPU lately.

Clean up rollup default export warnings

Just a chore, no functionality impact.

Add file creation API in world engine

Needed for camera plugin generating file tags (#18).

Add module versioning support

Related to attribute schema versioning (#62).

Site + docs

Fix file upload support

tagMesh multiselect / highlight support

Would also be nice to use a camera- or controller- aligned bounding box instead of an AABB.

Reconnect / connection error handling support

Delete hands engine

It might not be needed at all now that the world engine tracks tag grab states.

Fix remote user elements/files mesh tracking

Already works for the single-user cyborg case, but needs to work for all remote user meshes as well.

Currently XXX-commented in the world engine.

Server doesn't connect on load

Happens about 50% of the time.

Controller (shoulder) bag is unreachable

You can't see it by looking because the bag rotates too eagerly with the HMD.

Mail thread system

Need to figure out what to do about this.

Created files should not show their tag mesh immediately

Currently a file upload of camera snapshot immediately renders even if the menu is closed and tag meshes should no be visible.

Come up with an attribute schema change solution

Should work across module versioning.

Bugfix npm search input

Currently simply not working, commented out.

Add API documentation

Fix menu status page rendering

Currently just renders placeholder data.

Add microphone plugin

Similar to camera plugin, but for audio

Turn off bag+backpack meshes for insecure (inventory-less) servers

World server equipment save crash due to missing hubSpec

https://github.com/modulesio/zeo/blob/21fa0a5a8edecf6fe5282f3f28dbcb5c575ee00e/core/engines/world/server.js#L279
https://github.com/modulesio/zeo/blob/21fa0a5a8edecf6fe5282f3f28dbcb5c575ee00e/core/engines/world/server.js#L136

World link module

Initial envMap-based rendering work exists in the link plugin but needs to be hooked in to the servers system.

Mail page is crashing due to missing mail engine

Menu positioning cleanup

• Menu is too close on menu open hit.
• Menu might be better with rotateX=0.

Open Keyboard + Mouse mode when WebVR available starts WebVR mode

Add ability to exit out of headset mode

Just like the ability to exit out of keyboard + mouse mode. IT's less useful but would still be nice for the ability to revert to keyboard + mouse out of the headet when e.g. developing.

Add youtube-dl plugin

Tracked controllers are broken

Utilify various calls

Too many _makeId sprinkled around a lot of engine modules, it should be in js-utils or something.