Files
embyx/README.md
T
juneix 50522dd1dc v1.0
2026-03-07 17:20:39 +08:00

122 lines
3.9 KiB
Markdown

# 📱 EmbyX
[中文说明](./README_zh.md)
A TikTok-style web player for Emby / Jellyfin. Experience your private media library in a whole new, immersive way.
## ✨ Features
- **Fluid Playback**: TikTok-style vertical scrolling for an **immersive** experience.
- **Direct Play**: Up to **8K HEVC / AV1** on Android—no transcoding.
- **Poster Wall**: Elegant album view with pagination and **shuffle**.
- **Emby Sync**: Real-time sync for **libraries, playlists, and favorites**.
- **Desktop Friendly**: Optimized for **keyboard & mouse**, Perfect for TV and PC.
- **PWA Ready**: Install as a **standalone** app on your home screen or desktop.
- **Privacy First**: All data stays **on your device**, no cloud uploads.
## 💡 Get Started
Try EmbyX instantly via the official web app:
- 🌐 **Main Site** - [embyx.5nav.eu.org](https://embyx.5nav.eu.org)
-**Mirror Site** - [embyx.5nav.pp.ua](https://embyx.5nav.pp.ua)
Prefer full control? You can **self-host** EmbyX on your own server.
## 📢 Spread the Word
If EmbyX makes your digital life easier, please share it with your friends or on social media! As an independent developer, your word-of-mouth is the best way to help this project grow.
> Love it? [Donations are welcome!](#❤️-support-the-project)
## 🔮 Playback Performance
| Device | HEVC Decode | AV1 Decode |
|:---:|:---:|:---:|
| Apple | A9 (2015) / M1 | A17 Pro (2023) / M3 |
| Android | Budget Phones (2016) | Budget Phones (2024) |
| PC | Intel 6-8th Gen iGPU | Intel 11th Gen+ iGPU |
## ⌨️ Shortcuts Guide
| Key | Function |
|:---:|---|
| `W / S / ↑ / ↓` | Prev / Next Video |
| `A / D / ← / →` | Rewind / Forward 15s |
| `Space / Click OK` | Pause / Play |
| `U / Double Click OK` | Favorite Video |
| `J / Menu Key` | Toggle Aspect Ratio |
| `M` | Toggle Mute |
| `I` | Profile |
| `E` | Toggle View |
| `R` | Sequential / Random |
| `F` | Toggle Fullscreen |
| `G` | Select Libraries |
| `V` | Media Info |
## 📁 Directory Structure
```
embyx/
├── zh/ # Chinese Version
├── en/ # English Version
├── README.md # English Documentation (Default)
├── README_zh.md # Chinese Documentation
├── Dockerfile # Docker Image Build File
├── docker-compose.yml # Docker Compose Configuration
├── entrypoint.sh # Docker Entrypoint
└── nginx.conf # Nginx configuration
```
## 🚀 Deployment
### Option 1: Direct File Hosting (Recommended)
Simply put all files from `en/` folder into your web server (Nginx, Apache, etc.)
### Option 2: Docker Deployment
If you don't want to mess with the web environment, you can use docker to deploy quickly.
#### Docker:
```bash
docker run -d \
--name embyx \
--network host \
-e APP_LANG=en \
-e APP_PORT=8090 \
ghcr.io/juneix/embyx:latest
```
#### Docker Compose:
```yaml
services:
embyx:
image: ghcr.io/juneix/embyx:latest
container_name: embyx
restart: unless-stopped
network_mode: host
environment:
- APP_LANG=en # English Version
- APP_PORT=8090 # Access Port
```
## ❤️ Support & Community
If you find EmbyX useful, consider supporting its development or joining our community. Your word-of-mouth and support help this project grow!
| Support | Community |
| :--- | :--- |
| [![Donate with PayPal](https://img.shields.io/badge/PayPal-Donate-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/juneixtse) | [![Telegram Channel](https://img.shields.io/badge/Telegram-Join%20Channel-26A5E4?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/juneix_en) |
| [![Buy Me a Coffee](https://img.shields.io/badge/Ko--fi-Support%20Me-FF5E5B?style=for-the-badge&logo=kofi&logoColor=white)](https://ko-fi.com/juneixtse) | [![X (Twitter)](https://img.shields.io/badge/X-Follow%20Me-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/juneix_tse) |
## 📝 License
MIT License — Feel free to use, PRs and Issues are welcome.