Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rse/sdkig
Stream-Deck Key-Image Generator
https://github.com/rse/sdkig
deck font-awesome generator icon image key png stream
Last synced: 15 days ago
JSON representation
Stream-Deck Key-Image Generator
- Host: GitHub
- URL: https://github.com/rse/sdkig
- Owner: rse
- Created: 2020-03-28T09:20:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-06T16:10:48.000Z (10 months ago)
- Last Synced: 2025-01-17T20:49:36.638Z (20 days ago)
- Topics: deck, font-awesome, generator, icon, image, key, png, stream
- Language: JavaScript
- Homepage: http://npmjs.com/sdkig
- Size: 205 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SDKIG
=====
**Stream-Deck Key-Image Generator**
Abstract
--------
SDKIG is a small utility for generating key images for [Elgato Stream
Deck](https://www.elgato.com/en/gaming/stream-deck) devices. The key images are generated with a size of 288x288 pixels (similar
to the official online [Key Creator](https://www.elgato.com/en/gaming/keycreator), although
the device seems to downscale them to just 72x72 pixels) and are rendered
with the combination of a prominent centered [FontAwesome](https://fontawesome.com/)
[icon](https://fontawesome.com/icons?d=gallery&m=free)
and a small [TypoPRO](http://typopro.org/)
[Source Sans Pro](http://typopro.org/specimen/specimen.html#TypoPRO_0_Source_0_Sans_0_Pro-normal-normal-normal-normal)
based title at the bottom. The colors of the background, the icon and the title can be
choosen through arbitrary RGB values.
Installation
------------
```sh
$ npm install -g sdkig
```
Requirements
------------
Unfortunately, this utility needs a licensed [PrinceXML](https://www.princexml.com/) **prince**(1)
and the free [Poppler](https://poppler.freedesktop.org/) **pdftocairo**(1) utilities in the shell PATH.
PrinceXML is needed for rendering the internally generated HTML to the intermediate PDF format.
Poppler is needed for rendering the intermediate PDF to the PNG output format.
Usage
-----
```sh
Usage: sdkig [-h|--help] [-V|--version] [-b|--background-color ]
[-i|--icon-name ] [-I|--icon-color ] [-s|--subicon-name ]
[-S|--subicon-color ] [-t|--title-text ] [-T|--title-color
] [-f|--title-font ] [-o|--output-file ]
Options:
-h, --help Show help [boolean] [default: false]
-V, --version show program version information
[boolean] [default: false]
-b, --background-color background color [string] [default: "#000000"]
-i, --icon-name icon name [string] [default: ""]
-I, --icon-color icon color [string] [default: "#ffffff"]
-s, --subicon-name subicon name [string] [default: ""]
-S, --subicon-color subicon color [string] [default: "#ffffff"]
-t, --title-text title text [string] [default: ""]
-T, --title-color title color [string] [default: "#e0e0e0"]
-o, --output-file output file [string] [default: ""]
```
Example
-------
```sh
$ sdkig -b bb0000 -i radiation-alt -I ffc0c0 -t ATTENTION -T ffffff -o sample1.png
$ sdkig -b 336699 -s graduation-cap -S 6699cc -i face-grin -I c0e0ff -t USERS -T ffffff -o sample2.png
```
License
-------
Copyright © 2020-2024 Dr. Ralf S. Engelschall (http://engelschall.com/)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.