Data

Tools

Indexes

Applications

Experiments

Open Source Science

headsup

Utility server and web application to observe Unity-based VR tasks operating on headsets via LAN.

https://github.com/brain-development-and-disorders-lab/headsup

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization brain-development-and-disorders-lab has institutional domain (sites.wustl.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.3%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

Utility server and web application to observe Unity-based VR tasks operating on headsets via LAN.

Basic Info
  • Host: GitHub
  • Owner: Brain-Development-and-Disorders-Lab
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 1.17 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 2 years ago · Last pushed 12 months ago
Metadata Files
Readme License Citation

README.md

Headsup

Headsup is a control panel to remotely monitor and interact with VR headsets over LAN while delivering behavioral experiments to participants.

Headsup client dashboard

Requirements

  1. VR application created using Unity. Both CaptureManager.cs and HeadsupServer.cs must be added to the Unity project and integrated as described in the README.
  2. Local network without restrictions on peer-to-peer communications. There has been mixed success using private networks (enterprise, research facility) that are centrally administered. A very effective alternative is to purchase an inexpensive router (e.g. TP-Link Archer AX1500) and connect all headsets and client dashboard to this network.
  3. Knowledge of the local IP address of the VR headset. This can easily be found via the network settings menus, within the Wi-Fi connection details.

Components

Client: Dashboard UI presenting a screenshot feed and debugging information via a web browser.

Unity: Required Unity scripts for VR applications to stream information.

Considerations

  • Screenshots / streaming of the display content is very limited. Screenshots can be obtained, but capture results in a brief delay in the VR application while the PNG / JPG is processed. This is a technical limitation, this process must be performed on the main thread. Utilizing libraries such as UnityRenderStreaming has also generated mixed results, with significant framerate instability.

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Issues and Feedback

Please contact Henry Burgess <henry.burgess@wustl.edu> for all code-related issues and feedback.

Owner

  • Name: Brain Development and Disorders Lab
  • Login: Brain-Development-and-Disorders-Lab
  • Kind: organization
  • Email: corpuscallosumresearch@wustl.edu
  • Location: United States of America

Brain Development and Disorders Lab at Washington University School of Medicine, Department of Neuroscience, St. Louis MO

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Burgess"
  given-names: "Henry"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "Software name"
version: 1.0.0
doi: 10.0000/code.0000
date-released: 2024-02-02
url: "https://github.com/Brain-Development-and-Disorders-Lab/"

GitHub Events

Total
  • Push event: 10
  • Pull request event: 1
  • Create event: 1
Last Year
  • Push event: 10
  • Pull request event: 1
  • Create event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • fdzdani (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

client/package.json npm
  • @types/react ^18.2.66 development
  • @types/react-dom ^18.2.22 development
  • @typescript-eslint/eslint-plugin ^7.2.0 development
  • @typescript-eslint/parser ^7.2.0 development
  • @vitejs/plugin-react ^4.2.1 development
  • eslint ^8.57.0 development
  • eslint-plugin-react-hooks ^4.6.0 development
  • eslint-plugin-react-refresh ^0.4.6 development
  • typescript ^5.2.2 development
  • vite ^5.2.0 development
  • @chakra-ui/icons ^2.1.1
  • @chakra-ui/react ^2.8.2
  • @emotion/react ^11.11.4
  • @emotion/styled ^11.11.5
  • axios ^1.7.2
  • dayjs ^1.11.11
  • framer-motion ^11.2.10
  • lodash ^4.17.21
  • react ^18.2.0
  • react-dom ^18.2.0
client/yarn.lock npm
  • 410 dependencies