diff --git a/README.md b/README.md index 89636612..cafab7c9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,46 @@ -# Welcome to Emby for Kodi +# Emby for Kodi + +[![EmbyKodi_Banner](https://i.imgur.com/hx4cx41.png)](https://emby.media/community/index.php?/forum/99-kodi/) + +[![Wiki](https://img.shields.io/badge/wiki-get%20started-brightgreen.svg)](https://github.com/MediaBrowser/plugin.video.emby/wiki) +[![Forums](https://img.shields.io/badge/forums-report%20issues-3960C1.svg)](https://emby.media/community/index.php?/forum/99-kodi/) +[![Donate](https://img.shields.io/badge/kofi-donate-blue.svg)](https://ko-fi.com/A5354BI) +[![Emby](https://img.shields.io/badge/emby-server-lightgray.svg)](https://emby.media/) +___ **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. +The Emby for Kodi add-on combines the best of Kodi - ultra smooth navigation, beautiful UIs and playback of any file under the sun, and Emby - the most powerful open source multi-client media metadata indexer and server. You can now retire your MySQL setup in favor of a more flexible setup. + +Synchronize your media on your Emby server to the native Kodi database, browsing your media at full speed, while retaining the ability to use other Kodi add-ons to enhance your experience. In addition, you can use any Kodi skin you'd like! +___ + +### Supported + +The add-on supports a hybrid approach. You can decide which Emby libraries to sync to the Kodi database. Other libraries and features are accessible dynamically, as a plugin listing. +- Library types available to sync: + + Movies and sets + + TV shows + + Music videos + + Music +- Other features supported: + + Simple Live TV presentation + + Home Videos & photos + + Audiobooks + + Playlists + + Theme media +- Direct play and transcode +- A 2-way watched and resume state between your server and Kodi. This is a near instant feature. +- Remote control your Kodi; send play commands from your Emby web client or Emby mobile apps. +- Extrafanart (rotating backgrounds) for skins that support it +- Offer to delete content after playback +- Backup your emby kodi profile. See the [Emby backup option](https://github.com/MediaBrowser/plugin.video.emby/wiki/Create-and-restore-from-backup) +- and more... ### Download and installation +**Important notes** +- 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 not currently compatible with Kodi's Video Extras addon unless native playback mode is used. **Deactivate Video Extras if content start randomly playing.** View this short [Youtube video](https://youtu.be/IaecDPcXI3I?t=119) to give you a better idea of the general process. @@ -13,53 +50,6 @@ View this short [Youtube video](https://youtu.be/IaecDPcXI3I?t=119) to give you 4. The first sync of the Emby server to the 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, and syncs will be done automatically in the background. -### Our Wiki - -If you need additional information for 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 not currently compatible with Kodi's Video Extras addon unless native playback mode is used. **Deactivate Video Extras if content start randomly playing.** -- Emby for Kodi adds entries to your Kodi database. To stop them from being removed, make sure cleanonupdate is not enabled in your advancedsettings.xml - -### What is currently supported? - -Emby for Kodi is under constant development. The following features are currently provided: - -- Library types available: - + Movies - + Sets - + TV Shows - + Music Videos - + Music - + Home Videos - + Pictures -- 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. -- Remote control your Kodi; send play commands from your Emby webclient or Emby mobile apps. -- 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 -- **New!** Backup your emby kodi profile. See the [Emby backup option](https://github.com/MediaBrowser/plugin.video.emby/wiki/Create-and-restore-from-backup) -- and more... - -### What is being worked on -Have a look at our [Trello board](https://trello.com/b/qBJ49ka4/emby-for-kodi) to follow our progress. - -### Known Issues -Solutions to the following issues are unlikely due to Kodi limitations. +### Known 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.