Skip to content

Commit 25e8bc7

Browse files
committed
update readme
1 parent 11f8346 commit 25e8bc7

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
[![Releases](https://img.shields.io/github/release/GieziJo/ScriptableObjectVariant.svg)](https://github.com/GieziJo/ScriptableObjectVariant/releases/latest)
2+
[![openupm](https://img.shields.io/npm/v/ch.giezi.tools.scriptableobjectvariant?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/ch.giezi.tools.scriptableobjectvariant/)
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://github.com/GieziJo/ScriptableObjectVariant/blob/master/LICENSE.txt)
4+
15
# Scriptable Object Variant for Unity (Scriptable Object Data Overrider)
26
## Description
37
Adds a field to any scriptable object tagged with the `[SOVariant]` attribute that lets you select an original SO (parent) and override selected fields in the child object.
@@ -85,16 +89,24 @@ The visual interface is implemented in [Odin](odininspector.com/)'s [`OdinProper
8589
The data with the parent and the overriden fields is kept serialized inside the asset's metadata, set in unity with `AssetImporter.GetAtPath(AssetDatabase.GetAssetPath(targetObject)).userData`.
8690

8791
## Installation
88-
> Requires [Odin](odininspector.com/) to be installed
92+
> Requires [Odin](odininspector.com/) to be installed before adding the package
8993
### Using Unity's package manager
9094
Add the line
9195
```
9296
"ch.giezi.tools.scriptableobjectvariant": "https://github.com/GieziJo/ScriptableObjectVariant.git#master"
9397
```
9498
to the file `Packages/manifest.json` under `dependencies`, or in the `Package Manager` add the link [`https://github.com/GieziJo/ScriptableObjectVariant.git#master`](https://github.com/GieziJo/ScriptableObjectVariant.git#master) under `+ -> "Add package from git URL...`.
9599

100+
### Using OpenUPM
101+
The package is available on [OpenUPM](https://openupm.com/packages/ch.giezi.tools.scriptableobjectvariant/).
102+
OpenUPM packages can be installed in different ways:
103+
- via [OpenUPM CLI](https://github.com/openupm/openupm-cli): `openupm add ch.giezi.tools.scriptableobjectvariant`
104+
- by downloading the [`.unitypackage`](https://package-installer.glitch.me/v1/installer/OpenUPM/ch.giezi.tools.scriptableobjectvariant?registry=https%3A%2F%2Fpackage.openupm.com) and adding it to your project with `Assets > Import Package > Custom Package...`.
105+
106+
the package will be added as a scoped registry, which you can inspect under `Project Settings > Package Manager > OpenUPM`.
107+
96108
### Alternative
97-
Copy the content of `Editor` to your Editor folder inside Unity.
109+
Download and copy all files inside your project.
98110

99111
## Known issues and tweaks to be made
100112
<details>

0 commit comments

Comments
 (0)