Skip to content
This repository was archived by the owner on Nov 25, 2025. It is now read-only.

Commit a63f157

Browse files
Added installation info back
1 parent 7261d8a commit a63f157

File tree

1 file changed

+22
-7
lines changed
  • Bindings/Packages/com.virtualmaker.bindings/Documentation~

1 file changed

+22
-7
lines changed

Bindings/Packages/com.virtualmaker.bindings/Documentation~/README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,28 @@ The VirtualMaker Bindings library provides a robust system for creating and mana
66

77
## Installation
88

9-
To install the VirtualMaker Bindings library, add the following line to your `Packages/manifest.json` file in the `dependencies` section:
9+
Requires Unity 2020.3 LTS or higher.
1010

11-
```json
12-
"dependencies": {
13-
"com.virtualmaker.bindings": "https://github.com/virtual-maker-net/com.virtualmaker.bindings.git?path=/Bindings/Packages/com.virtualmaker.bindings#main"
14-
}
15-
```
11+
Once submitted and approved, the recommended installation method will be though the unity package manager and [OpenUPM](https://openupm.com/packages/com.virtualmaker.bindings), but through the Unity Package Manager and Git url will suffice in the meantime.
12+
13+
### Via Unity Package Manager and Git url
14+
15+
- Open your Unity Package Manager
16+
- Add package from git url: `https://github.com/virtual-maker-net/com.virtualmaker.bindings.git#upm`
17+
18+
### Via Unity Package Manager and OpenUPM
19+
20+
- Open your Unity project settings
21+
- Select the `Package Manager`
22+
![scoped-registries](images/package-manager-scopes.png)
23+
- Add the OpenUPM package registry:
24+
- Name: `OpenUPM`
25+
- URL: `https://package.openupm.com`
26+
- Scope(s):
27+
- `com.virtualmaker`
28+
- Open the Unity Package Manager window
29+
- Change the Registry from Unity to `My Registries`
30+
- Add the `Bindings` package
1631

1732
## Creating a `Property<T>`
1833

@@ -21,7 +36,7 @@ To create a property, simply instantiate the `Property<T>` class with the desire
2136
```cs
2237
using VirtualMaker.Bindings;
2338

24-
public class Ex ampleComponent : MonoBehaviour
39+
public class ExampleComponent : MonoBehaviour
2540
{
2641
[SerializeField]
2742
private Property<int> _intProperty = new();

0 commit comments

Comments
 (0)