1.0.1 • Published 6 months ago

@gonzalolog/mkscreator v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
6 months ago

mkscreator

Use MKSheet in your images to create Animated texture files

What's this useful for?

bird_1

Convert an image like that in a valid format for Source Engine to be used on Particles since mksheet tool it's a bit ugly, you can read more about mksheet in this link

Instruction on how to use it

Install this package globally, in first run it will ask you where is your source binaries folder (Make sure to modify or delete config.json) After that just run in your terminal

mkscreator <file-path.png>

It will ask you the dimensions of your animation, in the example from above, it's gonna be 3x3, you can also specify if you want it to be an animation or a single frame so your particle can select randomly, and then drop a vtf with a vmt ready to be used on source

How does it works

Well, it's boring and a bit forced, but basically the tool attacks a vulnerability by how the system works:

  • From the input, it will create Width x Height images (Not even split, just grabs frames)
  • Convert those files to TGA
  • Generates a sht file which the list of sequences on your final image
  • Run mksheet from the tga files and sht into a single image
  • Return a vtf along a vmt with the basic particle definition, only modify the final path on it

Notes:

  • Make the spritesheet png
  • Doesn't work well with non power of two images
  • Doesn't work well with 2x3 animations or 4x2, it must be the same number of rows and columns

The code it's pretty much awful to read, just a way I do tooling for myself