initial upload

experiment-scripts/README.md

@@ -0,0 +1,16 @@
+# README
+
+The documentation for most files can be found inside the file itself.
+The most important files are:
+
+ - control.py: For setting up the conditions
+ - app.py: For running the HTML user interface
+ - server.py: For running the relay server
+ 
+ To setup the experiment environment, you should:
+  1. Connect the HMDs to same network as the server
+  2. Start the relay server (i.e. server.py)
+  3. Start the HTML user interface (e.g. using `fastapi dev app.py`)
+  4. Communicate the server IP to the HMDs using `TARGET_IP=<HMD IPs> python3 control.py 'IP:<server ip>'`
+  5. Setup the desired condition (see control.py for more information)
+  6. Shuffle the word-list (i.e. word-list.txt); on linux this can be achieved using shuf e.g. `shuf word-list.txt > word-list-shuffled.txt`