diff options
author | Christian Klinger | 2016-05-18 14:09:07 +0200 |
---|---|---|
committer | Christian Klinger | 2016-05-18 14:09:07 +0200 |
commit | e40239dd30c03fb245b9d41663237c1923c6a543 (patch) | |
tree | 941698640009f619c01cdd32d3c493f68c4e655f /README.md | |
parent | . (diff) | |
download | pvs2-e40239dd30c03fb245b9d41663237c1923c6a543.tar.gz pvs2-e40239dd30c03fb245b9d41663237c1923c6a543.tar.xz pvs2-e40239dd30c03fb245b9d41663237c1923c6a543.zip |
provided sample configuration.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 38 |
1 files changed, 37 insertions, 1 deletions
@@ -3,7 +3,43 @@ Pool Video Switch 2 Developer and Integrator documentation ------------------------------------------------------ -### Configuration files +### Configuration File +The configuration file should be saved as `/opt/openslx/pvs2/pvs2.ini`. As this +extension is stateless the same set of files is used by both client and manager. + +A sample configuration can be found in `sample_configuration`. + +#### General settings + +* rooms: list all rooms that should be available to users + +* allowClientQuit: If set to true, users can shut down the client by clicking on + "Quit" in the toolbar of pvsclient. + + +#### Room settings +A room section represents a physical or virtual room where clients are +placed on defined positions. Viable configuration options are: + +MUST: + +* mgrIP: The ip of the instructor's PC + +* client: An array containing all clients and their positions. For the exact + syntax compare with the provided sample configuration + +CAN: + +* backgroundImage: Path to an image file that will be drawn as a background behind the room window + +* gridSize: size of the grid, defaults to minimal size to fit all clients on the + screen + +* clientSize: size of the clients on the grid. In combination with a big grid. + This allows you to create well-detailed room configurations. + +* priority: Important for the auto-connect feature, but also affects the sorting + in the connect window of the client. ### Lock/Unlock Scripts The functionality of PVS client(`pvsclient`) can be extended by providing |