BCIEssentials

A Unity package for development of BCI applications. This environment needs BCI-essentials-Python to work properly.

Getting Started

• Wiki – More detailed installation instructions and tutorials.
• API documentation

Install into Unity Project

Follow these instructions to install BCI Essentials as a package to an existing Unity project. For instructions on how to add packages hosted on Github using Unity's Package Manager click here

1. Install LSL4Unity Package using git URL: https://github.com/labstreaminglayer/LSL4Unity.git
2. Install BCI Essentials package using git URL: https://github.com/kirtonBCIlab/bci-essentials-unity.git

Note - tested with Uniy version 2021.3.15.f1, other editor versions might work but they have not been tested.

Running Sample

1. Using Package Manager, select the BCI Essentials package and import the sample named Original P300 Controller
2. Open the test scene located in: Assets > Samples > BCI Essentials > 1.0.0 > Original P300 Controller > Scenes > P300Training.Unity
3. Select the P300 object in the Hierarchy menu on the left hand side. This will open the inspector on the right hand side. Here you can modify the settings for the P300 controller.
4. Select the play button at the top-middle of the window.
5. You are now running a P300 BCI paradigm. You can use the keys detailed below to control the interface.

Key	Action
T	Begin training sequence
S	Start/stop stimulus
I	Begin interactive training (MI paradigm only)
U	Do user training, stimulus without BCI
0-9	Select objects from 0-9 when stimulus is on

Contribution Setup Guide

This project is no longer hosted as a skeleton Unity project, containing only package contents.

Pulling will break a local copy of version 1.2.0 or earlier

Contributors are recommended to follow the following steps to set up their local development projects:

1. Create an empty Unity project
2. Install LSL4Unity Package using git URL: https://github.com/labstreaminglayer/LSL4Unity.git through the Unity package manager
3. Clone the repository into your project under Packages/com.bci4kids.bciessentials
   • The Folder Name Has to Match

The Wiki Page contains more detailed instructions and shell scripts to automate this setup process.