# Sesame companion tool for easy file access

This companion tool can be used together with the Sesame Unity project. The app can either be installed by using the executable at the root of this repository, or by building it yourself using node.js. All documentation can be found in the Unity project repository. 

## Links

Link to the Unity project: [https://c4science.ch/source/sesame-unity/](https://c4science.ch/source/sesame-unity/)

Link to the Configurator project: [https://c4science.ch/source/sesame-configurator/](https://c4science.ch/source/sesame-configurator/)

## Requirements

If you are using the companion app on a Windows system, there are no prerequirements.

In order to access files on an Oculus Quest 2, the **Android Platform Tools** must be installed. They can be downloaded here: [developer.android.com](https://developer.android.com/studio/releases/platform-tools). Please make sure to add the installation path to the PATH environment variable in case this is not done automatically. 

## Build

In order to build de app, node.js must be installed. Following commands can then be used.

```
npm install
npm run make
```

The executable will be stored in the folder `out/make/[build target]`.

## Contributors

Project Manager: Houda Chabbi

Project Designer & Developer: Nicolas Baeriswyl

## Licence

Copyright 2022 iCoSys and iSIS Research Institutes, HEIA-FR, HES-SO-FR

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.