Slideshows - Keksuccino/Spiffy-HUD GitHub Wiki

About

FancyHud allows you to make your own slideshows and display them in the HUD.

Getting started

NOTE: If you're on Windows, don't forget to turn on file extensions!

Every slideshow has to be in its own folder inside the slideshows directory located at .minecraft/config/fancyhud/slideshows/.

slide_1

To make an slideshow getting recognized as this by the system, it needs to have a properties file located in its home directory. So if you've named your slideshow folder "myslideshow" (this is your slideshow home directory), the properties file should be located at .minecraft/config/fancyhud/slideshows/myslideshow/slideshow.properties. This file always need to be named slideshow.properties! For now, only create the empty properties file and move on to the next step.

slide_2

Adding Images

Sure, the most important part of a slideshow is..well..the images of the slideshow, so it isn't just a cool looking folder.

All images of your slideshow go to an extra folder inside the home directory of your slideshow. This folder have to be named images.

slide_3

Now place all your slideshow images in the images folder.

NOTE: It is very recommended to name your images just by numbers (e.g. 01.jpg, 02.jpg, etc.), because otherwise they could be ordered wrongly by the system. In my example, 01.jpg would be displayed first and 02.jpg after.

slide_4

Filling the Properties File

Yes, images are a very important part for your slideshow, but now comes the really most important part.

At the beginning, you've created an empty slideshow.properties file in your slideshow home directory. This file needs to be filled with important stuff now.

You need to add informations about your slideshow to this file.

NOTE: Properties files can be opened with a normal text editor.

Every slideshow properties file should look like this:

type = slideshow

slideshow-meta {
   name = cool_slideshow
   width = 1920
   height = 1080
   x = 0
   y = 0
   duration = 5.0
   fadespeed = 12.0
}

Only the variables inside the slideshow-meta section can be changed!

name

This is the name of your slideshow. You need it to identify your slideshow when using it. The name needs to be unique! It's not possible to have two slideshows with the same name!

width | height

The base width and base height of your slideshow. Used by FancyMenu to calculate the aspect ratio.

x | y

The x and y position of your slideshow. More for debugging purposes, just set both to 0.

duration

The duration in seconds every image is displayed before switching to the next one. Suppports decimal values!

fadespeed

The speed of the fade animation when switching to the next image. This value is a speed multiplicator. For example, 1.0 is default speed, 2.0 doubles the speed and 0.5 will half it. Negative values are not supported, use decimal values to slow the speed.

Using the Slideshow

All important steps are now done and your slideshow is finished! It should now contain a slideshow.properties file with informations inside and an images folder with all your slideshow images.

To load your new or edited slideshow into FancyHud, just press the Reload button to reload your slideshows.

Now you can add your slideshow to the HUD via the Layout Editor!