Difference between revisions of "Extensions:Watermarking"

From Lorekeeper Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
Tag: 2017 source edit
Line 3: Line 3:
 
Adds the ability to set masterlist images to automatically be resized and/or watermarked on being processed into the masterlist (via image upload, reupload, character creation, design update...) using the Intervention Image package (required by Lorekeeper by default).
 
Adds the ability to set masterlist images to automatically be resized and/or watermarked on being processed into the masterlist (via image upload, reupload, character creation, design update...) using the Intervention Image package (required by Lorekeeper by default).
  
By default, the only thing this does is trim images (remove excess transparent space around the edges). Resizing and watermarking are enabled via new values in the site settings admin panel. Resizing is done by scaling the shorter dimension (height/width) to the specified value in pixels. Watermarking is done by placing a set image file in the center of the uploaded image; if both resizing and watermarking are enabled, it resizes first and watermarks second, so take this into account. It does not adjust transparency on the watermark image, but ''does'' preserve it. Note that for thumbnail generation, the cropping is assumed to fit as much of the character in the square space as possible.
+
By default, the only thing this does is trim images (remove excess transparent space around the edges). Resizing and watermarking are enabled via new values in the site settings admin panel. Resizing is done by scaling the shorter dimension (height/width) to the specified value in pixels. Watermarking is done by placing a set image file in the center of the uploaded image; if both resizing and watermarking are enabled, it resizes first and watermarks second, so take this into account. It does not adjust transparency on the watermark image, but ''does'' preserve it.  
  
 
The watermark image itself, meanwhile, can be modified in the site images admin panel. By default it is one of the Lorekeeper default images.
 
The watermark image itself, meanwhile, can be modified in the site images admin panel. By default it is one of the Lorekeeper default images.
  
One of the quirks of this is that design update thumbnails are generated on image upload, so any design updates with images uploaded before this will not be properly watermarked, if that is desired.
+
By default, this uses the default behavior for thumbnail processing; the altered behavior can be enabled via the site settings admin panel. Note that for thumbnail generation, the cropping is assumed to fit as much of the character in the square space as possible. If you do not crop images along these lines, the cropping will likely be erroneous-- and, as the need to watermark the image is diminished in the first place, it is recommended you use the default cropping. Design update thumbnails are also generated on image upload, so any design updates with images uploaded before this will not be properly watermarked, if that is desired. This can be resolved by adjusting the crop on the thumbnail image, which will re-process it.
 
== Installation ==
 
== Installation ==
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
Line 13: Line 13:
 
== Configuration ==
 
== Configuration ==
 
<!-- Is any configuration necessary? Describe it here! -->
 
<!-- Is any configuration necessary? Describe it here! -->
Enable resizing and/or watermarking in the site settings admin panel as desired. If you enable watermarking, consider uploading a watermark in the site images admin panel.
+
Enable resizing, watermarking, and/or thumbnail processing in the site settings admin panel as desired. If you enable watermarking, consider uploading a watermark in the site images admin panel.
 
== Usage ==
 
== Usage ==
 
<!-- Is there anything users should know about using your extension? -->
 
<!-- Is there anything users should know about using your extension? -->

Revision as of 14:05, 25 August 2020

Watermarking
Description Adds support for automatic resizing and watermarking of images uploaded to the masterlist.
Author(s) Mercury
Status Testing
Github watermarking
LK Version Unspecified




Adds the ability to set masterlist images to automatically be resized and/or watermarked on being processed into the masterlist (via image upload, reupload, character creation, design update...) using the Intervention Image package (required by Lorekeeper by default).

By default, the only thing this does is trim images (remove excess transparent space around the edges). Resizing and watermarking are enabled via new values in the site settings admin panel. Resizing is done by scaling the shorter dimension (height/width) to the specified value in pixels. Watermarking is done by placing a set image file in the center of the uploaded image; if both resizing and watermarking are enabled, it resizes first and watermarks second, so take this into account. It does not adjust transparency on the watermark image, but does preserve it.

The watermark image itself, meanwhile, can be modified in the site images admin panel. By default it is one of the Lorekeeper default images.

By default, this uses the default behavior for thumbnail processing; the altered behavior can be enabled via the site settings admin panel. Note that for thumbnail generation, the cropping is assumed to fit as much of the character in the square space as possible. If you do not crop images along these lines, the cropping will likely be erroneous-- and, as the need to watermark the image is diminished in the first place, it is recommended you use the default cropping. Design update thumbnails are also generated on image upload, so any design updates with images uploaded before this will not be properly watermarked, if that is desired. This can be resolved by adjusting the crop on the thumbnail image, which will re-process it.

Installation

Pull the branch. Run

php artisan add-site-settings

Configuration

Enable resizing, watermarking, and/or thumbnail processing in the site settings admin panel as desired. If you enable watermarking, consider uploading a watermark in the site images admin panel.

Usage

Troubleshooting

I can be found in the Lorekeeper server!

See Also