BeeVR

The goal of this project is to provide a ready-to-use software for animal behaviour experiments in Virtual Reality
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

BeeVR was developed by Gregory Lafon as a tool to perfom visual conditionning of Honeybees (Apis mellifera) under Virtual Reality conditions. It is designed to be easy to use and adaptable to a variety a conditionning protocole. The source code is made available here in the hope of facilitating progress in the field of visual learning in insects by providing a simple software to run and record VR experiments. The software is already useable as is but there's still room for a lot of improvement.

Built With

• Game Engine: Unity

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Walking compensator with two mice optic detector at 90° of each other.
• Cylindrical or semi-spherical screen
• Video projector
• Computer running windows with at least 62 Mo of disc space
• You can get stl files to print the treadmill yoursefl there 3D Printed Assets

Installation

1. Get the lastes release

2. Unzip in your prefered folder

3. You're ready to go. See the documentation for more information on how to run the software.

Usage

For an exemple of what can be done with this software see: Lafon, G. et al. (2021)

Here's the documentation for more information on how to run the software.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

If you need a new feature to run your own experiments or have ideas to improve the existing ones contributions are very much welcome.

1. Fork the Project
2. Create your Feature Branch (git branch NewFeature)
3. Makes "NewFeature" the active branch (git checkout NewFeature)
4. Commit your Changes (git commit -m 'Add some new feature')
5. Push to the Branch (git push origin NewFeature)
6. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

When using BeeVR in your work please consider citing our original work:

• DOI: https://doi.org/10.1038/s41598-021-00630-x

• How to cite:

Lafon, G., Howard, S.R., Paffhausen, B.H. et al. Motion cues from the background influence associative color learning of honey bees in a virtual-reality scenario. Sci Rep 11, 21127 (2021).

Contact

Grégory Lafon - gregory.lafon@univ-tlse3.fr

Acknowledgements

• Université Toulouse III Paul Sabatier
• CBI-CRCA
• EXPLAIN team

Dependencies

• ManyMouseUnity plug-in: ManyMouseUnity
• File browser: UnitySimpleFileBrowser
• README-Template: Best-README-Template