@spark-apps/piclet 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 [Spark Games]
+
+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.

package/Readme.md

@@ -0,0 +1,180 @@
+[//]: # (Constants)
+[privacy-link]: ./PRIVACY.md
+[coffee-link]: https://buymeacoffee.com/spark88
+[issues-link]: ../../issues
+[fork-link]: ../../fork
+
+<div align="center">
+
+<img src="res/imgs/banana.png" width=100>
+
+# PicLet
+
+**Lightweight image tools for content creators • CLI, GUI, and Web**
+
+[![npm version](https://img.shields.io/npm/v/@spark-apps/piclet?color=blue)](https://www.npmjs.com/package/@spark-apps/piclet)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/muammar-yacoob?label=Sponsor&logo=github-sponsors&logoColor=white&color=pink)](https://github.com/sponsors/muammar-yacoob)
+[![Buy Me Coffee](https://img.shields.io/badge/Buy%20Me-Coffee-green?logo=buy-me-a-coffee&logoColor=white)][coffee-link]
+[![Report Bug](https://img.shields.io/badge/Report-Bug-red?logo=github&logoColor=white)][issues-link]
+
+</div>
+
+---
+
+## 🌐 Try PicLet Online
+
+**[piclet.app](https://piclet.app)** - Use all tools directly in your browser. No installation, 100% client-side processing, your images never leave your device.
+
+---
+
+## Tools & Features
+
+<table>
+<thead>
+<tr>
+<th width="80" align="center">Tool</th>
+<th>Description</th>
+<th>Formats</th>
+<th>Available In</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="center"><img src="src/icons/makeicon.ico" width="48" alt="Make Icon"></td>
+<td><strong>Make Icon</strong><br>Convert images to ICO with multiple resolutions (256, 128, 64, 48, 32, 16)</td>
+<td>PNG</td>
+<td>CLI, GUI, Web</td>
+</tr>
+<tr>
+<td align="center"><img src="src/icons/removebg.ico" width="48" alt="Remove BG"></td>
+<td><strong>Remove Background</strong><br>Remove solid backgrounds with configurable fuzz tolerance</td>
+<td>PNG</td>
+<td>CLI, GUI, Web</td>
+</tr>
+<tr>
+<td align="center"><img src="src/icons/rescale.ico" width="48" alt="Scale"></td>
+<td><strong>Scale Image</strong><br>Resize images with optional square padding</td>
+<td>PNG, JPG, GIF, BMP</td>
+<td>CLI, GUI, Web</td>
+</tr>
+<tr>
+<td align="center"><img src="src/icons/iconpack.ico" width="48" alt="Icon Pack"></td>
+<td><strong>Icon Pack</strong><br>Generate complete icon sets for Web, Android, and iOS</td>
+<td>PNG, JPG</td>
+<td>CLI, GUI, Web</td>
+</tr>
+<tr>
+<td align="center"><img src="src/icons/storepack.ico" width="48" alt="Store Assets"></td>
+<td><strong>Store Assets</strong><br>Generate graphics for Steam, itch.io, Unity Asset Store, and app stores</td>
+<td>PNG, JPG</td>
+<td>GUI, Web</td>
+</tr>
+</tbody>
+</table>
+
+---
+
+## Get Started
+
+### 🌐 Web Version (No Installation)
+
+Visit **[piclet.app](https://piclet.app)** - Works in any modern browser, 100% client-side processing.
+
+### 💻 Desktop Version (Windows)
+
+Download and install via npm for CLI access and Windows Explorer integration:
+
+```bash
+npm install -g @spark-apps/piclet
+```
+
+**Requirements:**
+- Windows with WSL (Windows Subsystem for Linux)
+- ImageMagick in WSL: `sudo apt update && sudo apt install imagemagick`
+- Node.js >= 18
+
+---
+
+## Desktop Usage
+
+### 🖱️ GUI Mode (Right-Click Integration)
+
+Right-click any image file in Windows Explorer to access PicLet tools:
+
+<div align="center">
+<img src="res/imgs/menu.png" style="border: 1px solid #eee; border-radius: 4px; max-width: 500px;" alt="PicLet Context Menu">
+</div>
+
+<div align="center">
+<img src="res/imgs/demo.png" alt="PicLet GUI" style="border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.1); max-width: 700px;">
+<p><em>GUI with real-time preview and batch processing</em></p>
+</div>
+
+### ⌨️ CLI Mode (Command Line)
+
+Fast batch processing via terminal:
+
+```bash
+# Convert PNG to ICO
+piclet makeicon logo.png
+
+# Remove background
+piclet remove-bg photo.png
+
+# Scale image
+piclet scale image.jpg
+
+# Generate icon pack for all platforms
+piclet iconpack app-icon.png
+
+# Open GUI with store assets preset
+piclet storepack image.png
+```
+
+<div align="center">
+<img src="res/imgs/cli.jpg" alt="PicLet CLI" style="border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.1); max-width: 600px;">
+<p><em>CLI for automation and batch operations</em></p>
+</div>
+
+### Registry Management
+
+```bash
+# Re-register context menu entries
+piclet install
+
+# Remove context menu entries
+piclet uninstall
+
+# Uninstall completely
+npm uninstall -g @spark-apps/piclet
+```
+
+## Icon Pack Output
+
+When you run `piclet iconpack`, it generates:
+
+**Web** (8 files)
+- `favicon.ico`, `favicon-16x16.png`, `favicon-32x32.png`, `favicon-48x48.png`
+- `apple-touch-icon.png` (180px)
+- `android-chrome-192x192.png`, `android-chrome-512x512.png`
+- `mstile-150x150.png`
+
+**Android** (6 files)
+- `mipmap-mdpi` through `mipmap-xxxhdpi` directories
+- `playstore-icon.png` (512px)
+
+**iOS** (15 files)
+- All `AppIcon` sizes including @2x/@3x variants
+- `AppIcon-1024.png` for App Store
+
+## Support & Contributions
+
+⭐ Star the repo and I power up like Mario!<br>
+☕ Devs run on [coffee][coffee-link].<br>
+🤝 [Contributions][fork-link] are welcome.
+
+---
+
+<div align="center">
+<sub>Released under MIT License | <a href="./PRIVACY.md">Privacy Policy</a></sub>
+</div>