Request flags
=======================

By default, the following post-processing options modify the entire request.

Syntax:
        `!REQ_TYPE ITEM [BRACKET]... [--flag]`

An example of functional usage of request flags would look like
this:

        `!req Taxi Driver [40:40] [45:00] --contrast 10 --aspect-quotient 1.1`

General processing
######################
--raw
************************

Don't crop the images.

--ultraraw
************************

Like `--raw`, but don't draw quotes.

--apply-to
************************

An indexed range of images that will be processed with the flags set. By default,
every image is processed. The flag can contain a single index or a
hyphen separated range (e.g. `1` or `1-2`). The index start is `1`.

Font processing
#########################

--font
************************

A custom font to use for every image (default: `segoesm`).

Available font values:
    nfsans helvetica helvetica-italic clearsans clearsans-regular
    clearsans-italic opensans comicsans impact segoe segoe-italic
    segoesm papyrus bangers timesnewroman oldenglish
    segoe-bold-italic

.. warning::
    Ensure that your joke is **really** funny when you request Comic
    Sans, Papyrus or Impact.
.. note::
    Kinobot will default to `segoesm` if you type a non-existent font
    value.

.. note::
    Most of the following descriptions were partially taken from the
    Pillow (PIL Fork) documentation.

--font-size
************************

A relative (to the image) float or integer value defining the font size (default: 27.0).

--font-color
************************

Acolor string; it can be a common html name (e.g. black, white, etc.) or a hexadecimal value (default: white).

--text-spacing
************************

An integer value defining the number of pixels between lines (default: 1.0).

--text-align
************************

The relative alignment of lines; it can be `left`, `center` or `right` (default: center).

--y-offset
************************

An integer value defining the relative vertical offset of the text (default: 85).

--stroke-width
************************

An integer value defining the relative stroke width (font border size for technologically illiterate cinephiles) (default: 3).

--stroke-color
************************

Same as `--font-color`, but for the stroke (default: black).

--text-background
************************
  
Same as `--font-color`, but a background color for the text (default: None).

.. note::
    The font stroke will be removed if `--text-background` is set.

Image processing
########################

--aspect-quotient
************************

A float value defining the aspect ratio's quotient that will be applied for every image.
By default, Kinobot will detect the "ideal" aspect ratio by amount
of images (e.g. 1.6 for one image; 1.8 for two images).

.. warning::
    This flag will raise `InvalidRequest` if the quotient is greater
    than 2.4 or lesser than 1.1.

--brightness
************************

An integer value defining -100 to 100 brightness to apply to all the images (default: 0)

--color
************************

An integer value defining -100 to 100 color to apply to all the images (default: 0)

--contrast
************************

An integer value defining -100 to 100 contrast to apply to all the images (default: 20)

--sharpness
************************

An integer value defining -100 to 100 sharpness to apply to all the images (default: 0)

Collage processing
########################

--no-collage
************************

Don't try to draw a collage, no matter the amount of frames (default: False)

.. warning::
    `--no-collage` is **highly discouraged** as it is spammy; you might
    piss off people in the server with your experimental dumbassery.
    Use it only when you know what you are doing.

--dimensions
************************

The dimensions of the collage that Kinobot should draw. By default,
Kinobot will detect this automatically. You can choose between 1x2,
1x3, 2x1, 2x2, 1x4, 1x5, 2x3, 1x7 and 2x4.

.. note::
    These values should match the amount of frames produced (e.g 2x2
    for 4 frames, 1x2 for 2 frames, etc).

--border
************************

A custom list of comma separated integer values defining the relative extra colored border values that will be applied to every
image (default 0,0). Only works for collages.

--border-color
************************
  
Same as `--font-color`, but for borders (default: white).