Skip to content

Commit bcf0eda

Browse files
committed
readme
1 parent 22b0949 commit bcf0eda

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
OVRSharp is a high-level idiomatic C# interface for working with the OpenVR API.
44

5+
## Installation
6+
7+
> **Note:** While OVRSharp does technically come packaged with `openvr_api.dll`, you will need to distribute it yourself alongside your application executable. You can download it [here](https://github.com/ValveSoftware/openvr/tree/master/bin) for the platform you are targeting.
8+
>
9+
> We are currently exploring options to automatically distribute the appropriate DLL alongside OVRSharp.
10+
11+
OVRSharp is available on [NuGet](https://www.nuget.org/packages/OVRSharp), so you can install it just like any other NuGet package:
12+
13+
```shell
14+
# .NET CLI
15+
dotnet add package OVRSharp
16+
17+
# VS PowerShell
18+
Install-Package OVRSharp
19+
```
20+
21+
## Usage
22+
523
Right now, our main goal with this is to make working with the overlay API easier and more C#-like, as well as being entirely platform-agnostic. So you could use this all on its own in your own .NET Core project, or throw it into Unity and work with it there.
624

725
Later on, we plan on supporting basically the entirety of the OpenVR API, so you don't need to deal with pointers and stuff. Just write C# as you would expect.
@@ -73,8 +91,14 @@ if (overlayErr != EVROverlayError.None)
7391
}
7492
```
7593

76-
Docs coming Soon™️.
94+
If you encounter anything that is not natively supported by OVRSharp, you can always use the internal `Valve.VR` APIs. An instance of `CVRSystem` is accessible through `Application`, as `OVRSystem`.
95+
96+
If you run into something you would really like to see supported, feel free to open an issue describing your use case! That will help us prioritize what functionality to add next.
7797

7898
## Examples
7999

80-
OVRSharp is currently being used in [WhereIsForward](https://github.com/OVRTools/WhereIsForward), and in some unreleased projects.
100+
OVRSharp is currently being used in [WhereIsForward](https://github.com/OVRTools/WhereIsForward), and in some unreleased projects.
101+
102+
## License
103+
104+
MIT

0 commit comments

Comments
 (0)