sketch-hq / sketch-image-compressor

A Plugin for Sketch that compresses your bitmap assets, to keep filesize to a minimum.

Image Compressor

⚠️ This plugin is no longer maintained. We recommend using ImageOptim instead.

A Plugin for Sketch that compresses your exported bitmap assets, to keep filesize to a minimum. This Plugin requires Sketch 3.8.

Please note that the compression is lossless, so no pixels will be harmed by running this Plugin : )

Installation

• Download Sketch Image Compressor & unzip it.
• Double click Sketch Image Compressor.sketchplugin to install the Plugin.

Usage

The Plugin uses two methods for asset compression:

• Quick Compression happens automatically, whenever you export an asset from Sketch using the File › Export… menu option or the Export button in the toolbar. The Plugin will run your PNG & JPG assets through optipng and jpegoptim using the quickest settings for both, so that you get smaller files as fast as possible.
• Full Compression happens when you choose the Plugins › Sketch Image Compressor › Export All Assets menu option. You'll be asked for a path where your assets will be exported, and then the Plugin will export every exportable layer from your document, and run the assets through advpng, optipng, pngcrush, zopflipng, jpegtran and jpegoptim, using more aggressive settings than the Quick Compression (i.e: the operation will be extremely slow)

Please note that both methods won't block Sketch's UI when running, so you'll be able to keep on working while the compressors run. However, running a Full Compression on a non-trivial document will most likely consume a lot of CPU for a long time, so don't expect Sketch to be as snappy as usual : )

You'll get some feedback about the process in the Sketch window while it's running, and some stats when it is done.

Acknowledgements

• Thank you ImageOptim for the inspiration. If you're looking for more fine-grained control of your compression settings, or a way to do lossy compression, it doesn't get any better than this.
• Thanks to the following projects:
  • advpng
  • jpegoptim
  • jpegtran
  • optipng
  • pngcrush
  • zopflipng

LICENSE

The MIT License (MIT)

Copyright (c) 2016 Bohemian Coding

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sketch-image-compressor's Issues

Hard compressed images still after uninstall

I tried this plugin. Img quality of JPG was too low for me after compression, so I removed plugin (with Sketch plugin manager). But I realize compression with bad image quality after export remains. Any help?

Couldn't find .sketchplugin file in the zipped file

Not sure if I'm doing something wrong but I couldn't find the .sketchplugin file anywhere in the unzipped folder.

Paths in artboard names aren't respected

With the built-in export (File->Export), if your artboard has a name like "foo/bar", then the artboard will be exported in a subdirectory called foo, aka foo/bar.png.

However, when running the plugin via Plugins->Sketch Image Compressor->Export All Assets, this information is lost, and the files are simply exported with the filename, i.e. bar.png.

Update to latest Zopfli

According to https://imageoptim.com/changelog.html, the newest version of zopfli is up to 2x times faster.

Add OxiPNG support

According to https://github.com/shssoichiro/oxipng, OxiPNG should be way faster than OptiPNG, so it probably makes sense to use it instead

Sketch Toolbox is missing this plugin?

Is this repo missing the mainfest.json file to get Sketch Toolbox to pick this plugin up?

No .sketchplugin file

README says:

Double click Sketch Image Compressor.sketchplugin to install the Plugin.

But there's no .sketchplugin file in the repo when downloading the master .zip.

Lovely plugin!

Hey, just want to complement you on a plugin well done. It works out of the box and was a breeze to install in Sketch. Thank you. 👍 😄

"Export All Assets" can swap files due to pngcrush shared tempfile

pngcrush uses a temp file (I believe pngout.png) when running. When "Export All Assets" is used, multiple NSTask's are created, all of which use pngcrush. One pngcrush can write to the temp file and then another pngcrush reads from it.

Steps to reproduce:

1. Remove advpng and optipng from compress-full-png.sh. This ensures that pngcrush will always override the file rather than bailing.
2. Export All Assets

The following document:

Produces these results:

Add toggle for TinyPNG compression

Hi there. I just have a small suggestion for this plugin. When exporting an artboard, image or whatever, it would be nice to have a nice checkbox in the export dialogue that you can turn on or off, which decides if the image will be compressed or not.

Sometimes we have to further edit images we export from Sketch in Photoshop or some other program and a lossless file would be better for that. Uninstalling the plugin every time you want to do so is a hassle, though.

I hope you consider this and I also want to say thanks for this great plugin.

Investigate qualityOfService

As seen in ImageOptim/ImageOptim@f945dc2

Not much info on Apple's docs, but it seems to be an interesting feature for this Plugin: http://nshipster.com/nsoperation/#quality-of-service

No options?

Hello,

i have a bout 24 pages in my document with a lot of artboards ... :-)
I need a really important feature, like:

Only selected artboards (or layers / objects / pages ...)

Thanks

Address comments in https://github.com/BohemianCoding/sketch-image-compressor/pull/1

There's still some spit & polish to do to address the comments in #1

This is a reminder to do that : )

0% compression

After installing MacOS High Sierra Beta 6 plugin has stopped to compress. It always shows that image is 0.00% off.

.sketchplugin file missing?

Hi,
In the installation instructions it says to double click on the Sketch Image Compressor.sketchplugin file, but it seems to be missing from the repo?

Should I be doing somethinh else?

Cheers
Damian

“optipng” cannot be opened because the developer cannot be verified.

Title says it all, did some Googling but can't find a clear answer.

Plugin not working with Sketch 47.1?

I just installed Sketch 47.1 and somehow the plugin is not working anymore. Tried uninstalling it and reinstalling the most recent version. Not working means, it's not "firing" or "hooking" in when exporting an image from Sketch.

Might it be that the plugin is not compatible with this Sketch version?

Settings? (disable zopfli)

Hi, how to disable zopfli?
in imageoptim, Zopfli is the one that takes most of the time processing images, and found no filesize advantages by leaving it enabled in imageOptim. Want to do the same in Sketch

Not exporting compressed images when using Sketch 50.2

Following the two different ways in the docs, results in nothing happening, i.e. the images don't get compressed. This happens in Sketch 50.2 and has been tested on two different Macs.

macOS Catalina 10.15系统下无法压缩图片

macOS Catalina 10.15系统下导出图片提示：无法打开“optipng”，因为无法验证开发者