Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AtlasEngineCa/ParticleEmitter
Library for drawing particle effects in Minecraft java edition using bedrock json files
https://github.com/AtlasEngineCa/ParticleEmitter
minecraft minecraft-java-edition minestom-library snowstorm
Last synced: 12 days ago
JSON representation
Library for drawing particle effects in Minecraft java edition using bedrock json files
- Host: GitHub
- URL: https://github.com/AtlasEngineCa/ParticleEmitter
- Owner: AtlasEngineCa
- License: apache-2.0
- Created: 2022-10-15T01:47:10.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-19T07:18:56.000Z (15 days ago)
- Last Synced: 2024-06-19T15:37:00.387Z (15 days ago)
- Topics: minecraft, minecraft-java-edition, minestom-library, snowstorm
- Language: Java
- Homepage:
- Size: 1.01 MB
- Stars: 38
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-minestom - ParticleEmitter - Library for drawing particle effects with [Snowstorm](https://snowstorm.app/) (Libraries)
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![APACHE-2.0 License][license-shield]][license-url]
## About The Project
With this library, you can design particle animations with [snowstorm](https://snowstorm.app/) and draw them in a Minecraft world.
Currently only [Minestom](https://github.com/Minestom/Minestom) is supported.
## Getting Started
A full, runnable example server can be found in [here](https://github.com/WorldSeedGames/ParticleEmitter/blob/master/src/test/java/Demo.java)
Particle examples can be found [here](https://github.com/WorldSeedGames/ParticleEmitter/tree/master/src/test/resources/particles)
### Adding as a dependency
Add the following to your `build.gradle.kts` file:
```
repositories {
maven("https://reposilite.worldseed.online/public")
}
```
Add the library as a dependency
```
dependencies {
implementation("net.worldseed.particleemitter:ParticleEmitter:")
}
```
The lastest version number can be found [here](https://reposilite.worldseed.online/#/public/net/worldseed/particleemitter/ParticleEmitter)
### JAVA FLAGS
To execute the code you must add the java VM flag `--add-opens java.base/java.lang=ALL-UNNAMED`.
## Features
ParticleEmitter supports the following features
- Emitter lifetime expression, loop and once
- Emitter rate instant and steady
- Emitter shape box, disc, point and sphere
- Particle tinting (colour)
## Limitations
[Minecraft Query Language](https://github.com/hollow-cube/common/tree/main/modules/mql) (MQL) does not fully support Molang
- Variables do not work
- Functions do not work
Particle Restrictions
- Velocity only works on certain particles and acceleration don't work on any particles
- Custom particle textures don't work
- Curves have not been implemented
- Particle lifetimes have not been implemented
[contributors-shield]: https://img.shields.io/github/contributors/WorldSeedGames/ParticleEmitter.svg?style=for-the-badge
[contributors-url]: https://github.com/WorldSeedGames/ParticleEmitter/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/WorldSeedGames/ParticleEmitter.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[stars-shield]: https://img.shields.io/github/stars/WorldSeedGames/ParticleEmitter.svg?style=for-the-badge
[stars-url]: https://github.com/WorldSeedGames/ParticleEmitter/stargazers
[issues-shield]: https://img.shields.io/github/issues/WorldSeedGames/ParticleEmitter.svg?style=for-the-badge
[issues-url]: https://github.com/WorldSeedGames/ParticleEmitter/issues
[license-shield]: https://img.shields.io/github/license/WorldSeedGames/ParticleEmitter?style=for-the-badge
[license-url]: https://github.com/WorldSeedGames/ParticleEmitter/blob/master/LICENSE
