mirror of
https://github.com/jellyfin/jellyfin-mpv-shim.git
synced 2024-11-23 05:59:43 +00:00
Update readme and scripts for new name.
This commit is contained in:
Ian Walton
parent
0ec1a28c32
commit
6702ff5fc0
@ -4,7 +4,7 @@
|
||||
#define MyAppName "Jellyfin MPV Desktop"
|
||||
#define MyAppVersion "1.8.1"
|
||||
#define MyAppPublisher "Ian Walton"
|
||||
#define MyAppURL "https://iwalton.com/"
|
||||
#define MyAppURL "https://github.com/jellyfin/jellyfin-desktop"
|
||||
#define MyAppExeName "run-desktop.exe"
|
||||
|
||||
[Setup]
|
||||
|
||||
42
README.md
42
README.md
@ -1,12 +1,12 @@
|
||||
# Jellyfin MPV Shim
|
||||
# Jellyfin Desktop (MPV Shim)
|
||||
|
||||
[](https://github.com/iwalton3/jellyfin-mpv-shim/releases)
|
||||
[](https://github.com/jellyfin/jellyfin-desktop/releases)
|
||||
[](https://pypi.org/project/jellyfin-mpv-shim/)
|
||||
[](https://translate.jellyfin.org/projects/jellyfin/jellyfin-mpv-shim/)
|
||||
[](https://dev.azure.com/iwalton3/jellyfin-mpv-shim/_build/latest?definitionId=1&branchName=master)
|
||||
[](https://github.com/psf/black)
|
||||
|
||||
Jellyfin MPV Shim is a fully featured, cross-platform desktop and cast client for Jellyfin.
|
||||
Jellyfin Desktop is a fully featured, cross-platform desktop and cast client for Jellyfin.
|
||||
It has support for all your advanced media files without transcoding, as well as tons of
|
||||
features which set it apart from other multimedia clients:
|
||||
|
||||
@ -14,21 +14,21 @@ features which set it apart from other multimedia clients:
|
||||
- Watch videos with friends using SyncPlay.
|
||||
- Offers both a desktop mode and a shim mode which runs in the background.
|
||||
- The Jellyfin mobile apps can fully control the client.
|
||||
- [Reconfigure subtitles](https://github.com/iwalton3/jellyfin-mpv-shim#menu) for an entire season at once.
|
||||
- Supports all of the [MPV keyboard shortcuts](https://github.com/iwalton3/jellyfin-mpv-shim#keyboard-shortcuts).
|
||||
- Enhance your video with [Shader Packs](https://github.com/iwalton3/jellyfin-mpv-shim#menu) and [SVP Integration](https://github.com/iwalton3/jellyfin-mpv-shim#svp-integration).
|
||||
- [Reconfigure subtitles](https://github.com/jellyfin/jellyfin-desktop#menu) for an entire season at once.
|
||||
- Supports all of the [MPV keyboard shortcuts](https://github.com/jellyfin/jellyfin-desktop#keyboard-shortcuts).
|
||||
- Enhance your video with [Shader Packs](https://github.com/jellyfin/jellyfin-desktop#menu) and [SVP Integration](https://github.com/jellyfin/jellyfin-desktop#svp-integration).
|
||||
- Optionally share your media activity with friends using Discord Rich Presence.
|
||||
- Most features, as well as MPV itself, [can be extensively configured](https://github.com/iwalton3/jellyfin-mpv-shim#configuration).
|
||||
- You can configure the player to use an [external MPV player](https://github.com/iwalton3/jellyfin-mpv-shim#external-mpv) of your choice.
|
||||
- Enable a chromecast-like experience with [Display Mirroring](https://github.com/iwalton3/jellyfin-mpv-shim#display-mirroring).
|
||||
- You can [trigger commands to run](https://github.com/iwalton3/jellyfin-mpv-shim#shell-command-triggers) when certain events happen.
|
||||
- Most features, as well as MPV itself, [can be extensively configured](https://github.com/jellyfin/jellyfin-desktop#configuration).
|
||||
- You can configure the player to use an [external MPV player](https://github.com/jellyfin/jellyfin-desktop#external-mpv) of your choice.
|
||||
- Enable a chromecast-like experience with [Display Mirroring](https://github.com/jellyfin/jellyfin-desktop#display-mirroring).
|
||||
- You can [trigger commands to run](https://github.com/jellyfin/jellyfin-desktop#shell-command-triggers) when certain events happen.
|
||||
|
||||
To learn more, keep reading. This README explains everything, including [configuration](https://github.com/iwalton3/jellyfin-mpv-shim#configuration), [tips & tricks](https://github.com/iwalton3/jellyfin-mpv-shim#tips-and-tricks), and [development information](https://github.com/iwalton3/jellyfin-mpv-shim#development).
|
||||
To learn more, keep reading. This README explains everything, including [configuration](https://github.com/jellyfin/jellyfin-desktop#configuration), [tips & tricks](https://github.com/jellyfin/jellyfin-desktop#tips-and-tricks), and [development information](https://github.com/jellyfin/jellyfin-desktop#development).
|
||||
|
||||
## Getting Started
|
||||
|
||||
If you are on Windows, simply [download the binary](https://github.com/iwalton3/jellyfin-mpv-shim/releases).
|
||||
If you are using Linux, you can [install via flathub](https://flathub.org/apps/details/com.github.iwalton3.jellyfin-mpv-shim) or [install via pip](https://github.com/iwalton3/jellyfin-mpv-shim/blob/master/README.md#linux-installation). If you are on macOS, see the [macOS Installation](https://github.com/iwalton3/jellyfin-mpv-shim/blob/master/README.md#osx-installation)
|
||||
If you are on Windows, simply [download the binary](https://github.com/jellyfin/jellyfin-desktop/releases).
|
||||
If you are using Linux, you can [install via flathub](https://flathub.org/apps/details/com.github.iwalton3.jellyfin-mpv-shim) or [install via pip](https://github.com/jellyfin/jellyfin-desktop/blob/master/README.md#linux-installation). If you are on macOS, see the [macOS Installation](https://github.com/jellyfin/jellyfin-desktop/blob/master/README.md#osx-installation)
|
||||
section below.
|
||||
|
||||
### Desktop Client
|
||||
@ -64,14 +64,14 @@ bare IP addresses and not specifying the port by default. If you want to connect
|
||||
|
||||
Please also note that the on-screen controller for MPV (if available) cannot change the
|
||||
audio and subtitle track configurations for transcoded media. It also cannot load external
|
||||
subtitles. You must either [use the menu](https://github.com/iwalton3/jellyfin-mpv-shim#menu) or the application you casted from.
|
||||
subtitles. You must either [use the menu](https://github.com/jellyfin/jellyfin-desktop#menu) or the application you casted from.
|
||||
|
||||
Please note the following issues with controlling SyncPlay:
|
||||
- The desktop client can join SyncPlay groups from the web app's menu, but not create them.
|
||||
- If you attempt to create a group from the web app's menu, it will break SyncPlay for all users until you close the client or leave the invalid group. ([Link to Issue.](https://github.com/iwalton3/jellyfin-mpv-shim/issues/107))
|
||||
- If you attempt to create a group from the web app's menu, it will break SyncPlay for all users until you close the client or leave the invalid group. ([Link to Issue.](https://github.com/jellyfin/jellyfin-desktop/issues/107))
|
||||
- If you attempt to join a SyncPlay group when casting to MPV Shim, it will play the media but it will not activate SyncPlay.
|
||||
- You can, however, proceed to activate SyncPlay [using the menu within MPV](https://github.com/iwalton3/jellyfin-mpv-shim#menu).
|
||||
- If you would like to create a group or join a group for currently playing media, [use menu within MPV](https://github.com/iwalton3/jellyfin-mpv-shim#menu).
|
||||
- You can, however, proceed to activate SyncPlay [using the menu within MPV](https://github.com/jellyfin/jellyfin-desktop#menu).
|
||||
- If you would like to create a group or join a group for currently playing media, [use menu within MPV](https://github.com/jellyfin/jellyfin-desktop#menu).
|
||||
|
||||
Music playback sort-of works, but repeat, shuffle, and gapless playback have not been implemented and
|
||||
would require major changes to the application to properly support, as it was built for video.
|
||||
@ -414,7 +414,7 @@ Determine which screen you would like MPV to show up on.
|
||||
- If you are on Windows, right click the desktop and select "Display Settings". Take the monitor number and subtract one.
|
||||
- If you are on Linux, run `xrandr`. The screen number is the number you want. If there is only one proceed to **Option 2**.
|
||||
|
||||
Add the following to your `mpv.conf` in the [config directory](https://github.com/iwalton3/jellyfin-mpv-shim#mpv-configuration), replacing `0` with the number from the previous step:
|
||||
Add the following to your `mpv.conf` in the [config directory](https://github.com/jellyfin/jellyfin-desktop#mpv-configuration), replacing `0` with the number from the previous step:
|
||||
```
|
||||
fs=yes
|
||||
fs-screen=0
|
||||
@ -442,7 +442,7 @@ LVDS-0 connected 1600x900+1920+180 (normal left inverted right x axis y axis) 30
|
||||
1600x900 59.98*+
|
||||
```
|
||||
|
||||
If you want MPV to open on VGA-0 for instance, add the following to your `mpv.conf` in the [config directory](https://github.com/iwalton3/jellyfin-mpv-shim#mpv-configuration):
|
||||
If you want MPV to open on VGA-0 for instance, add the following to your `mpv.conf` in the [config directory](https://github.com/jellyfin/jellyfin-desktop#mpv-configuration):
|
||||
```
|
||||
fs=yes
|
||||
geometry=1920x1080+0+0
|
||||
@ -560,7 +560,7 @@ If you are on Windows there are additional dependencies. Please see the Windows
|
||||
|
||||
1. Install the dependencies: `sudo pip3 install --upgrade python-mpv jellyfin-apiclient-python pystray Jinja2 pywebview python-mpv-jsonipc Flask Werkzeug pypresence pydantic`.
|
||||
- If you run `./gen_pkg.sh --install`, it will also fetch these for you.
|
||||
2. Clone this repository: `git clone https://github.com/iwalton3/jellyfin-mpv-shim`
|
||||
2. Clone this repository: `git clone https://github.com/jellyfin/jellyfin-desktop`
|
||||
- You can also download a zip build.
|
||||
3. `cd` to the repository: `cd jellyfin-mpv-shim`
|
||||
4. Run prepare script: `./gen_pkg.sh`
|
||||
@ -666,7 +666,7 @@ the installer. If you'd like to build a 32 bit version, download the 32 bit vers
|
||||
copy it into a new folder called mpv32. You'll also need [WebBrowserInterop.x86.dll](https://github.com/r0x0r/pywebview/blob/master/webview/lib/WebBrowserInterop.x86.dll?raw=true).
|
||||
You may also need to edit the batch file for 32 bit builds to point to the right python executable.
|
||||
|
||||
1. Install Git for Windows. Open Git Bash and run `git clone https://github.com/iwalton3/jellyfin-mpv-shim; cd jellyfin-mpv-shim`.
|
||||
1. Install Git for Windows. Open Git Bash and run `git clone https://github.com/jellyfin/jellyfin-desktop; cd jellyfin-desktop`.
|
||||
- You can update the project later with `git pull`.
|
||||
2. Install [Python3](https://www.python.org/downloads/) with PATH enabled. Install [7zip](https://ninite.com/7zip/).
|
||||
3. After installing python3, open `cmd` as admin and run `pip install --upgrade pyinstaller python-mpv jellyfin-apiclient-python pywin32 pystray Jinja2 pywebview[cef] python-mpv-jsonipc Flask Werkzeug pypresence pydantic`.
|
||||
|
||||
@ -66,7 +66,7 @@ then
|
||||
fi
|
||||
|
||||
# Verify versioning
|
||||
current_version=$(get_resource_version iwalton3/jellyfin-mpv-shim)
|
||||
current_version=$(get_resource_version jellyfin/jellyfin-desktop)
|
||||
current_version=${current_version:1}
|
||||
constants_version=$(cat jellyfin_mpv_shim/constants.py | grep '^CLIENT_VERSION' | cut -d '"' -f 2)
|
||||
setup_version=$(grep 'version=' setup.py | cut -d '"' -f 2)
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<metadata_license>FSFAP</metadata_license>
|
||||
<project_license>GPL-3.0</project_license>
|
||||
<name>Jellyfin MPV Shim</name>
|
||||
<summary>MPV Client for Jellyfin Media Server</summary>
|
||||
<summary>Official Desktop Client for Jellyfin Media Server</summary>
|
||||
<developer_name>Ian Walton</developer_name>
|
||||
|
||||
<description>
|
||||
@ -30,9 +30,9 @@
|
||||
<category>Player</category>
|
||||
</categories>
|
||||
|
||||
<url type="homepage">https://github.com/iwalton3/jellyfin-mpv-shim</url>
|
||||
<url type="help">https://github.com/iwalton3/jellyfin-mpv-shim/blob/master/README.md</url>
|
||||
<url type="bugtracker">https://github.com/iwalton3/jellyfin-mpv-shim/issues</url>
|
||||
<url type="homepage">https://github.com/jellyfin/jellyfin-desktop</url>
|
||||
<url type="help">https://github.com/jellyfin/jellyfin-desktop/blob/master/README.md</url>
|
||||
<url type="bugtracker">https://github.com/jellyfin/jellyfin-desktop/issues</url>
|
||||
|
||||
<screenshots>
|
||||
<screenshot type="default">
|
||||
@ -52,14 +52,15 @@
|
||||
<launchable type="desktop-id">com.github.iwalton3.jellyfin-mpv-shim.desktop</launchable>
|
||||
<launchable type="desktop-id">com.github.iwalton3.jellyfin-mpv-shim.desktop-player.desktop</launchable>
|
||||
|
||||
<url type="homepage">https://github.com/iwalton3/jellyfin-mpv-shim</url>
|
||||
<url type="homepage">https://github.com/jellyfin/jellyfin-desktop</url>
|
||||
|
||||
<provides>
|
||||
<binary>jellyfin-mpv-desktop</binary>
|
||||
</provides>
|
||||
|
||||
<content_rating type="oars-1.1" />
|
||||
<release version="1.8.1" date="2020-12-12">
|
||||
<releases>
|
||||
<release version="1.8.1" date="2020-12-12">
|
||||
<description>
|
||||
<p>This is a maintenance update and the last one to support SyncPlay on 1.6.x. Changes:</p>
|
||||
<ul>
|
||||
@ -76,7 +77,6 @@
|
||||
</ul>
|
||||
</description>
|
||||
</release>
|
||||
<releases>
|
||||
<release version="1.8.0" date="2020-08-18">
|
||||
<description>
|
||||
<p>This update integrates many improvements, many directly from user feedback. Changes:</p>
|
||||
|
||||
@ -15,8 +15,7 @@ if TYPE_CHECKING:
|
||||
log = logging.getLogger("update_check")
|
||||
|
||||
release_urls = [
|
||||
"https://github.com/jellyfin/jellyfin-desktop/releases/",
|
||||
"https://github.com/iwalton3/jellyfin-mpv-shim/releases/"
|
||||
"https://github.com/jellyfin/jellyfin-desktop/releases/"
|
||||
]
|
||||
one_day = 86400
|
||||
|
||||
|
||||
4
setup.py
4
setup.py
@ -8,11 +8,11 @@ setup(
|
||||
version="1.8.1",
|
||||
author="Ian Walton",
|
||||
author_email="iwalton3@gmail.com",
|
||||
description="Cast media from Jellyfin Mobile and Web apps to MPV. (Unofficial)",
|
||||
description="Cast media from Jellyfin Mobile and Web apps to MPV.",
|
||||
license="GPLv3",
|
||||
long_description=open("README.md").read(),
|
||||
long_description_content_type="text/markdown",
|
||||
url="https://github.com/iwalton3/jellyfin-mpv-shim",
|
||||
url="https://github.com/jellyfin/jellyfin-desktop",
|
||||
packages=[
|
||||
"jellyfin_mpv_shim",
|
||||
"jellyfin_mpv_shim.display_mirror",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user