README.md

🎬 Presentation - WezTerm

presentation.wez is a rather simple presentation mode toggle for WezTerm.

Main repository lives on GitLab. Mirror can found through GitHub.

⚡️ Quick Start

This will use the defaults. If you'd like to fine tune, keep reading, otherwise:

wezterm.plugin.require("https://gitlab.com/xarvex/presentation.wez").apply_to_config(config)

Then, activate with CTRL + ALT + P for presentation mode, or CTRL + ALT + SHIFT + P for fullscreen presentation.

🔱 Features

• 💻 Fullscreen and maximized mode, depending on your preference.
• 🕹 Can seamlessly toggle between modes.
• 🌗 Easy toggle on/off, reverts to your settings.

Planned:

• Color switching customizations.
• Better reverting of window settings in certain scenarios.

🔧 Requirements

• WezTerm

⚙️ Configuration

Shown is the default settings:

{
    presentation = {
        enabled = true,
        keybind = { key = "p", mods = "CTRL|ALT" }
        -- font_weight:          active font weight
        -- font_size_multiplier: multiplier for font size
    },
    presentation_full = {
        enabled = true,
        keybind = { key = "p", mods = "CTRL|ALT|SHIFT" }
        -- font_weight:         active font weight
        -- font_size_multipler: multiplier for font size
    },
    font_weight = "DemiBold",  -- active font weight for both modes
    font_size_multiplier = 2.0 -- multiplier for font size for both modes
}

💡 Usage

Inside your WezTerm config:

-- you may also use the "https://github.com/Xarvex/presentation.wez" mirror
wezterm.plugin.require("https://gitlab.com/xarvex/presentation.wez").apply_to_config(config, {
    font_size_multiplier = 1.8, -- sets for both "presentation" and "presentation_full"
    presentation = {
        keybind = { key = "t", mods = "SHIFT|SUPER" } -- setting a keybind
    },
    presentation_full = {
        font_weight = "Bold",
        font_size_multiplier = 2.4 -- overwrites "font_size_multiplier" for "presentation_full"
    }
})

📃 License

This project is licensed under MIT.