Luminary Documentation

Everything you need to know about using Luminary Media Player

Introduction

"Luminary" derives from the Latin word lumen (light). It symbolizes the idea of "lighting up" the media experience, making audio and video content vivid and engaging.


Luminary Media Player is designed to be intuitive and compact, offering a straightforward experience without overwhelming options. Everything you need is at your fingertips.

Getting Started: FFmpeg

Installing and Configuring FFmpeg for Luminary

If you've just installed Luminary and need to set up FFmpeg, don't worry! This guide will walk you through the process step-by-step, making it easy even for those who aren't tech-savvy.

Step 1: Download FFmpeg

  • Visit the Official FFmpeg Website: FFmpeg download page or FFmpeg External link.
  • Select Windows: Hover over the Windows icon and click on the link for "Windows builds from gyan.dev".
  • Choose the Right Build: On the new page, look for the latest release version. We recommend downloading the ffmpeg-release-essentials.7z file, as it contains all the necessary tools.

Step 2: Extract the Downloaded Files

  • Locate and Extract: Find the downloaded .7z file in your Downloads folder. You will need a tool like 7-Zip to extract it. Right-click the file, hover over "7-Zip", and select "Extract Here."
  • Rename the Folder: After extraction, a new folder will appear. For simplicity, rename this folder to ffmpeg.
  • Move the Folder: To make it easy to find, move the newly renamed ffmpeg folder to the root of your C: drive. The final path should be C:\ffmpeg.

Step 3: Add FFmpeg to Environment Variables

This critical step allows your system to run FFmpeg from anywhere.

  1. Open System Properties: Press the Windows key, type "Edit the system environment variables," and select the matching result.
  2. Access Environment Variables: In the new window, click the "Environment Variables" button.
  3. Edit the Path Variable: In the "User variables" section, select the "Path" variable and click "Edit".
  4. Add the FFmpeg Path: Click "New" and type in the exact path to the `bin` folder: C:\ffmpeg\bin. Click OK on all windows to save.

Step 4: Restart Your Computer

A restart is sometimes recommended to ensure Windows applies the new path variable correctly.

Step 5: Verify the Installation

  1. Open Command Prompt: Press the Windows key, type cmd, and hit Enter.
  2. Check FFmpeg: In the command prompt, type ffmpeg and press Enter.
  3. If it's installed correctly, you'll see version and configuration details. If you get a 'not recognized' error, carefully re-check the previous steps, especially the path in Step 3.

Conclusion

With FFmpeg successfully configured, Luminary is now ready to use with all its features enabled. Enjoy an enhanced multimedia experience!

Getting Started: Ollama

Luminary uses Ollama to provide powerful, offline translation features. Ollama allows you to run large language models, like Llama 3 and Gemma, directly on your computer, ensuring your data remains private.

- Official Website: Ollama


Setting Up Ollama for Translation

Step 1: Install Ollama for Windows

  • Download the official installer directly from the Ollama website.
  • Run the installer. It requires Windows 10 or later and is a very straightforward "next-next-finish" process.

Step 2: Verify the Installation

  • Once installed, Ollama should start running automatically in the background.
  • To verify it's working, open your web browser and go to http://localhost:11434/.
  • If you see the message "Ollama is running", you're all set! If not, there may be an issue with the installation.

Step 3: Important File Locations (Optional)

Ollama stores files in a few key locations. You can view them by typing the path into the File Explorer address bar or using the Run command (Windows Key + R).


  • %LOCALAPPDATA%\Ollama: Contains logs (app.log, server.log) and downloaded updates. You can safely delete log files if you need to.
  • %LOCALAPPDATA%\Programs\Ollama: Contains the application binaries. The installer automatically adds this to your system's PATH.
  • %HOMEPATH%\.ollama: The most important folder. This is where your downloaded models and configuration are stored. You can delete models files and folders manually under models\blobs (files) and models\manifests\registry.ollama.ai\library (folders)

Step 4: Understanding Available Models

The first time you use the translation feature in Luminary, you will be prompted to download a model. Here’s a breakdown of the models available within the app to help you choose:


ModelQualitySize (GB)RAM NeededVRAM Needed (GPU)Best For
gemma3:4bGood3.3~8 GB~4 GBGeneral use on most systems.
gemma3:4b-it-qat (Recommended)Very Good4.0~8 GB~5 GBEfficient, memory-saving without losing quality.
gemma3:12b-it-q4_K_MExcellent8.1~16 GB~10 GBDemanding tasks and complex translations.
llama3:instructHigh4.7~8 GB~6-8 GBDetailed instructions and clear answers.
llama3.1:8b-instruct-q5_K_MHigh5.7~16 GB~8 GBBalanced model for fast and accurate results.

Features Overview

🎡

Multi-Format Support

Supports a wide range of audio and video formats, including MP3, WAV, MP4, and MKV.

πŸ“‚

Media Panel

Organize media folders and create favorites for quick access. Your settings are saved automatically.

πŸ“

Audio Transcription

Utilizes the Whisper model for accurate offline transcription, generating both text and SRT files (Raw & Formatted).

🌐

Offline Subtitle Translation

Translate subtitles into different languages using powerful offline Ollama models, keeping your data private.

πŸ”„

Media Conversion

A built-in tool for fast and easy conversion between various audio and video formats using FFmpeg.

🎨

Subtitle Customization

Fine-tune subtitle appearance with easy-to-use customization options for a personalized viewing experience.

Supported Formats:

.mp3.wav.flac.ogg.wma.amr.aac.mp4.avi.mkv.mov.ts.wmv

Transcription Models

Luminary's transcription feature is powered by Whisper models. For convenience, you can download these models directly to the application's designated models folder. You will be prompted to do this the first time you use the transcription feature.


If you prefer to download them manually or need to replace a corrupted file, you can use the official links below (make sure the file extension is .pt).



You can place the models in the utils folder where the Luminary app is installed. If the folder doesn't exist, create it and then add the model file (e.g., small.pt) inside

Frequently Asked Questions

Why are the file sizes for the transcription (Whisper) and translation (Ollama) models large?

+

What are the system requirements for transcription?

+

Are there any known sound issues?

+

Why isn't the app working correctly?

+

Why does transcription take some time?

+

How long does media conversion take?

+

Are future updates planned for Luminary?

+