Skip to content

Commit

Permalink
Update the readme for current changes
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonylavado committed May 17, 2020
1 parent c04cf6e commit c20f21d
Showing 1 changed file with 7 additions and 21 deletions.
28 changes: 7 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,40 +9,26 @@ Jellyfin for macOS is a launcher/wrapper built in Swift and Objective-C.

### Getting Started

1. Clone or download this repository.
The Build Process instructions need to be updated, and will be coming soon.
<!--1. Clone or download this repository.
```sh
git clone https://github.com/jellyfin/jellyfin-server-macos.git
```
2. Download Jellyfin, and extract it. Rename the folder to `jellyfin` and put it inside the resources folder.
3. Download the correct version of FFmpeg. Extract it, and place `ffmpeg` and `ffprobe` in the root of `jellyfin-mac-app-resources`.
4. Open `Server.xcodeproj` with Xcode, and build.
4. Open `Server.xcodeproj` with Xcode, and build.-->


### Directory Structure

The basic directory structure should look like this:

```
jellyfin-mac-app
├── LICENSE
├── Server
└── Server.xcodeproj
jellyfin-mac-app-resources/
├── ffmpeg
├── ffprobe
└── jellyfin
```



### FFmpeg Download

It's recommended to use a static macOS build of FFmpeg, such as [Zeranoe's Builds](https://ffmpeg.zeranoe.com/builds/macos64/static/). There is a build phase script that will download this for you.
It's recommended to use a static macOS build of FFmpeg, such as [Zeranoe's Builds](https://ffmpeg.zeranoe.com/builds/macos64/static/).

At the time of writing, please use [ffmpeg-4.2.1-macos64-static.zip](https://ffmpeg.zeranoe.com/builds/macos64/static/ffmpeg-4.2.1-macos64-static.zip).
At the time of writing, please use [ffmpeg-4.2.2-macos64-static.zip](https://ffmpeg.zeranoe.com/builds/macos64/static/ffmpeg-4.2.2-macos64-static.zip).


## Troubleshooting
Expand All @@ -53,10 +39,10 @@ Please review the error inside Xcode. If a build failed, it is likely because th

### The project built, but Jellyfin didn't launch. Xcode shows an error.

Does the console inside Xcode show `Error Domain=NSPOSIXErrorDomain Code=13 "Permission denied"`? If so, you need to fix your Jellyfin directory inside `-resources`.
This is because Jellyfin needs to be placed in the app bundle so it can be launched. This is currently a manual process, which will be automated for future use.

Does the console show a `Failed to bind to address` message? You may already have a copy of Jellyfin running on your computer. This can happen if you did not shutdown a separate Jellyfin install, or if you clicked on "Stop" inside Xcode. Use Activity Monitor to find and quit any open Jellyfin process.

### The project built, but Jellyfin didn't launch. There are no errors I can see.

This wrapper does not launch the Web UI automatically. This will eventually become a configurable option. In the meanwhile, you can use the Jellyfin icon in the menu bar to launch the Web UI.
This wrapper may launch the Web UI too quickly. This will eventually be configurable. In the meanwhile, you can use the Jellyfin icon in the menu bar to launch the Web UI again.

0 comments on commit c20f21d

Please sign in to comment.