https://github.com/indiesoftby/defold-dissolve-fx

An example of implementing the dissolve effect for sprites for the Defold game engine.
https://github.com/indiesoftby/defold-dissolve-fx

defold defold-asset defold-library

Last synced: 3 months ago
JSON representation

An example of implementing the dissolve effect for sprites for the Defold game engine.

• Host: GitHub
• URL: https://github.com/indiesoftby/defold-dissolve-fx
• Owner: indiesoftby
• License: cc0-1.0
• Created: 2023-09-14T21:30:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-11T14:28:07.000Z (over 1 year ago)
• Last Synced: 2024-10-25T09:48:29.839Z (3 months ago)
• Topics: defold, defold-asset, defold-library
• Language: Lua
• Homepage: https://indiesoftby.github.io/defold-dissolve-fx/
• Size: 4.92 MB
• Stars: 25
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-defold - Dissolve FX

README

        
[![Dissolve FX for Defold cover](cover.jpg)](https://github.com/indiesoftby/defold-dissolve-fx)

# Dissolve FX for Defold

This is an example of implementing the dissolve effect for sprites for the Defold game engine.

![Example video](example.gif)

> [!NOTE]

> Use [FastNoiseLite](https://github.com/Auburn/FastNoiseLite) to generate an unique and cool noise texture!

## Quick Start

1. Add this project as a [Defold library dependency](http://www.defold.com/manuals/libraries/). Open your `game.project` file and in the dependencies field under project add:

https://github.com/indiesoftby/defold-dissolve-fx/archive/main.zip

2. Next, add two textures to sprite's atlas: `noise` and `ramp`. The noise will be used to animate sprite's dissolve, and the ramp will be used to create the burning effect.

3. Set `dissolve_fx/materials/sprite.material` as the material of the sprite.

4. Do some magic in your script:

```lua

local dissolve_fx = require("dissolve_fx.dissolve_fx")

function init(self)

    dissolve_fx.init("#sprite", "noise", "ramp", "cover") -- args: sprite component with dissolve material, noise image name, ramp image name, scale mode (`cover`` or `stretch``).

    go.set("#sprite", "dissolve.z", 0.25) -- size of the fire. Adjust subjectively to your eye!

    go.set("#sprite", "dissolve.w", 0.0) -- to control the fx, 0.0 - 1.0

    -- Play the FX in the loop

    go.animate("#sprite", "dissolve.w", go.PLAYBACK_LOOP_PINGPONG, 1, go.EASING_LINEAR, 3)

end

```

## Credits

This project and all included assets are licensed under the terms of the CC0 1.0 Universal license. It's developed and supported by [@aglitchman](https://github.com/aglitchman).