preferences
Retrieve or update Aseprite application, tool, or per-sprite document settings by section and option names.
Instructions
Gets or sets an Aseprite preference (app.preferences..), a tool preference (tool=) or a per-sprite document preference (document=true). Use list_preferences to discover names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tool | No | Read tool preferences for this tool id | |
| value | No | ||
| action | Yes | ||
| option | Yes | Option name; nested options use dots, e.g. 'brush.size' with section from the tool prefs | |
| sprite | No | File path, open tab title, or sprite id. Defaults to the active sprite (live). Batch mode needs a file path. | |
| backend | No | auto (default): live Aseprite if connected, else headless batch | |
| section | Yes | ||
| document | No | Read the sprite's document preferences |