Skip to content

Commit 86ecb6e

Browse files
authored
clarity improvements (#12)
1 parent 1b5f7f5 commit 86ecb6e

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

.github/demo.png

15.7 KB
Loading

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,24 @@
55

66
This project is a DMI (BYOND's Dream Maker icon files) editor extension for Aseprite, a popular pixel art tool. It is written in Rust and Lua and aims to enhance the Aseprite experience by providing tools for editing and managing DMI files.
77

8-
## Download
8+
![demo screenshot](./.github/demo.png)
99

10-
The latest version of this extension is available for download from the [Releases](https://github.com/spacestation13/aseprite-dmi/releases) page on the project's GitHub repository.
10+
## Download
1111

12+
The latest version of this extension is available for download from the [Releases](https://github.com/spacestation13/aseprite-dmi/releases) page.
1213
The plugin will also prompt you to download an update when a new version is released.
1314

14-
### Linux
15+
## Usage
1516

16-
Unfortunately, due to dynamic library linking issues, __Aseprite running on Linux via Steam is not supported.__
17+
Once the project has been downloaded or built, the extension can be added to Aseprite by dragging and dropping it into the application or by selecting the 'Add Extension' button in the 'Edit > Preferences > Extensions' menu.
1718

18-
Running a Windows build via Wine works just fine, and is what we recommend.
19+
**DMI files can now be opened in Aseprite in the same way as any other file format.** You will need to change the open file dialog filter to 'All Files'.
1920

20-
## Usage
21+
### Linux
2122

22-
Once the project has been downloaded or built, the extension can be added to Aseprite by dragging and dropping it into the application or by selecting the 'Add Extension' button in the 'Edit > Preferences > Extensions' menu.
23+
Unfortunately, due to dynamic library linking issues, **Aseprite running on Linux via Steam is not supported.**
2324

24-
DMI files can now be opened in Aseprite in the same way as any other file format. You will need to change the open file dialog filter to 'All Files'.
25+
Running a Windows build via Wine works just fine, and is what we recommend.
2526

2627
### Creating New Files
2728

@@ -44,17 +45,18 @@ In Aseprite's timeline, new frames can be added and delays between frames can be
4445
The DMI file may be expanded, resized, or cropped via the `File > DMI Editor` menu. It should be noted that the active sprite must be a DMI iconstate in order to utilise these commands.
4546

4647
### Plugin Preferences
48+
4749
Under the `File > DMI Editor` menu, there is an `Preferences` menu which contains various options:
4850

49-
- **Auto Overwrite**: Automatically overwrites the source DMI file when saving an iconstate.
50-
- **Auto Flatten** *(Enabled by Default)*: Automatically flattens layers downward into directional layers when saving an iconstate, allowing you to fully use Aseprite layers.
51+
- **Auto Overwrite**: Automatically overwrites the source DMI file when saving an iconstate.
52+
- **Auto Flatten** _(Enabled by Default)_: Automatically flattens layers downward into directional layers when saving an iconstate, allowing you to fully use Aseprite layers.
5153

5254
## Building the Project
5355

5456
### Requirements
5557

56-
- [Rust](https://www.rust-lang.org/)
57-
- [Python](https://www.python.org/) (build script)
58+
- [Rust](https://www.rust-lang.org/)
59+
- [Python](https://www.python.org/) (build script)
5860

5961
To build the project, run `tools/build.py` Python script.
6062

scripts/main.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ function init(plugin)
101101

102102
plugin:newCommand {
103103
id = "dmi_raw_open",
104-
title = "Open DMI (No Editor - Will Delete DMI Metadata!!)",
104+
title = "ADVANCED: Open DMI as Spritesheet (Won't save DMI metadata!)",
105105
group = "dmi_editor",
106106
onclick = function()
107107
opening_dmi_noeditor = true

0 commit comments

Comments
 (0)