Follow along with the Learn OpenMaze Video Tutorial Series to learn everything you need to know to create your first experiment!

If you are following along with the OpenMaze tutorials there may be discrepencies between instructions in the tutorial videos and most recent version of the OpenMaze software. Please make sure that you carefully read over the Release History / Change Log below to see how these changes impact the tutorial videos.

• Unity 2019.x or above.
• Your PC must meet the minimum requirements to run Unity, found here.
• OpenMaze has been extensively tested on Mac OSX and Windows 10; however, the project should still behave normally on most Linux distros.

To use this software in your experiments you will need to download the following software packages: Unity, Open Maze, Sublime Text/Text editor of choice.

1. Download and Install the Unity Hub

   1. Go to: https://store.unity.com/download?ref=personal.
   2. Follow Installation instructions for your specific computer.
   3. Open the Unity Hub application and create an account or login.

2. Download Open Maze Software

   1. Go to https://github.com/DuncanLab/OpenMaze (you're already here!).
   2. In the grey dropdown on the left side of the page called 'branch' make sure that master is selected. Alternatively, checkout the releases section for the latest release.
   3. Now, click the green button on the right hand side called Clone or Download and make sure to select Download ZIP.
   4. Unzip the file you downloaded in an easy to access place. For example, your desktop.

3. Download and Install Sublime Text:

   Please note, if you already have a text editor on your computer that is compatible with .json and .py files you can choose to skip this step and use the text editor you are most comfortable with.

   1. Go to https://www.sublimetext.com/3
   2. Follow the instruction and select the correct download for your computer.

4. Set up Unity with Open Maze

   1. Open the Unity Hub application.
   2. If you have not done so already, please log in or create a free account.
   3. Once signed in, click Open near the top right of the window.
   4. Navigate to and select the entire folder that you just unzipped and placed in an easy to access place. This folder should be titled OpenMaze-Release. Select the folder and click Open.
   5. Once the OpenMaze project has been loaded into the Unity Hub click the small yellow triangle below the project. This will create a propmt at the bottom of the screen to install the appropriate Unity version. Click install (NOTE: installing Unity takes longer than you may expect - be patient!)
   6. Once installed click the back arrow in the top left of the Unity hub window. You will now see the Unity Version code has been added beside the OpenMaze project and the yellow triangle no longer appears.
   7. Click the project to Open it in Unity. If prompted to update Unity to the newest version click no.

Congratulations! You have set up the Open Maze project. To start building your OpenMaze experiment, visit the OpenMaze website an check out our User's Manual and tutorial videos
https://duncanlab.github.io/OpenMazeSite

-1.1.0

IMPORTANT NOTES FOR UBUNTU USERS*:

1. Image File references in Configuration Files Image Files referenced in Configuration Files must end uppercase .PNG. This change must be done for all tutorial Configuration Files currently ending in lowercase .png.
2. Cannot use "space" as end key Space is currently assigned to the "TrialEndKey" in many of the tutorial configuration files. Unfortunately, space cannot be used as an end key on Ubuntu. Change Space to any other keyboard key to resolve this issue (e.g. "TrialEndKey" : "x")

*We hope to fix these issues in future releases, thanks for your patience!

new features added

1. Start button: A "Start Experiment" button has been added to the +Launch Experiment Scene.

2. Exit Experiment Button: An Exit button can be added instruction trials by adding the attribute value pair: "ExitButton": true. When this is added a button will appear at the bottom of the instruction trial and when pressed the application will close. Note: Data will be automatically saved. A URL may also be added to the ExitButton within the Unity Editor. See https://openmaze.duncanlab.org/documentation#online for more information.

3. Auto Run Configuration File: The folder "AutoRun_Config" has been added to the "Configuration_Files" folder. This folder contains the configuration file "AutoRun_Test.json". When the "AutoRun_Config" folder is moved to the "StreamingAssets" folder, the "AutoRun_Test.json" configuration will be automatically executed upon launching the experiment (i.e. you will not be prompted to select a configuration file). See https://openmaze.duncanlab.org/documentation#test for more information

4. HUD Features: The Trial Attribute "Header" has been changed to "DisplayText" - functionality remains the same. "DisplayText" can also be added to Blocks "DisplayImage" can be added to any Trial to display an image in the HUD. "ShowTrialTotal", "ShowBlockTotal" and "ShowNumSuccesses" can be added to Blocks or Trials. See https://openmaze.duncanlab.org/documentation#configT for more information.

Tutorial Videos Discrepencies

Note: Descrepencies listed below are in addition to the discrepencies detailed in previous release notes.

All Tutorials: Start button is now used to start the experiment rather than the space bar. "Header" attribute has been changed to "DisplayText". All Tutorial Configuration Files have been updated with this change, however video tutorial files will still have "Header" attribute.

Tutuorial 2 - Building 3D Environment: Textures used when creating terrains differ from the textures now available with OpenMaze. Simple choose the textures that closely resemble those in the tutorial, or pick your own from the new textures included.

• 1.0.1

  new features added

  1. Start button - a "Start Experiment" button has been added to the +Launch Experiment Scene.
  2. Exit Experiment Button - Exit Experiment button can be added instruction trials by adding the attribute value pair: "ExitButton": true. When this is added a button will appear at the bottom of the instruction trial and when pressed the application will close. Note: Data will be automatically saved.
  3. Default Configuration File - the folder Default_Config has been added to the StreamingAssets folder. If there is a configuration file within this folder, the experiment will automatically load this configuration file instead of prompting the experimenter/participant to select a configuration file through the file browser. Only one configuration file should be added to this folder.

  Changes to Download & Setup

  1. Unity has recently deprecated the Standard Assets package. Because of this we have changed the release so that it already includes all the standard assets needed. There is no longer a need to download any additional asset packs from the Unity asset store after launching OpenMaze.

  Tutorial Videos Discrepencies

  1. Tutorial 1 - Download, Install and Setup - OpenMaze no longer requires you to download Nature Starter Kit 2 or StandardAssets disregard these instructions in the tutorial video.
  2. Tutorial 2: Building 3D Environment - Textures used when creating terrains differ from the textures now available with OpenMaze. Simple choose the textures that closely resemble those in the tutorial, or pick your own from the new textures included.
  3. All Tutorials - Start button is now used to start the experiment rather than the space bar.

• 1.0.0 This is the first official release version of OpenMaze Experiment Toolbox for the Unity Engine. This version was released with the publication "OpenMaze: An Open Source Unity Toolbox for Creating Virtual Environment Experiments" and was used to create the "Learn OpenMaze in a Day" video tutorial series (https://www.youtube.com/playlist?list=PLppXGUtW-XlIuTh-lW6URgm5Cim_DH4gL). For more information about the OpenMaze Toolbox please visit https://openmaze.organica.dev/

• 0.1.0 Beta Testing Release

Please read Contributing for details on the process for submitting pull requests to us.

We use SemVer for versioning. For the versions available, see the releases on this repository.

Please feel free to reach out to current project maintainers for help working with OpenMaze.

• Kyle Nealy - Project Owner - GitHub
• Alex Gordienko - Contributor - GitHub
• Cody Howarth - Contributor - GitHub

See also the list of contributors who participated in this project.

This project is licensed under the MIT License.

• File browser used: https://github.com/gkngkc/UnityStandaloneFileBrowser

This website and software is not sponsored by or affiliated with Unity Technologies or its affiliates. Unity Trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere