kudit/particleeffects

Features

• Can develop and modify without Xcode using Swift Playgrounds on iPad!
• SF Symbol particles
• Image particles
• Emoji particles
• Text particles
• Easily specify multiple symbols/images/emoji/text to use by comma-separating a string.
• Emmitter customizations

Requirements

Most of these minimums are dictated by our usage of Date.now which is needed.

• iOS 15+ (15.2+ minimum required for Swift Playgrounds support)
• macOS 12+
• macCatalyst 13.0+ (first version available)
• tvOS 15.0+
• watchOS 8.0+
• visionOS 1.0+
• Theoretically should work with Linux, Windows, and Vapor, but haven't tested. If you would like to help, please let us know.

Known Issues

See CHANGELOG.md for known issues and roadmap

Installation

Install by adding this as a package dependency to your code. This can be done in Xcode or Swift Playgrounds!

Swift Package Manager

Swift 5+

You can try these examples in a Swift Playground by adding package: https://github.com/kudit/ParticleEffects

If the repository is private, use the following link to import: https://<your-PAT-string>@github.com/kudit/ParticleEffects.git

Or you can manually enter the following in the Package.swift file:

dependencies: [
    .package(url: "https://github.com/kudit/ParticleEffects.git", from: "1.0.0"),
]

Usage

First make sure to import the framework:

import ParticleEffects

Here are some usage examples.

Get the version of ParticleEffects that is imported.

let version = ParticleEffects.version

Create a simple fire emitter.

ParticleSystemView(behavior: .fire)
    .font(.largeTitle)
    .aspectRatio(contentMode: .fit)

Create a rainbow sunburst emitter. Note the ability to take a base behavior and modify specific values.

ParticleSystemView(behavior:
    .sun.modified(
        string: "star.fill",
        birthRate: .frequent,
        blur: Blur.none,
        coloring: .rainbow
    )
).aspectRatio(contentMode: .fit)

Create an emoji confetti emitter.

ParticleSystemView(behavior: .fountain, string: "😊,👍,☺️,👏,🙌")

All these tests can be demonstrated using previews or by running the app executable that is bundled in the Development folder of the module.

Thanks

Inspired by Effects Library by GetStream

Contributing

If you have the need for a specific feature that you want implemented or if you experienced a bug, please open an issue. If you extended the functionality yourself and want others to use it too, please submit a pull request.

Donations

This was a lot of work. If you find this useful particularly if you use this in a commercial product, please consider making a donation to http://paypal.me/kudit

License

Feel free to use this in projects, however, please include a link back to this project and credit somewhere in the app. Example Markdown and string interpolation for the version:

Text("Open Source projects used include [ParticleEffects](https://github.com/kudit/ParticleEffects) v\(ParticleEffects.version)

Contributors

The complete list of people who contributed to this project is available here. A big thanks to everyone who has contributed! 🙏

Package Metadata

Repository: kudit/particleeffects

Default branch: main

README: README.md