Slideshows

How to make and use slideshows.

Slideshowslink

FancyMenu allows you to add slideshows and display them in menus and as menu backgrounds.

Making a Slideshowlink

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

1

To make a slideshow get recognized as one by the system, it needs to have a properties file located in its slideshow folder, so if you've named your slideshow folder myslideshow, the properties file should be located at /config/fancymenu/slideshows/myslideshow/properties.txt.

This file always needs to be named properties.txt!
For now, only create the empty properties file and move on to the next step.

2

Adding Imageslink

A slideshow needs images (duh), so let's add some!

All images of your slideshow go to an extra folder inside your slideshow folder (myslideshow in the example above).
This folder's name needs to be images.

3

Now place all your slideshow images in the images folder.
They get ordered alphabetically (respecting numbers), so just name them something like image_1.png, image_2.png and so on.
In my example, image_1.png would be displayed first and image_2.png after.


Screenshot_2

Adding Content to the Properties Filelink

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

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
   randomize = false
}

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

namelink

This is the name, or better the identifier, of your slideshow.
Slideshow names need to be unique, so it's not possible to have two slideshows with the same name!

width | heightlink

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

x | ylink

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

durationlink

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

fadespeedlink

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 make it half as fast as default.
Negative values are not supported.

randomizelink

If the slideshow images should play in random order (true) or not (false).

Using the Slideshowlink

All important steps are done and your slideshow should be ready now, so lets test it!

To load your new (or edited) slideshow into FancyMenu, reload the mod via Customization -> Reload FancyMenu.

Now you can use your slideshow in the Slideshow element or as menu background (right-click the layout editor background -> Menu Background).