Skip to content
This repository was archived by the owner on Jul 3, 2025. It is now read-only.

Commit 971d221

Browse files
committed
Update README.md
1 parent ebe41cd commit 971d221

File tree

8 files changed

+16
-14
lines changed

8 files changed

+16
-14
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,7 @@ jobs:
4141
run: dotnet test --configuration Release --no-build --verbosity normal
4242

4343
- name: Publish
44-
run: |
45-
dotnet publish --configuration Release --no-build \
46-
--runtime ${{ matrix.platform }}-${{ matrix.arch }} \
47-
--self-contained true \
48-
-p:PublishSingleFile=true \
49-
-p:PublishTrimmed=true \
50-
-o ./publish
44+
run: dotnet publish Animation2Tilemap/Animation2Tilemap.csproj --configuration Release --runtime ${{ matrix.platform }}-${{ matrix.arch }} --self-contained true -p:PublishSingleFile=true -p:UseAppHost=true -o ./publish
5145

5246
- name: Create Release Package
5347
shell: bash

Animation2Tilemap.Test/Animation2Tilemap.Test.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
<IsPackable>false</IsPackable>
99
<IsTestProject>true</IsTestProject>
10+
<RuntimeIdentifiers>win-x64;linux-x64;osx-x64</RuntimeIdentifiers>
1011
</PropertyGroup>
1112

1213
<ItemGroup>

Animation2Tilemap/Animation2Tilemap.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
<AssemblyName>$(MSBuildProjectName)</AssemblyName>
1010
<ApplicationIcon>icon.ico</ApplicationIcon>
1111
<LangVersion>12</LangVersion>
12+
<RuntimeIdentifiers>win-x64;linux-x64;osx-x64</RuntimeIdentifiers>
1213
</PropertyGroup>
1314

1415
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,23 @@ Animation2Tilemap is a tool that converts images or GIF animations into tilemaps
1414
- **Tilemap Generation** - Generate complete tilemaps that recreate your original animations
1515
- **Advanced Customization** - Control tile size, transparency settings, and frame timing
1616

17+
## Limitations
18+
19+
- Only orthographic maps are supported at this time
20+
1721
## Example
1822

1923
Convert a GIF animation into a tileset and tilemap:
2024

21-
| Input GIF Animation | Output Tilemap |
22-
|:-----------------------------:|:-------------------------------:|
23-
| ![Input](Resources/input.gif) | ![Output](Resources/result.png) |
24-
25-
Image source: https://x.com/jmw327/status/1405872936783802384
25+
| From | To |
26+
|:------------------------------------------------------:|:-------------------------------------------------------:|
27+
| <img src="Resources/Sonic_md_fg1.gif" width="1280"> | ![Input](Resources/Screenshot%20from%202025-05-17_.png) |
2628

2729
## Getting Started
2830

2931
### Installation
3032

31-
1. Ensure you have [.NET 8 runtime](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) installed.
33+
1. Ensure you have [.NET 10 runtime](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) installed.
3234
2. Download the latest release from the [releases page](https://github.com/vonhoff/Animation2Tilemap/releases).
3335
3. Extract the zip file to your preferred location.
3436

@@ -46,12 +48,16 @@ animation2tilemap --help
4648

4749
## How It Works
4850

49-
It begins by loading the input, which can be a single image, a multi-frame file (such as a GIF), or a folder of images. Multi-frame files are automatically treated as animations. When processing a folder where all images have the same dimensions, they are assumed to be animation frames; confirmation is requested unless the `--assume-animation` option is used.
51+
It starts by loading the input, which can be a single image, a multi-frame file (such as a GIF), or a folder of images. Multi-frame files are automatically treated as animations. When processing a folder where all images have the same dimensions, they are assumed to be animation frames; confirmation is requested unless the `--assume-animation` option is used.
5052

5153
Next, the tileset factory divides each frame into tiles and uses image hashing to track unique tiles at each grid position, ensuring that only unique tiles are stored for a compact tileset. For each grid position, a unique identifier is generated to represent the sequence of tiles across frames, capturing any tile animation patterns.
5254

5355
Finally, the tilemap factory constructs a tilemap that references the generated tileset, creating a map layer that reflects the original frame layout. It then uses the calculated sequence IDs to assign the correct animated tile ID to each grid position, reconstructing the original animation.
5456

57+
## Related Projects
58+
59+
For converting tilemaps to GIFs, check out [Tilemap2Animation](https://github.com/vonhoff/Tilemap2Animation).
60+
5561
## Support and Contribute
5662

5763
If you find value in this project, there are several ways you can contribute:
118 KB
Loading

Resources/Sonic_md_fg1.gif

23.1 KB
Loading

Resources/input.gif

-1.47 MB
Binary file not shown.

Resources/result.png

-176 KB
Binary file not shown.

0 commit comments

Comments
 (0)