neeeoo / funkin-packer

Funkin Packer

Funkin Packer

Funkin packer creates sprite sheets for you game or site. Rotation, trimming, multipacking, various export formats (json, xml, css, pixi.js, godot, phaser, cocos2d). Zip support. Split sheet tool.

Web version: https://neeeoo.github.io/funkin-packer/

Custom templates

Free texture packer uses mustache template engine.

There are 3 objects passed to template:

rects (Array) list of sprites for export

prop	type	description
name	String	sprite name
frame	Object	frame info (x, y, w, h, hw, hh)
rotated	Boolean	sprite rotation flag
trimmed	Boolean	sprite trimmed flag
spriteSourceSize	Object	sprite source size (x, y, w, h)
sourceSize	Object	original size (w, h)
first	Boolean	first element in array flag
last	Boolean	last element in array flag

config (Object) current export config

prop	type	description
imageWidth	Number	texture width
imageHeight	Number	texture height
scale	Number	texture scale
format	String	texture format
imageName	String	texture name
imageFile	String	texture file (name with extension)
base64Export	Boolean	base64 export flag
base64Prefix	String	prefix for base64 string
imageData	String	base64 image data

appInfo (Object) application info

prop	type	description
displayName	String	App name
version	String	App version
url	String	App url

Example:

{
  "frames": {
    {{#rects}}
    "{{{name}}}": {
      "frame": {
        "x": {{frame.x}},
        "y": {{frame.y}},
        "w": {{frame.w}},
        "h": {{frame.h}}
      },
      "rotated": {{rotated}},
      "trimmed": {{trimmed}},
      "spriteSourceSize": {
        "x": {{spriteSourceSize.x}},
        "y": {{spriteSourceSize.y}},
        "w": {{spriteSourceSize.w}},
        "h": {{spriteSourceSize.h}}
      },
      "sourceSize": {
        "w": {{sourceSize.w}},
        "h": {{sourceSize.h}}
      },
      "pivot": {
        "x": 0.5,
        "y": 0.5
      }
    }{{^last}},{{/last}}
    {{/rects}}
  },
  "meta": {
    "app": "{{{appInfo.url}}}",
    "version": "{{appInfo.version}}",
    "image": "{{config.imageFile}}",
    "format": "{{config.format}}",
    "size": {
      "w": {{config.imageWidth}},
      "h": {{config.imageHeight}}
    },
    "scale": {{config.scale}}
  }
}

funkin-packer's Issues

Row Column for grid splitter

Min width and height checks untrimmed frames

This is unintentional, it's supposed to check the trimmed sie

Show calculated ram when repacking

OK SO IT WONT WORK.

YEA FNF CRASHES WHENEVER I USE THIS AND I KNOW WHY ITS CUZ THE XML AINT LIKE ADOBE ANIMATE AND SO IT CRASHES PLZ FIX!!!!!!!!!!!

Dark mode

Make frames sorted when exported

Make the size and ram counter centered

Building problems

By the way, how to build this thing, please give me a tutorial, thank you?

Maybe: Show all anims in anim player if no frames are selected

CLI tool

funkinpacker -bp 1 -sp 3 -nr -e Sparrow -o texture combo/

-bp = border padding
-sp = symbol padding
-nr = no rotation
-e = export format
-o = output file

funkinpacker -r BOYFRIEND.png BOYFRIEND.xml -rm Sparrow

-r = repack
-rm = repack method
-e = export to folder (works differently when using -r)

Fix repacking manually offsetted sprites

Example
KapiAngry.zip