Difference between revisions of "Web Interface"

From Constructive Labs
Jump to navigation Jump to search
Line 5: Line 5:
 
You must enable the web server by setting this config line  in ClientConfig.json : '''"enableWebManagement" : true'''
 
You must enable the web server by setting this config line  in ClientConfig.json : '''"enableWebManagement" : true'''
  
this config setting defines the server port: "webManagementPort" : 8080,
+
this config setting defines the server port: "webManagementPort" : 8080
 +
 
 +
located at C:\Program Files (x86)\Monkey\HyperbeClient\config\
 +
 
 +
or
 +
 
 +
c:\Program Files\Steam\steamapps\common
  
 
once that is on, you can talk to The API at port 8080 using a browser
 
once that is on, you can talk to The API at port 8080 using a browser

Revision as of 13:34, 20 May 2021

There is a web interface API, and some web apps you can access in a browser that can talk to the GorillaXR client engine running on a local or remote machine via HTTP.

do: http://localhost:8080 to access the web server running in your local GorillaXR client.

You must enable the web server by setting this config line in ClientConfig.json : "enableWebManagement" : true

this config setting defines the server port: "webManagementPort" : 8080

located at C:\Program Files (x86)\Monkey\HyperbeClient\config\

or

c:\Program Files\Steam\steamapps\common

once that is on, you can talk to The API at port 8080 using a browser


UI - web apps

you can have a tree view of all the stuff in the zone

and a JS fiddle like thing for the content of the nodes

the js methods and such

https://ace.c9.io/

the "JS code" will just be an additional property on any object called "Code"

any JS inside that has access to the properties on the object

any JS methods listed in another property called CodeExposedInputs are available as ports on the object

CodeExposedOutputs - this is outputs. JS can call these outputs and they can be wired from

otherwise it works the same as what is there now

code

Look in the WebContent directory of the client

there you will find a folder called Hyperbe/js/classes (edited)

that has js code which talks to those ports

look especially at the files called MessageFactory.js, IndexInterface.js, PropertyDialog.js etc

oh and also the Realtime.js file

there is also a PropertyDialog.js

CommandLineInterface.js can do things like invoke methods on objects


there is a Console.jsp page which sort of does something

Does anything useful to a normal user happen if you open a browser on that port?

not really. maybe a command line from the console page I mentioned

So there is some kind of API that a JS script running on the browser can use to send commands to that port?

you can make messages and send them to the engine

look at MessageFactory.js

you can Index what is there - look a IndexInterface.js