32 lines
2.2 KiB
Markdown
32 lines
2.2 KiB
Markdown
## Shapes
|
|
|
|
A GPU-based real-time vector graphics library for Unity by [Freya Holmér](http://twitter.com/FreyaHolmer).
|
|
|
|
[Website](https://acegikmo.com/shapes/) • [Documentation](https://www.acegikmo.com/shapes/docs/) • [Changelog](https://www.acegikmo.com/shapes/changelog/) • [Feedback / Report Bugs](https://shapes.userecho.com/)
|
|
|
|
Shapes will let you draw high-quality vector graphics such as lines, polylines, discs, rings, spheres, and other primitives, many of which with an infinite resolution, achieved using ~~witchcraft~~ shader math, rather than relying on high-resolution textures or a high polygon density.
|
|
|
|
Essentially - I got tired of how Unity was lacking in drawing vector primitives, and yet these things were ubiquitous in 2D environments like html5 canvas. I basically just wanted that, without having to leave Unity and C# because they're so neat~ and who uses javascript gosh
|
|
|
|
If you want to share your creations on twitter, feel free to tag me [@FreyaHolmer](http://twitter.com/FreyaHolmer) or use #madewithshapes! I'd love to see your work!
|
|
|
|
Made possible by the support of the wonderful people on [Patreon](https://www.patreon.com/acegikmo), thank you all so much!! 💖
|
|
|
|
## Installation
|
|
##### As a Submodule _(recommended for easy versioning and updates)_
|
|
* In your git client, add Shapes as a submodule at `.../Assets/Shapes`
|
|
* Note that you need the TextMeshPro package installed to use Shapes
|
|
##### Direct Download (very much not recommended, I'm judging you just for even contemplating reading this section)
|
|
* Click Clone or Download, then Download ZIP and put it in `.../Assets/Shapes`
|
|
* Note that you need TextMeshPro installed to use Shapes
|
|
|
|
## Getting Started
|
|
* Shapes (component-based) can be found in the menu bar under `Shapes/Create/...`
|
|
* Immediate mode shapes are in the Shapes namespace, eg: `Shapes.Draw.X`
|
|
* Full Documentation at [acegikmo.com/shapes](https://acegikmo.com/shapes)
|
|
|
|
## License & Legal
|
|
Legal TLDR: Treat Shapes like a commercial product you license through my Patreon, on a pay-what-you-want-but-at-least $10 basis, with further support very much encouraged, but not required for those who can't~
|
|
|
|
[Full legal details here](https://github.com/acegikmo/Shapes/blob/master/LICENSE)
|