Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ayecue/gh-image-transformer
Transform images to TextMesh Pro Rich-Text tags for Grey Hack
https://github.com/ayecue/gh-image-transformer
greyhack
Last synced: 12 days ago
JSON representation
Transform images to TextMesh Pro Rich-Text tags for Grey Hack
- Host: GitHub
- URL: https://github.com/ayecue/gh-image-transformer
- Owner: ayecue
- License: mit
- Created: 2024-01-01T22:53:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-10T23:34:42.000Z (about 1 year ago)
- Last Synced: 2024-12-06T18:43:20.556Z (about 1 month ago)
- Topics: greyhack
- Language: TypeScript
- Homepage:
- Size: 4.55 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gh-image-transformer
This CLI does not only transform images into TextMesh Pro Rich-Text tags for Grey Hack but also creates animation frames out of GIFs which are usable in Grey Hack.
# Install
```bash
npm install -g gh-image-transformer
```
# Usage
## Image transformer
```
Usage: gh-image-transformer [options] [width] [height]
Transform images to TextMesh Rich-Tags output for Grey Hack.
Arguments:
filepath image to transform
width output width of image
height output height of image
Options:
-V, --version output the version number
-o, --output-directory output directory
-s, --scale scale of output
-wa, --without-alpha ignore alpha channel
-h, --help display help for command
```
## Animation transformer
```
Usage: gh-animation-transformer [options] [width] [height]
Transform GIFs to TextMesh Rich-Tags output animation frames for Grey Hack.
Arguments:
filepath image to transform
width output width of image
height output height of image
Options:
-V, --version output the version number
-o, --output-directory output directory
-s, --scale scale of output
-wa, --without-alpha ignore alpha channel
-d, --delay delay between frames
-h, --help display help for command
```
# How to
## Static Image
Static images can be simply transformed into TextMesh Pro Rich-Text tags by using:
```bash
gh-image-transformer path/to/image.png
```
Optionally you can also select the width and height. By default, it will resize the image by a width of `64px`. If you want to resize the image by height just place a `-1` at the spot of the `width`.
Keep in mind that the images should be kept below 100px since Grey Hack has a limit of `160000` characters for each print line. Anything above that may cause the image to be displayed incorrectly.
Via the additional options, you can also change the scale of each pixel by default that value is `2`. It is not recommended to go lower since that will cause vertical space between lines.
## GIF
GIFs can be transformed into TextMesh Pro Rich-Text tags animation frames by using:
```bash
gh-animation-transformer path/to/image.gif
```
The options of the animation transformer are the same as the ones from the normal image transformer. There is only one additional option which is about the delay between each frame.
**Note**: It is highly recommended to use either [greybel-js](https://github.com/ayecue/greybel-js) or [greybel-vs](https://github.com/ayecue/greybel-vs) to import animations otherwise you end up with a lot of copy paste depending on how many frames the GIF got.
In case you are using greybel-js you just need to execute `greybel path/to/image.src`. It is recommended to use the `--create-ingame` flag to avoid copy-pasting all the files.
If you are using greybel-vs you just need to right click on the `image.src` and select `build`. To make it more convenient please make sure to activate the `create-ingame` option.
# Example output
