Documentation

Everything you need to get started with renaym

Getting StartedInstallationUsageFeaturesConfigurationTroubleshooting
🚀

Getting Started

renaym is an intelligent media file renamer that uses AI-powered parsing and TMDB metadata to help you organize your movie and TV show library.

Prerequisites

  • ✓TMDB API Key — Get one free at themoviedb.org⚠ī¸ Use the API Key (v3 auth), not the "API Read Access Token"
  • ✓.NET 8 Runtime — Included in standalone downloads
đŸ“Ļ

Installation

1

Download

Download renaym for your platform from the download page

2

Extract

Extract the downloaded archive to your preferred location

3

Run

Launch the Server application first, then the Client

4

Configure

Enter your TMDB API key in Settings when prompted

đŸŽ¯

Basic Usage

📁Step 1

Select Folder

Click 'Select Folder' or drag & drop files into the application

🔍Step 2

Scan & Match

Click 'Scan & Match' to automatically match files with TMDB

👁ī¸Step 3

Review

Check the proposed renames and adjust if needed

✏ī¸Step 4

Execute

Click 'Execute Rename' to rename your files

↩ī¸Pro tip: Use "Undo Last" if you need to revert any changes

⭐

Features

🤖

AI-Powered Parsing

Local LLM intelligently extracts metadata from even the messiest filenames

đŸŽŦ

TMDB Integration

Accurate metadata matching with intelligent scoring from The Movie Database

📝

Subtitle Support

Automatically pairs and renames .srt, .sub, .ass, .ssa, .vtt files

🛡ī¸

Safe Operations

Collision detection prevents overwrites, with full undo support

🎨

Custom Templates

Customize naming patterns to match your preferred organization style

💾

Smart Caching

Caches TMDB responses for faster subsequent operations

⚙ī¸

Configuration

Settings are managed through the Settings panel in the application. You can configure:

// Available settings
TMDB API Key — Required for metadata lookup
LLM Model Path — Optional, for AI parsing
Movie Template — e.g., "{Title} ({Year})"
TV Template — e.g., "{Title} S{Season}E{Episode}"
Cache Settings — Configure caching behavior
🔧

Troubleshooting

❓No matches found?

Try adjusting the filename to be clearer, or search manually in TMDB. Sometimes files with unusual naming conventions need manual intervention.

❓LLM not working?

Download the Phi-3-Mini model and configure the path in settings. The app will automatically fall back to regex parsing if LLM is unavailable.

❓Server won't start?

Ensure no other application is using the required port. Check that .NET 8 Runtime is installed if using the framework-dependent version.

Need Help?

For issues and feature requests, visit our GitHub repository

Open GitHub Issues