Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
zarstensen committed Jul 8, 2023
2 parents d6001f6 + bd25c91 commit 46b2469
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,50 @@

</div>

Record and generate timelapses automatically whilst drawing in the [aseprite](https://www.aseprite.org/) program.
Record and generate time lapses automatically whilst drawing in the [aseprite](https://www.aseprite.org/) program.

Below is the timelapse generated, for the creation of the extension icon:
Below is the time lapse generated, for the creation of the extension icon:

<img src=resources/AselapseIcon-lapse.gif alt="Icon" width="160" height="160"/>

This extension requires Aseprite version 1.3-rc3 or greater to function.

To download the latest beta trough steam, please perform the following steps:
- go to 'Library'
- Right click Aseprite,
- Click 'Properties'
- Go to the 'Betas' menu
- Select 'beta - v1.3 ...' under beta participation.
## Usage

To enable timelapse recording for a sprite, locate the 'Edit Timelapse' command, under the Sprite menu. The sprite must be saved to disk before this is done!
To enable time lapse recording for a sprite, locate the 'Edit time lapse' command, under the Sprite menu. The sprite must be saved to disk before this is done!

<img src=resources/MenuLocation.png alt="Icon" width="160" height="160"/>

When pressed the following dialog window will appear.

<img src=resources/Dialog.png alt="Icon" height="160"/>

This window displays the current number of frames recorded for the timelapse, and lets one pause and restart recording, as well as generate a sprite, that contains the timelapse.
This window displays the current number of frames recorded for the time lapse, and lets one pause and restart recording, as well as generate a sprite, that contains the time lapse.


<img src=resources/UsageExample.gif alt="Icon" height="400"/>

The extension automatically begins recording sprites on project load, that previously have enabled the timelapse function.
### Modifying timelapses
The extension automatically begins recording sprites on project load, that previously have enabled the time lapse function.
### Modifying time lapses

To modify a timelapse, first close the sprite which timelapse needs to be modified.
To modify a time lapse, first close the sprite which time lapse needs to be modified.

Then locate a file with the same name as the target sprite, suffixed with '-lapse'.
For example 'Sprite.aseprite' will have its modifyable timelapse stored in the 'Sprite-lapse.aseprite' in the same folder.
For example 'Sprite.aseprite' will have its modifyable time lapse stored in the 'Sprite-lapse.aseprite' in the same folder.

Perform any modifications to the timelapse, and reopen the target sprite.
Perform any modifications to the time lapse, and reopen the target sprite.

The timelapse stored in the extension should now match up with the modified version on disk.
The time lapse stored in the extension should now match up with the modified version on disk.

## [IMPORTANT] Moving / Renaming Sprites

If your sprite (lets say 'Sprite.aseprite') has a timelapse, and you want to move it to a different folder, you also need to move the 'Sprite-lapse.json' as well as the 'Sprite-lapse.aseprite' files along with it, to preserve the timelapse data.
If your sprite (lets say 'Sprite.aseprite') has a time lapse, and you want to move it to a different folder, you also need to move the 'Sprite-lapse.json' as well as the 'Sprite-lapse.aseprite' files along with it, to preserve the time lapse data.

Simmilarly, when renaming a sprite file, (e.g. 'Sprite_A.aseprite' to 'Sprite_B.aseprite'), you need to rename the following files as well:

Expand All @@ -55,7 +61,7 @@ Download the 'aselapse.aseprite-extension' file, under [Releases](https://github

Double-click and say yes to install.

Whenever the extension is run for the first time, some popup windows will appear asking for some permissions. These permissions are needed by the extension, to store the timelapse and some json files on disk.
Whenever the extension is run for the first time, some popup windows will appear asking for some permissions. These permissions are needed by the extension, to store the time lapse and some json files on disk.

To disable these popups check the 'Dont't show this specific alert again for this script' (this will need to be done multiple times for every sprite). And press 'Allow Write Access' (or similar).

Expand Down

0 comments on commit 46b2469

Please sign in to comment.