Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BrianHicks/elm-particle
Simple particle system for web apps. Designed for visual flourishes like confetti.
https://github.com/BrianHicks/elm-particle
Last synced: 26 days ago
JSON representation
Simple particle system for web apps. Designed for visual flourishes like confetti.
- Host: GitHub
- URL: https://github.com/BrianHicks/elm-particle
- Owner: BrianHicks
- License: bsd-3-clause
- Created: 2018-10-27T18:28:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-03T16:59:53.000Z (about 3 years ago)
- Last Synced: 2024-05-08T23:43:53.572Z (about 2 months ago)
- Language: Elm
- Homepage: https://package.elm-lang.org/packages/BrianHicks/elm-particle/latest/
- Size: 390 KB
- Stars: 36
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-ccamel - BrianHicks/elm-particle - Simple particle system for web apps. Designed for visual flourishes like confetti. (Elm)
- awesome-elm-gamedev - Elm-Particle - Simple particle system for web apps. (Tools)
README
# elm-particle
Simple particle system for web apps.
Designed for visual flourishes like confetti.
```
elm install BrianHicks/elm-particle
```
## Getting Started
The general overview of elm-particle:
1. Create a Random generator for the types of particles you want.
2. Combine those to make effects, like confetti bursting or a stream of water.
3. Give those to a system which manages random seeds and animation frame subscriptions for you!
You can see fully worked examples online:
- 🎉 [Confetti](https://brianhicks.github.io/elm-particle/Confetti.html)
- 🚰 [Water](https://brianhicks.github.io/elm-particle/Water.html)
- 🎇 [Fireworks](https://brianhicks.github.io/elm-particle/Firework.html)
The source for these examples all live in the `examples` directory on GitHub.
If you'd like to see how this is done step-by-step, I gave a [20-minute presentation at Olso Elm Day 2019](https://www.youtube.com/watch?v=goL7LeDHFi4).
There's also [an Elm town episode on the background behind elm-particle](https://elmtown.simplecast.fm/confetti-and-waterfalls).
## Climate Action
I want my open-source activities to support projects addressing the climate crisis (for example, projects in clean energy, public transit, reforestation, or sustainable agriculture.)
If you are working on such a project, and find a bug or missing feature in any of my libraries, **please let me know and I will treat your issue as high priority.**
I'd also be happy to support such projects in other ways.
In particular, I've worked with Elm for a long time and would be happy to advise on your implementation.
## License
`elm-particle` is licensed under the BSD 3-Clause license, located at `LICENSE`.