Documentsspecial-assets

Special assets

Files uploaded with these reserved names do special things on your player.

Upload these files to the server with the Add Asset button. When you deploy a group, all special files in your account are copied to the player and take effect on the next reboot.

Boot video

The boot video option is not supported in player 4.x and later. Add a PNG image instead, see Changing boot logo in 4.x and 5.x player versions.

  1. brand_intro.mp4: a welcome video (MP4) shown while the player boots. It is used for both landscape and portrait mode unless brand_intro_portrait.mp4 exists.
  2. brand_intro_portrait.mp4: a welcome video (MP4) for portrait mode. If it is missing, brand_intro.mp4 is used for portrait too, if present.

Welcome screen

welcome.ejs is an EJS file, which is HTML with embedded JavaScript. Start from the reference welcome.ejs on GitHub. A set of variables is available. Modify the HTML to suit your needs and upload it as welcome.ejs.

Custom layouts

  1. Design your layout based on the examples on GitHub. Pick one that fits and modify it.
  2. Put all the CSS, JavaScript and HTML in a single file.
  3. Name the file starting with custom_layout and ending with .html, for example custom_layout_foodmenu.html.
  4. Select the file under custom layout in the playlist layout selection popup.

You can also build layouts visually in the Template Designer.

Notice template

Change the basic notice style by uploading your own template as notice_template.ejs. It is an EJS file like welcome.ejs. Start from the base file on GitHub and modify it.

Upload a PNG at its actual size, then select it in the group settings to show it on the screen.

Select an image to show in the menu bar of the server UI in place of the PiSignage logo. On pisignage.com, branding is done in Settings > Branding Settings, see White Label.

Other special items

  1. system_notice.html is a special asset in the playlist asset selection. It is the welcome screen asset.
  2. TV_OFF is a special playlist. Schedule it in a group to switch the TV off. For the current way to power the TV on and off, see Scheduled TV powering ON and OFF.