Skip to content

README.md

Latest commit

 

History

History
116 lines (83 loc) · 4.56 KB

README.md

File metadata and controls

116 lines (83 loc) · 4.56 KB

Pause Customizer

CI Downloads (all) Downloads (latest release) Latest Release Foundry Version Forge Installs Ko-fi Patreon

A module to fully customize the FoundryVTT pause overlay — icon, text, animation, positioning and background.

This module is based on the Custom Pause module by John Stevens.

FVTT Icon

Features

Icon

  • Custom pause icon (image or video)
  • Image width and height
  • Opacity
  • Vertical offset
  • Video support (mp4, webm, ogg) with autoplay and loop

Text

  • Custom pause text
  • Font family, size, weight
  • Text color
  • Text transform (uppercase, lowercase, capitalize)
  • Letter spacing
  • Text shadow
  • Vertical offset

Animation

  • Animation direction (rotate, reverse, alternate, none)
  • Animation duration
  • Animation timing function

Background

  • Custom CSS background (color, gradient, etc.)
  • Background image

Random Pause Image

Select a folder instead of a single file to randomly pick an image each time the game is paused. Use the folder button next to the file picker.

Additional Features

  • Dynamic system defaults — automatically detects and displays default values from the active game system (e.g. DnD5e)
  • Reset to defaults button
  • No reload required — changes apply on save without reloading Foundry
  • Supports 6 languages: English, German, Spanish, French, Japanese, Portuguese (Brazil)

Video Support

Videos can be used as the pause icon instead of a static image. Supported formats: mp4, webm, ogg.

Note: The Foundry desktop app (Electron) requires WebM format for video playback due to codec limitations. MP4 works when accessing Foundry via a web browser.

How to Use

  1. Open Module Settings for Pause Customizer.
  2. Configure the desired settings — changes apply immediately.
  3. Use the file picker button to select an image/video, or the folder button to select a folder for random images.

For possible CSS values and more information, see:

Installation

Method 1:

  • Start Foundry and head to the Add-on Modules tab.
  • Click Install Module.
  • Search for "Pause Customizer"
  • Click the Install button when it comes up.

Method 2:

Contributing

Translations are managed via Weblate. Feel free to contribute translations for your language.

Support

If you enjoy this module, consider supporting its development on Ko-fi or Patreon.