diff --git a/README.md b/README.md index 59b8de90..a9fdc034 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,60 @@ -### Welcome to Emby for Kodi +# Welcome to Emby for Kodi **A whole new way to manage and view your media library.** The Emby addon for Kodi combines the best of Kodi - ultra smooth navigation, beautiful UIs and playback of any file under the sun, and Emby - the most powerful fully open source multi-client media metadata indexer and server. -**What does it do?** +### Download and installation -With the old MediaBrowser addon for Kodi we have a couple of issues because you browse your media as a "video addon": -- 3rd party addons such as NextAired, remote apps etc. won't work -- Speed: when browsing the data has to be retrieved from the server. Especially on slower devices this can take too much time. -- All kinds of workaround were needed to get the best experience on Kodi clients +View this short [Youtube video](https://youtu.be/IaecDPcXI3I?t=119) to give you a better idea of the general process. -The new Emby addon synchronizes your media on your Emby server to the native Kodi database. Because we use the native Kodi database with this new approach the above limitations are gone! You can browse your media full speed and all other Kodi addons will be able to "see" your media. +1. Install the Emby repository for Kodi, from the repo install the Emby addon. +2. Within a few seconds you should be prompted for your server-details (or auto discovered). If not, try to restart Kodi +3. Once you're succesfully authenticated to your Emby server, the initial sync will start. +4. The first sync of the Emby server to local Kodi database may take some time depending on your device and library size. +5. Once the full sync is done, you can browse your media in Kodi, syncs will be automatically done in the background. -**What is currently supported ?** +### Our Wiki -We're still in beta stage of development. Currently these features are working: -- Movies -- Sets -- TV Shows -- MusicVideos -- Full sync at first run (import), background syncs configurable by the user in the addonsetting. The current default is that it will do a full sync on the background every couple of minutes. -- Deletions are supported: Items that are deleted on the Emby server will be deleted on the Kodi database. Deletions done from the Kodi client TO the Emby server is only supported if you enable file deletions in the Kodi settings. An additional warning will be diaplayed if you really want to remove the item from the Emby server. +If you need additional information on Emby for Kodi, check out our [wiki](https://github.com/MediaBrowser/plugin.video.emby/wiki). + +### What does Emby for Kodi do? + +The Emby addon synchronizes your media on your Emby server to the native Kodi database. Because we use the native Kodi database, you can browse your media full speed and all other Kodi addons will be able to "see" your media. You can also use any Kodi skin you'd like! + +### IMPORTANT NOTES + +- If you require help, post to our [Emby-Kodi forums](http://emby.media/community/index.php?/forum/99-kodi/) for faster replies. +- To achieve direct play, you will need to ensure your Emby library paths point to network paths (e.g: "\\\\server\Media\Movies"). See the [Emby wiki](https://github.com/MediaBrowser/Wiki/wiki/Path%20Substitution) for additional information. +- **The addon is not (and will not be) compatible with the MySQL database replacement in Kodi.** In fact, Emby takes over the point of having a MySQL database because it acts as a "man in the middle" for your entire media library. +- Emby for Kodi is currently not compatible with Kodi's Video Extras addon unless native playback mode is used. **Deactivate Video Extras if content start randomly playing.** + +### What is currently supported? + +Emby for Kodi is constantly being worked on. The following features are currently provided: + +- Library types available: + + Movies + + Sets + + TV Shows + + Music Videos + + Music +- Emby for Kodi context menu: + + Mark content as favorite + + Refresh content + + Delete content +- Direct play and transcode - Watched state/resume status sync: This is a 2-way synchronisation. Any watched state or resume status will be instantly (within seconds) reflected to or from Kodi and the server. -- Possibility to copy Theme Music locally for use with the TVTunes addon -- Possibility to copy ExtraFanart (rotating backgrounds) across for use with skins that support it +- Copy Theme Music locally for use with the TV Tunes addon +- Copy ExtraFanart (rotating backgrounds) across for use with skins that support it +- Offer to delete content after playback +- and more... -**To get started with the Emby addon for Kodi, first follow these guides to set up Emby and Kodi:** +### What is being worked on +Have a look at our [Trello board](https://trello.com/b/qBJ49ka4/emby-for-kodi) to follow our progress. -1. To prevent any conflicts, remove the "old" MediaBrowser addon from your Kodi setup. -2. If you were using a modded skin for the MediaBrowser addon, make sure to set it in "normal Kodi mode" or just install the unmodded version of the skin. -3. Install the MediaBrowser/Emby BETA repository for Kodi, from the repo install the Emby addon. -4. Within a few seconds you should be prompted for your server-details (or auto discovered). If not, try to restart Kodi -5. Once you're succesfully authenticated to your Emby server, the initial sync will start. -6. The first sync of the Emby server to local Kodi database may take some time. On a powerful machine and fast network, expect around 15-45 minutes. On a slow machine (such as a Raspberry Pi) the first sync may take up to two hours. -7. Once the full sync is done, you can browse your media in Kodi, syncs will be automatically done in the background. - - -**Known Issues:** -- Windows users: Kodi Helix 14.2 RC1 required - other versions will result in errors with recently added items etc. - -**Important note about MySQL database in kodi** - -The addon is not (and will not be) compatible with the MySQL database replacement in Kodi. In fact, Emby takes over the point of having a MySQL database because it acts as a "man in the middle" for your entire media library. - -**Important note about user collections/nodes** - -Emby has the ability to create custom nodes/folders for your Media, such as having a seperate folder for your "Kids Movies" etc. In Kodi this isn't supported, you just have "movies" or "tvshows". But... Kodi let's you create your own playlists and tags to get this same experience. During the sync the foldernode from the Emby server is added to the movies that are imported. In Kodi you can browse to Movie library --> tags and you will have a filtered result that points at your custom node. If you have a skin that let's you create any kind of shortcut on the homescreen you can simply create a shortcut to that tag. Another possibility is to create a "smart playlist" with Kodi and set it to show the content of a certain tag. - -At this point, please hold on to your feature requests and report bugs only. - -Report bugs or any usefull feedback on the forums +### Known Issues +Solutions to the following issues are unlikely due to Kodi limitations. +- Chapter images are missing unless native playback mode is used. +- Certain add-ons that depend on seeing where your content is located will not work unless native playback mode is selected. +- External subtitles (in separate files, e.g. mymovie.srt) can be used, but it is impossible to label them correctly unless direct playing +- Kodi only accepts direct paths for music content unlike the video library. Your Emby music library path will need to be formatted appropriately to work in Kodi (e.g: "\\\\server\Music\Album\song.ext"). See the [Emby wiki](https://github.com/MediaBrowser/Wiki/wiki/Path%20Substitution) for additional information. diff --git a/addon.xml b/addon.xml index 08000cf0..746cc7b4 100644 --- a/addon.xml +++ b/addon.xml @@ -1,7 +1,7 @@ diff --git a/changelog.txt b/changelog.txt index a9282f60..70d0235c 100644 --- a/changelog.txt +++ b/changelog.txt @@ -1,3 +1,7 @@ +version 2.2.17 +- Fix crash when device wakes up +- Add option to disable external subs for direct stream - under add-on settings > playback + version 2.2.16 - Fix strptime error - Temporary fix for database being locked