|
8 | 8 | [](https://discord.gg/xWGh4GskG5) |
9 | 9 | [](https://ko-fi.com/T6T8WZD0W) |
10 | 10 |
|
11 | | -plenticons is a pack of icons to use with custom nodes in the [Godot] editor. |
| 11 | +A pack of icons to use with custom nodes in the [Godot] editor. Or wherever |
| 12 | +else! |
| 13 | + |
| 14 | +## Features |
| 15 | + |
| 16 | +*  50+ icons of various categories |
| 17 | +*  Each icon comes in multiple variants |
| 18 | +*  Licensed as CC0 - take it and use it |
| 19 | +*  [Dedicated site] for browsing |
| 20 | +*  Available for HiDPI displays too |
| 21 | +*  Optimized for size |
| 22 | + |
| 23 | +## Overview |
12 | 24 |
|
13 | 25 | Often, when working on projects, it would be nice to have some custom icons for |
14 | 26 | specific nodes, but finishing the project is a big enough task in itself. |
15 | 27 | Making custom icons for different nodes is often overkill, as it adds effort, |
16 | 28 | but doesn't effect the finished game at all. |
17 | 29 |
|
18 | | -## Variations |
| 30 | +This is where *plenticons* saves the day! Providing many different icons, |
| 31 | +instead of having to make them on your own, just pick and choose which one fits |
| 32 | +your node! |
| 33 | + |
| 34 | +Each icon comes in multiple color variations, using Godot's standard node |
| 35 | +colors for your color coding pleasure! White and black variants are also |
| 36 | +included, to be used as masks, or tinting. |
| 37 | + |
| 38 | +And with its permissive license, *plenticons* can be used outside of the Godot |
| 39 | +editor, in your games, applications, wherever you deem fit! |
| 40 | + |
| 41 | +## Install |
| 42 | + |
| 43 | +Depending on your preference, you may: |
| 44 | + |
| 45 | +* Download from the Godot Asset Library, searching for *plenticons* |
| 46 | +* Download the latest [release] from Github |
| 47 | + |
| 48 | +## Usage |
| 49 | + |
| 50 | +After importing the addon to your Godot project, use the `@icon` annotation on |
| 51 | +your custom scripts, e.g.: |
| 52 | + |
| 53 | +```gdscript |
| 54 | +@icon("res://addons/plenticons/icons/16x/foxs-sake/plenticons-yellow.png") |
| 55 | +``` |
| 56 | + |
| 57 | +For the HiDPI version, replace `16x` with `64x-hidpi` in the path: |
| 58 | + |
| 59 | +```gdscript |
| 60 | +@icon("res://addons/plenticons/icons/64x-hidpi/foxs-sake/plenticons-yellow.png") |
| 61 | +``` |
| 62 | + |
| 63 | +To pick an icon visually, browsing the [site] and clicking on an icon will show |
| 64 | +the corresponding code snippet. Clicking on the snippet will automatically copy |
| 65 | +it to the clipboard. |
| 66 | + |
| 67 | +## Support |
| 68 | + |
| 69 | +If you've found *plenticons* useful, feel free to fund us on ko-fi: |
19 | 70 |
|
20 | | -Each icon comes in multiple color variations: |
| 71 | +[](https://ko-fi.com/T6T8WZD0W) |
21 | 72 |
|
22 | | -* Gray ( `#e0e0e0` ) |
23 | | -* Red ( `#fc7f7f` ) |
24 | | -* Blue ( `#8da5f3` ) |
25 | | -* Green ( `#8eef97` ) |
26 | | -* Yellow ( `#ffca5f` ) |
| 73 | +## License |
27 | 74 |
|
28 | | -Variations are generated by a script, and then optimized by [svgo], before |
29 | | -packing. |
| 75 | +*plenticons* is under the [CC0 1.0 license](LICENSE). |
30 | 76 |
|
| 77 | +[Dedicated site]: https://foxssake.github.io/plenticons/ |
31 | 78 | [Godot]: https://godotengine.org/ |
32 | | -[svgo]: https://svgo.dev/ |
| 79 | +[release]: https://github.com/foxssake/plenticons/releases |
| 80 | +[site]: https://foxssake.github.io/plenticons/ |
0 commit comments