https://github.com/funexpected/godot-flash-module

https://github.com/funexpected/godot-flash-module

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/funexpected/godot-flash-module
• Owner: funexpected
• License: mit
• Created: 2020-06-04T07:11:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-10T11:30:38.000Z (8 months ago)
• Last Synced: 2024-08-02T06:19:20.790Z (6 months ago)
• Language: C++
• Size: 153 KB
• Stars: 37
• Watchers: 5
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-godot - Flash Module - Use Adobe Animate (Flash) projects in Godot. (Modules / 3D)
• awesome-godot-3 - Flash Module - Use Adobe Animate (Flash) projects in Godot. (Modules / 3D)
• awesome-godot-3 - Flash Module - Use Adobe Animate (Flash) projects in Godot. (Modules / 3D)

README

        
## About

This module adds [Adobe Animate](https://www.adobe.com/products/animate.html) animation support for Godot Engine. `FlashPlayer` node available to draw a flash document (imported as` FlashDocument` resource) within a single draw call. You can use the precompiled editor (see [releases](https://github.com/funexpected/godot-flash-module/releases)) or build editor and templates by yourself.

## Compilation

Add this repo to `modules/flash` folder of Godot Engine source. See engine [compilation instructions](https://docs.godotengine.org/en/stable/development/compiling/index.html) instructions.

``` bash

cd /path/to/godot

git submodule add https://github.com/funexpected/godot-flash-module.git modules/flash

scons -j8

```

## Usage

- Install [Funexpected Flash Tools](https://github.com/funexpected/flash-tools) plugin.

- Export your `Amazing Project.xfl` Flash project using `Commands/Funepxected Tools/Export` to` amazing_project.zfl`

- Add `amazing_project.zfl` to Godot project

- Add `FlashPlayer` node to the scene

- Set `Resource` property of` FlashPlayer` to `res: // amazing_project.zfl`

- You can switch active timeline, label (if it present), and change skins of symbols.

## Supported and planed features

- [x] Bitmaps (full rasterization prepared by [Funexpected Flash Tools](https://github.com/funexpected/flash-tools))

- [x] Groups (decomposed and rasterized)

- [x] Name Labels (for splitting single animation to multiply parts)

- [x] Anchor Labels (for skinning, e.g. forcing custom frames in target symbols)

- [x] User-defined signals (`animation_event` using comment-labels)

- [x] Predefined signals (`animation_completed`)

- [x] Looping (loop, once, single frame)

- [x] Color effects

- [x] Tweening (for properties together)

- [x] Masks (up to 4 masking elements per masked element)

- [x] Mutltiply spritesheets packed by [Funexpected Flash Tools](https://github.com/funexpected/flash-tools)

- [x] Downscaling spritesheets on import time

- [x] Custom properties for importing textures (loseless/vram/uncompressed, mipmaps, filter)

- [x] Compressing VRAM textures (reducing disk space of exported Godot project)

## Unsupported features:

- [ ] Shapes

- [ ] Tweening (for properties separately)

- [ ] Motion guides

- [ ] Warp tool

- [ ] Sounds

- [ ] Custom material (for now, you can't change material for `FlashPlayer` node)

- [ ] Blending

- [ ] Filters