NSTCG / wle-hyperbeam

Integration of hyperbeam library with wonderland engine to render interactive virtual computer in AR/ VR in web.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

wle-hyperbeam

Integration of hyperbeam library with wonderland engine to render interactive virtual computer in AR/ VR in web.

npm i

Install dependencies. Retreive api key from https://hyperbeam.com/dashboard/ image add api key to component attatched to display.

image

(leave the rest for quick start)

Package and run

Hurray! you have a hyperbeam vm running in your localhost.

now lets look what the rest of the colums do:

customEmbedUrl : you can create your custom vm instance from here https://docs.hyperbeam.com/rest-api/dispatch/start-chromium-session and pass the embed url. Note : if you do that then you can leave all other colums as blank ( no need to further provide apikey.also no need to tag or staturl since you can configure it from site itself). if you want to generate dynamic vm,then add apiKey and then dont Provide customEmbedUrl!

apiKey: this is manditory unless you have a customUrl. You can get it from https://hyperbeam.com/dashboard/.

defaultTagValue: the tag value is the unique id of the vm.The id will fallback to the string provided in this column unless you loadhyperbeam with a custom tag value.

startUrl: as the name says , what url do you want to displayed in your vm browser on startup.

autoStartVm: unless its ticked , the vm wont start automatically unless the function getEmbedUrlAndLoadHyperbeam is called.

Note : the dynamic spawning of url is made possible through a cloudflare worker : https://hyperbeam.nithinsteven32.workers.dev/. If you can retrieve embed url yourself via any custom worker then you can call the function loadHyperbeam(embedURL) from hyperbeam component to pass your embedurl.

About

Integration of hyperbeam library with wonderland engine to render interactive virtual computer in AR/ VR in web.

License:MIT License


Languages

Language:JavaScript 100.0%