Merge pull request #26 from Etharr/polish
[plugin.video.netflix.git] / README.md
1 # plugin.video.netflix
2
3 ## Netflix Plugin for Kodi 18
4
5 Disclaimer
6 -------------
7 This plugin is not officially commisioned/supported by Netflix.
8 The trademark "Netflix" is registered by "Netflix, Inc."
9
10 Prerequisites
11 -------------
12
13 - Kodi 18 [agile build](https://github.com/FernetMenta/kodi-agile)
14 - Libwidevine 1.4.8.962 (A german description how to get/install it, can be found [here](https://www.kodinerds.net/index.php/Thread/51486-Kodi-17-Inputstream-HowTo-AddOns-f%C3%BCr-Kodi-17-ab-Beta-6-aktuelle-Git-builds-Updat/))
15 - Inputstream.adaptive [agile branch build](https://github.com/liberty-developer/inputstream.adaptive/tree/agile)
16
17 FAQ
18 ---
19
20 - [Does it work with Kodi 17](https://github.com/asciidisco/plugin.video.netflix/issues/25)
21 - [Does it work on a RPI](https://github.com/asciidisco/plugin.video.netflix/issues/28)
22 - [Which video resolutions are supported](https://github.com/asciidisco/plugin.video.netflix/issues/27)
23
24 Functionality
25 -------------
26 - Multiple profiles
27 - Search Netflix (incl. suggestions)
28 - Netflix categories, recommendations, "my list" & continue watching
29 - Rate show/movie
30 - Add & remove to/from "my list"
31 - Export of complete shows & movies in local database (custom library folder can be configured, by default the .strm files are stored in `userdata/addon_data/plugin.video.netflix` )
32
33 ToDo
34 ----
35
36 > Note: Those Todos are considered enhancements, they´re not issues, nor they prevent the usage of the plugin for everyday business
37
38 If you feel, you´d like to contribute to this plugin or directly work on one of these items,
39 please open an issue & we can provide you with some help to get started
40
41 - [ ] Add missing meta data for episodes/seasons (Cast, bookmark position, etc.)
42 - [ ] Change list of shows to actual list of episodes in the "Continue watching"" section, like it´s done on the website
43 - [ ] Enable possibility to export single episodes or seasons to the Library
44 - [ ] Evaluate idea of an auto updating library exporter that keeps track (on Plugin start/on Service start maybe)
45 - [ ] If a new user has been created, they need to select their movie/show preferences to actually get started, we could provide the same mechanisms in Kodi
46 - [ ] Enable aggressive fetching of data in background (maybe using Futures), like the Netflix website does, to enhance the speed and the user experience when browsing the frontend
47
48 Something doesn't work
49 ----------------------
50
51 If something doesn't work for you, please:
52
53 - Make sure all prerequisites are met
54 - Enable verbose logging in the plugin settings
55 - Enable the Debug log in you Kodi settings
56 - Open an issue with a titles that summarises your problems and include:
57         - Kodi version (git sha as long as we´re on agile only)
58         - Inputstream.adaptive version (git sha as long as we´re on the agile branch)
59         - Your OS and OS version
60         - Libwedevine version
61         - A Kodi debug log that represents your issue
62
63 Licence
64 -------
65
66 Licenced under The MIT License.
67 Includes [pyjsparser](https://github.com/PiotrDabkowski/pyjsparser) by [Piotr Dabkowski](https://github.com/PiotrDabkowski)