Welcome to the Suite for the Assessment of Low Level cues on Orientation (SALLO) Unity Package. SALLO is a comprehensive suite of tools designed to simplify the development of psychophysical experiments focused on spatial orientation in Unity projects.
SALLO is built on the understanding that psychophysical experiments can be divided into four essential sub-elements:
- Stimulus: Define and manipulate the visual or sensory stimuli presented to participants.
- Task: Implement experimental tasks that participants need to perform in response to the stimuli.
- Psychophysical Method: Apply various psychophysical methods to quantify perceptual experiences.
- Spatial Positioning: Control the spatial arrangement and positioning of elements within the virtual environment.
Therefore, SALLO includes template game objects and base components that cover each sub-element of the psychophysical experiment. The tools included in SALLO provide a reference base that developers can customize easily to their needs, so as to speed up and simplify the experiment development.
Import SALLO in your project using Unity's Package Manager.
With Unity's package manager you can install packages directly from a remote repository or download the packages and install them from the local folder. Currently, there are some issues with importing SALLO from git URL, as the package manifest meta file (package.json.meta) do not get imported. Therefore, we recommend the installation from local folder.
To do so, put the content of this repository in your Unity project folder /Packages in one of the following ways:
- Downloading and extract this repo in it
- Initialize a git folder in it and pull this repo in it.
Then, in your open Unity project:
- Go to
Window>Package Manager. - Click on the add (+) button, choosing the
Add package from diskoption. - select the package.json file of this repo
- You're all set! You can now start using the SALLO tools in your Unity project.
In your open Unity project:
- Go to
Window>Package Manager. - Click on the add (+) button, choosing the
Add package from git URLoption. - copypaste the git url to this repository and click import
- You're all set! You can now start using the SALLO tools in your Unity project.
The QUEST implemented in SALLO requires the Python for Unity package, which in turn requires python 2.7. If you want to use the QUEST algorithm, make sure to have it installed on your machine and added to your path. Check the Python for Unity installation guide for additional info.
SALLO contains a sample experiment to get you started quickly. The sample experiment requires the Unity Experiment Framework. You can install it from their github page, or you can import the unitypackage file of the UXF version provided within the SALLO sample experiment folder.
For more detailed instructions and examples, please refer to the SALLO research paper and to the SALLO API Documentation.
We welcome contributions to the SALLO package! If you have ideas for new features, improvements, or bug fixes, please let us know. If you develop new tools that you think may be beneficial to the community, please add them to the SALLO package in the corresponding folder.
If you encounter any issues or have questions about using the SALLO package, feel free to open an issue on the GitHub repository. We'll be happy to assist you!
The Suite for the Assessment of Low Level cues on Orientation (SALLO) package is released under the GNU General Public License v3.0.
Designed and maintained by Davide Esposito (https://www.linkedin.com/in/davide-esposito-438116161/)
Disclaimer: This software is provided as-is and without any warranty. Use at your own risk.
Please acknowledge this project if you use it for academic or research purposes by citing:
Esposito, D., Bollini, A. & Gori, M. The Suite for the Assessment of Low-Level cues on Orientation (SALLO): The psychophysics of spatial orientation in virtual reality. Behav Res (2023). https://doi.org/10.3758/s13428-023-02265-4