Skip to content

Commit 3002945

Browse files
Update Getting Started Doc (#44)
* Update getting-started.md Added installation tutorial and told namespace to use * Update getting-started to point to NuGet package * Update getting-started.md * Adds code closure (couldn't do on GitHub) --------- Co-authored-by: camegone <121595305+camegone@users.noreply.github.com>
1 parent 8374542 commit 3002945

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

getting-started.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# OSCQuery Quickstart
22
## Installation into your project
3-
To use OSCQuery in your project, you first need to integrate the library. This can be done by either installing it via NuGet *(not yet available)* or by building the .dll file yourself after pulling this repository.
4-
3+
To use OSCQuery in your project, you first need to integrate the library. This can be done by either [installing it via NuGet](https://www.nuget.org/packages/VRChat.OSCQuery) or by building the .dll file yourself after pulling this repository.
54
**Disclaimer:**
65
OSCQuery can itself neither receive nor send OSC, its purpose is to allow OSC services to find other services and to communicate to them what they can do. If you are looking to send OSC you can use any OSC library, like **[OscCore](https://github.com/vrchat/OscCore)** for Unity projects and **[Rug.Osc](https://bitbucket.org/rugcode/rug.osc/src/master/)** for .NET.
76

7+
## Import the Namespace into your Class
8+
9+
Make sure to import the namespace so you can use the example code below:
10+
11+
```csharp
12+
using VRC.OSCQuery
13+
```
14+
815
## Starting the OscQueryService
916

1017
The OSCQueryServiceBuilder has a [Fluent Interface](https://en.wikipedia.org/wiki/Fluent_interface) for creating and configuring the OSCQuery service. To start a service that does "all the things" using the typical settings, you can call:

0 commit comments

Comments
 (0)