Official Driver for the eteeControllers in SteamVR.
Explore the wiki »
Report Bug
·
Request Feature
Table of Contents
This repository contains the OpenVR driver source files and deployable builds for TG0 etee devices. This driver allows for the etee hardware devices to integrate into the SteamVR platform.
- Open a command prompt.
- Change the current working directory to the location where you want the cloned directory.
- Type git clone, and then paste the URL for the Github repository.
git clone https://github.com/eteeXR/etee-OpenVR-Driver.git
Depending on your needs, you might decide to use (a) deployable drivers (i.e. ready-to-use) or (b) build and test your own driver changes.
Description: Device drivers ready to be used in SteamVR.
Located in the /deployable folder, you can find different versions of available drivers which can be directly used with your SteamVR application.
To deploy the selected etee VR driver, follow the instructions in Step 3.
Description: Build and test your own custom driver changes in SteamVR.
Otherwise, if you want to test your code changes, please check our Building documentation in the wiki.
Copy the desired etee driver folder to the SteamVR drivers folder, usually located in:
C:\Program Files (x86)\Steam\steamapps\common\SteamVR\drivers
For deployable drivers, unzip the desired version and drag the etee folder inside it to the SteamVR drivers folder above.
For custom driver builds, make sure that the driver folder you build is in Release mode. See more at: Building documentation.
Add the path location of the desired driver folder to the openvrpaths.vrpath file, in the external_drivers array. Make sure to use proper JSON formatting with double dashes and correct comma placement. Use a validator to check the JSON format is correct, as SteamVR will overwrite the file when improper formatting or errors cause the driver to not activate.
A common location for the "openvrpaths.vrpath" file is:
C:\Users\<username>\AppData\Local\openvr
For example, if you're using a deployable driver, first unzip the version of the driver you wish to deploy. Then, format your "openvrpaths.vrpath" file as described above. The file might look similar to this:
{
"config" :
[
"c:\\program files (x86)\\steam\\config"
],
"external_drivers" :
[
"C:\\Users\\MyUser\\Documents\\etee-OpenVR-Driver\\deployable\\etee-vr-driver_1.4.1-release\\etee"
],
"jsonid" : "vrpathreg",
"log" :
[
"c:\\program files (x86)\\steam\\logs"
],
"runtime" :
[
"C:\\Program Files (x86)\\Steam\\steamapps\\common\\SteamVR"
],
"version" : 1
}If you want to use your custom driver build, then your path may look like:
"external_drivers" :
[
"C:\\Users\\MyUser\\Documents\\etee-OpenVR-Driver\\build\\Release\\etee"
],Note: The order of the external_drivers paths are important.
If you have downloaded our eteeConnect app, then you will see its path in the external_drivers array, pointing at our official driver release. Do not delete the eteeConnect path, simply paste your desired new etee driver path before it. SteamVR will executes the external drivers in order, and when two of the same driver are available, it ignores the second one if the first one successfully activates.
This driver allows the etee hardware devices to connect the SteamVR platform.
The etee OpenVR driver will automatically activate when an eteeDongle is detected in a PC or laptop COM port. If the driver is active, you will see the controller icons change to the etee ones.
etee devices icons active in the SteamVR Status Window.
The device firmware versions required for this driver version is:
- eteeController(s) Firmware:
1.3.7.stable.0or higher.
Note: Firmware for etee devices can be updated through the official eteeConnect app, under the ‘Settings ‣ Firmware’ Section.
For further information on how to prepare your physical devices, check our Quickstart Guide.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue to describe your suggestion or report a bug.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
To help us and the community easily identify the nature of your commit or issue, use semantic type prefixes to precede your message / title.
Some common type prefixes include:
feat: A new feature for the user, not a new feature for a build script.fix: Bug fix for the user, not a fix for a build scripts.enhanc: Enhancement or improvement to existing feature.perf: Code improved in terms of processing performance.refactor: Refactoring production code (e.g. renaming a variable).chore: Changes to the build process or auxiliary tools and libraries.docs: Changes to documentation.style: Formatting, missing semicolons, etc. No code change.vendor: Update version for dependencies and other packages.test: Adding missing tests or refactoring tests. No production code change.
Format: <type>(<scope>): <subject>, where < scope > is optional.
For example, your commit message header might look like this:
feat(imu): Implemented Euler angles estimation from quaternion
For more references and guides on semantic code messages, see:
- How are you writing a commit message? - by Darkø Tasevski
- Git Commit Msg - Karma by Friedel Ziegelmayer
This repository was created by the TG0 team, for the etee brand.
Code and documentation authors include:
- Daniel Willmott
- Pilar Zhang Qiu
- Harvey Upton
Distributed under the Apache 2.0 License. See LICENSE.txt for more information.
For any queries or reports, please use the Issues tab in this repository. When possible, use an identifier to help us describe your query, report or request. See more at: Semantic Type Prefixes.
For further support or queries, you can contact us:
- Support e-mail: customer@eteexr.com
- Support Form: https://eteexr.com/pages/support-form