ParticleAnimationLib

Хочешь создавать крутые эффекты частиц — конусы, кубы, сферы и вихри — но не знаешь как? Тогда этот мод для тебя! В основном это утилита для разработчиков, но как игрок ты можешь поиграться с командами, особенно чтобы опробовать эффекты перед тем, как реализовать их в коде. Мод полностью серверный, то есть на клиенте он не нужен. Как ты, наверное, догадался, он вдохновлён плагином EffectLib.

Доступные на данный момент эффекты:

• [3D] Анимированная сфера, Сфера, Параллелепипед, Вихрь, Конус, Пончик
• [2D] Дуга, Линия, Анимированный круг, Цветные и чёрно-белые изображения, Текст

На данный момент мод находится в бете, так что что-то ещё может ломаться или немного меняться. И некоторые эффекты пока отсутствуют. Версия для Forge/NeoForge может появиться в будущем, но сначала я хочу полностью доделать Fabric/Quilt, прежде чем начинать порт. Извините! (Скорее всего, пока он будет работать через Syntra connector)

Как использовать этот мод

Сам по себе этот мод предназначен только для разработчиков. Но не волнуйся, если ты игрок и всё ещё хочешь попробовать все эти потрясающие эффекты (пусть пока и с некоторыми ограничениями), ты можешь сделать это, установив ParticleAnimationLibCommands.

Да, я знаю, команды немного длинные и запутанные, поэтому я также начал работу над вики, которую можно найти вот здесь!

Как создавать эффекты?

Все эффекты находятся в пакете effects, и ты можешь создать новый эффект, просто создав новый объект эффекта, или воспользоваться их builder-методом — примерно как со свойствами блока.

Затем можно использовать любой удобный тебе вариант метода #run(), чтобы активировать эффект:

//Псевдокод конструктора с примером runFor
Effect effect = new Effect(ServerWorld world, ParticleEffect effect, Vec3d originPos, int particles, Other stuff...)
effect.runFor(5);

//Псевдокод builder с примером run и setIterations (20 тиков = 1 секунда)
Effect effect = Effect.builder(ServerWorld world, ParticleEffect effect, Vec3d originPos).particles(10).anotherOption(true).build;
effect.setIterations(5*20);
effect.run();

Примечание: при использовании builder тебе всегда нужно передавать в метод мир, эффект частиц и начальную позицию, потому что каждый анимационный эффект их использует, и предполагается, что они не null. Позже их можно изменить, если понадобится. TLDR; их обязательно нужно указывать, чтобы эффект работал, а не крашился!

Демонстрация некоторых эффектов из версии 0.0.1

Как управлять анимационным эффектом?

У каждого эффекта есть свои геттеры и сеттеры, так что их можно использовать, чтобы изменить настройки перед вызовом метода run. Также можно передать в метод run/runFor лямбду, которая будет выполняться каждый тик, пока эффект активен. Подробнее о том, что делает каждая настройка, смотри в javadoc конструктора этого эффекта.

Как использовать команды?

Прежде всего, нужно установить сопутствующий мод ParticleAnimationLibCommands. Можно использовать либо pal, либо particleanimationlib, а затем с помощью автодополнения по Tab создавать свои эффекты. Ты даже можешь посмотреть превью каждого эффекта с помощью `/pal demo `!

Подробнее смотри в вики!

Для разработчиков:

Добавь эту библиотеку в свой build.gradle как зависимость

repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies {
    modImplementation "maven.modrinth:particleanimationlib:<version>"
}

Номер версии можно узнать на странице версий modrinth.

Благодарности

Этот мод основан на bukkit-плагине EffectLib от команды elBukkit, тоже загляните туда! Эффекты взяты оттуда и доработаны для совместимости с моддингом, иногда с добавлением дополнительного функционала.

Лицензия

Эта библиотека доступна под лицензией MIT