Skip to content

live-miracles/folder-player

Repository files navigation

vMix Folder Player

Number the files in a folder and this app will automatically generate a vMix playlist, plus a simplified web UI for users who only need the essential controls.

Base vMix Preset

Choose a default .vmix preset. A nearby base.vmix overrides it.

Selected default base preset
        |
        v
Content folder
  |-- base.vmix        <- used first, when present
  |-- 01 Video.mp4
  |-- 02 Audio.mp3

Parent folder
  |-- base.vmix        <- fallback for child folders
  |-- Session A
      |-- 01 Video.mp4

For overlays, title base inputs exactly:

Cam  -> camera input
Mic  -> microphone input

Content Folder

Number files to set playlist order. Unnumbered items are ignored.

Content folder
  |-- 01 Welcome.mp4
  |-- 02 Teaching.mkv
  |-- 03 Meditation.mp3
  |-- 03 Slide.png        <- overlays 03 Meditation.mp3
  |-- 04 Deck.pptx        <- PowerPoint slideshow
  |-- 05 Photos           <- folder slideshow
  |   |-- image-1.jpg
  |   |-- image-2.jpg
  |-- Notes.txt           <- ignored

Same number = overlay:

07 Audio.mp3
07 Image.png

Result:
07 Audio.mp3 + Image.png overlay

+ = reuse one overlay:

03 Audio.mp3
08 Audio.mp3
03+08 Photos

Result:
03 Audio.mp3 + Photos overlay
08 Audio.mp3 + Photos overlay

_ = sub-item ordering:

06_1 Slide.png
06_2 Slide.png

Supported inputs include images, video files, audio files, photo folders, and PowerPoint .pptx files.

Overview

  1. Create a folder and order all the files with leading numbers. image

  2. Open the folder in the app and click "Open Config". image

  3. Review the playlist config. If needed, enable or disable the mic, adjust volume, or change the slideshow rotation time. image

  4. Save the config, go back, and click "Setup Folder in vMix". The app will create a .vmix preset file and open it in vMix. image

  5. The app also opens a simple web UI for users who are new to vMix and only need a "Next" button: image

Run Dev

npm run css
npm run dev

Publish

Create a .env file in the project root with a GitHub token:

GH_TOKEN=ghp_***

Then run:

npm run publish

This builds the app and publishes the Electron release to GitHub.

Format

npm run format

Test

npm run format:check
npm test

GitHub Actions runs the same checks on every push and pull request.

Links

About

App to generate a vMix preset from folder with numbered files and to control vMix via simple UI.

Topics

Resources

License

Stars

1 star

Watchers

1 watching

Forks

Contributors