Skip to content

Commit 2c05207

Browse files
authored
update readme
1 parent f4b028f commit 2c05207

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
## Download unitypackage
2-
For Unity 2017.3 and later: [SpriteGlow.unitypackage](https://github.com/Elringus/SpriteGlow/releases/download/v1.6-release/SpriteGlow.unitypackage). Check [releases](https://github.com/Elringus/SpriteGlow/releases) for previous versions support.
3-
4-
Please be aware that you don't need to clone the whole repository in order to use the extension in your project. Either download package from the link above or extract `Assets/SpriteGlow` folder from the repository project – it contains all the required assets; other stuff is just for testing purposes.
1+
## Installation
2+
Either download and import a [standalone Unity package](https://github.com/Elringus/SpriteGlow/releases/download/v1.7-alpha/SpriteGlow.unitypackage) or add `"com.elringus.spriteglow": "https://github.com/Elringus/SpriteGlow.git#package"` as a dependency for your project's `Packages/manifest.json` ([guide](https://docs.unity3d.com/Manual/upm-git.html)).
53

64
## Description
75
The glow effect is achieved using sprite outline in HDR colors (applied via shader) and bloom post-processing.
@@ -48,4 +46,8 @@ Make sure 'Threshold' value of the bloom image effect is set high enough. It's u
4846
Most likely the outline shader is not included to the build (it happens when none of the included assets reference SpriteGlow component directly). You can force-include the shader by assigning it to the "Always Included Shaders" in Edit -> Project Settings -> Graphics.
4947

5048
### It's still not working
51-
Please check the active [issues](https://github.com/Elringus/SpriteGlow/issues).
49+
Make sure you're using a compatible Unity version; supported versions per release are available on the [releases page](https://github.com/Elringus/SpriteGlow/releases).
50+
51+
Download (clone) this repository and examine the example scenes, comparing them with your setup. Chances are, you've misconfigured something.
52+
53+
In case nothing of the above helps, check the active [issues](https://github.com/Elringus/SpriteGlow/issues) or open a new one. Don't forget to include the full [error log](https://docs.unity3d.com/Manual/LogFiles.html), detailed information about your system, Unity version, package version and steps required to reproduce the issue.

0 commit comments

Comments
 (0)