svg-rasterizer-maven-plugin

Another Fork

This particular fork was made to get the plugin into Maven central as the GitHub repositories in the unmaintained upstream projects no longer work.

Summary

Maven SVG rasterization plugin. This plugin converts SVG files to raster images like png, jpg. Also supports converting to multiple resolutions for Android.

This implementation is based on uphy/svg-maven-plugin. It uses the same rasterizer-core but the maven-mojo's were re-written to support easier an more flexible configuration which i needed for my projects. There will not be much development here after the initial-release.

Setup

Edit your pom.xml as follows. See also example pom.xml.

1.Add plugin.

<plugin>
    <groupId>uk.co.bithatch</groupId>
    <artifactId>svg-rasterizer-maven-plugin</artifactId>
    <version>1.2</version>
    <executions>
        <execution>
            <id>Rasterize</id>
            <goals>
                <goal>rasterize[-image|-directory|-android-image|-android-directory]</goal>
            </goals>
            <configuration>
                <!-- ... -->
            </configuration>
        </execution>
    </executions>
</plugin>

Goals

Rasterize a single SVG image file

Convert a SVG image to raster images.

Goal: rasterize-image

<configuration>
    <!-- Input file path.  Must exist.[Required] -->
    <inputFile>svg/sample.svg</inputFile>
    <!-- Output directory [Required] -->
    <destDir>output/</destDir>
    <outputs>
        <output>
            <!-- Output file path. [Optional, default: {name}-{width}x{height}{ext}] -->
            <path>sample128.png</path>
            <!-- width of output image. [Required] -->
            <width>128</width>
            <!-- height of output image. [Required] -->
            <height>128</height>
            <!-- Format for output image (png, jpg, pdf, tiff). [Optional, default: png] -->
            <format>png</format>
            <!-- Quality (Optional, default 0.99) -->
            <quality>0.85</quality>
        </output>
        <output>
            <path>sample256.pdf</path>
            <width>256</width>
            <height>256</height>
            <format>pdf</format>
        </output>
    </outputs>
</configuration>

Using Placeholders for output-path:

<configuration>
    <inputFile>svg/sample.svg</inputFile>
    <destDir>output/</destDir>
    <outputs>
        <output>
            <path>sample{width}{ext}</path>
            <width>128</width>
            <height>128</height>
            <format>png</format>
        </output>
        <output>
            <path>sample{width}{ext}</path>
            <width>256</width>
            <height>256</height>
            <format>pdf</format>
        </output>
    </outputs>
</configuration>

Using defaults-block for default-settings

<configuration>
    <inputFile>svg/sample.svg</inputFile>
    <destDir>output/</destDir>
    <defaults>
        <path>{name}-{width}x{height}{ext}</path>
        <format>png</format>
        <quality>0.8</quality>
    </defaults>
    <outputs>
        <output>
            <width>128</width>
            <height>128</height>
        </output>
        <output>
            <width>256</width>
            <height>256</height>
        </output>
    </outputs>
</configuration>

Using the filename of the input-file to determine the dimensions of the outputs

The filenames must follow the pattern <name>-'['<width>x<height>[,<width>x<height>...]']'.svg, e.g. image-\[48x48,32x32].svg.

<configuration>
    <!-- see required filename-pattern above -->
    <inputFile>svg/sample-[48x48,32x32].svg</inputFile>
    <destDir>output/</destDir>
    <defaults>
        <path>{name}-{width}x{height}{ext}</path>
        <format>png</format>
        <quality>0.8</quality>
    </defaults>
</configuration>

Rasterize SVG all images in a directory (non-recursive!)

Convert SVG images in a directory at once.

Goal: rasterize-directory

<configuration>
    <!-- Input directory path.  Must exist.[Required] -->
    <inputDir>svg/images</inputDir>
    <!-- Output directory path [Required] -->
    <destDir>output/</destDir>
    <outputs>
        <output>
            <!-- output-path [Optional, default: {name}-{width}-{height}{ext}] -->
            <path>{width}x{height}/{name}{ext}</path>
            <width>128</width>
            <height>128</height>
            <format>png</format>
        </output>
        <output>
            <path>{width}x{height}/{name}{ext}</path>
            <width>256</width>
            <height>256</height>
            <format>png</format>
        </output>
    </outputs>
</configuration>

Using defaults-block for default-settings

<configuration>
    <inputDir>svg/images</inputDir>
    <destDir>output/</destDir>
    <defaults>
        <path>{name}-{width}x{height}{ext}</path>
        <format>png</format>
    </defaults>
    <outputs>
        <output>
            <width>128</width>
            <height>128</height>
        </output>
        <output>
            <width>256</width>
            <height>256</height>
        </output>
    </outputs>
</configuration>

Using the filename of the input-file to determine the dimensions of the outputs

The filenames must follow the pattern <name>-'['<width>x<height>[,<width>x<height>...]']'.svg, e.g. image-\[48x48,32x32].svg.

<configuration>
    <inputDir>svg/images</inputFile>
    <destDir>output/</destDir>
    <defaults>
        <format>png</format>
    </defaults>
</configuration>

Rasterize a single SVG image for Android

Convert a SVG image to raster images for multiple resolutions of Android.

Goal: rasterize-android-image

<configuration>
    <!-- Input file path.  Must exist.[Required] -->
    <inputFile>svg/sample.svg</inputFile>
    <!-- Output directory path [Required] -->
    <destDir>output/</destDir>
    <outputs>
        <output>
            <!-- width of output image (this width is used for MDPI, other outputs get scaled accordingly). [Required] -->
            <width>128</width>
            <!-- height of output image (this width is used for MDPI, other outputs get scaled accordingly). [Required] -->
            <height>128</height>
            <!-- "res" directory of Android. [Optional, default:res] -->
            <resDirectory>android/res</resDirectory>
            <!-- name of the ouptut-file without extension (fixed to .png) below res-directory [Optional, default:{name}] -->
            <name>sample-icon</name>
            <!-- Output resolutions. [Optional, default:LDPI,MDPI,HDPI,XHDPI,XXHDPI] -->
            <!-- The size of MDPI equals to the base size(same as ${width},${height}}).-->
            <!-- Output location will be determined automatically. -->
            <!-- e.g., LDPI will be located in ${resDirectory}/drawable-ldpi/ -->
            <resolutions>
                <resolution>LDPI</resolution>
                <resolution>MDPI</resolution>
                <resolution>HDPI</resolution>
                <resolution>XHDPI</resolution>
                <resolution>XXHDPI</resolution>
            </resolutions>
        </output>        
    </outputs>
</configuration>

Using the filename of the input-file to determine the dimensions of the outputs

The filenames must follow the pattern <name>-'['<width>x<height>[,<width>x<height>...]']'.svg, e.g. image-\[48x48,32x32].svg.

<configuration>
    <!-- see required filename-pattern above; for android the should exists only one output-definition -->
    <inputFile>svg/sample-[48x48].svg</inputFile>
    <destDir>output/</destDir>
</configuration>

Rasterize SVG images in a directory for Android

Convert SVG images in a directory to Android multiple resolution images. Filename must be a special below format.

Goal: rasterize-android-directory

<configuration>
    <!-- Input directory path.  Must exist.[Required] -->
    <inputDir>svg/images</inputDir>
    <!-- Output directory path [Required] -->
    <destDir>output/</destDir>
    <outputs>
        <output>
            <!-- width of output image (this width is used for MDPI, other outputs get scaled accordingly). [Required] -->
            <width>128</width>
            <!-- height of output image (this width is used for MDPI, other outputs get scaled accordingly). [Required] -->
            <height>128</height>
            <!-- "res" directory of Android. [Optional, default:res] -->
            <resDirectory>android/res</resDirectory>
            <!-- name of the ouptut-file without extension (fixed to .png) below res-directory [Optional, default:{name}] -->
            <name>sample-icon</name>
            <!-- Output resolutions. [Optional, default:LDPI,MDPI,HDPI,XHDPI,XXHDPI] -->
            <!-- The size of MDPI equals to the base size(same as ${width},${height}}).-->
            <!-- Output location will be determined automatically. -->
            <!-- e.g., LDPI will be located in ${resDirectory}/drawable-ldpi/ -->
            <resolutions>
                <resolution>LDPI</resolution>
                <resolution>MDPI</resolution>
                <resolution>HDPI</resolution>
                <resolution>XHDPI</resolution>
                <resolution>XXHDPI</resolution>
            </resolutions>
        </output>        
    </outputs>
</configuration>

Using the filename of the input-file to determine the dimensions of the outputs

The filenames must follow the pattern <name>-'['<width>x<height>[,<width>x<height>...]']'.svg, e.g. image-\[48x48,32x32].svg.

<configuration>
    <inputFile>svg/images</inputFile>
    <destDir>output/</destDir>
</configuration>