Skip to content

New Project Setup

The SightLab projects folder is by default in Documents\\SightLab2 or Documents\\SightLab VR Projects 2.0 for SightLab 2 Beta

1. Create Your Project Folder

  • Option A: Use the "BlankProject" folder directly.
  • Option B: Make a copy of the "BlankProject" folder (recommended).

  • Option C: Create a new folder and copy over essential files:

  • SightLab_VR.py

  • SightLabVR_Replay.py
  • A folder called "Resources" with sub-folders for "environments" and "media" (also "scene_objects" if you want to have easy access to the start point, region of interest, and custom objects)

Note: The sightlab_configs, Data, and recordings folders will be created automatically when you first run your session.

While you can place your project folder anywhere on your computer, the recommended location is within the SightLab projects folder.

2. Understand Key Files

  • SightLab_VR.py: Use this for creating and running your project and leverage the GUI (note that SightLab can also be attached to any existing Vizard or SightLab script).
  • SightLabVR_Replay.py: Use this for replaying your project.
  • SightLabVR_NonGUI.py: A template for creating a scene using only code

3. Add Resources

  • Copy resources from the SampleProject, or add new assets to the following folders:

  • Resources/environments: For 3D models

  • Resources/media: For 360° media

If starting from your own folder:

  1. Create a new folder called resources.
  2. Inside resources, create two subfolders:
  3. environments (for 3D models)
  4. media (for 360° media, if needed)

4. Collect Assets

  • Add your 3D models to the resources/environments folder.
  • Add media files to the resources/media folder.
  • A good place to get started if you don't have any assets is Fab or Sketchfab (download as .glb).
  • Refer to the "Getting Models and Assets" page for more options.
  • You can also use included assets in the Sample Project or click "Built In" for using the built-in resources (note: "Built In" resources would need to be taken out of the sightlab_resources folder before they can be modified).

5. Creating Additional Projects

For new projects, you only need:

  • A copy of SightLab_VR.py
  • A copy of SightLabVR_Replay.py
  • A resources folder (with either environments or media subfolders)

Additional Resources

Troubleshooting

If you encounter any issues, try the following:

  1. Navigate to the sightlab_configs folder.
  2. Delete the recent_config file.