82 lines
6.5 KiB
Plaintext
82 lines
6.5 KiB
Plaintext
================================================================================
|
|
Image Optimizer [NAT]: Compress originals & remove unused images v1.2.0
|
|
================================================================================
|
|
|
|
Thank you for purchasing our extension!
|
|
If you have any questions, feel free to contact us: info@nat.od.ua
|
|
Online Web Documentation: http://oc3-demo.nat.od.ua/instructions/image_optimizer_nat_instruction.html
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
TERMS & CONDITIONS (License & Support Policy)
|
|
--------------------------------------------------------------------------------
|
|
By purchasing and downloading this extension, you strictly agree to the following terms:
|
|
|
|
1. Single Domain License: One purchase allows you to install and use the extension on exactly one (1) live domain and one (1) local/test environment. You need a separate License Key for each additional live project.
|
|
2. License Activation: The module requires a License Key to function. Please email info@nat.od.ua with your Order ID and Domain Name after purchase to receive your key.
|
|
3. Support: We provide free technical support for bugs and standard installation issues. Support is available via email (info@nat.od.ua). Please allow up to 24-48 hours for a response.
|
|
4. Compatibility: The module is guaranteed to work on standard OpenCart / ocStore installations. We cannot guarantee out-of-the-box compatibility with heavily customized core files or third-party checkout/theme modules, though we will do our best to assist you.
|
|
5. Refund Policy: We offer a 100% refund if the extension is completely non-functional on a standard OpenCart setup and our support team is unable to fix it. We do not issue refunds for "change of mind" or if you have already requested and received a domain license key.
|
|
6. Distribution: The code is open-source, meaning you can modify it for your own needs. However, you may not resell, redistribute, share, or publish this extension in any form.
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
INSTALLATION & UPGRADE
|
|
--------------------------------------------------------------------------------
|
|
1. Extract the archive.
|
|
2. Upload the contents of the upload/ folder to your OpenCart root directory via FTP (no core files will be overwritten).
|
|
3. Go to OpenCart Admin -> System -> Users -> User Groups. Select Administrator and check both "Access" and "Modify" permissions for extension/module/img_opti (or module/img_opti on OC 2.0-2.2).
|
|
4. Go to Extensions -> Extensions -> Modules. Find "Image Optimizer [NAT]" and click "Install", then "Edit".
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
EXHAUSTIVE TAB-BY-TAB MODULE GUIDE
|
|
--------------------------------------------------------------------------------
|
|
WARNING: Always create a full backup of your /image/catalog/ folder before running any optimizations or deletions!
|
|
|
|
TAB 1: MODULE SETTINGS & SYSTEM STATUS
|
|
- Engine Selection: GD (Standard) or Imagick (Advanced) with explicit GD/Imagick action labelling across all scanning tools.
|
|
- Individual Folder Rules: Set per-folder custom JPG/WebP quality and max width/height overrides.
|
|
- Disk Usage Chart: Renders a pie chart of folder sizes (Catalog, Cache, Trash) with manual quota limit override.
|
|
- Server-side Persistent DB Statistics: Stores total processed files, saved MB, and average savings percentage in site database (oc_setting) with a [Reset Statistics] button.
|
|
- Full Settings Export / Import (JSON): Backup and restore 100% of module settings (cron tasks, watermark rules, placeholders, folder rules, formats, limits).
|
|
- Online Web-Instruction Button: Direct link to complete web documentation.
|
|
|
|
TAB 2: OPTIMIZE & RESIZE (COMPRESSION)
|
|
- Multi-folder Tree Selection: Select specific subfolders inside image/catalog/.
|
|
- Safe Copy vs Replace Originals: Choose between creating a backup copy (catalog_new) or replacing originals directly.
|
|
- Dimension Limits & Quality Controls: Max width/height, JPG quality (0-100), PNG quality (0-9), WebP quality (0-100).
|
|
- Performance & Multi-threading: Batch chunk size, log screen lines, and multi-threading execution controls.
|
|
- Savings Replacement Thresholds: Minimum byte/percent savings required to replace files.
|
|
- Interactive Controls: Balanced 50/50 Pause & Stop controls during active processing, plus cache clear button.
|
|
|
|
TAB 3: UNUSED IMAGES CLEANER (JUNK REMOVAL)
|
|
- Deep DB & Theme File Scanning: Scans product, category, manufacturer, banner images, and checks theme files (.tpl, .twig, .php, .css, .js) to prevent accidental deletion of active graphics.
|
|
- Safe Quarantine & permanent deletion: Move unused files to image/catalog_trash/ with one-click restore capability, or delete permanently.
|
|
|
|
TAB 4: IMAGE FORMATS & PROTECTION
|
|
- Support SVG & WebP: Enable native SVG uploading and WebP conversion (including TrueFileManager integration).
|
|
- WebP "On-the-Fly": Generates WebP images dynamically when requested by storefront browsers.
|
|
- Progressive Lazy Load: Applies blur-up progressive image loading on product lists.
|
|
- On-the-Fly Fake JPG Guard: Binary PNG header detection inside .jpg extension to eliminate black background glitches on the storefront. Mode dropdown toggle: Convert to white JPG vs save as transparent PNG.
|
|
- Fallback Image: Global placeholder image override for broken image links.
|
|
|
|
TAB 5: TOOLS (PRO) & VISUAL PREVIEW
|
|
- File & Folder Name Sanitizer: Cleans Cyrillic characters, spaces, and special symbols from filenames.
|
|
- CMYK to sRGB Converter: Converts CMYK printing colorspace to sRGB web colorspace.
|
|
- Black Background Fixer: Edge-only perimeter floodfill replacement of black borders from transparent PNGs converted improperly to JPG.
|
|
- Per-row Visual Preview: Compare original vs processed image side-by-side in modal dialog before applying changes.
|
|
|
|
TAB 6: WATERMARKS
|
|
- Dynamic On-the-Fly Overlays: Apply image or text watermarks dynamically on products, categories, brands, or banners.
|
|
- Customization: Position, opacity, angle, TTF font, size scaling, and category exclusion/inclusion rules.
|
|
|
|
TAB 7: PLACEHOLDERS
|
|
- Automatic fallback image replacement for products, categories, and brands without an assigned image.
|
|
|
|
TAB 8: CRON BACKGROUND SCHEDULER
|
|
- Automated Background Runner: Set up scheduled cron tasks (daily, weekly, monthly) for compression, junk cleaning, name sanitizing, and black background fixing without manual admin interaction.
|
|
|
|
TAB 9: INFO & ECOSYSTEM [NAT]
|
|
- Module suite promotion, support contact info, and online web documentation button.
|