{"id":15174288,"url":"https://github.com/bytez1337/particlelib","last_synced_at":"2025-10-01T12:30:47.494Z","repository":{"id":40473782,"uuid":"191531426","full_name":"ByteZ1337/ParticleLib","owner":"ByteZ1337","description":"Multiversion spigot library supporting all particles and their data (1.8-1.19.3)","archived":true,"fork":false,"pushed_at":"2023-06-15T16:15:53.000Z","size":380,"stargazers_count":275,"open_issues_count":0,"forks_count":28,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-09-23T05:02:15.093Z","etag":null,"topics":["bukkit","minecraft","minecraft-api","minecraft-library","minecraft-particleeffect","minecraft-particles","particle","particle-api","particleapi","particleeffect","particles","spigot","spigot-particle-api","spigot-particles"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ByteZ1337.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"patreon":"xenondevs"}},"created_at":"2019-06-12T08:36:30.000Z","updated_at":"2024-09-08T05:37:11.000Z","dependencies_parsed_at":"2023-01-30T19:10:39.438Z","dependency_job_id":"185dcac9-f50f-4519-8128-2d589c8e7d78","html_url":"https://github.com/ByteZ1337/ParticleLib","commit_stats":{"total_commits":164,"total_committers":8,"mean_commits":20.5,"dds":0.2682926829268293,"last_synced_commit":"9218785ce91c8f68498684cf4a1534b4040dd2b2"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ByteZ1337%2FParticleLib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ByteZ1337%2FParticleLib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ByteZ1337%2FParticleLib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ByteZ1337%2FParticleLib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ByteZ1337","download_url":"https://codeload.github.com/ByteZ1337/ParticleLib/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219871445,"owners_count":16554410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bukkit","minecraft","minecraft-api","minecraft-library","minecraft-particleeffect","minecraft-particles","particle","particle-api","particleapi","particleeffect","particles","spigot","spigot-particle-api","spigot-particles"],"created_at":"2024-09-27T11:42:37.739Z","updated_at":"2025-10-01T12:30:47.152Z","avatar_url":"https://github.com/ByteZ1337.png","language":"Java","readme":"# NO LONGER MAINTAINED. ANY VERSION AFTER 1.19.4 WILL NOT BE SUPPORTED! USE [PAPER'S PARTICLEBUILDER](https://jd.papermc.io/paper/1.20/com/destroystokyo/paper/ParticleBuilder.html)\n\n\u003ch1 align=\"center\"\u003e\n  \u003cimg width=250 height=250 src=\"https://raw.githubusercontent.com/ByteZ1337/ParticleLib/0703161cf8b3402541c895885fbd0083ac688394/.github/img/logo.svg\" /\u003e\n  \u003cbr\u003eParticleLib\u003cbr\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eA spigot library supporting all particles from \u003ccode\u003e1.8\u003c/code\u003e to \u003ccode\u003e1.19.3\u003c/code\u003e\u003c/b\u003e\u003cbr\u003e\u003cbr\u003e\n  \u003ca href=\"https://app.codacy.com/manual/ByteZ1337/ParticleLib?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=ByteZ1337/ParticleLib\u0026utm_campaign=Badge_Grade_Dashboard\"\u003e\n    \u003cimg src=\"https://api.codacy.com/project/badge/Grade/166f125b74014326831ca21c1d7df65b\" alt=\"codacy\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://search.maven.org/artifact/xyz.xenondevs/particle\"\u003e\n    \u003cimg src=\"https://img.shields.io/maven-central/v/xyz.xenondevs/particle\" alt=\"maven\"\u003e \n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/ByteZ1337/ParticleLib/issues\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/ByteZ1337/ParticleLib\" alt=\"issues\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/ByteZ1337/ParticleLib/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/ByteZ1337/ParticleLib\" alt=\"stars\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/ByteZ1337/ParticleLib/blob/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/ByteZ1337/ParticleLib\" alt=\"license\"/\u003e\n  \u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/ByteZ1337/ParticleLib/maven.yml?branch=master\" alt=\"build\"/\u003e\u003cbr\u003e\u003cbr\u003e\n  \u003ca href=\"#support\"\u003eSupport\u003c/a\u003e •\n  \u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e •\n  \u003ca href=\"#download\"\u003eDownload\u003c/a\u003e •\n  \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\n\u003c/p\u003e\n\n## Support\n\nJoin the [Discord](https://discord.gg/EpVMXtXB2t) if you have any questions. **Don't** open an issue to ask for support.\n\n## Features\n\n* Multiversion support from 1.8 - 1.19.3 \u003csup\u003e(All in one Jar)\u003c/sup\u003e\n* Colored particles\n* Particles with custom velocities\n* Particles with textures\n* Support for every particle in minecraft\n* An easy and fluent API to easily spawn particles with custom data\n\n## Download\n\nThe latest version \u003cimg src=\"https://img.shields.io/github/v/release/ByteZ1337/ParticleLib\"/\u003e can be downloaded on the\n\u003ca href=\"https://github.com/ByteZ1337/ParticleLib/releases\"\u003ereleases\u003c/a\u003e page.\u003cbr\u003e\n\n### Maven\n\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003exyz.xenondevs\u003c/groupId\u003e\n        \u003cartifactId\u003eparticle\u003c/artifactId\u003e\n        \u003cversion\u003e1.8.4\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n### Gradle\n\n```groovy\ndependencies {\n    implementation 'xyz.xenondevs:particle:1.8.4'\n}\n```\n\n\u003csmall\u003eNote: ParticleLib is on the central repository, so no extra repositories are required.\u003c/small\u003e\n\n## Usage\n\n\u003cb\u003eFor more advanced usage explanations check out the [Wiki](https://github.com/ByteZ1337/ParticleLib/wiki). \u003c/b\u003e\n\n### Simple\n\nTo spawn particles, you can either use the ``ParticleEffet#display`` method, or you can use the ``ParticleBuilder``.\n\u003cbr\u003eFor normal particles without any extra data, the display method is the best choice.\n\n**Example:**\n\n```java\nParticleEffect.FLAME.display(location);\n```\n\nThis code will spawn a flame particle at the specified location.\n\n**Some particles can have extra data. This data can contain a range of different properties.**\u003cbr\u003e\nFor these special cases, I will only use the ParticleBuilder. Display methods with the specific parameters still exist,\nbut shouldn't be used to avoid confusion.\n\n---\n\n### Directional\n\nSome particles accept a custom velocity. When given a ``Vector`` they will travel to the specified offset. The velocity\nis stored in the offsetX, offsetY and offsetZ properties of the particle.\n\nTo see if a particle is Directional check if it has the ``DIRECTIONAL`` PropertyType.\n\n**Note:** The particles ``Enchantment_Table`` and ``Nautilus`` will be displayed at the offset location and fly to the\noriginal location.\n\n**Example:**\n\n```java\nnew ParticleBuilder(ParticleEffect.FLAME, player.getLocation())\n        .setOffsetY(1f)\n        .setSpeed(0.1f)\n        .display();\n```\n\nThis code will spawn a flame particle that flies to the player's head.\u003cbr\u003e\n\nMinecraft's particles can behave quite weirdly, so you may have to tweak the speed parameter when using directional\nparticles.\n\n---\n\n### Colored\n\nA few particles like ``Redstone`` can have custom colors applied to them. This color can be set with ``ParticleColor``\nimplementations:\n\n* ``RegularColor``\n* ``NoteColor``\n\nIf your plugin runs on a pre 1.13 server, you can also set the RGB values in the offset properties.\n\nTo see if a particle is colorable check if it has the ``COLORABLE`` PropertyType.\n\n**Note:**\n\n* Since 1.13 ``Redstone`` particles are storing their color values in another property. Therefore, the offset properties can be properly used on servers above 1.13.\n* ``Note`` particles don't accept a custom color. Instead, they support a note value from 0 to 24. Use ``NoteColor`` for\n  this particle.\n\n**Regular Example:**\n\n```java\nnew ParticleBuilder(ParticleEffect.REDSTONE, location)\n        .setParticleData(new RegularColor(255,255,0))\n        .display()\n```\n\nThis code will spawn a yellow ``Redstone`` particle at the specified location.\n\n``setParticleData(new RegularColor(255, 255, 0))`` can also be replaced with ``setColor(Color.YELLOW)`` in case you want\nto use ``java.awt.Color`` instead.\n\n**Note Example:**\n\n```java\nnew ParticleBuilder(ParticleEffect.NOTE, location)\n        .setParticleData(new NoteColor(1))\n        .display()\n```\n\nThis code will spawn a green ``Note`` particle at the specified location.\n\n---\n\n### Textured\n\nSeveral particles even accept textures as custom properties! These textures are modified with implementations of the\n``ParticleTexture`` class:\n\n* ``BlockTexture``\n* ``ItemTexture``\n\n**Warning:** These particles **NEED** the texture property, or the particle won't be displayed.\n\nTo see if a particle supports custom textures check if it has the ``REQUIRES_BLOCK`` or the ``REQUIRES_ITEM``\nPropertyType.\n\n\u003cb\u003eBlock texture example:\u003c/b\u003e\n\n```java\nnew ParticleBuilder(ParticleEffect.FALLING_DUST, location)\n        .setParticleData(new BlockTexture(Material.STONE))\n        .display()\n```\n\nThis code will spawn a ``Falling Dust`` particle with a stone texture.\n\n\u003cb\u003eItem texture example:\u003c/b\u003e\n\n```java\nItemStack item = new ItemStack(Material.DIAMOND_AXE);\nnew ParticleBuilder(ParticleEffect.ITEM_CRACK, location)\n        .setParticleData(new ItemTexture(item))\n        .display();\n```\n\nThis code will spawn an ``Item Crack`` particle with a diamond axe texture.\n","funding_links":["https://patreon.com/xenondevs"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytez1337%2Fparticlelib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbytez1337%2Fparticlelib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytez1337%2Fparticlelib/lists"}