Difference between revisions of "Extensions:Watermarking"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Created page with "{{subst:Extension Page}}")
Tag: 2017 source edit
 
Tag: 2017 source edit
Line 1: Line 1:
{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Watermarking|desc=Adds support for automatic resizing and watermarking of images uploaded to the masterlist.|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=watermarking}}|migration=no|package=no}}
 
<!-- Put a short summary of your extension here! -->
 
<!-- Put a short summary of your extension here! -->
 +
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.
 +
 +
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.
 
== Installation ==
 
== Installation ==
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 +
Pull the branch. Run <pre>php artisan add-site-settings</pre>
 
== 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.
 
== Usage ==
 
== Usage ==
 
<!-- Is there anything users should know about using your extension? -->
 
<!-- Is there anything users should know about using your extension? -->
 
== Troubleshooting ==
 
== Troubleshooting ==
 
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
 
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
 +
I can be found in the Lorekeeper server!
 
== See Also ==
 
== See Also ==
 
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 

Revision as of 22:27, 24 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.

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.

Installation

Pull the branch. Run

php artisan add-site-settings

Configuration

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.

Usage

Troubleshooting

I can be found in the Lorekeeper server!

See Also