Some FFmpeg capabilities are so niche no UI exist. With the "do one thing well" philosophy in mind, Alpha-Badger🦡 is a platform for creating simple user interfaces that abstract complex FFmpeg commands. The goal is to enable you to build and deliver a focused, single-purpose UI that solves a specific need.

Existing presets:

• Convert video files to gif with optional control on resolution and frame rate
• Compare target video to baseline video - compose baseline, target, and diff into a single output video
• Raw command

Future presets:

• Extract alpha channel to separate video
• Batch create a low-res video clips, composed with timecode and optional watermark

1. Have Alpha-Badger🦡 running on your machine by either

   • Download Alpha-Badger🦡 from "release" page and install. There may be OS prompt about unsigned application
   • Checkout the repo and run locally

2. Set FFmpeg and FFprobe. Alpha-Badger🦡 does not come with FFmpeg and FFprobe binaries

   • Download the relevant executables from FFmpeg.org
     • macOS users will have to allow Alpha-Badger🦡, ffmpeg, and ffplay by opening each app separatly and allowing it in Prefrences > Privacy & Security.
   • Set the path fo FFmpeg and FFprobe in the Alpha Badger menu

Please note that Alpha-Badger🦡 is not auto updating yet. You can check the version in the help menu.

Alpha-Badger🦡 is built using Electron.

• Start with cloning the repo and npm install
• Renderer / frontend side updates automatically or after refresh, but for main / backend it might be best to re-run npm start again
• Use npm run checks to see everything is in order, or individually run typecheck, lint and test-all

• Platform: Electron and Electron Forge
• Main process: Node.js and TypeScript
• Renderer process:
  • React and TypeScript
  • Blueprint and Emotion
• Bundler: Webpack
• CI / CD: Github actions
• Code linting and formatting: ESLint and Prettier
• Testing: Jest and Testing Library

• Commit changes. If the change minor or major, use keywords that will be detected by the bump github action
• Open a pull request and see that checks pass
• Merge pull request. Version bumping will happen automatically, updating package.json and creating a git tag
• Navigate to new release page, choose the latest tag, fill in the title and add description
• Github action will build and attach the artifacts to the new release, which can be found here

Feel free to open an issue on anything and everything. Same for PRs.

• Finish MVP API - a use should be able to select file, click render and see when render ends
• Block pushing to main branch run checks before merge to main (CI)
• Set / save / load FFmpeg binary location
• Basic CD - Build app on merge to main
• Modular UI - using presets
• [-] UI component library for easy consumption
• [-] Examples
• Tests
• Code signing
  • Windows
  • macOS
• Auto updates
• More presets
• E2E tests