---
metadata:
  - name: generator
    content: Diplodoc Platform v5.71.0
alternate:
  - https://3y3.dev/en/guides/screencaster.md
  - https://3y3.dev/ru/guides/screencaster.md
  - href: https://3y3.dev/ru/guides/screencaster.md
    type: text/markdown
    title: Markdown version
  - href: https://3y3.dev/ru/llms.txt?revision=3042681f9f84fe9359ab985ca7c95c40c1694660
    rel: describedby
updatedAt: '2026-11-20T18:29:07.000Z'
tags:
  - инструкция
---
> **Documentation Index:** Fetch the complete configuration index at https://3y3.dev/ru/llms.txt?revision=3042681f9f84fe9359ab985ca7c95c40c1694660


# Создание скриншотов и видео

Пакет [@diplodoc/screencaster](https://github.com/diplodoc-platform/screencaster) создаёт скриншоты и видео для документации. Он открывает страницу в Chromium, выполняет действия в интерфейсе и сохраняет результат.

Скриншотницей управляет агент с поддержкой MCP (Model Context Protocol). Вы описываете, что нужно показать, агент находит элементы страницы и выполняет сценарий. Для использования в собственном приложении у пакета есть TypeScript API.

## Возможности {#features}

С помощью скриншотницы можно:

- Снять видимую область страницы, всю страницу или отдельный элемент.
- Выделить нужный элемент на скриншоте или в видео.
- Записать работу с интерфейсом и сократить паузы между действиями.
- Добавить озвучку и субтитры.
- Вырезать фрагмент записи или сохранить его как GIF.
- Обрезать скриншоты, собрать коллаж и подготовить разметку YFM для вставки изображений.

Исходная запись сохраняется вместе с обработанными файлами. Из неё можно подготовить ещё один вариант видео без повторного прохождения сценария.

Скриншоты сохраняются в PNG, обработанные ролики — в WebM. Для размещения на сайте ролик можно преобразовать в MP4 с помощью FFmpeg.

## Подготовка {#setup}

1. Установите Node.js версии 24 или выше и npm версии 11.5.1 или выше.

1. Установите пакет:

    ```bash
    npm install @diplodoc/screencaster
    ```

1. Подготовьте Chromium для версии Playwright, которую использует пакет. Для обработки видео также нужен FFmpeg с кодеками `libvpx-vp9` и `libopus`. Если FFmpeg находится вне `PATH`, укажите путь к нему в переменной `FFMPEG_PATH`.

   Требования к окружению и установке браузера приведены в [README пакета](https://github.com/diplodoc-platform/screencaster#development).

## Настройка {#config}

Создайте файл `run.config.json`. В этом примере скриншотница открывает [Playground](https://diplodoc-platform.github.io/transform/), записывает видео и позволяет делать скриншоты с выделением элементов:

```json
{
  "version": 1,
  "directory": "./runs",
  "browser": {
    "url": "https://diplodoc-platform.github.io/transform/",
    "headless": true,
    "locale": "ru-RU",
    "colorScheme": "light",
    "viewport": {
      "width": 1920,
      "height": 1080
    },
    "deviceScaleFactor": 1
  },
  "policy": {
    "rules": [
      {
        "origin": "https://diplodoc-platform.github.io",
        "pathPrefix": "/transform/",
        "actions": ["read", "act"]
      }
    ]
  },
  "outputs": {
    "video": {
      "name": "walkthrough",
      "highlights": true
    },
    "screenshots": {
      "highlight": true
    }
  }
}
```

- `directory` — папка для результатов. Для каждой съёмки внутри неё создаётся отдельный каталог.
- `browser.url` — адрес страницы, с которой начинается сценарий.
- `browser.headless` — режим запуска браузера. Значение `true` скрывает окно, `false` открывает его на экране.
- `browser.viewport` — размер области страницы в CSS-пикселях. Этот размер также используется для записи видео.
- `browser.deviceScaleFactor` — плотность пикселей для скриншотов. Например, значение `2` даёт изображение двойного разрешения.
- `policy` — адреса страниц и действия, к которым у агента есть доступ.
- `outputs.video` — автоматическая обработка видео после завершения съёмки.
- `highlights` и `highlight` — выделение элементов в видео и на скриншотах.

Пути в конфигурации отсчитываются от каталога, в котором лежит `run.config.json`. Параметр `locale` задаёт язык браузера, но не меняет язык, сохранённый в настройках самого сервиса.

Для страницы с авторизацией можно передать подготовленную сессию через `storageState` или подключить свой модуль входа. Эти варианты описаны в [настройках авторизации](https://github.com/diplodoc-platform/screencaster/blob/master/docs/host-adapters.md#host-authentication).

## Подключение к агенту {#connect}

Добавьте MCP-сервер в настройки агента. В клиентах с JSON-конфигурацией подключение выглядит так:

```json
{
  "mcpServers": {
    "screencaster": {
      "command": "npx",
      "args": [
        "--yes",
        "@diplodoc/screencaster",
        "--config",
        "/path/to/run.config.json"
      ]
    }
  }
}
```

Замените `/path/to/run.config.json` на абсолютный путь к вашему файлу. Формат настроек зависит от клиента. Для клиентов с другим форматом используйте ту же команду и аргументы.

Сервер запускается командой:

```bash
npx @diplodoc/screencaster --config ./run.config.json
```

После подключения дайте агенту [сценарий съёмки](#example). Инструкцию можно передать текстом, файлом Markdown или ссылкой на источник Markdown.

## Съёмка {#capture}

В сценарии укажите адрес страницы, последовательность действий и результат, который должен быть виден после каждого шага. Например, «Переключись на второй таб и проверь, что появился его текст».

Если нужны скриншоты, укажите, какие состояния интерфейса нужно снять и что выделить. Видео записывается во время выполнения сценария.

Попросите агента завершить съёмку и вернуть пути к готовым файлам. Скриншотница обработает запись и сохранит результаты в папке `runs`. Список файлов, статусы шагов и ошибки доступны в `manifest.json` внутри каталога съёмки.

Перед публикацией проверьте, что на записи показан нужный результат, подписи читаются, а выделение попадает на нужные элементы.

## Озвучка и субтитры {#narration}

Для озвучки подключите сервис синтеза речи (TTS, text-to-speech). В пакет входит адаптер [Яндекс SpeechKit](https://yandex.cloud/ru/docs/speechkit/tts/).

1. Создайте рядом с `run.config.json` файл `.env` и сохраните в нём API-ключ:

    ```dotenv
    SPEECHKIT_API_KEY=ваш_ключ
    ```

1. Добавьте в конфигурацию поля `envFile` и `tts`:

    ```json
    {
      "envFile": ".env",
      "tts": {
        "provider": "speechkit",
        "options": {
          "apiKey": {"env": "SPEECHKIT_API_KEY"},
          "voice": "jane",
          "speed": 1
        }
      }
    }
    ```

1. Дополните существующий блок `outputs` настройкой `narration`, сохранив в нём `video` и `screenshots`:

    ```json
    {
      "narration": {
        "name": "narrated",
        "captions": true,
        "maxHoldSeconds": 5
      }
    }
    ```

1. На macOS и Linux ограничьте доступ к файлам:

    ```bash
    chmod 600 run.config.json .env
    ```

В сценарии задайте короткую реплику для каждого шага. Агент использует эти реплики в поле `actionText` плана. После завершения записи скриншотница добавит озвучку к успешно выполненным шагам.

Настройка `captions: true` также создаёт файл субтитров WebVTT. Подключите этот файл к плееру отдельно. Субтитры не вшиваются в кадры видео.

Если реплика длиннее подходящего фрагмента, скриншотница может продлить показ кадра в пределах `maxHoldSeconds`. Для короткого видео лучше сократить реплику, чтобы зритель успел услышать её и увидеть действие.

Для русского языка в примере используется голос `jane`, для английского — `john`. Для каждого языка переведите текст сценария и реплики, измените голос и запишите отдельный ролик.

## Обработка результатов {#editing}

После съёмки агент может вырезать лишние действия, подготовить короткий фрагмент, GIF или обложку. Для этого используются инструменты MCP `screencaster_edit`, `screencaster_clip` и `screencaster_preview`.

Сокращение пауз опирается на записанные действия и изменения страницы. Длительность готового ролика зависит от самого сценария, а при озвучке — ещё и от длины реплик.

Для скриншотов доступна отдельная обработка: кадрирование, выделение области, сравнение двух состояний и сборка серии изображений. Описание этого режима есть в [руководстве по иллюстрациям](https://github.com/diplodoc-platform/screencaster/blob/master/docs/illustrations.md).

## Пример {#example}

В [статье о табах](https://3y3.dev/ru/syntax/interactive-elements/tabs.md) используется пример с двумя разделами, списком и жирным начертанием. На его основе можно записать работу с Playground.

[Откройте пример в Playground](https://diplodoc-platform.github.io/transform/?input=%7B%2525%20list%20tabs%20%2525%7D%0A%0A-%20%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20%D1%82%D0%B0%D0%B1%D0%B0%201%0A%0A%20%20%D0%A2%D0%B5%D0%BA%D1%81%D1%82%20%D1%82%D0%B0%D0%B1%D0%B0%201.%0A%0A%20%20*%20%D0%9C%D0%BE%D0%B6%D0%BD%D0%BE%20%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D1%8C%20%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B8.%0A%20%20*%20%D0%98%20**%D0%B4%D1%80%D1%83%D0%B3%D1%83%D1%8E**%20%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D1%83.%0A%0A-%20%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20%D1%82%D0%B0%D0%B1%D0%B0%202%0A%0A%20%20%D0%A2%D0%B5%D0%BA%D1%81%D1%82%20%D1%82%D0%B0%D0%B1%D0%B0%202.%0A%0A%7B%2525%20endlist%20%2525%7D). Чтобы записать такой ролик, передайте агенту ссылку на пример выше и следующую инструкцию:

> Открой готовый пример с табами в Playground Diplodoc и запиши короткое видео. Проверь результат в превью, переключись на второй таб и вернись к первому. Добавь озвучку и субтитры. В готовом ролике сократи ожидания агента, сохрани переключения и время на чтение результата. Заверши съёмку и верни пути к готовым файлам.
