libresprite-extensions

Scripts that generate or update an image (the current layer in a sprite) or the palette. For additional information about the LibreSprite API, go check the Wiki.

Download

Click on the latest Release (see on the right of the page) and then, in the Assets section, click the "libresprite-extensions" .zip file. Unzip the files in the LibreSprite scripts directory ("Scripts/Open Folder" in LibreSprite), and then select "Scripts/Rescan scripts" in LibreSprite.

Scripts description (in alphabetical order)

• countTiles counts unique tiles in the sprite and displays the results in the console, in the form : "{number of occurences} : {list of coordinates of the tiles that have that number of occurences}". The number of unique tiles is displayed first. You need to edit the script to fit your tile size (look for the string "EDIT").

• ellipticGradient does for ellipses what the fillGradient script does for rectangles : it fills ellipses with gradients. Nothing special here, except two things : the ellipses have to be contained in the image whole ; and each ellipse should contain only one inner ellipse.

• fillGradient creates a rectangle between two pixels and fills it with a linear gradients between the two top left and bottom right colors. This script will fill the whole image, so it's better if it's used on an empty sprite image/layer, where you just plot a top left and bottom right pixel of the desired colors, and then run the script. You can change the gradient progression from hsl to rgb in the editable part of the file (look for "EDIT"). Other progressions (like sine, polynomial, parabolic.. any function really) can and will be added in the future. If you plan to rotate the dithered gradient (using the palettize script), make sure you rotate the gradient before dithering it with palettize.

• grisaille just removes all the color from your sprite and turns it into shades of grey (but the sprite and color palette is still rgb).

• increase/decreaseLuminosity directly increase/decrease the RGB components by 10%.

• The other increase/decrease scripts (Hue, Saturation, Lightness) change the corresponding components of the pixel when it's converted to HSL. Hue is changed by +/- 15° on the 360° wheel, and the Saturation and Lightness by +/- 10%. You can easily change these values in the script, around line 10-11 at the time of this writing.

• isometricGrid draws an isometric grid. On an empty layer, draw the left-to-bottom diagonal edge of an isometric tile, then plot a point at the bottom right of the layer and use the script : the layer will be filled with an isometric grid. You can also draw the grid for a forward-facing vertical wall, by drawing a vertical line going towards the bottom, starting at the top left of your firstly drawn edge line, then using the script.

• mergeChanges allows you to merge the changes made to an original image by 2 different people who were working on it at the same time. To use it, put the original image on the top left of an empty sprite sheet ; you put the image modified by, say, Alice, exactly one pixel below it (meaning you have to leave an empty line of one pixel) ; on the right of this one, you put the image modified by, say, Bob (leaving an empty column of one pixel). And the you run the script. The original image will be deleted, the only pixels left are those that are conflicting (modified by both Alice and Bob) ; and to the right of the original image, you'll see Alice and Bob's changes merged into the original image.

• monochrome makes it.. monochrome. There is no dialog to pick the color, so you have to edit lines of code in the script (look for the string "EDIT") to select the hue you want.

• outline creates an outline around all the non-transparent pixels of an image. You can edit lines of the script (look for the string "EDIT") to select the outline color and the outline direction(s). Please note, due to the way sprites are stored in LibreSprite, you need to draw a non-empty pixel on the top left and bottom right of your sprite before using the script (drawing a rectangle around your object will work just fine). You can delete these pixels after the outline has been drawn. Exemple use : select the item you want to outline with the magic wand, copy it into a new sprite at least 2 pixels larger (to give room for the outline), draw the top left and bottom right pixels, and use the script. Then you can copy the outlined item back into your project.

• palettize changes the pixels in your image to the closest color in your palette. Example use : load an image, load your palette, use the scripts : now your image is composed of pixels that belong in your palette. You can select one of "RGB" or "LAB" methods by editing the file (look for the string "EDIT") ; "LAB" often gives buggy and worse results than "RGB" but it can lead to interesting results. Also, you can select dithering options (no dithering is applied by default). Dithering available options are Atkinson, Floyd-Steinberg, Jarvis-Judice-Ninke and various ordered ditherings... Others are coming.

• pixellate creates pixels of the specified size (you can select it in the script - look for the string "EDIT"). This can be useful if you want to "pixellate" an image without changing its size (i.e. making "big" pixels). Compared to a simple sprite size change, this script tries to keep the image edges cleaner, and it does not add new colors to the image.

• quantize does color quantization on the image, and updates the palette accordingly. It can do color dithering, and has many options that are described in the "EDIT" section.

• reducePalette reduces the palette size : when 2 colors are close to each other in the palette, it removes one of them. This does NOT change the image, just the palette. You can select your target palette size by editing the script file (look for the string "EDIT"). When two colors are alike, it removes the first, or the last one in the palette, or the one that's the closest to all the other colors, depending on the option you select by editing the file.

• reduceTilesCount reduces the number of tiles required to draw the current image. It does this by replacing tiles that resemble the most to other tiles, starting by the rarest ones. The difference between two tiles is the sum of the rgb differences between both tile pixels -but other algorithms are possible, hit me if you think another way of calculating this would be better. You can adjust the tile size and the final tiles count by editing the script (look for the string "EDIT").

• reorganizePalette reorders the colors in your palette according to your specifications (by HSL or RGB components, pixel count, or whiteness). Details can be found in the script file, after the string "EDIT".

• synthesizeTexture fills an image with a texture that is created using the Image Quilting algorithm by Alexei A. Efros and William T. Freeman. To use it, you need to put your texture in an empty image, its top left corner will define the top left corner of the zone that will be synthesized. Then, you need to set a non-empty pixel to define the bottom right of your synthesized image -you can draw anything with the pen, or paste your texture and move it to the bottom right of your sprite.. anything goes. And then, just use the script. The result is partially random, so you will get different results every time. You can adjust the script parameters in the script, as usual, by looking for the string "EDIT". Read carefully the parameters description.

Warnings

• The changes from scripts can not be undone with Edit/Undo : if you want to get back from a change you need to close and reopen your working file, so you probably should to save your file before using the scripts. Or you can select everything (Ctrl-A), and cut/paste (Ctrl-X Ctrl-V) the image on itself. This will trigger an undo step to which you can go back later.