Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-06 19:03:19 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

added readme

Browse source
This commit is contained in:
milad 2019-10-31 09:36:58 -07:00
parent 6291590737
commit 9e3318e5dd
2 changed files with 24 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
screenshare/.gitignore vendored
View file

@ -1,3 +1,4 @@
hifi-screenshare-*/
hifi-screenshare*.zip
screenshare*.zip
screenshare*.zip
screenshare-*/

22
screenshare/README.md Normal file
View file

@ -0,0 +1,22 @@
# Hifi-Screenshare
The Screenshare app will allow easy desktop sharing by being launced from within the highfidelity interface.
# Setup
Create the following environment variable the hifi-screenshare app will use to get the proper connection info:
hifiScreenshareURL="<URL for authentication>"
# Screenshare API
In order to launch the hifi-screenshare app from within interface, you will call the following:
Screenshare.startScreenshare(displayName, userName, token, sessionID, apiKey);
The app won't run without the correct info.
# Files included
packager.js :
Calling npm run packager will use this file to create the actual electron hifi-screenshare executable
src/main.js :
The main process file to configure the electron app
srce/app.js :
The render file to dispaly the screenshare UI