getting_started

Getting Started

Using Screens

In Reef, screens are the main entity that displays slideshows. These screens handle the summoning of elements, playing of transitions, and many more. Each world can have multiple screens at once and they will all be independent from each other, meaning you can load several slideshows if you have multiple screens in your world. Screens can also be rotated which will make the displayed slideshow face the same direction too.

To summon a screen, run the function reef:api/screen/summon. Make sure you have picked the correct coordinates and rotation to summon the screen at before running the function since you will not be able to move or rotate the screen once it is placed. You will have to delete and re-summon the screen again to reposition it.

To actually control the screens you've summoned, you can use the remote to control every single function of the screen.

Main article: Using the Remote

Making slideshows

Now that you've covered the basics of using screens, you now need slideshows to display on the screen. Slideshows are composed of multiple building blocks that let Reef know how to display everything correctly. Writing these manually is a very manual and tedious process so it is advised to use the provided helper Beet plugin to make your life easier :D

See: Using the Beet Plugin

Even though a preprocessor and a plugin is advised to make these slideshows, you are not required to use these. You can still use vanilla data packs and resource packs to write these without any other tools.

This next section will teach you the components of a Reef slideshow and how to write definitions.