https://github.com/kudit/particleeffects
ParticleEffects allows developers to create particle systems with minimal effort that are compatible with macOS, iOS, iPadOS, visionOS, tvOS, and watchOS.
https://github.com/kudit/particleeffects
Last synced: 9 months ago
JSON representation
ParticleEffects allows developers to create particle systems with minimal effort that are compatible with macOS, iOS, iPadOS, visionOS, tvOS, and watchOS.
- Host: GitHub
- URL: https://github.com/kudit/particleeffects
- Owner: kudit
- License: apache-2.0
- Created: 2024-05-04T05:49:12.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-12T03:36:13.000Z (about 1 year ago)
- Last Synced: 2025-10-21T09:59:43.905Z (9 months ago)
- Language: Swift
- Homepage:
- Size: 8.49 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://swiftpackageindex.com/kudit/ParticleEffects)
# ParticleEffects.swiftpm
ParticleEffects allows developers to create particle systems with minimal effort that are compatible with macOS, iOS, iPadOS, visionOS, tvOS, and watchOS.
The primary goals are to be easily maintainable by multiple individuals, employ a consistent API that can be used across all platforms, and to be maintainable using Swift Playgrounds on iPad and macOS. APIs are typically present even on platforms that don't support all features so that availability checks do not have to be performed in external code, and where irrelevant, code can simply return optionals.
This is actively maintained so if there is a feature request or change, we will strive to address within a week.
## 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://@github.com/kudit/ParticleEffects.git`
Or you can manually enter the following in the Package.swift file:
```swift
dependencies: [
.package(url: "https://github.com/kudit/ParticleEffects.git", from: "1.0.0"),
]
```
## Usage
First make sure to import the framework:
```swift
import ParticleEffects
```
Here are some usage examples.
### Get the version of ParticleEffects that is imported.
```swift
let version = ParticleEffects.version
```
### Create a simple fire emitter.
```swift
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.
```swift
ParticleSystemView(behavior:
.sun.modified(
string: "star.fill",
birthRate: .frequent,
blur: Blur.none,
coloring: .rainbow
)
).aspectRatio(contentMode: .fit)
```
### Create an emoji confetti emitter.
```swift
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](https://github.com/GetStream/effects-library)
## 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:
```swift
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](https://github.com/kudit/ParticleEffects/graphs/contributors).
A big thanks to everyone who has contributed! 🙏