Skip to content

Commit af2b66d

Browse files
committed
updated readme
1 parent 3e73168 commit af2b66d

File tree

1 file changed

+40
-26
lines changed

1 file changed

+40
-26
lines changed

README.md

Lines changed: 40 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,49 @@ This repository does not provide any instructions on how to modify any Supercell
1919
- [Requirements](#requirements)
2020
- [Installing](#installing)
2121
- [Updating](#plugin-update)
22-
- [Dependencies](#dependecies)
2322
- [Building](#building)
2423
- [Examples](#examples)
2524
- [Changelog](#changelog)
26-
- [Authors](#authors)
2725
- [Support](#support)
2826

2927
<br/>
3028

29+
# How to use
30+
- Check [requirements](#requirements), make sure everything is satisfied
31+
- [Install](#installing) or [build](#building) extension
32+
- Open your Adobe Animate and go to New Document panel
33+
- Create new "SupercellSWF" document:
34+
35+
<p align="center">
36+
<img src="./assets/new_document_panel.png" width="45%">
37+
</p>
38+
39+
- Create something!
40+
In [examples](#examples) you can find good and different use cases for extension in different games!
41+
Also, before creating something, do not forget to read information about ["limitations"](#Limitations) that will help you not to create any problems.
42+
43+
- To set export options you need to click "File -> Publish Settings.."
44+
You can set all options here for the first time only once and then just press "Publish" button. You can also find a description of all options in ["Publisher options"](#publisher-options)
45+
46+
<p align="center">
47+
<img src="./assets/publish_settings_select.png" width="35%" height="30%">
48+
</p>
49+
50+
- After setting all options, you can click on publish button. You are great!
51+
Then you just need to wait until file is saved.
52+
53+
# Content creation tips
54+
For the most part these tips will help you make a more "correct" and more optimized project.
55+
56+
- Be sure to pay attention to ["Limitations"](#limitations) section.
57+
- Pay attention to linkage name.
58+
Plugin exports only MovieClips that have an linkage name, it is used as export name of symbol.
59+
For details, see [Examples](#examples)
60+
- Avoid using sprites, and especially vector graphics in MovieClips.
61+
Animate is a fairly flexible program and you will notice very little difference between different types of symbols, but speed of export and rendering performance in general depends on how correctly you use these types.
62+
When organizing project structure, note that Shapes or so-called Graphic symbols are intended to contain sprites or vector graphics. They can have only one frame.
63+
At the same time, MovieClip symbols are used to create animation using shapes. They can have an unlimited (within technical limits) number of frames and they can have a linkage name.
64+
3165
# Support
3266
This project was created with the goal of exploring various interesting tools and to support a small but quite creative community of modders. I put a lot of heart and time into this creation, so if you want to support me, you can buy me a coffee right here :3
3367
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/daniilsivi)
@@ -75,31 +109,7 @@ Full support. Be careful when using it, the result can be very unstable.
75109

76110
- Nine-slice ✅
77111
Full support. But keep in mind that on Animate 2024 and above this may not work correctly.
78-
79-
# How to use
80-
- Check [requirements](#requirements), make sure everything is satisfied
81-
- [Install](#installing) or [build](#building) extension
82-
- Open your Adobe Animate and go to New Document panel
83-
- Create new "SupercellSWF" document:
84112

85-
<p align="center">
86-
<img src="./assets/new_document_panel.png" width="45%">
87-
</p>
88-
89-
- Create something!
90-
In [examples](#examples) you can find good and different use cases for extension in different games!
91-
Also, before creating something, do not forget to read information about ["limitations"](#Limitations) that will help you not to create any problems.
92-
93-
- To set export options you need to click "File -> Publish Settings.."
94-
You can set all options here for the first time only once and then just press "Publish" button. You can also find a description of all options in ["Publisher options"](#publisher-options)
95-
96-
<p align="center">
97-
<img src="./assets/publish_settings_select.png" width="35%" height="30%">
98-
</p>
99-
100-
- After setting all options, you can click on publish button. You are great!
101-
Then you just need to wait until file is saved.
102-
103113
# Limitations
104114

105115
- Color transforms
@@ -190,6 +200,10 @@ If you find any problem with export process or you just need any help, please re
190200
Also, native part of plugin saves logs in "%temp%/org.scWorkshop.SupercellSWF_export_log.txt", please provide them along with a description for a faster solution to the problem.
191201

192202
# Changelog
203+
## v 1.3.1
204+
- Improved progress window behavior
205+
- Added object caching
206+
- Various bug fixes
193207
## v 1.3.0
194208
- Improved Atlas Generator
195209
- Added SC2 support

0 commit comments

Comments
 (0)