Show Video

Description#

'show video <video_id> <mode> [with <properties>]'

The video action allows you to show videos in your visual novel in different display modes.

Action ID: Video

Reversible: Yes

Requires User Interaction: Depends on mode and properties. Blocking modes (modal, immersive, fullscreen) wait for video completion unless close property is used.

Parameters#

Display Modes#

Properties#

Asset Declaration#

To play a video, add the file to your assets/videos/ directory and declare it:

monogatari.assets('videos', {
    'intro': 'intro.mp4',
    'ending': 'ending_credits.mp4',
    'rain': 'rain_loop.webm'
});

Supported Formats#

MP4 is recommended for maximum browser compatibility. Other formats:

See the MDN compatibility table for detailed browser support.

Examples#

Modal Video#

Shows a video in a modal that blocks game progression:

monogatari.script({
    'Start': [
        'show video intro modal',
        'The intro has finished.',
        'end'
    ]
});

Background Video#

Use a video as an animated background:

monogatari.script({
    'Start': [
        'show video rain background with loop',
        'e The rain keeps falling...',
        'hide video rain',
        'end'
    ]
});

Auto-Close Video#

Video that automatically closes when finished:

monogatari.script({
    'Start': [
        'show video cutscene immersive with close',
        // Game continues automatically after video ends
        'e That was intense!',
        'end'
    ]
});

Video with Controls#

Let the player control playback:

monogatari.script({
    'Start': [
        'show video tutorial modal with controls',
        'Did you understand the tutorial?',
        'end'
    ]
});

Fullscreen Video#

Attempts to play in fullscreen (falls back to immersive if permission denied):

monogatari.script({
    'Start': [
        'show video ending fullscreen with close',
        'Thanks for playing!',
        'end'
    ]
});

Displayable Video#

Shows video as an element without blocking the game:

monogatari.script({
    'Start': [
        'show video news_broadcast displayable',
        'e Look at what\'s on TV!',
        'hide video news_broadcast with fadeOut',
        'end'
    ]
});

Behavior Notes#

• Blocking modes (modal, immersive, fullscreen): The game waits for the video to end before proceeding, unless close is specified
• Non-blocking modes (background, displayable): The game continues immediately
• Loop + Close: If both are specified, loop takes priority and the video won’t auto-close
• Volume: Video volume respects the player’s Video volume preference setting

Related Actions#

• Hide Video - Stop and remove a video
• Show Scene - Change background (static images)
• Play Music - Background audio