drezynsoft/split-image

Split PNG images into pieces.

Split Image

Split Image is a tool written in PHP to split images in format of PNG to smaller pieces. What is more valuable it could be used to split images with repetition of the left/right top/bottom fragments to get atlas form of presentation., _(*1)

Installation

composer require drezynsoft/split-image

or simply download the package in zip format., _(*2)

Configuration

You can use the config/config.php file or just override default options with args in console., _(*3)

config/config.php options

Params obliged:

After split command: source-file

Path to PNG file to split., _(*4)

After source-file: destination-dir (second after split command)

Path to directory where split files will be saved., _(*5)

Note: Minimal command is as follows (warning: last slash is required):, _(*6)

$ split-image split path/to/png/file.png path/to/save-dir/, _(*7)

Note: Trailing slash in directory path is necessary., _(*8)

List of other available params:

--width default: 2200 (int)

Destination width [px] of the every split image., _(*9)

--height default: 3300 (int)

Destination height [px] of the every split image., _(*10)

--left-right-margin default: 500 (int)

Margin of the previous (if any) split image. It is the simply floating coat of the previous split image (in width) [px]., _(*11)

--top-bottom-margin default: 500 (int)

Margin of the previous (if any) split image. It is the simply floating coat of the previous split image (in height) [px]., _(*12)

--sep default: '_' (string)

Text between digits of rows count and cols count., _(*13)

--prefix default: '' (string)

Text before digits of rows and cols., _(*14)

--suffix default: '' (string)

Text after digits of rows and cols., _(*15)

--RAM-factor default: 3.0 (float)

Multiplier for calculating predicted RAM usage., _(*16)

--compression default: 0 max: 9 (int)

Compression of PNG file 0-9., _(*17)

Note: All params starting with -- are optional and could be given in any order. Also all of them can be used in config/config.php without the -- prefix., _(*18)

List of params outside of the console:

default-file default: 'data/to_convert/DrezynSoft.png' (string)

Source file., _(*19)

default-dir default: 'data/converted/' (string)

Destination directory., _(*20)

Usage

Simplest usage (with defaults)

By console

$ vendor/bin/split-image split path/to/png/file.png path/to/save-dir/, _(*21)

or without composer, _(*22)

$ scripts/split-image split path/to/png/file.png path/to/save-dir/, _(*23)

Note: Trailing slash in directory path is necessary., _(*24)

Tip: When params in config/config.php are the same you would like to use, you don't have to pass them into console command. The params will be get from config file., _(*25)

By http

go to: http://example.com/split-image/, _(*26)

Note: With assumption that tool is installed in split-image dir in public of the site., _(*27)

Recommendation: When you use huge files it can take long to split so end of script execution could interrupt the process., _(*28)

Note: There is no possible to change defaults options. You can only edit the config/config.php and then open the http page., _(*29)

Issues

The tool has been made for one reason at one moment so we really can not to predict new version of this program., _(*30)