PicSharp

PicSharp

<a href="./LICENSE">
  <img
    src="https://img.shields.io/github/license/AkiraBit/PicSharp?style=flat-square"
  />
</a>
<a href="https://github.com/AkiraBit/PicSharp/releases/latest">
  <img
    src="https://img.shields.io/github/package-json/v/AkiraBit/PicSharp?style=flat-square"
  />
</a>
<a href="https://github.com/AkiraBit/PicSharp/releases">
  <img
    src="https://img.shields.io/github/downloads/AkiraBit/PicSharp/total?style=flat-square"
  />
</a>

A feature-rich, efficient and flexible cross-platform desktop image compression application.

Supported Platforms

• Mac: ✅ (macOS 12+)
• Windows: ✅ (Windows 10+ x64)
• Linux: ✅ (Ubuntu 20.04+ or other Linux distributions that support libstdc++ 11.3+)

MacOS	Windows	Linux(Ubuntu)
	[Placeholder]

Key Features

Compress Localy & TinyPNG

Powerful Batch Processing

Watch Mode

Rich Configuration

General	Description	Status
Internationalization	Partial support: zh-CN, en-US	✅
Dark/Light Theme	-	✅
System Notifications	-	✅
Startup on Boot	-	✅
Auto Check for Updates	-	✅

---

Compression	Description	Status
Compression Mode	Default use Tinypng, if Tinypng compression fails, switch to local compression for retry.	✅
Compression Type	Optional lossless compression and lossy compression are available. When the image does not support lossless compression, switch to lossy compression	✅
Compression Level	Five levels can be selected. When using lossy compression, setting a reasonable compression level can achieve the best visual effect.	✅
Save Type	How to save compressed images after compression.	✅
Compression Rate Limit	When the image compression rate is below the set threshold, saving will not be performed.	✅
Format Conversion	After compression is completed, additionally convert the image to the specified format, such as PNG, JPG, WebP, AVIF.	✅
Alpha Background Fill	Specifies which color to use for fill when an image with a transparent background is converted to an image format that does not support transparency (e.g. WEBP, AVIF, PNG to JPG).	✅

---

TinyPNG	Description	Status
API Keys Management	Manage multiple TinyPNG API keys and provide functions such as availability detection and usage monitoring	✅
Preserve Metadata	Select the metadata to preserve during compression.	✅

Easy to use

Feature	Description	Status
Clipboard Support	Support compressing images or directories from clipboard	✅
Finder Services menu	Use Finder Services menu to compress images (Mac Only).
Right-click menu for image operation	Operate on the image before and after compression.
Image Comparison	Compare the original and compressed images.
DeepLink	Use DeepLink to compress images.	✅

Summary

• Powerful Batch Processing: Based on Rust implementation, it scans selected files or directories with high performance and low resource consumption, identifying and processing image files within them. Even 100,000+ images can be handled with ease.
• TinyPNG Integration: Optional TinyPNG compression is available, with account pool management for automatic selection during task processing. Supported image formats: PNG/Animated PNG, JPEG, WebP, AVIF.
• Offline Compression Support: Fully localized processing with rich compression option configurations (compression level, lossy/lossless, etc.). Supported image formats: PNG, JPEG, WebP/Animated WebP, AVIF, TIFF, GIF, SVG.
• Combined Compression Strategies: TinyPNG offers the best compression ratio but requires an internet connection, is less efficient for large numbers of images, and is not suitable for sensitive images. Offline compression is slightly less effective than TinyPNG but offers extremely high batch processing efficiency, requires no internet connection, and ensures privacy and security. During compression, both strategies are automatically combined to achieve optimal processing efficiency.
• Automatic Compression Mode: Select folders to monitor, and images added to these folders will be automatically compressed, enhancing your workflow.
• Convenient Operations: Drag and drop files into the application or onto the application icon for quick opening, select files or directories in Mac Finder and choose a compression method from the "Services" menu, and more.
• Rich Application Configuration: Offers dark/light themes, multiple languages, system notifications, startup on boot, save methods for processed images, save locations, number of parallel tasks, and more.
• Open Integration: Provides image compression invocation capabilities via DeepLink, allowing automation tools to call it and enhance your workflow.

Troubleshooting

1. PicSharp Won’t Launch on Windows (Missing Edge WebView2 Runtime)

Symptom

• When you double-click picsharp.exe, nothing happens. No window appears, and Task Manager does not show the process.
• This can affect both the standard installer and the portable version.

Cause

• Microsoft Edge WebView2 Runtime is either missing, outdated, or improperly installed on your system. PicSharp depends on WebView2 to render the interface on Windows.

How to Fix

1. Check if WebView2 is installed
   • Open “Add or Remove Programs” (a.k.a. Apps & features) on Windows. Look for “Microsoft Edge WebView2 Runtime.”
2. Install or Update WebView2
   • Download the WebView2 Runtime directly from Microsoft: link.
   • If you prefer an offline installer, download the offline package and run it as an Administrator.
3. Re-run PicSharp
   • After installing/updating WebView2, launch picsharp.exe again.
   • If you still encounter problems, reboot your PC and try again.

Additional Tips

• If reinstalling once doesn’t work, uninstall Edge WebView2 completely, then reinstall it with Administrator privileges.
• Verify your Windows installation has the latest updates from Microsoft.

2. How to use AppImage in a Linux distribution

AppImage is a distribution format that does not rely on the system installed packages and instead bundles all dependencies and files needed by the application. For this reason, the output file is larger but easier to distribute since it is supported on many Linux distributions and can be executed without installation.

1. Download

Go to the download page to download the AppImage file corresponding to the system architecture.

2. Set Permissions

Open the directory where AppImage is located in the command line and set the running permissions for it.

chmod a+x PicSharp_x.x.x_xxx.AppImage

3. Run In Terminal

./PicSharp_x.x.x_xxx.AppImage

4. Run In Desktop

The above steps have opened PicSharp and it can be used normally, but the desktop icon is missing and the terminal cannot be closed. The following steps can create the desktop icon.

```bash
./PicSharp_x.x.x_xxx.AppImage --appimage-extract

sed -i 's|Exec=.*|Exec=/opt/picsharp/PicSharp.AppImage|g' squashfs-root/usr/share/applications/Picsharp.desktop

sed -i 's/^Icon=.*/Icon=PicSharp/g' squashfs-root/usr/share/applications/picsharp.desktop

sudo install -Dm644 squashfs-root/usr/share/applications/picsharp.desktop /usr/share/applications/PicSharp.desktop

wget "https://raw.githubusercontent.com/AkiraBit/PicSharp/main/doc/logo.png" -O PicSharp.png

sudo install -Dm644 PicSharp.png /usr/share/icons/hicolor/48x48/apps/PicSharp.png
rm -r squashfs-root PicSharp.png

mkdir -p /opt/picsharp

mv PicSharp_x.x.x_xxx.AppImage /opt/picsharp/PicSharp.AppImage

This command enables the AppImage application to be launched from the application menu in the desktop environment, just like traditionally installed software, without having to run in the terminal every time.

Development

To get started with PicSharp, follow these steps to clone and build the project.

git clone https://github.com/AkiraBit/PicSharp.git
cd PicSharp

Requirements

• Node.js 20+
• pnpm 9+
• Rust and Cargo for Tauri development

Refer to the Tauri documentation for details on setting up the development environment prerequisites on different platforms.

1. Install Dependencies

pnpm install

2. Build for Development

# For App
pnpm dev:app

# For Sidecar
pnpm dev:sidecar

3. Build for Production

About building on different platforms can distribute product details, please refer to the Tauri document.

Contributing

If you want to help out please see CONTRIBUTING.md to see how to get started.

Roadmap

• Add Windows arm64 support

Support

If you enjoy this project consider giving it a star ⭐.

Star History