Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omrawaley/ab-particles
This is a particle system I designed for the 8-bit gaming platform, the Arduboy. However, it can be ported to other platforms with ease.
https://github.com/omrawaley/ab-particles
arduboy arduino cpp particle-physics particle-system particles
Last synced: 3 days ago
JSON representation
This is a particle system I designed for the 8-bit gaming platform, the Arduboy. However, it can be ported to other platforms with ease.
- Host: GitHub
- URL: https://github.com/omrawaley/ab-particles
- Owner: omrawaley
- License: apache-2.0
- Created: 2023-06-10T14:37:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-18T13:30:06.000Z (over 1 year ago)
- Last Synced: 2024-11-12T13:16:38.903Z (3 days ago)
- Topics: arduboy, arduino, cpp, particle-physics, particle-system, particles
- Language: Makefile
- Homepage:
- Size: 303 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AB-Particles Particle System
**V1.1.0 now out with new settings and features.**
AB-Particles is a particle system I designed for the 8-bit gaming platform, the [Arduboy](https://www.arduboy.com/). However, it can be ported to other platforms with ease. I probably will end up porting it to the ESP32.
A simple `.ino` file is included for a demo of the particle system, and it's use.
(Default settings shown above. The "explosion" can be altered by the user)
## Features
AB-Particles is a simple, minamalistic approach to a particle system.
Currently, it has the option for either square or circular particles, and an option to have filled or "outlined" particles.
Square (not filled):
Square (filled):
Circular (not filled):
Circular (filled):
Each particle also has a set lifespan/lifetime, where after the lifespan of a particle is over, the particle will disapear. The lifespan of a particle is pseudo-randomly generated, leading some particles to disapear earlier than others for a nice effect.
A horizontal and vertical force (which are added to the particle's velocity) is also pseudo-randomly generated (but restricted by a limit defined by the user) meaning each and every time you reset (and update + render) the particles, you'll have an entirely new effect.
Bigger particles (defined by `size`) will also fall faster than smaller particles, giving the "explosion" a realistic feel.
You can also define how many particles you want. (30 by default).
Settings are configured inside the `User-Setup.cpp` file.
One setting is also available in `User-Setup.h`, however most will not need to change it unless they have memory concerns regarding their program.
## To Use:
To utilise AB-Particles in your project, you must include the `AB-Particles.cpp` and `AB-Particles.h` files (available above in the `src` folder) in your project directory.
From then, make an object of the class `Particles` called `particles`, as `particles` is `extern`ed in the header meaning it is known throughout all your project files. Same thing with the `Arduboy2` class, so you should call your `Arduboy2` object `arduboy`. If you have any confusion regarding this step, feel free to check out the demo included.
Note that in order for the `random()` function to work properly, you must seed it with the `Arduboy2` function, `initRandomSeed()` in `setup()`.
As mentioned above, you can change and configure values/settings in the `User-Setup.cpp` file.
### Functions
AB-Particles includes three functions: `reset(float x, float y)`, `update()`, and `render()`.
`reset(float x, float y)`: Randomizes each particle's attributes in the array set, and takes an x and y coordinate for each particle's position (world space or camera space depending on what you input to the function).
`update()`: Updates each particle per frame.
`render()`: Renders each particle per frame.
## License Notice:
Copyright 2023 Om Rawaley (@omrawaley)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### Terms
- Redistribution and modification is permitted as long as you abide by the redistribution terms
- The author or license cannot be held liable for any damage caused by the software
- Must include a copy of the license and original copyright notice when redistributing
- Must state all changes made to the software when distributing