From 8b4cc23bb0a595039c58ed7043d0c43f4c3d8b36 Mon Sep 17 00:00:00 2001 From: annabunches Date: Tue, 30 Jul 2024 21:54:35 -0400 Subject: [PATCH] Documentation cleanup. --- readme.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 63f061d..61a9e2d 100644 --- a/readme.md +++ b/readme.md @@ -8,17 +8,26 @@ To install, go to Aseprite's Settings -> Extensions -> Add Extension, and select ## Features -* Choose which layers to export, regardless of visibility. -* Export groups as a single sprite. +* Export layers regardless of visibility. (layers and groups can instead be explicitly ignored) +* Selectively export layer groups as single sprites without modifying or flattening the groups. * Configure layer settings via Layer menu, right click menu, or keyboard shortcut. +* Modify settings for multiple selected layers at once. ## Usage -* All layers are exported by default. To ignore the active layer or group, select Layer -> Advanced Export -> Toggle Ignore. (default keyboard shortcut: Ctrl+Alt+I) -* To export a layer group as a single sprite, select Layer -> Advanced Export -> Toggle Merge Group. (default keyboard shortcut: Ctrl+Alt+M) -* Invoke the tool via File -> Export -> Export Sprite Sheet (Advanced). (default keyboard shortcut: Ctrl+Alt+E) +* All layers are exported by default. To ignore the active layer or group, select Layer -> Advanced Export -> Toggle Ignore. +* To export a layer group as a single sprite, select Layer -> Advanced Export -> Toggle Merge Group. +* Invoke the tool via File -> Export -> Export Sprite Sheet (Advanced). -## Additional Notes +### Default Keyboard Shortcuts + +| Command | Keyboard Shortcut (Windows and Linux) | Shortcut (MacOS) | +|-------------------------------|---------------------------------------|------------------| +| Toggle Ignore Layer(s) | Ctrl+Alt+I | Cmd+Ctrl+I | +| Toggle Merge Group(s) | Ctrl+Alt+M | Cmd+Ctrl+M | +| Export Spritesheet (Advanced) | Ctrl+Alt+E | Cmd+Ctrl+E | + +### Additional Notes * Ignored layers always take precedence over merging; if a sublayer in a group is ignored, it will not be merged into the final sprite. * Toggling the advanced export settings on a layer will modify the layer colors. The extension will attempt to detect and preserve user-colored layers. If you happen to use one of the exact colors we have chosen, this will fail. We have chosen odd alpha values to reduce the likelihood of a false negative, but if you are using layer colors extensively, this extension may not work well for you.