v1.0

2026-03-07 17:20:39 +08:00
parent 0ae9155c2f
commit 50522dd1dc
5 changed files with 174 additions and 197 deletions
@@ -1,80 +1,89 @@
-# 📱 EmbyX Vertical Player `v1.1`
+# 📱 EmbyX

-[中文说明](./README_zh.md) | [English Documentation](./README.md)
+[中文说明](./README_zh.md)

-> A TikTok-style web interface for Emby / Jellyfin, designed for browsing and managing short videos in an immersive way.
-
---
+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, immersive full-screen experience.
- **Grid View**: Browse with cover walls, supports pagination and random refresh.
- **Direct Play**: Works natively on modern devices. Support for 8K, AV1, and HEVC without transcoding.
- **Library Sync**: One-tap to favorite/unfavorite videos, fully synced with Emby server.
- **Key & Mouse Support**: Complete keyboard shortcut mapping. Friendly for TV and PC browsers.
- **PWA Ready**: Install as a desktop or home screen app.
- **Privacy First**: All data is stored locally; nothing is uploaded to the cloud.
+- **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 (2016) | Budget (2024) |
-| PC | Intel Core 6-8th Gen (iGPU) | Intel Core 11th Gen+ (iGPU) |
+| Android | Budget Phones (2016) | Budget Phones (2024) |
+| PC | Intel 6-8th Gen iGPU | Intel 11th Gen+ iGPU |

---

 ## ⌨️ Shortcuts Guide

 | Key | Function |
 |:---:|---|
-| `W / S / ↑ / ↓` | Previous / Next Video |
-| `A / D / ← / →` | Seek Back / Forward 15s |
+| `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` | Open Settings / Profile |
-| `E` | Toggle View Mode (List/Grid) |
-| `R` | Sequential / Random Mode |
-| `F` | Fullscreen Mode |
-| `G` | Toggle Libraries |
-| `V` | Show File Info |
+| `I` | Profile |
+| `E` | Toggle View |
+| `R` | Sequential / Random |
+| `F` | Toggle Fullscreen |
+| `G` | Select Libraries |
+| `V` | Media Info |

---

 ## 📁 Directory Structure

 ```
 embyx/
 ├── zh/               # Chinese Version
-│   ├── index.html
-│   ├── manifest.json
-│   └── ...
 ├── en/               # English Version
-│   ├── index.html
-│   ├── manifest.json
-│   └── ...
-├── README.md         # English (Default)
-└── README_zh.md      # Chinese
+├── 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 either `zh/` or `en/` folder into your web server (Nginx, Apache, etc.).
+Simply put all files from `en/` folder into your web server (Nginx, Apache, etc.)

 ### Option 2: Docker Deployment

-One image, multiple languages. Controlled by environment variable.
+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 \
@@ -83,17 +92,30 @@ docker run -d \
  -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) |

-| Env | Description | Default |
-|---|---|---|
-| `APP_LANG` | `en` (English) / `zh` (Chinese) | `en` |
-| `APP_PORT` | The port the container will listen on | `8090` |

---

 ## 📝 License

 MIT License — Feel free to use, PRs and Issues are welcome.
-
-👨🏻‍💻 Author: [@Juneix](https://juneix.github.io)  
-🛜 Official Site: [June's Hub](https://5nav.eu.org)