Getting started - glitchfur/NeosVR-Headless-API GitHub Wiki

Prerequisites

You will need

  • A Linux distribution with a working headless client setup.
  • Minimum Python version is 3.7, recommended is 3.9 or later. Python 2 is not supported.

Setup

Clone this repository and change directories into it.

git clone https://github.com/glitchfur/NeosVR-Headless-API
cd NeosVR-Headless-API

Next, create a virtual environment, activate it, and install the required packages. There's only a few, so it shouldn't take long.

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Notes:

  • On some distributions Python 2 is still the default instead of Python 3. Make sure you are using Python 3. You may need to explicitly use python3 instead of python for these commands.
  • The second line assumes you're using bash. If you're using another shell you'll have to use one of the other activation scripts in the bin directory.
  • Depending on your distribution, you may need to install another package to be able to create virtual environments. Follow the instructions that appear on screen or follow your distribution's documentation for info on how to do this.

After that, we should be good to go. Head over to Starting a local headless client to learn how to use NeosVR-Headless-API.

⚠️ **GitHub.com Fallback** ⚠️