Skip to content

3 Commands

Lauri Koutaniemi edited this page May 25, 2024 · 63 revisions

Introduction

With commands, you can send messages to custom paint run time. Command is a postMessage call with Javascript from another window, tab or document, to tell custom paint to perform actions. You can control the image, layers, effects, undo history and almost everything that is inside your custom paint application.

You can also chain the commands with semicolons (;) if you use the query parameter.

Using commands is very simple. Take a look for this example for integration.

Basically, you just send the command to custom content window to perform actions:

// sending commands to sumo (iframe)
sumo = document.getElementById('sumo')
sumo.contentWindow.postMessage({ 'command': 'command-to-send:optional-value' }, '*')

Here is a simple example for choosing the AI tool with prompt "dog" and generating the image.

// send commands to sumo
function command(c) {
  document.getElementById('sumo').contentWindow.postMessage({'command': c }, "*");
}

command('ai-create:dog')
command('ai-generate')

Adjustment

Commands for adjusting the colors.

adjustment-b

Update yellow-blue value of color adjustments. Possible values from -1 to 1.

adjustment-b:0.5 live dev local

adjustment-brightness

Update brightness value of color adjustments. Possible values from -1 to 1.

adjustment-brightness:0.5 live dev local

adjustment-contrast

Update contrast value of color adjustments. Possible values from -1 to 1.

adjustment-contrast:0.5 live dev local

adjustment-exposure

Update exposure value of color adjustments. Possible values from -1 to 1.

adjustment-exposure:0.5 dev

adjustment-g

Update magenta-green value of color adjustments. Possible values from -1 to 1.

adjustment-g:0.5 dev

adjustment-hue

Update hue value of color adjustments. Possible values from -1 to 1.

adjustment-hue:0.5 dev

adjustment-r

Update cyan-red value of color adjustments. Possible values from -1 to 1.

adjustment-r:0.5 dev

adjustment-saturation

Update saturation value of color adjustments. Possible values from -1 to 1.

adjustment-saturation:0.5 dev

adjustment-temperature

Update temperature value of color adjustments. Possible values from -1 to 1.

adjustment-temperature:0.5 dev

adjustment-tint

Update tint value of color adjustments. Possible values from -1 to 1.

adjustment-tint:0.5 dev

adjustment-vibrance

Update vibrance value of color adjustments. Possible values from -1 to 1.

adjustment-vibrance:0.5 dev

Adjustmentbrush

Commands for adjustmentbrush.

adjustmentbrush-opacity

Change brush opacity for the adjustmentbrush tool.

Example: https://tatami.sumo.app/?commands=adjustmentbrush-opacity:50

adjustmentbrush-pressure

Change brush pressure for the adjustmentbrush tool.

Example: https://tatami.sumo.app/?commands=adjustmentbrush-pressure:50

adjustmentbrush-size

Change brush size for the adjustmentbrush tool.

Example: https://tatami.sumo.app/?commands=adjustmentbrush-size:10

adjustmentbrush-spacing

Change brush spacing for the adjustmentbrush tool.

Example: https://tatami.sumo.app/?commands=adjustmentbrush-spacing:10

AI

Commands for AI features.

ai-create

Open AI tool with create mode. Optional parameter prompt.

ai-create dev

ai-create:lion dev

ai-fix-face

Run AI fix face for a photo.

Example: https://tatami.sumo.app/?work=face&commands=ai-fix-face

ai-generate

Generate AI image based on the mode and prompt.

ai-generate dev

ai-image-guidance-scale

Set image guidance scale for AI tool.

Example: https://tatami.sumo.app/?commands=ai-image-guidance-scale

ai-instruct

Open AI tool with instruct mode. Optional parameter prompt.

ai-instruct dev

ai-instruct:rabbit dev

ai-prompt

Change the AI prompt.

ai-prompt:dog dev

ai-prompt-negative

Change the negative prompt.

ai-prompt-negative:cat dev

ai-prompt-randomize

Randomize new prompt and negative prompt.

ai-prompt-randomize dev

ai-prompt-strength

Change prompt strength.

Example: https://tatami.sumo.app/?commands=ai-prompt-strenght:10

ai-reimagine

Open AI tool with reimagine mode. Optional parameter prompt.

ai-reimagine dev

ai-reimagine:mouse dev

ai-reimagine-strength

Set reimagine strength for AI tool.

Example: https://tatami.sumo.app/?commands=ai-reimagine-strength

ai-remove-background

Perform AI remove background command.

ai-remove-background dev

ai-scale-and-enhance

Perform AI scale and enhance command.

ai-scale-and-enhance dev

ai-scale-up

Perform AI scale up command.

ai-scale-up dev

ai-texture-generate

Generate AI texture.

Example: https://tatami.sumo.app/?commands=ai-texture-generate

API

API related commands.

api-save

Perform API save command. See api-start and api-data messages.

api-save dev

App

General commands for the app.

app-alert

Show alert message. Supports language strings. Full list of language strings is available here.

app-alert:login_first dev

app-install

Ask to install the app (PWA).

app-install dev

app-language

Change the app language.

app-language:fi dev

app-message

Add message below the top banner for the user.

app-message:message dev

app-parent

Send message to parent document.

Example: https://tatami.sumo.app/?run=false&commands=app-parent:message

app-reset

Reset the app settings and image to defaults.

app-reset dev

app-reset-user-data

Reset user data. Removes all user saved gradients, color swatches and shortcut buttons on cloud.

app-reset-user-data dev

app-run

Run app. If app is disabled with query parameter run=false, it should be started with this command.

Example: https://tatami.sumo.app/?run=false&commands=app-run

app-shortcut

Run shortcut button. Possible values from 1 to 10.

app-shortcut:1 dev

app-style

Update style for app element. Value should be in following format: element:parameter:value.

app-style:menu:background:red dev

app-view-toggle

Toggle app view between 3D and canvas. 3D object needs to be loaded.

app-view-toggle dev

app-work-name

Set work name.

Example: https://tatami.sumo.app/?commands=app-work-name:Test

Brush

Brush related commands.

brush-angle-random

Set angle random value for the brush. Possible values from 0 to 100.

brush-angle-random:50 dev

brush-auto-rotate

Toggle brush auto rotate. Optional parameter auto rotate value.

Example: https://tatami.sumo.app/?commands=brush-auto-rotate:10

brush-color

Set color for the brush. Hex value without hash.

brush-color:ff0000 (set brush color to red) dev

brush-color-random

Set color random value for the brush. Possible values from 0 to 100.

brush-color-random:50 dev

brush-color-save

Save color swatch.

Example: https://tatami.sumo.app/?commands=brush-color-save

brush-color-shortcut

Add new color shortcut. Hex value without hash.

brush-color-shortcut:ffff00 dev

brush-dash-length

Set brush dash length value.

Example: https://tatami.sumo.app/?commands=brush-dash-length:10

brush-drawing-assists

Open drawing assists. Optional parameter: "symmetry", "perspective", "gravity", "spinner" or "live stroke".

brush-drawing-assist dev

brush-drawing-assist:gravity dev

brush-drawing-assist-close

Close drawing assist.

Example: https://tatami.sumo.app/?commands=brush-drawing-assist-close

brush-dynamics

Set dynamics value for the brush. Possible values from -100 to 100.

brush-dynamics:50 dev

brush-dynamics-scale

Set dynamics scale value for the brush. Possible values from 0 to 100.

brush-dynamics-scale:50 dev

brush-fade-in

Set fade in value for the brush. Possible values from 0 to 512.

brush-fade-in:300 dev

brush-fade-out

Set fade out value for the brush. Possible values from 0 to 512.

brush-fade-out:300 dev

brush-gravity

Enable or disable gravity drawing assist. Optional values true or false.

brush-gravity dev

brush-gravity:false dev

brush-gravity-aim

Set brush gravity aim value.

Example: https://tatami.sumo.app/?commands=brush-gravity-aim:10

brush-gravity-friction

Set brush gravity friction value.

Example: https://tatami.sumo.app/?commands=brush-gravity-friction:10

brush-gravity-rope-length

Set brush gravity rope value.

Example: https://tatami.sumo.app/?commands=brush-gravity-rope-length:10

brush-hue

Set brush hue value in degrees. Possible values from 0 to 360.

brush-hue:100 (hue color 100 degrees) dev

brush-ink-fade

Set ink fade value for the brush. Possible values from 0 to 100.

brush-ink-fade:50 dev

brush-jitter

Set jitter value for the brush. Possible values from 0 to 30.

brush-jitter:20 dev

brush-light

Set brightness value for the brush. Possible values from 0 to 100.

brush-light:80 (set brush lightness to 80 %) dev

brush-livestroke

Activate livestroke drawing assist. Optional parameter for deactivation.

brush-livestroke (activate livestroke drawing assist) dev

brush-livestroke:false (deactivate livestroke drawing assist) dev

brush-load

Load brush. Required parameter brush id.

brush-load:1002 (load brush 1003) dev

brush-opacity

Change the brush opacity. Required parameter opacity in percent.

brush-opacity:50 (set brush opacity to 50 percent) dev

brush-perspective

Activate perspective drawing assist. Optional parameter for deactivation.

brush-perspective (activate perspective drawing assist) dev

brush-perspective:false (deactivate perspective drawing assist) dev

brush-pressure

Change the brush pressure. Required parameter pressure from 0 to 100.

brush-pressure:50 dev

brush-pressure-sensitivity

Change the brush pressure sensitivity. Required parameter from 0 to 100.

Example: https://tatami.sumo.app/?commands=brush-pressure-sensitivity:50

brush-rotate

Change the brush rotation. Required parameter rotation from 0 to 100.

brush-rotate:30 dev

brush-saturation

Change the brush saturation. Required parameter saturation in percents.

brush-saturation:30 (saturate the brush color with 30%) dev

brush-scale-random

Change the brush scale random. Required parameter size in percents.

brush-scale-random:20 dev

brush-size

Change the brush size. Required parameter size in pixels.

brush-size:100 (set brush size to 100 pixels) dev

brush-spacing

Change the brush spacing. Required parameter spacing in pixels.

brush-spacing:10 (set brush spacing to 10 pixels) dev

brush-spinner

Activate spinner drawing assist. Optional parameter for deactivation.

brush-spinner (activate spinner drawing assist) dev

brush-spinner:false (deactivate spinner drawing assist) dev

brush-spinner-speed

Spinner drawing assist speed.

Example: https://tatami.sumo.app/?commands=brush-spinner-speed:10

brush-symmetry

Activate symmetry drawing assist. Optional parameter points.

brush-symmetry (activate symmetry drawing assist) dev

brush-symmetry:10 (activate symmetry drawing assist with 10 points) dev

brush-symmetry:0 (deactivate symmetry drawing assist) dev

brush-stylus-options

Activate brush stylus options.

Example: https://tatami.sumo.app/?commands=brush-stylus-options

File

Commands for file handling.

file-backup

Create backup.

file-backup dev

file-download

Download file. Optional parameter format. Default value jpg.

file-download dev

file-download:png dev

file-export-as-pdf

Export file as PDF file.

Example: https://tatami.sumo.app/?commands=file-export-as-pdf

file-export-project

Export project in LZMA format.

file-export-project dev

file-new

Create new file. Required parameters width and height, separated with colon (:). Optional parameters bg and layer count.

file-new:1920:1080 dev

file-new:1920:1080:ff0000 dev

file-new:1920:1080:ffff00:5 dev

file-open-object

Open 3D object from url.

file-open-object:url dev

file-open-pricing

Open pricing page. Affiliate reference is always sent with the request.

file-open-pricing dev

file-open-url

Open image from url. Required parameter url.

file-open-url:url dev

file-open-work

Open work. Required parameter work slug.

file-open-work:work dev

file-open-work-page

Open work page. Required parameter work slug.

file-open-work-page:slug dev

file-restore

Restore latest backup.

file-restore dev

file-save-to-cloud

Save to cloud. Required parameters work name and status separated with colon (:).

file-save-to-cloud:work:1 dev

Fractal

Commands for fractal.

fractal-generate

Generate fractal art.

Example: https://tatami.sumo.app/?commands=fractal-generate

fractal-x

Generate fractal with x value.

Example: https://tatami.sumo.app/?commands=fractal-x:10

fractal-y

Generate fractal with y value.

Example: https://tatami.sumo.app/?commands=fractal-y:10

fractal-zoom

Generate fractal with zoom value.

Example: https://tatami.sumo.app/?commands=fractal-zoom:50

Frame

Commands for frames.

frames-add-frame

Add new frame.

Example: https://tatami.sumo.app/?commands=frames-add-frame

frames-delete-frame

Delete frame.

Example: https://tatami.sumo.app/?commands=frames-delete-frame

frames-duplicate-next

Duplicate frame.

Example: https://tatami.sumo.app/?commands=frames-duplicate-next

frames-ghost-toggle

Toggle ghost frame.

Example: https://tatami.sumo.app/?commands=frames-ghost-toggle

frames-goto

Go to selected frame.

Example: https://tatami.sumo.app/?commands=frames-goto:3

frames-goto-next

Go to next frame.

Example: https://tatami.sumo.app/?commands=frames-goto-next

frames-goto-previous

Go to previous frame.

Example: https://tatami.sumo.app/?commands=frames-goto-previous

frames-play

Play frames.

Example: https://tatami.sumo.app/?commands=frames-play

Gradient

Commands for gradient tool.

gradient-randomize

Randomize gradient to random colors without changing the handle points.

gradient-randomize dev

gradient-reverse

Reverse gradient.

gradient-reverse dev

Image

Commands for the image.

image-canvas

Change the canvas size. Required parameters width and height separated with colon (:).

image-canvas:600:600 dev

image-copy

Copy image.

image-copy dev

image-copy-selection

Copy selection from all layers as merged image.

image-copy-selection dev

image-create-coloring-project

Create coloring project from the image. Optional value word.

image-create-coloring-project dev

image-create-coloring-project:flower dev

image-crop

Crop image.

image-crop dev

image-export

Export image.

image-export dev

image-export-preview

Export 3D preview image.

image-export-preview dev

image-flatten

Flatten image.

image-flatten dev

image-flip-horizontal

Flip image horizontal.

image-flip-horizontal dev

image-flip-vertical

Flip image vertically.

image-flip-vertical dev

image-layer-from-selection

Create layer from selection.

image-layer-from-selection dev

image-redo

Redo last step.

image-redo dev

image-reset

Reset image. Flatten all layers and set background to default.

image-reset dev

image-rotate-180

Rotate image 180 degrees.

image-rotate-180 dev

image-rotate-90

Rotate image 90 degrees clockwise.

image-rotate-90 dev

image-rotate-90-ccw

Rotate image 90 degrees counter clockwise.

image-rotate-90-ccw dev

image-size

Set image size. Required parameters width and height separated with colon (:).

image-size:600:400 dev

image-undo

Undo last step.

image-undo dev

Layer

Commands for layers.

layer-add

Add new layer.

layer-add dev

layer-add-color

Show add color layer modal or add new color layer using hex color as parameter.

layer-add-color dev

layer-add-color:ff0000 dev

layer-analyze-colors

Analyze layer colors and add them to used colors for the color picker.

layer-analyze-colors dev

layer-blending-mode

Set blending mode for the selected layer. Required parameter blending mode.

layer-blending-mode dev

layer-brush-texture

Set layer as brush texture.

layer-brush-texture dev

layer-brush-tip

Set selected layer as brush tip.

layer-brush-tip dev

layer-center

Center layer to canvas. Do not resize.

layer-center dev

layer-clear

Clear the layer. Optional parameter index. If not set the selected layer will be cleared.

layer-clear (clear the selected layer) dev

layer-clear:0 (clear the bottom layer) dev

layer-copy

Copy layer. Optional parameter index. If not set the selected layer will be copied.

layer-copy (copy the selected layer) dev

layer-copy:0 (copy the bottom layer) dev

layer-copy-selection

Copy layer content from selection. Optional parameter index. If not set the selected layer's content will be copied.

layer-copy-selection (copy the selection from selected layer) dev

layer-copy-selection:0 (copy the selection from bottom layer) dev

layer-crop-auto

Auto crop and center layer.

layer-crop-auto dev

layer-cut

Cut layer. Optional parameter index. If not set the selected layer will be cut.

layer-cut (cut the selected layer) dev

layer-cut:0 (cut the bottom layer) dev

layer-delete

Delete layer. Optional parameter index. If not set the selected layer will be deleted.

layer-delete (delete the selected layer) dev

layer-delete:0 (delete the bottom layer) dev

layer-duplicate

Duplicate layer.

layer-duplicate dev

layer-export

Export layer. Optional parameter index. If not set the selected layer will be exported.

layer-export (export the selected layer) dev

layer-export:0 (export the bottom layer) dev

layer-export-all

Export all layers.

layer-export-all dev

layer-flip-horizontal

Flip layer image horizontal.

layer-flip-horizontal dev

layer-flip-vertical

Flip layer image vertical.

layer-flip-vertical dev

layer-generate

Generate layers based on layer data.

layer-generate dev

layer-hide

Hide layer. Optional parameter index. If not set the selected layer will be hided.

layer-hide (hide the selected layer) dev

layer-hide:0 (hide the bottom layer) dev

layer-import

Import image to layer from device.

layer-import dev

layer-import-mask

Add layer mask from url. Required parameter url to png image to use as a mask.

layer-import-mask:url dev

layer-import-url

Import url to layer. Required parameter url.

layer-import-url:https://cdn.sumo.app/images/icon.png dev

layer-invert-colors

Invert colors for the selected layer.

layer-invert-colors dev

layer-lock

Lock layer. Optional parameter index. If not set the selected layer will be locked.

layer-lock (lock the selected layer) dev

layer-lock:0 (lock the bottom layer) dev

layer-merge-down

Merge layer down.

layer-merge-down dev

layer-move

Move layer to new index.

layer-move:0:2 (move layer from index 0 to index 2) dev

layer-name

Update the name of the current layer.

layer-name:test dev

layer-opacity

Update the opacity of the current layer.

layer-opacity:0.5 dev

layer-paste

Paste clipboard content to layer.

layer-paste dev

layer-rotate-180

Rotate layer 180 degrees.

layer-rotate-180 dev

layer-rotate-90

Rotate layer 90 degrees clockwise.

layer-rotate-90 dev

layer-rotate-90-ccw

Rotate layer 90 degrees counter clockwise.

layer-rotate-90-ccw dev

layer-scale

Perform scale to layer. Required parameters width and height.

layer-scale:width:height dev

layer-scale-to-cover

Perform scale to cover for the layer. It will scale the layer to cover the canvas.

layer-scale-to-cover dev

layer-scale-to-fit

Perform scale to fit for the layer. It will scale the layer to fit inside the canvas.

layer-scale-to-fit dev

layer-select

Select layer. Optional parameter index. If not set the selected layer will be selected again.

layer-select:0 (select bottom layer) dev

layer-set-layer-as-page

Set layer as page.

layer-set-layer-as-page dev

layer-show

Show layer. Optional parameter index. If not set the selected layer will be visible.

layer-show (show the selected layer) dev

layer-show:0 (show bottom layer) dev

layer-toggle

Toggle visibility for the layer. Optional parameter index. If not set the selected layer will be toggled.

layer-toggle (toggle visibility for the selected layer) dev

layer-toggle:0 (toggle visibility for the bottom layer) dev

layer-toggle-lock

Toggle lock for the layer. Optional parameter index. If not set the selected layer will be toggled.

layer-toggle-lock (toggle lock for the selected layer) dev

layer-toggle-lock:0 (toggle lock for the bottom layer) dev

layer-transform

Move and scale layer. First two attributes x and y, then optional width and height.

Example: https://tatami.sumo.app/?commands=layer-transform:10:10:300:300

layer-unlock

Unlock layer. Optional parameter index. If not set the selected layer will be unlocked.

layer-unlock (unlock the selected layer) dev

layer-unlock:0 (unlock the bottom layer) dev

Lens

Commands for lenses.

lens-burn

Burn selected lens to layer.

lens-burn dev

lens-clarity

Open clarity lens.

lens-clarity dev

lens-clear

Clear lenses.

lens-clear dev

lens-cmyk-halftone

Open cmyk halftone lens.

lens-cmyk-halftone dev

lens-difference-of-gaussian

Open difference of gaussian lens.

lens-difference-of-gaussian dev

lens-directional-blur

Open directional blur lens.

lens-directional-blur dev

lens-displace

Open displace lens.

lens-displace dev

lens-hexallate

Open hexallate lens.

lens-hexallate dev

lens-kaleidoscope

Open kaleidoscope lens.

lens-kaleidoscope dev

lens-pixelate

Open pixelate lens.

lens-pixelate dev

lens-spin-blur

Open spin blur lens.

lens-spin-blur dev

Modal

Commands for modals.

modal-about

Show about modal.

modal-about dev

modal-adjust-colors

Show adjust colors modal.

modal-adjust-colors dev

modal-ai-fix-face

Show AI fix face modal.

ai-fix-face dev

modal-ai-images-browser

Show AI images browser.

modal-ai-images-browser dev

modal-analyze-colors

Show analyze colors modal.

modal-analyze-colors dev

modal-assets-browser

Show assets browser.

Example: https://tatami.sumo.app/?commands=modal-assets-browser

modal-brush-browser

Show brush browser.

Example: https://tatami.sumo.app/?commands=modal-brush-browser

modal-brush-preset-save

Show save brush preset modal.

modal-brush-preset-save dev

modal-brush-preset-delete

Show delete brush preset modal.

Example: https://tatami.sumo.app/?commands=modal-brush-preset-delete

modal-canvas-size

Show canvas size modal. Optional parameters width and height.

modal-canvas-size dev

modal-canvas-size:800:600 dev

modal-close

Close modal.

Example: https://tatami.sumo.app/?commands=modal-close

modal-close-color-adjustments

Close color adjustments.

Example: https://tatami.sumo.app/?commands=modal-close-color-adjustments

modal-close-fractal

Close fractal modal.

Example: https://tatami.sumo.app/?commands=modal-close-fractal

modal-close-lens-options

Close lens options.

Example: https://tatami.sumo.app/?commands=modal-close-lens-options

modal-convert-to-coloring

Show convert to coloring modal.

modal-convert-to-coloring dev

modal-create-qrcode

Open create QR code modal.

Example: https://tatami.sumo.app/?commands=modal-create-qrcode

modal-image-size

Show image size modal. Optional parameters width and height.

modal-image-size dev

modal-image-size:800:600 dev

modal-import-coloring

Show import coloring modal.

modal-import-coloring dev

modal-import-mask

Show import mask file system modal.

modal-import-mask dev

modal-import-object

Show import object modal.

modal-import-object dev

modal-install

Show install modal.

modal-install dev

modal-lenses

Show lenses modal. Optional parameter selected lens.

modal-lenses dev

modal-lenses:pixelate dev

modal-login

Show login modal.

modal-login dev

modal-mandala-browser

Open mandala browser.

Example: https://tatami.sumo.app/?commands=modal-mandala-browser

modal-new

Show new image modal. Optional parameters width and height or width, height and color.

modal-new dev

modal-new:1920:1080 dev

modal-new:300:300:ff0000 dev

modal-new-coloring

Show new coloring modal.

modal-new-coloring dev

modal-new-fractal

Open fractal modal.

Example: https://tatami.sumo.app/?commands=modal-new-fractal

modal-object-browser

Show object browser.

modal-object-browser dev

modal-open-from-cloud

Show open from cloud modal.

modal-open-from-cloud dev

modal-open-from-device

Show open from device modal.

modal-open-from-device dev

modal-open-from-url

Show open from url modal.

modal-open-from-url dev

modal-photo

Show photo modal.

Example: https://tatami.sumo.app/?commands=modal-photo

modal-rating

Show rating modal.

Example: https://tatami.sumo.app/?commands=modal-rating

modal-save-asset

Show save asset modal.

Example: https://tatami.sumo.app/?commands=modal-save-asset

modal-save-to-cloud

Show save to cloud modal.

modal-save-to-cloud dev

modal-save-to-device

Show save to device modal.

modal-save-to-device dev

modal-share

Show share modal.

modal-share dev

modal-text-browser

Show text browser.

Example: https://tatami.sumo.app/?commands=modal-text-browser

modal-toggle-script

Toggle script modal.

Example: https://tatami.sumo.app/?commands=modal-toggle-script

modal-two-factor-auth

Show two factor auth modal.

modal-two-factor-auth dev

modal-welcome

Show welcome modal.

Example: https://tatami.sumo.app/?commands=modal-welcome

modal-work-info

Show work info modal.

Example: https://tatami.sumo.app/?commands=modal-work-info

Object

Commands for 3D objects.

object-mesh

Update object mesh. Requires new mesh data as JSON object.

object-mesh:{ "object1": { "parameter":value }, "object2": {} } dev

Panel

Commands for panels.

panel-add

Select add panel.

Example: https://tatami.sumo.app/?commands=panel-add

panel-close

Close panels or individual panel.

panel-close (close all panels) dev

panel-close:layers (close only layers panel) dev

panel-info

Select info panel.

panel-info dev

panel-layers

Select layers panel.

panel-layers dev

panel-user

Select user panel.

panel-user dev

Pointer

Commands for pointer events.

pointer-end

End pointer.

Example: https://tatami.sumo.app/?commands=pointer-end

pointer-move

Move pointer.

Example: https://tatami.sumo.app/?commands=pointer-move

pointer-start

Start pointer.

Example: https://tatami.sumo.app/?commands=pointer-start

Select

Commands for select tool and selecting objects.

select-all

Select all pixels.

select-all dev

select-alpha

Select transparent pixels from the layer.

select-alpha dev

select-area

Select rectangle area. Requires 4 parameters (top, right, bottom, left) separated with colon (:).

select-area:100:300:300:100 (selects 200x200 pixels from x:100 and y:100) dev

select-create-mask

Create mask from selection.

Example: https://tatami.sumo.app/?commands=select-create-mask

select-deselect

Remove selection if selection exists.

select-deselect dev

select-duplicate

Duplicate selected area from selected layer.

select-duplicate dev

select-erase

Clear selected area.

select-erase dev

select-invert

Select invert pixels.

select-invert dev

select-magic-fill

Perform select magic fill action.

select-magic-fill dev

Shape

Commands for shapes.

shape-add

Add new shape. Optional 8 parameters (shape:stroke:x:y:w:h:color:strokecolor).

Example: https://tatami.sumo.app/?commands=shape-add:circle:0:10:10:300:300:ff0000

shape-bring-to-front

Bring shape to front.

shape-bring-to-front dev

shape-corner-roundness

Change shape corner roundness.

Example: https://tatami.sumo.app/?commands=shape-corner-roundness:10

shape-delete

Delete selected shape. Optional parameter shape id.

shape-delete dev

shape-delete:1 (delete shape with id 1) dev

shape-gradient-fill-color1

Change shape gradient fill (color 1).

Example: https://tatami.sumo.app/?commands=shape-gradient-fill-color1:ff0000

shape-gradient-fill-color2

Change shape gradient fill (color 2).

Example: https://tatami.sumo.app/?commands=shape-gradient-fill-color2:ff0000

shape-gradient-fill

Change shape gradient fill.

Example: https://tatami.sumo.app/?commands=shape-gradient-fill:value

shape-gradient-fill-startx

Change shape gradient fill start x position.

Example: https://tatami.sumo.app/?commands=shape-gradient-fill-startx:10

shape-gradient-fill-endx

Change shape gradient fill end x position.

Example: https://tatami.sumo.app/?commands=shape-gradient-fill-endx:100

shape-gradient-fill-starty

Change shape gradient fill start y position.

Example: https://tatami.sumo.app/?commands=shape-gradient-fill-starty:10

shape-gradient-fill-endy

Change shape gradient fill end y position.

Example: https://tatami.sumo.app/?commands=shape-gradient-fill-endy:100

shape-peak-radius1

Change shape peak radius 1.

Example: https://tatami.sumo.app/?commands=shape-peak-radius1:100

shape-peak-radius2

Change shape peak radius 2.

Example: https://tatami.sumo.app/?commands=shape-peak-radius2:200

shape-peak-roundness

Change shape peak roundness.

Example: https://tatami.sumo.app/?commands=shape-peak-roundness:20

shape-peaks

Change shape peaks.

Example: https://tatami.sumo.app/?commands=shape-peaks:5

shape-points

Change shape points.

Example: https://tatami.sumo.app/?commands=shape-points:10

shape-send-to-back

Send shape to back.

shape-send-to-back dev

shape-set-fill-color

Set fill color for the shape.

Example: https://tatami.sumo.app/?commands=shape-set-fill-color:ffff00

shape-set-outline-color

Set outline color for the shape.

Example: https://tatami.sumo.app/?commands=shape-set-outline-color:ff0000

shape-stroke-width

Set stroke width for the shape.

Example: https://tatami.sumo.app/?commands=shape-stroke-width:10

Text

Commands for texts.

text-add

Add new text element. Optional value for the selected text string.

text-add dev

text-add:test (add text "test") dev

text-align-bottom

Align text to bottom of the text box.

text-align-bottom dev

text-align-center

Align text to center of the text box.

text-align-center dev

text-align-left

Align text to left of the text box.

text-align-left dev

text-align-middle

Align text to middle of the text box.

text-align-middle dev

text-align-right

Align text to right of the text box.

text-align-right dev

text-align-top

Align text to top of the text box.

text-align-top dev

text-set

Set text. First parameter is text id and second is new value.

Example: https://tatami.sumo.app/?commands=text-set:id:value

text-set-color

Set text color.

Example: https://tatami.sumo.app/?commands=text-set-color:ff0000

text-shadow-x

Set text shadow x distance.

Example: https://tatami.sumo.app/?commands=text-shadow-x:2

text-shadow-y

Set text shadow y distance.

Example: https://tatami.sumo.app/?commands=text-shadow-y:2

text-shadow-blur

Set text shadow blur.

Example: https://tatami.sumo.app/?commands=text-shadow-blur:2

text-shadow-strength

Set text shadow strength.

Example: https://tatami.sumo.app/?commands=text-shadow-strength:2

text-shadow-color

Set text shadow color.

Example: https://tatami.sumo.app/?commands=text-shadow-color:ff0000

text-size

Set text size.

Example: https://tatami.sumo.app/?commands=text-size:24

text-tool

Set text tool and add text. See text-add for optional parameters.

Example: https://tatami.sumo.app/?commands=text-tool:Text

Tool

Commands for tools.

tool-adjustmentbrush

Select adjustmentbrush tool. Optional value mode. Possible values "pro" or "none".

tool-adjustmentbrush dev

tool-adjustmentbrush:pro (open with pro tools) dev

tool-adjustmentbrush:none (open without quick actions) dev

tool-ai

Select ai tool. Optional value mode. Possible values "pro" or "none".

tool-ai dev

tool-ai:pro (open with pro tools) dev

tool-ai:none (open without quick actions) dev

tool-brush

Select brush tool. Optional value mode. Possible values "pro" or "none".

tool-brush dev

tool-brush:pro (open with pro tools) dev

tool-brush:none (open without quick actions) dev

tool-circle

Select shape tool with circle mode. Optional value mode. Possible values "pro" or "none".

tool-circle dev

tool-circle:pro (open with pro tools) dev

tool-circle:none (open without quick actions) dev

tool-color

Choose select tool with color mode. Optional value mode. Possible values "pro" or "none".

tool-color dev

tool-color:pro (open with pro tools) dev

tool-color:none (open without quick actions) dev

tool-color-threshold

Set color threshold.

Example: https://tatami.sumo.app/?commands=tool-color-threshold:10

tool-color-softness

Set color softness.

Example: https://tatami.sumo.app/?commands=tool-color-softness:10

tool-crop

Select crop tool. Optional value mode. Possible values "pro" or "none".

tool-crop dev

tool-crop:pro (open with pro tools) dev

tool-crop:none (open without quick actions) dev

tool-dashedline

Select dashed line tool. Optional value mode. Possible values "pro" or "none".

tool-dashedline dev

tool-dashedline:pro (open with pro tools) dev

tool-dashedline:none (open without quick actions) dev

tool-ellipsoid

Choose select tool with ellipsoid mode. Optional value mode. Possible values "pro" or "none".

tool-ellipsoid dev

tool-ellipsoid:pro (open with pro tools) dev

tool-ellipsoid:none (open without quick actions) dev

tool-eraser

Select eraser tool. Optional value mode. Possible values "pro" or "none".

tool-eraser dev

tool-eraser:pro (open with pro tools) dev

tool-eraser:none (open without quick actions) dev

tool-eyedropper

Select eyedropper tool. Optional value mode. Possible values "pro" or "none".

tool-eyedropper dev

tool-eyedropper:pro (open with pro tools) dev

tool-eyedropper:none (open without quick actions) dev

tool-gingerbread

Choose gingerbread tool.

Example: https://tatami.sumo.app/?commands=tool-gingerbread

tool-gradient

Select gradient tool. Optional value mode. Possible values "pro" or "none".

tool-gradient dev

tool-gradient:pro (open with pro tools) dev

tool-gradient:none (open without quick actions) dev

tool-gradient-hue

Set gradient hue.

Example: https://tatami.sumo.app/?commands=tool-gradient-hue:10

tool-gradient-saturation

Set gradient saturation.

Example: https://tatami.sumo.app/?commands=tool-gradient-saturation:10

tool-gradient-light

Set gradient light.

Example: https://tatami.sumo.app/?commands=tool-gradient-light:10

tool-lasso

Choose select tool with lasso mode. Optional value mode. Possible values "pro" or "none".

tool-lasso dev

tool-lasso:pro (open with pro tools) dev

tool-lasso:none (open without quick actions) dev

tool-move

Select move tool. Optional value mode. Possible values "pro" or "none".

tool-move dev

tool-move:pro (open with pro tools) dev

tool-move:none (open without quick actions) dev

tool-paintbucket

Select paint bucket tool. Optional value mode. Possible values "pro" or "none".

tool-paintbucket dev

tool-paintbucket:pro (open with pro tools) dev

tool-paintbucket:none (open without quick actions) dev

tool-polygon

Select shape tool with polygon mode. Optional value mode. Possible values "pro" or "none".

tool-polygon dev

tool-polygon:pro (open with pro tools) dev

tool-polygon:none (open without quick actions) dev

tool-polygonlasso

Choose select tool with polygon lasso mode.

Example: https://tatami.sumo.app/?commands=tool-polygonlasso

tool-rectangle

Select shape tool with rectangle mode. Optional value mode. Possible values "pro" or "none".

tool-rectangle dev

tool-rectangle:pro (open with pro tools) dev

tool-rectangle:none (open without quick actions) dev

tool-secondary

Open secondary tool (if exists). Optional value mode. Possible values "pro" or "none"

tool-secondary dev

tool-secondary:pro (open with pro tools) dev

tool-secondary:none (open without quick actions) dev

tool-select

Choose select tool. Optional value mode. Possible values "pro" or "none".

tool-select dev

tool-select:pro (open with pro tools) dev

tool-select:none (open without quick actions) dev

tool-smudge

Select smudge tool. Optional value mode. Possible values "pro" or "none".

tool-smudge dev

tool-smudge:pro (open with pro tools) dev

tool-smudge:none (open without quick actions) dev

tool-star

Select shape tool with star mode. Optional value mode. Possible values "pro" or "none".

tool-star dev

tool-star:pro (open with pro tools) dev

tool-star:none (open without quick actions) dev

tool-text

Select text tool. Optional value mode. Possible values "pro" or "none".

tool-text dev

tool-text:pro (open with pro tools) dev

Tunes

tunes-play

Play tunes song.

Example: https://tatami.sumo.app/?commands=tunes-play

tunes-stop

Stop tunes song.

Example: https://tatami.sumo.app/?commands=tunes-stop

tunes-tempo

Change song tempo.

Example: https://tatami.sumo.app/?commands=tunes-tempo:200

tunes-volume

Change song volume.

Example: https://tatami.sumo.app/?commands=tunes-volume:50

View

Commands for view.

view-frames

View frames.

Example: https://tatami.sumo.app/?commands=view-frames

view-recorder

View recorder.

Example: https://tatami.sumo.app/?commands=view-recorder

Vignette

Commands for vignette.

vignette-exposure

Change vignette exposure.

Example: https://tatami.sumo.app/?commands=vignette-exposure:50

vignette-hardness

Change vignette hardness.

Example: https://tatami.sumo.app/?commands=vignette-hardness:50

vignette-opacity

Change vignette opacity.

Example: https://tatami.sumo.app/?commands=vignette-opacity:50

vignette-position

Change vignette position.

Example: https://tatami.sumo.app/?commands=vignette-position:50

vignette-radius

Change vignette radius.

Example: https://tatami.sumo.app/?commands=vignette-radius:50

Clone this wiki locally