Merge branch 'master' of https://github.com/immersivecognition/unity-experiment-framework into master

Author: jackbrookes

README.md

@@ -1,16 +1,16 @@
 <p align="center">
-  <img src="media/banner-tp-small.png">
+  <img src="media/banner-2-0-small.png">
 </p>
 
 # UXF - Unity Experiment Framework
-A set of components which simplify human behaviour experiments developed in the Unity engine. This is the development project, if you want to download the package, do not clone this repository, see "Get Started" below. 
+A set of components which simplify human behaviour experiments developed in the Unity engine. UXF 2.0 supports Desktop, PCVR, Standalone VR, as well as Web based experiments for full remote data collection, with different data output modes. This is the development project, if you want to download the package, do not clone this repository, see "Get Started" below. 
 
 <p align="center">
   <a href="https://doi.org/10.3758/s13428-019-01242-0">
   <img src="media/uxf-paper.PNG">
   </a>
 
-  Read the [open access paper](https://doi.org/10.3758/s13428-019-01242-0) in Behavior Research Methods! Developed by Jack Brookes, Immersive Cognition Group, University of Leeds.
+  Read the [open access paper](https://doi.org/10.3758/s13428-019-01242-0) in Behavior Research Methods! The paper is now slightly out of date but gives a good overview of the motivation of this project. Developed by Jack Brookes, Immersive Cognition Group, University of Leeds.
 </p>
 
 If you have developed a project using UXF please [let me know](http://twitter.com/jackbrookes)! 
@@ -49,15 +49,15 @@ If you have developed a project using UXF please [let me know](http://twitter.co
 
 1. Import the latest ```UXF.unitypackage``` [release](https://github.com/immersivecognition/unity-experiment-framework/releases/latest) to your existing Unity project. (Drag the file into your project.)
 
-2. The UXF Setup Wizard will launch (or via the top menu: UXF > UXF Wizard) - Use it to fix any .NET compatibility issues. 
+2. The UXF Setup Wizard will launch (or via the top menu: UXF > UXF Wizard) - Use it to fix any compatibility issues. 
 
-3. Open an example scene. (UXF -> Examples -> Advanced -> AdvancedExample)
+3. Open an example scene. (e.g. UXF -> Examples -> 2_MoveToTarget -> MoveToTargetExample)
 
-4. Press play, and use the UI to create a new participant list in an appropriate directory.
+4. Press play, and use the UI to enter any details.
 
 5. Press start to begin the session.
 
-Visit the [Uncyclo](https://github.com/immersivecognition/unity-experiment-framework/wiki) for more detail.
+Visit the [Uncyclo](https://github.com/immersivecognition/unity-experiment-framework/wiki) for more details.
 
 ## Features
 
@@ -68,11 +68,11 @@ Visit the [Uncyclo](https://github.com/immersivecognition/unity-experiment-framewor
 
 ### Data collection
 
-UXF automates the process of collecting data.
+UXF automates the process of collecting data. How the data are stored depends on the platform (PC, Web, etc) as well as your configuration of different "Data Handlers". For PC platforms, you probably just want to store data in files on the PC locally. In that case, the File Saver data handler will output data in several forms: 
 
-**Behavioural data** is collected with 1 row per `Trial`, and automatically records some values such as the timestamp of the start and end of the trial. Developers can easily record observations of any type and associate them with a trial. Data is output with one row per trial in a results csv file.
+**Behavioural data** are collected with 1 row per `Trial`, and automatically records some values such as the timestamp of the start and end of the trial. Developers can easily record observations of any type and associate them with a trial. Data is output with one row per trial in a results csv file.
 
-**Continuous data** is data that is measured continuously over time during a trial. The main use case of this is to track the position and rotation of any object in the scene, which is captured at whatever frame rate the application is running at (in the `Update()` loop) by adding a `PositionRotationTracker` component to a GameObject. This can be used to track positions of user controlled objects (such as hands or head in a virtual reality application) or an arbitrary object in the scene (e.g. some kind of stimuli). However this system is generic and developers can create their own `Tracker` classes that perform measurements of any variable during trials. 
+**Continuous data** are data that are measured continuously over time during a trial. The main use case of this is to track the position and rotation of any object in the scene, which is captured at whatever frame rate the application is running at (in the `Update()` loop) by adding a `PositionRotationTracker` component to a GameObject. This can be used to track positions of user controlled objects (such as hands or head in a virtual reality application) or an arbitrary object in the scene (e.g. some kind of stimuli). However this system is generic and developers can create their own `Tracker` classes that perform measurements of any variable during trials. 
 
 Data is stored in CSV files with automatic handling of file & directory naming.
 
@@ -95,13 +95,13 @@ trial_results.csv        | Main results file (behavioural data)
 
 **Example Output** You can see an example of the data structure UXF outputs in the [example_output](example_output) folder of this repository.
 
-### Events
+### Web & Database
 
-A `UnityEvent` is invoked on `Trial` begin and end, allowing you to easily trigger presentation of stimuli at trial start (for example).
+For Web platforms, the data cannot be stored on the participant's PC. Instead, data can be uploaded to a database. UXF handles all of the hard work for you and automatically uploads the data files as long as you set up a DynamoDB database using Amazon Web Services. 
 
-### CSV Participant List
+### Events
 
-A participant list feature is used allowing experimenters to optionally pre-prepare participant information. Additionally, this participant list is shared between experiments, allowing easy cross comparison of observations within participants.  
+A `UnityEvent` is invoked on `Trial` begin and end, allowing you to easily trigger presentation of stimuli at trial start (for example).
 
 ### Settings system
 
@@ -112,13 +112,9 @@ The settings is cascading, allowing setting independent variables at a `Session`
 A UI is available (but optional) allowing loading of participant data from file (or add new participant data). Variables that are collected are customisable and can be used in the experiment (e.g. a parameter for a participant's age could be used to change the difficulty of the experiment).
 
 <p align="center">
-  <img src="media/screenshot-1.png" width=300>
+  <img src="media/uxf-ui.png" width=300>
 </p>
 
-### File IO
-
-Files are read and written in a separate thread to avoid frame drops, which can induce motion sickness in VR HMDs.
-
 ## Example
 
 UXF is built around the idea of separating the specification of your experiment (the "what") and the implementation of your experiment (the "how").