ParticleAnimationLib Guides
SoruceModritnh page
  • Welcome
  • Getting Started
    • Quickstart
  • Commands
    • General Information
    • AnimatedBall command
    • AnimatedCircle command
    • Arc command
    • Cone command
    • Cuboid command
    • Donut command
    • Image command
    • Line command
    • Sphere command
    • Text command
    • Vortex command
  • Devolopment Guide
    • Coming soon!
Powered by GitBook
On this page
  • Description
  • Demo effect
  • Command Structure
  1. Commands

Image command

Oriented Effect

PreviousDonut commandNextLine command

Last updated 2 months ago

Description

This effect displays a custom Image! Both in colored form or even in black and white or inverted colors! Transparency is also supported, along with ways to rotate the image and other stuff.

To achive this effect, Dust particles are used to represent each (sort of) pixel of the image. You can customize their size to cover more or less pixels of the image.

To use this command you will need to type:

/pal image <paramters...>

Demo effect

To display the demo effect use:

/pal image demo <filePath> <posX> <posY> <posZ> <duration>

This will spawn a transparent static image. The filePath paramter is described below

Command Structure

The basic command structure for this effect is:

/pal image <filePath> <originPos> <transparent> <scale> <particleSize> <stepX> <stepY> <orient> <rotation> <rotatesDynamically> <angVelocity> <blackAndWhite> <invertColors> <duration>

or

/pal image <filePath> <originPos> <yaw> <pitch> <transparent> <scale> <particleSize> <stepX> <stepY> <orient> <rotation> <rotatesDynamically> <angVelocity> <blackAndWhite> <invertColors> <duration>

  • filePath is a string that points to an image file. This can either be a URL to a remote image, or a local path on your machine. It can even be an Identifier, like a texture file inside a datapack (and not resourcepack!!! This is because this mod runs only on server side!).

If you get an error like "Invalid escape sequence", it means you have to use double slashes \\ instead of single onese in your path. This is beacuse single slashes are used to make special actions in strings.

  • transparent if set to true, PNGs with transparent areas won't display any particles, if set to false those areas will be white (like a jpg)

  • scale allows you to scale up or down the image. Usually you will scale it down with values around 0.4 (for example with the fabricmc logo)

  • particleSize is the size of the dust particles. Bigger values (1.1+) can help cover holes in the image

  • stepX and stepY define how many particles/pixels to skip before displaying the image. This is done to save up on memory and prevent freezes. You can combine this with particleSize to have good quality images without expending too many resources. Lower values mean better fidelty/resolution/quality for the images, higher values will skip more pixels and thus making a lower quality image (bear in mind that we are indeed, displaying an image inside minecraft using particles!)

  • orient if set to true allows the image to orient towards the specified yaw and pitch, or towards the player-

  • rotation applies a fixed rotation to the images. The three double floating point values for x,y,z are expressed in radians.

  • rotatesDynamically allow the image to rotate around with a certain angular velocity

  • angVelocity is antoher set ot three double values in radians, and specifies the velocity with which the image rotates

  • blackAndWhite will display the image in black and white colors instead of its original ones

  • invetedColors will display the negative of the image, with its colors inverted

originPos , yaw, pitch and durationhave already been explained in the .

Valid examples include: "" - For remote url (the fabric logo) — "C:\\Users\\<yourusername>\\Desktop\\amazing_image.png" - For a local path — "palcommands:images/image.png" - For an identifier inside a datapack

General Information page
https://fabricmc.net/assets/logo.png

Page cover image
Cover

The standard circle

/pal animatedcircle minecraft:soul_fire_flame ~ ~ ~ 50 2 0 3.14 true false false 0.0 0.0 0.0 0.0 0.0 0.0 5

Cover

A semi circle

/pal animatedcircle minecraft:soul_fire_flame ~ ~ ~ 50 2 0 3.14 true true false 0.0 0.0 0.0 0.0 0.0 0.0 5

Cover

Adding some angular velocity

/pal animatedcircle minecraft:soul_fire_flame ~ ~ ~ 50 2 0 3.14 false false true 2.0 0.0 0.0 0.0 0.0 0.0 5

Cover

Example of messing around with parameters (angularVelocity x=2.0)

/pal animatedcircle minecraft:electric_spark ~ ~ ~ 50 2 0 7 true false true 0.0 2.0 0.0 0.0 0.0 0.0 3