1.0.1 • Published 2 years ago

minecraft-glint-generator v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

GlintCreator (minecraft-glint-generator)

Lets you put the Minecraft enchantment glint onto an image

Install

npm install (if not using the NPM module)

Start

  1. Go to the config.json file and edit it to your liking. If you are using the NPM package pass through an object with these parameters to generate the gif.
ParamterDescriptionTypeRequired
imageThe url to an image or a path to an imageStringtrue
nameThe name of the output fileStringtrue
sizeThe size of the gif (pixels)Integerfalse
sequenceChoose between the short or long sequence. The short sequence makes the file sizes much lower which can be used for discord emojis while the long sequence allows to show the entire glint sequenceStringfalse
outputOutput of the gifStringfalse
compressed_outputOutput of the compressed gifStringfalse
show_progressIf to show the progress on generating the gif in the console or notBooleanfalse
  1. Run node . to start the program. Wait a bit and the image should come out in the images/original folder as well as in the images/compressed folder for a compressed version of the gif. If you are using the NPM package, call the function to start generating the gif. At the end, the function will return a buffer.

NPM Package Example

const glintGenerator = require('minecraft-glint-generator');

glintGenerator({
	image: './example.png',
	name: 'example',
	size: 160,
	sequence: 'long',
	output: 'images/output',
	compressed_output: 'images/compressed_output',
	show_progress: true
})

Discord Emojis

If you want to use this to generate Discord emojis I recommend choosing these settings and using the compressed version of the gif: | Parameter | Value | | --- | --- | | size | 64 | | sequence | short |

Credit

The enchantment glint this is using is from https://minecraft.fandom.com/wiki/User:MrJam003/Animated_Sprites_Render.