Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.73 KB

stream.md

File metadata and controls

55 lines (42 loc) · 2.73 KB

TV Stream

The TV stream component is used to display the current active TV stream below the sign. A custom resolution can be set to adjust the size of the stream. The aspect ratio is always predefined by the current running stream. If the resolution does not match the aspect ratio, black bars will be added to the top and bottom or left and right side of the stream.

If no stream is active, the upcoming matches will be displayed instead with a background image.

stream

Configuration

The namespace and identifier in the first line is worldcup:stream
The second line is the resolution of the stream in the format widthxheight
If 0 is set on either width or height, the aspect ratio of the stream will be used to calculate the missing value.
The resolution has a maximum of 100x56 blocks. It can also be a floating point number to adjust the aspect ratio using the dot as a separator.

This component has the following arguments you can configure:

  • info: Position of the current match info text. It shows the current playing team with their scores.
    It has the following values:
    • top: The match info is displayed at the top of the stream. (Default)
    • bottom: The match info is displayed at the bottom of the stream.
    • hide: The match info is hidden.
  • fw: Behavior of the firework attached to the stream.
    These firework effects can also be placed individually on the map with the effect component.
    You can test the effects by manually triggering it with the /worldcup-test command.
    The firework argument has the following values:
    • show: The burst and flag firework is both visible when the score increases. (Default)
    • hide: The entire firework is hidden for this component. (Recommended if placed individually)
    • burst: The burst firework shows up when the score increases for the specific team.
    • flag: The flag firework shows up when the score increases for the specific team.
  • off: The offset of the canvas as a 3-dimensional vector.
    The offset is relative to the sign position and can be used to adjust the position of the canvas.
    The offset has the following format: x,y,z
    The offset can be negative or positive.

Example

Example of a TV stream component with a resolution of 16x9 blocks and the match info at the bottom.
sign

The stream is always rendered to the opposite side of the sign, to make it possible to hide the sign behind a block as you can see in this example:

sign

Example of the match info that is configured to be displayed at the bottom of the stream:

sign