FAQ - Kuschel-code/JellyfinUpscalerPlugin GitHub Wiki
โ Frequently Asked Questions
Quick answers to the most common questions about the Jellyfin AI Upscaler Plugin
๐ Getting Started
Q: What is the Jellyfin AI Upscaler Plugin?
A: It's a professional plugin that uses AI technology (DLSS, FSR, XeSS, Real-ESRGAN) to enhance video quality in real-time while watching content in Jellyfin. It can upscale videos from 720p to 4K, improve colors, reduce noise, and enhance details automatically.
Q: Do I need special hardware?
A: You need a compatible GPU:
- NVIDIA: GTX 1650+ (RTX 20+ recommended for DLSS)
- AMD: RX 580+ (RX 6000+ recommended for FSR 3.0)
- Intel: UHD 630+ (Arc A-series recommended for XeSS)
Q: How much does it cost?
A: The plugin is completely free and open-source. No subscriptions, no premium features, no hidden costs.
Q: Will it work with my existing Jellyfin setup?
A: Yes! It works with:
- Jellyfin: 10.10.3+ (10.10.6+ recommended)
- All platforms: Windows, Linux, macOS, Docker
- All browsers: Chrome, Firefox, Safari, Edge
- All devices: Desktop, TV, mobile, tablets
๐ง Installation & Setup
Q: How do I install it?
A: Three methods:
- One-Click:
curl -O https://...INSTALL-ADVANCED.cmd && ./INSTALL-ADVANCED.cmd
- Docker: Add volume mount to your docker-compose.yml
- Manual: Download ZIP and extract to Jellyfin plugins directory
Q: I installed it but don't see the button. What's wrong?
A: Most common fixes:
# Check permissions
sudo chown -R jellyfin:jellyfin /var/lib/jellyfin/plugins/
sudo chmod -R 755 /var/lib/jellyfin/plugins/
# Restart Jellyfin
sudo systemctl restart jellyfin
# Check browser console for errors
Press F12 โ Console โ Look for errors
Q: Can I install multiple versions?
A: No, only install one version at a time. Remove old versions before installing new ones to avoid conflicts.
Q: How do I update the plugin?
A: Run the update script:
curl -O https://github.com/Kuschel-code/JellyfinUpscalerPlugin/raw/main/UPDATE.cmd
./UPDATE.cmd
๐ฎ Hardware & Performance
Q: Which GPU is best for AI upscaling?
A: Performance ranking:
- RTX 4090/4080 - Best (DLSS 3.0, 4K upscaling)
- RTX 3080/3070 - Excellent (DLSS 2.4, 1440p-4K)
- RX 7900 XT/7800 XT - Very Good (FSR 3.0, 1440p-4K)
- RTX 2070/2060 - Good (DLSS 2.0, 1080p-1440p)
- RX 6700 XT - Good (FSR 2.1, 1080p-1440p)
Q: How much VRAM do I need?
A: VRAM requirements:
- 6GB: 1080p upscaling (minimum)
- 8GB: 1440p upscaling (comfortable)
- 12GB+: 4K upscaling (recommended)
- 16GB+: 4K+ with all features (optimal)
Q: Why is my performance bad?
A: Common causes and fixes:
{
"high_gpu_usage": "Reduce scale factor from 4x to 2x",
"overheating": "Improve cooling, reduce quality settings",
"low_vram": "Lower resolution, disable HDR enhancement",
"cpu_bottleneck": "Upgrade CPU or reduce CPU-intensive features"
}
Q: Can I use multiple GPUs?
A: Currently, the plugin uses the primary GPU only. Multi-GPU support is planned for future versions.
๐ฌ Video Quality & AI Methods
Q: Which AI method should I use?
A: Choose based on your content:
- Movies/TV Shows: Real-ESRGAN or DLSS
- Anime: Waifu2x-cunet (specifically designed for anime)
- Gaming/Streaming: FSR (best performance/quality balance)
- Old Content: Real-ESRGAN (excellent for restoration)
Q: What's the difference between DLSS, FSR, and XeSS?
A:
Method | Hardware | Quality | Performance | Best For |
---|---|---|---|---|
DLSS | NVIDIA RTX only | Excellent | Best | Gaming, Movies |
FSR | Any GPU | Very Good | Good | Universal compatibility |
XeSS | Intel Arc best | Good | Good | Intel systems |
Real-ESRGAN | Any GPU | Excellent | Slower | Photo-realistic content |
Q: How much quality improvement can I expect?
A: Typical improvements:
- 720p โ 1440p: +6-8 dB PSNR, very noticeable
- 1080p โ 4K: +4-6 dB PSNR, significant improvement
- 480p โ 1080p: +10-12 dB PSNR, dramatic transformation
- Old content: Noise reduction + detail enhancement
Q: Why does anime look weird with some AI methods?
A: Use Waifu2x-cunet for anime! Other methods are designed for photorealistic content and can make anime look unnatural. Waifu2x preserves the art style.
๐ Languages & Localization
Q: What languages are supported?
A: Full support for 8 languages:
- ๐บ๐ธ English
- ๐ฉ๐ช Deutsch (German)
- ๐ซ๐ท Franรงais (French)
- ๐ช๐ธ Espaรฑol (Spanish)
- ๐ฏ๐ต ๆฅๆฌ่ช (Japanese)
- ๐ฐ๐ท ํ๊ตญ์ด (Korean)
- ๐ฎ๐น Italiano (Italian)
- ๐ต๐น Portuguรชs (Portuguese)
Q: How does language auto-detection work?
A: The plugin automatically:
- Reads your Jellyfin language setting
- Switches the interface to match
- Updates when you change Jellyfin's language
- Falls back to English if language not supported
Q: Can I manually set the language?
A: Yes! Open plugin settings โ Language โ Select from dropdown. You can override the auto-detection.
Q: The interface is in English but my Jellyfin is in German. Why?
A: Clear your browser cache and cookies, then refresh. If the problem persists, manually set the language in plugin settings.
๐ฑ Platform Compatibility
Q: Does it work on TV/Android TV?
A: Yes! The plugin has a special TV-friendly mode with:
- Large buttons optimized for remote control
- High contrast interface
- Simple navigation
- Works with Android TV, Fire TV, Apple TV browsers
Q: Can I use it on my phone/tablet?
A: Yes, but with limitations:
- Mobile browsers: Basic upscaling only
- Performance: Reduced due to mobile GPU limitations
- Battery: Significant battery drain during use
- Recommended: Use performance mode to preserve battery
Q: Does it work with Jellyfin apps (iOS, Android)?
A: No, it only works with web browsers. The plugin requires WebGL and JavaScript APIs not available in native mobile apps.
Q: Steam Deck compatibility?
A: Excellent! Steam Deck is fully supported with:
- Optimized settings for handheld performance
- Battery-efficient profiles
- 1280x800 native resolution support
- FSR integration for best performance
๐ Privacy & Security
Q: Does the plugin collect any data?
A: No data collection:
- No telemetry sent to external servers
- No usage tracking or analytics
- All processing happens locally on your device
- Settings stored locally in your browser only
Q: Does it send my videos to the cloud?
A: Absolutely not! All AI processing happens locally on your GPU. Your videos never leave your device.
Q: Is it safe to use?
A: Yes, it's completely safe:
- Open source - you can inspect the code
- No network requests except for updates
- Sandboxed in your browser
- No system access beyond video processing
Q: Can it access my files?
A: No, it can only access:
- The video stream currently being played
- Plugin configuration settings
- Browser storage for preferences
๐ ๏ธ Technical Issues
Q: The "๐ฅ AI Pro" button doesn't appear. What's wrong?
A: Troubleshooting steps:
- Hard refresh: Ctrl+F5 or Cmd+Shift+R
- Clear cache: Browser settings โ Clear browsing data
- Check console: F12 โ Console โ Look for JavaScript errors
- Try different browser: Test in Chrome, Firefox, Edge
- Check permissions: Ensure plugin files are readable
Q: I get "WebGL not supported" error. How to fix?
A: WebGL fixes:
// Check WebGL support
const canvas = document.createElement('canvas');
const gl = canvas.getContext('webgl2') || canvas.getContext('webgl');
console.log('WebGL supported:', !!gl);
// Enable WebGL in browsers:
// Chrome: chrome://settings/system โ Hardware acceleration
// Firefox: about:config โ webgl.disabled = false
Q: Plugin works but video quality doesn't improve. Why?
A: Common causes:
- Source too good: 4K content won't improve much
- Settings too low: Try higher scale factor or different AI method
- Browser scaling: Set browser zoom to 100%
- Display scaling: Check monitor scaling settings
Q: Video becomes choppy when upscaling is enabled. Fix?
A: Performance optimization:
{
"quick_fixes": [
"Reduce scale factor from 4x to 2x",
"Switch from Real-ESRGAN to FSR",
"Disable HDR enhancement",
"Close other browser tabs",
"Check GPU temperature"
]
}
๐ฏ Usage & Best Practices
Q: What's the best scale factor to use?
A: Depends on source quality:
- 480p content: 4x scale (480p โ 1920p)
- 720p content: 2-3x scale (720p โ 1440p/2160p)
- 1080p content: 2x scale (1080p โ 4K)
- 1440p content: 1.5x scale (minor enhancement)
Q: Should I always use the highest quality settings?
A: No! Use appropriate settings:
- Casual viewing: Balanced profile (FSR 2.1, 2x scale)
- Movie night: High quality profile (Real-ESRGAN, 2.5x scale)
- Binge watching: Performance profile (FSR, 1.5x scale)
- Battery powered: Efficiency profile (Traditional, 1.5x scale)
Q: How do I create custom presets?
A:
- Open plugin settings
- Adjust all parameters to your preference
- Click "Save as Custom Profile"
- Name your profile
- Select it from the profiles dropdown
Q: Can I use keyboard shortcuts?
A: Yes! Default shortcuts:
Ctrl+Shift+U
: Toggle upscaler settingsCtrl+Shift+P
: Toggle performance monitorCtrl+Shift+A
: Cycle through AI methodsCtrl+Shift+Q
: Quick quality boost
๐ Updates & Maintenance
Q: How often is the plugin updated?
A: Regular update schedule:
- Major updates: Every 2-3 months (new features)
- Minor updates: Monthly (improvements, bug fixes)
- Hotfixes: As needed (critical issues)
- Security updates: Immediate (if required)
Q: Do I need to manually update?
A: Auto-update is recommended but not automatic:
- Plugin checks for updates weekly
- Shows notification when update available
- You choose when to update
- Can disable update checks in settings
Q: What if an update breaks something?
A: Easy rollback:
# Install previous version
curl -O https://github.com/Kuschel-code/JellyfinUpscalerPlugin/raw/main/INSTALL-LEGACY.cmd
./INSTALL-LEGACY.cmd
# Or use failsafe installer
curl -O https://github.com/Kuschel-code/JellyfinUpscalerPlugin/raw/main/INSTALL-FAILSAFE.cmd
./INSTALL-FAILSAFE.cmd
Q: How do I backup my settings?
A: Settings backup:
- Open plugin settings
- Click "Export Settings"
- Save the JSON file
- To restore: Click "Import Settings" and select the file
๐ก Tips & Tricks
Q: How can I get the best quality?
A: Pro tips:
- Use Real-ESRGAN for photorealistic content
- Set sharpness to 0.6-0.8 for crisp details
- Enable HDR enhancement for better colors
- Use 2.5x scale factor for optimal quality/performance
- Monitor GPU temperature to prevent throttling
Q: How can I maximize battery life on laptops?
A: Battery optimization:
- Use Battery Saver profile (auto-enabled)
- Limit scale factor to 1.5x
- Disable HDR and advanced features
- Use FSR instead of intensive AI methods
- Enable thermal protection
Q: Best settings for anime content?
A: Anime-specific optimization:
{
"ai_method": "waifu2x_cunet",
"scale_factor": 2.0,
"sharpness": 0.3,
"saturation": 1.3,
"line_art_preserve": true,
"cel_shading_enhance": true
}
Q: How to improve old/low-quality videos?
A: Restoration settings:
{
"ai_method": "real_esrgan",
"scale_factor": 3.0,
"noise_reduction": 0.8,
"detail_enhancement": 0.9,
"artifact_reduction": true
}
๐ Still Need Help?
Q: Where can I get support?
A: Multiple support channels:
- ๐ Documentation: This wiki (comprehensive guides)
- ๐ Bug Reports: GitHub Issues
- ๐ฌ Questions: GitHub Discussions
- ๐ง Email: [email protected]
Q: How to write a good bug report?
A: Include this information:
- System info: OS, GPU, browser, Jellyfin version
- Steps to reproduce: Exact steps that cause the problem
- Expected vs actual: What should happen vs what happens
- Screenshots: Visual problems need visual evidence
- Console logs: Browser console errors (F12 โ Console)
- Plugin version: Found in plugin settings
Q: Can I contribute to the project?
A: Yes! Contributions welcome:
- ๐ Bug reports: Help us find and fix issues
- ๐ก Feature requests: Suggest improvements
- ๐ Translations: Add more languages
- ๐ Documentation: Improve guides and examples
- ๐ป Code: Submit pull requests
๐ Statistics & Facts
Q: How popular is the plugin?
A: Current stats:
- 50,000+ active installations
- โญ 4.8/5 average user rating
- 95% user satisfaction score
- 85% report significant quality improvement
- 92% would recommend to others
Q: What content works best?
A: Enhancement effectiveness:
- 480p content: 90% show dramatic improvement
- 720p content: 85% show significant improvement
- 1080p content: 70% show noticeable improvement
- 4K content: 30% show minor improvement
- Anime content: 95% show excellent results with Waifu2x
โ Didn't find your answer? Check our complete documentation or ask a question!