Add-on:Emby for Kodi: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Addon
{{Add-on
|Name=Emby for Kodi
|Name=Emby for Kodi
|provider-name=angelblue05, xnappo, null_pointer, marcelveldt, im85288, jurmb84(sync plugin)
|provider-name=angelblue05, marcelveldt, null_pointer, xnappo, im85288, jurmb84(sync plugin)
|ID=plugin.video.emby
|ID=plugin.video.emby
|latest-version=1.1.39
|latest-version=2.2.19
|extension point=xbmc.python.pluginsource
|extension point=xbmc.python.pluginsource
|provides=video audio
|provides=video audio
|Summary=Allows Kodi to use an Emby as a media management backend. This add on effectively replaces the Kodi built-in media database with Emby. Currently supported media includes Movies, TV Episodes, & Music.
|Summary=Allows Kodi to use Emby as a media management back-end.
|Description=The Emby addon for Kodi combines the best of Kodi - ultra smooth navigation, beautiful UIs and playback of any file under the sun, and [https://emby.media Emby] - the most powerful fully open source multi-client media metadata indexer and server.
<br />
|Platform=all
|Platform=all
|Language=en
|Language=en
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://emby.media/community/index.php?/forum/99-kodi/
|Forum=https://emby.media/community/index.php?/forum/99-kodi/
|Website=http://emby.media/
|Website=https://emby.media Emby
|Source=https://github.com/MediaBrowser/Emby.Kodi
|Source=https://github.com/MediaBrowser/plugin.video.emby Github
|repo= [http://www.mb3admin.com/downloads/addons/xbmb3c/kodi-repo/repository.emby.kodi-1.0.2.zip Emby for Kodi Repository]
|Email=
|Email=
|repo=[http://embydata.com/downloads/addons/xbmb3c/repo-install/repository.emby.kodi-1.0.3.zip Kodi Emby Repository - Version 1.0.3]
|broken=
|broken=
|icon url=https://raw.githubusercontent.com/MediaBrowser/Emby.Resources/master/images/Logos/logoicon.png}}
|icon url=https://raw.githubusercontent.com/MediaBrowser/Emby.Resources/master/images/Logos/logoicon.png
|repo=[https://emby.media/]
}}


== Introduction ==  
== Introduction ==
<section begin="intro"/>Emby is a media management server that allows you to synchronize media libraries, watched status, and watch progress between compatible devices. Emby for Kodi allows Kodi to use an Emby as a media management backend. This add-on effectively replaces the Kodi built-in media database with Emby. Currently supported media includes Movies, TV Episodes, & Music. <section end="intro"/>
<section begin="intro"/>Emby is a media management server that allows you to synchronize media libraries, watched status, and watch progress between compatible devices. Emby for Kodi allows Kodi to use Emby as a media management back-end. This add-on effectively replaces the Kodi built-in media database with Emby. Supported media includes movies, series, music and more.<section end="intro"/>


A quick intro video from one of the dev's: https://youtu.be/IaecDPcXI3I?t=119
 
A quick intro video:
 
{{youtube|IaecDPcXI3I}}


{|
{|
|| {{divbox|yellow||<big>'''NOTICE:''' This addon completely takes over the Kodi database, so be sure to do a backup before you begin.</big>}}||  
|| {{divbox|yellow||<big>'''NOTICE:''' This add-on completely takes over the Kodi database, so be sure to do a backup before you begin.</big>}}||
|}
|}


 
<big>Reference: [[Import-export_library]]</big>
<big><big>Reference: [[Import-export_library]]</big></big>


<br />
<br />


== Setting up Emby ==
== Setting up your Emby server ==


=== Basic Setup ===
=== Basic Setup ===
# Download and install Emby for your desired operating system: http://emby.media/download/
# Download and install Emby for your desired operating system: https://emby.media/download/
# Open the Emby web interface @ http://[server ip address]:8096
# Open the Emby web interface @ http://[server ip address]:8096
# Follow the instructions as prompted
# Follow the instructions as prompted
# Enable path substitution, if necessary
# Enable path substitution in your Emby server: [https://github.com/MediaBrowser/Wiki/wiki/Path%20Substitution Emby Path Substitution Wiki]
::a. Select Library from the left side of the server management page
::b. Select Path Substitution
::c. Setup all path substitutions


=== Optional: Plugins ===
=== Optional: Plugins ===
Line 54: Line 57:
# Trakt.tv:  Sync's watched status between Emby and trakt.tv
# Trakt.tv:  Sync's watched status between Emby and trakt.tv
::Disable Trakt.tv add-on from all kodi installs, if this is used.
::Disable Trakt.tv add-on from all kodi installs, if this is used.
<br />
 
;For further information or a more detailed explanation of the installation process, please see [https://github.com/MediaBrowser/Wiki/wiki/Installation the Emby Official Wiki page]
;For further information or a more detailed explanation of the installation process, please see [https://github.com/MediaBrowser/Wiki/wiki/Installation the Emby Official Wiki page]


Line 61: Line 64:
== Installing Emby for Kodi ==
== Installing Emby for Kodi ==


'''Step 1:''' Download the Emby for Kodi repository.
{|
::a. [http://www.mb3admin.com/downloads/addons/xbmb3c/kodi-repo/repository.emby.kodi-1.0.2.zip Stable Repository]
|| {{divbox|yellow||<big>'''NOTICE:''' It is recommended to start with a fresh Kodi install. Otherwise, remove any Kodi sources added as Emby libraries. </big>}}||
::b. [http://www.mb3admin.com/downloads/addons/xbmb3c/kodi-beta-repo/repository.beta.mediabrowser.kodi-1.0.4.zip Beta Repository]
|}
 
'''Step 1:''' Download the Emby repository.
::a. [https://github.com/MediaBrowser/plugin.video.emby/wiki/Emby-Repository No Side-Loading Method]
::b. [http://embydata.com/downloads/addons/xbmb3c/repo-install/repository.emby.kodi-1.0.3.zip Stable Repository]
::c. [http://embydata.com/downloads/addons/xbmb3c/repo-install/repository.beta.emby.kodi-1.0.5.zip Beta Repository]
<br />
'''Step 2:''' Open Kodi.
'''Step 2:''' Open Kodi.


Line 77: Line 86:
</gallery>
</gallery>


;At this point Emby for Kodi is installed and it has connected to your Emby server.  You should see a box in on the screen showing the progress of the import from Emby into the Kodi database.
;At this point Emby for Kodi is installed and it has connected to your Emby server.  You should see the progress of the import from Emby into the Kodi database.


<br />
<br />
Line 86: Line 95:
;# Select Configure
;# Select Configure


=== Emby Tab ===
View the Emby for Kodi settings here: [https://github.com/MediaBrowser/plugin.video.emby/wiki/Emby-for-kodi-settings Settings Details]
[[File:Emby_for_Kodi_Emby.PNG|none|500px]]
:- Primary Server Address
::=> ''This is the IP address of the computer running Emby''
:- Port Number
::=> ''The port used by Emby (Defaut: 8096)''
:- Enable HTTPS
::=> ''Enable to use HTTPS instead of HTTP''
::- Verify Host SSL Certificate
:::=> ''Specify if the host SSL certificate must be verified''
::- Client SSL certificate
:::=> ''Identify client SSL Certificate''
:- Use alternate address
::=> ''Enable secondary server address.  This is useful for mobile devices that will access Emby both on a local network and remotely''
::- Secondary Server Address
:::=> ''Secondary IP address for Emby.''
::- Enable HTTPS
:::=> ''Enable to use HTTPS instead of HTTP''
:::- Verify Host SSL Certificate
::::=> ''Specify if the host SSL certificate must be verified''
:::- Client SSL certificate
::::=> ''Identify client SSL Certificate''
:- Username
::=> ''Emby primary username''
:- Use alternate Device Name
::=> ''Allows you to set the device name, as seen by Emby''
::- Device Name
:::=> ''Custom Device name seen by Emby''
 
=== Sync Options Tab===
[[File:Emby_for_Kodi_Sync_Options.PNG|none|500px]]
:- Show sync progress on screen
::=> ''Toggle on to display sync progress pop-up within Kodi''
:- Sync specials ordering
::=> ''Inserts special episodes into the normal episode seasons.''
::: ''Special Episodes are inserted at the beginning of seasons based on aired date.''
:- Sync empty TV Shows
::=> ''Add TV Shows to Kodi Library that do not currently have any associated episodes in the library''
:- Enable Music Library Sync
::=> ''Sync Kodi Library to Emby''
::- Direct stream music library
:::=> ''Directly play music from network shares, instead of through Emby''
::- Use local paths instead of addon redirect for playback
:::=> ''Directly play videos from network shares, instead of through Emby''
:- Auto add images to the Kodi texture cache
::=> ''Add Images to Kodi texture cache during sync.''
:- Use incremental sync at startup (Requires Server Plugin)
::=> ''Limit startup sync data to only changes, instead of the full library''
::: ''Requires "Emby for Kodi Sync Queue" plugin to be installed in Emby''
::- Max change set size
:::=> ''Specify the maximum number of items changed before triggering a full sync instead''
:::: ''Sometimes a full sync is faster, if enough items status' have changed''
 
=== Playback Tab ===
[[File:Emby_for_Kodi_Playback.PNG|none|500px]]
:- Network username
::=> ''Username used to connect to SMB shares''
:- Network Password
::=> ''Password used to connect to SMB shares''
:- Offer delete after playback
::=> ''Enables a prompt that will show up after watching a video.''
::: ''This prompt gives the user the option to delete the video from the Emby library''
::- For Episodes
:::=> ''Enable prompt to delete video for Episodes''
::- For Movies
:::=> ''Enable prompt to delete video for Movies''
:- On Resume jump Back Seconds
::=> ''On resume, the video will start a specified number of seconds before the point at which it was stopped''
:- Play from HTTP instead of SMB
::=> ''Use the Emby HTTP server for playback source, instead of SMB shares''
::- Video Quality
:::=> ''Specify the maximum video transfer rate''
 
=== Extras Tab ===
[[File:Emby_for_Kodi_Extras.PNG|none|500px]]
:- Disable Enhanced Images (eg CoverArt)
::=> ''Disable special images i.e. CoverArt''
::- Force CoverArt Ratio
:::=> ''Resize CoverArt to match Kodi sizes (may result in images being distorted)''
:- Ignore specials in next episodes
::=> ''Causes "Next Episodes" to ignore all special episodes''
:- Permanent users to add to the session
::=> ''List of all other uses whose watched status should be updated when videos are watched''
 
=== Advanced Tab ===
[[File:Emby_for_Kodi_Sync_Advanced.PNG|none|500px]]
:- Log Level:
::=> ''Select level of data to be included in the log (None/Info/Debug)''
:- Suppress server connection message on start-up
::=> ''Suppress welcome message when connecting to Emby''
:- Enable server message when it's restarting
::=> ''Enable notification that Emby has restarted''
:- Reset Local Kodi DB
::=> ''Completely wipe data out of local Kodi database (an option to delete the Emby plugin settings will be shown as well)''
::: ''Requires Kodi to be restarted''
 
<br />


== Emby Shortcuts on the Kodi Home Screen ==
== Emby Shortcuts on the Kodi Home Screen ==
Note: This is an example, but the basic knowledge will help you for most skins.
Basic knowledge will help you for most skins. The add-on will automatically tag your content by Emby library name and recreate your them as Video Nodes and Playlists.
:1. Install a custom skin (Confluence does not support adding shortcuts to the home screen)
:: A. Mimic is being used for this particular example.
:: B. See the following links to help compare different skin options.
::: [[Comparison_of_skin_features]]
::: [http://forum.kodi.tv/forumdisplay.php?fid=67 Kodi Skin Forum]
:2. Navigate to Videos: Files
:3. Locate desired Emby Media source (e.g. TV: Next Episodes)
:4. Add desired Emby Media source to favorites
:5. Navigate to Skin Settings (Typically a found on the Appearance section of the settings)
:6. Select Setup Main Menu
:7. Select an unused menu item
:8. Enable & name the unused menu item
:9. Select "Set Default Action"
:10. Find and select your saved favorite
:11. Return to main screen to verify that the setup worked


Note: Screenshots to be added soon.
'''Step 1: Step "Simple"'''
# Your only job as a user is to add the Emby library shortcuts created for you to your Home Screen.


== Extra Info ==
== Extra Info ==
 
:See: '''[https://github.com/MediaBrowser/Emby.Kodi/wiki Emby for Kodi Github Wiki]'''
:'''Note: This page is currently in the process of being updated.'''
:See: '''https://github.com/MediaBrowser/Emby.Kodi/wiki'''

Revision as of 06:03, 21 September 2016

Emby for Kodi
https://raw.githubusercontent.com/MediaBrowser/Emby.Resources/master/images/Logos/logoicon.png

Author: angelblue05, marcelveldt, null_pointer, xnappo, im85288, jurmb84(sync plugin)
Website: Emby link
Type: Music/Audio and Video
Repo:

License: GPL v2.0
Source: Github Source code
Summary: Allows Kodi to use Emby as a media management back-end.
Home icon grey.png   ▶ Add-ons ▶ Emby for Kodi
Attention talk.png Need help with this add-on? See here.

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.

Introduction

Emby is a media management server that allows you to synchronize media libraries, watched status, and watch progress between compatible devices. Emby for Kodi allows Kodi to use Emby as a media management back-end. This add-on effectively replaces the Kodi built-in media database with Emby. Supported media includes movies, series, music and more.


A quick intro video:

NOTICE: This add-on completely takes over the Kodi database, so be sure to do a backup before you begin.

Reference: Import-export_library


Setting up your Emby server

Basic Setup

  1. Download and install Emby for your desired operating system: https://emby.media/download/
  2. Open the Emby web interface @ http://[server ip address]:8096
  3. Follow the instructions as prompted
  4. Enable path substitution in your Emby server: Emby Path Substitution Wiki

Optional: Plugins

Installation of Emby plugins (Add-ons) is done from the Emby web interface
  1. Navigate to http://[server ip address]:8096/web/dashboard.html
  2. Select Plugins from the left side
  3. Select Catalog from within the right side of the window
  4. Scroll down to general and select the desired pugin to install it.

Useful Emby Plugins

  1. Emby for Kodi Sync Queue: This plugin will speed up the media sync done by kodi on every startup
  2. Auto-Box Set: Automatically organizes Movies into sets (collections in Emby), based on data from themoviedb.org
  3. Trakt.tv: Sync's watched status between Emby and trakt.tv
Disable Trakt.tv add-on from all kodi installs, if this is used.
For further information or a more detailed explanation of the installation process, please see the Emby Official Wiki page


Installing Emby for Kodi

NOTICE: It is recommended to start with a fresh Kodi install. Otherwise, remove any Kodi sources added as Emby libraries.

Step 1: Download the Emby repository.

a. No Side-Loading Method
b. Stable Repository
c. Beta Repository


Step 2: Open Kodi.

  • Step 3: Navigate to System > Add-ons > Install from zip file.

    Step 3: Navigate to System > Add-ons > Install from zip file.

  • Step 4: Navigate to where the Emby for Kodi repository was saved and select the zip file.

    Step 4: Navigate to where the Emby for Kodi repository was saved and select the zip file.

  • Step 5: Navigate to System > Add-ons > Install from Repository > Kodi Emby stable/beta add-ons

    Step 5: Navigate to System > Add-ons > Install from Repository > Kodi Emby stable/beta add-ons

  • Step 6: Navigate to Video Addons>Emby

    Step 6: Navigate to Video Addons>Emby

  • Step 7: Select install

    Step 7: Select install

  • Step 8: If your Emby server is running, the add-on should detect it and prompt you connect to it.

    Step 8: If your Emby server is running, the add-on should detect it and prompt you connect to it.

  • Step 9: After connecting to your server, you should be prompted to select a user.

    Step 9: After connecting to your server, you should be prompted to select a user.

  • Step 10: Finally, you should see a notification

    Step 10: Finally, you should see a notification

At this point Emby for Kodi is installed and it has connected to your Emby server. You should see the progress of the import from Emby into the Kodi database.


Configuring Emby for Kodi Add-on

  1. Navigate to System > Add-ons > My add-ons > Video add-ons
  2. Open Emby
  3. Select Configure

View the Emby for Kodi settings here: Settings Details

Emby Shortcuts on the Kodi Home Screen

Basic knowledge will help you for most skins. The add-on will automatically tag your content by Emby library name and recreate your them as Video Nodes and Playlists.

Step 1: Step "Simple"

  1. Your only job as a user is to add the Emby library shortcuts created for you to your Home Screen.

Extra Info

See: Emby for Kodi Github Wiki
Retrieved from "https://kodi.wiki/index.php?title=Add-on:Emby_for_Kodi&oldid=124396"