short-video-maker

Videos are assembled from multiple Scenes. Each scene consists of two primary components:

1. Text: The narration that the Text-to-Speech (TTS) engine reads and from which captions are generated.
2. Search terms: Keywords used to find relevant background videos via the Pexels API. If no specific terms are provided or found, the system uses 'joker terms': nature, globe, space, or ocean.

While Docker is recommended, you can run the server via npm or npx.

Supported Platforms:

• Ubuntu (≥ 22.04): Requires git, wget, cmake, ffmpeg, curl, make, and several system libraries (libsdl2-dev, libnss3, libgbm-dev, etc.).
• macOS: Requires ffmpeg (install via brew install ffmpeg) and Node.js (tested on 22+).
• Windows: NOT supported due to whisper.cpp installation issues.

Use Docker Compose to integrate Short Video Maker with other services like n8n. If using the Self-hosted AI starter kit, ensure you add networks: ['demo'] to the service configuration so n8n can reach it at http://short-video-maker:3123.

version: "3"

services:
  short-video-maker:
    image: gyoridavid/short-video-maker:latest-tiny
    environment:
      - LOG_LEVEL=debug
      - PEXELS_API_KEY=
    ports:
      - "3123:3123"
    volumes:
	    - ./videos:/app/data/videos # expose the generated videos

To expand the music library, follow these two steps:

1. Place your MP3 file into the static/music/ directory.
2. Register the file in src/short-creator/music.ts by adding a new object to the musicList array. The object must specify the filename, the start and end timestamps (in seconds), and the corresponding MusicMoodEnum value.

{
  file: "your-new-music-file.mp3",  // Filename of your MP3
  start: 5,                        // Start time in seconds (when to begin playing)
  end: 30,                          // End time in seconds (when to stop playing)
  mood: MusicMoodEnum.happy,        // Mood tag for the music
}

When deploying to a cloud VPS, follow these recommendations:

• OS: Ubuntu ≥ 22.04
• Hardware: ≥ 4GB RAM, ≥ 2 vCPUs, and ≥ 5GB storage
• Process Management: Use pm2 to run and manage the server process.
• Environment Variables: Store your configuration in the .bashrc file or a similar environment management tool.

To run Short Video Maker, ensure your environment meets the following requirements:

• Internet access: Required for Pexels API and potentially other services.
• Pexels API Key: A free key is required for background video sourcing.
• RAM: Minimum 3 GB (4 GB recommended).
• CPU: Minimum 2 vCPUs.
• Disk Space: Minimum 5 GB.

The connection URL between n8n and the short-video-maker server depends on your deployment architecture:

The ShortCreator class is the central orchestrator of the video generation process. It requires the following initialized components to function:

• Config: Application configuration.
• Remotion: Video rendering engine.
• Kokoro: Text-to-speech (TTS) engine.
• Whisper: Speech-to-text (STT) engine.
• FFMpeg: Media processing utility.
• PexelsAPI: Stock video footage provider.
• MusicManager: Handles music file management and availability.

🟢 Application Configuration

⚙️ System Configuration

When making requests to the API, you can specify the following configuration options to customize the output video: