You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,9 @@ A set of C# scripts which simplifies management of human-based experiments devel
5
5
6
6
## Get started
7
7
8
-
Import the latest ```.unitypackage```[release](https://github.com/jackbrookes/unity-experiment-framework/releases) to your existing Unity project.
8
+
1.Import the latest ```UXF.unitypackage```[release](https://github.com/jackbrookes/unity-experiment-framework/releases) to your existing Unity project.
9
9
10
-
Note: Users must change API Compatibility Level to .NET 2.0 in Unity player settings.
10
+
2. In Unity, go to `Edit` -> `Player` -> `Other` and change API Compatibility Level to .NET 2.0 in Unity player settings.
11
11
12
12
13
13
## Features
@@ -19,7 +19,7 @@ Note: Users must change API Compatibility Level to .NET 2.0 in Unity player sett
19
19
20
20
### Data collection
21
21
22
-
ExpMngr automates the process of collecting behavioural and movement data. **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.
22
+
UXF automates the process of collecting behavioural and movement data. **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.
23
23
**Movement data** is 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 `Tracker` 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).
24
24
Data is stored in CSV files with automatic handling of file & directory naming.
25
25
@@ -54,6 +54,7 @@ UXF classes will be useful in two main parts of your project:
54
54
```csharp
55
55
classExperimentBuilder : Monobehaviour
56
56
{
57
+
57
58
// set this to your Session instance in the inspector
58
59
public UXF.Sessionsession;
59
60
@@ -85,6 +86,7 @@ class ExperimentBuilder : Monobehaviour
85
86
```csharp
86
87
classSceneManipulator : MonoBehaviour
87
88
{
89
+
88
90
public UXF.Sessionsession;
89
91
90
92
...
@@ -111,9 +113,7 @@ class SceneManipulator : MonoBehaviour
111
113
}
112
114
```
113
115
114
-
115
-
See `Assets/ExpMngr/ExampleScript.cs` for another simple example.
0 commit comments