Official Kodi Wiki - User contributions [en]

Add-on:Library Node Editor

2016-10-03T15:30:15Z

BobCratchett:

{{Addon
|Name=Library Node Editor
|provider-name=Unfledged, Team-Kodi
|ID=plugin.library.node.editor
|latest-version=0.0.4
|extension point=xbmc.python.pluginsource
|provides=executable
|Summary=Manage custom library nodes.
|Description=Create and edit custom library nodes.
|Platform=all
|Language=
|License=GNU General Public License, v2
|Forum=http://forum.kodi.tv/showthread.php?tid=224512
|Website=
|Source=https://github.com/XBMC-Addons/plugin.library.node.editor
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/jarvis/plugin.library.node.editor/icon.png}}

== About ==
The Library Node Editor allows you to create and customise custom [[video nodes]] and [[music nodes]] within Kodi.

== Anatomy of a Custom Node ==
=== Parent nodes ===
Parent nodes act like folders - they contain nodes, and can contain parent nodes. You can also add rules to a parent node, which will be applied to all nodes immediately within it.

=== Nodes ===
Nodes describe views of your media. They can include multiple elements which describe what media Kodi will display, and how it will filter it. A new node will let you set one of two parameters, either 'Content' or 'Path'. If you select 'Content', then you will be able to create a node based on various rules. If you select 'Path', you will be able to create a node which links directly to a library path with various path components specified within the editor.

==== Content ====
Set content to the type of media that Kodi will display in this node. Either Movies, TV Shows, Episodes or Music Videos for a video node; Artists, Albums or Songs for a music node. Once content is set, new options become available.

===== Order =====
Set the property of the media that it will be ordered by in the view. You can select the property (title, year, director, etc) and the direction that it will be ordered (ascending, descending)

===== Grouping =====
Group media be a given property (genre, actor, director, etc)

===== Limit =====
Limit the number of results that will be returned

===== Rule =====
A rule that must be matched by any content that will be returned. Rules are made of three parts - the property of the media that is being queried (title, year, director, etc); the operator (Is, Is Not, etc) and the value that must be matched.

==== Path ====
Set content to a particular videodb:// or musicdb:// address provided by Kodi. For example, for recently added movies, videodb://recentlyaddedmovies/. You will then be able to specify additional components of the path to customise what content will be available.

== Examples ==

=== Add a 'Recently Viewed' node ===
To add a new 'Recently Viewed' node which shows the last 20 watched items to an existing parent node:
# Open the Parent Node you wish to add the Recently Viewed node to
# Select 'New Node...' and give it the title 'Recently Viewed'
# Open the 'Recently Added' node you just added
# Select 'Add content...' and choose the content that matched the Parent Node you are using
# Select 'Add limit...' and type 20 in the dialog
# Select 'Add order...'
## Select 'Title' and change this to 'Last played'
## Select 'ascending' and change this to 'Descending'
## Back out of the 'Order' property by clicking '..' or pressing Back

=== Limit content by path ===
To add a new Parent Node for video nodes which only shows movies from a particular path.
(This presumes that differing types of media you want to display are kept in different sources. In this example, the source is smb://anime/)
# Select 'Video Library'
# Select 'New parent node...'
## Type a title which corresponds to the type of media you want to display, for example 'Anime'
## Choose 'Movies' when asked which defaults to start with. This will give you all the nodes you will find under the default 'Movies' Parent Node
# Open the new Parent Node you just added
# Select 'Add Rules...'
## Select 'Title' and change to 'Path'
## Select 'contains' and change to 'starts with'
## Select '<No value>' and type in 'smb://anime/' OR select 'Browse for value', open the source containing your media and click OK.

All nodes within your new Parent Node will now be limited to content from that path.

[[Category:Isengard add-on repository]]
[[Category:Jarvis add-on repository]]

Video nodes

2016-09-30T20:57:20Z

BobCratchett: /* Video node editor add-on */

{{mininav|[[Video library]]|[[Video management|Management]] }}
<section begin="intro" />Video nodes are defined views that are used to organize your media from the videos menu. In the past Kodi has had a number of standard nodes such as Title, Director, Year, Studios, Countries, Genres that were hard coded. As of v12 Frodo, Kodi introduces the ability to customize these nodes using an XML file. Using XML files really gives great flexibility in how you display your media. Don't want your screaming kids stuff in your main movie node... exclude it. Want documentaries in a separate node, create it. Don't like how recently added is presented, change it.

To get full functionality from custom nodes, you need to use a skin that allows you to deploy them as you would like (e.g. latest builds of Aeon Nox). Confluence will show your nodes, but doesn't allow you to decide exactly where.<section end="intro" />

== Library node editor add-on ==
{{main|Add-on:Library Node Editor}}
Users can now create and edit video and music nodes from within {{kodi}} thanks to the community add-on [[Add-on:Library Node Editor|Lbrary Node Editor]].

== Technical documentation ==

=== Default video nodes ===
[[File:defaultnodes.jpg|right|500px|frame|The standard video nodes]]
You can find a copy of the default nodes in one of two ways. One is to download all or some of the nodes you want form https://github.com/xbmc/xbmc/tree/master/system/library .

The other way is to copy the Kodi system default nodes that come with Kodi, shown in the table below:

{| border="1" cellpadding="4" class="prettytable"
! '''Operative system'''
! '''default nodes paths'''
|-
|'''Android''' || /data/data/org.xbmc.kodi/cache/apk/assets/system/library/
|-
|'''iOS''' - Varied || /Applications/Kodi.frappliance/KodiData/KodiHome/system/library/ <br /> /Applications/Kodi.app/KodiData/KodiHome/system/library/
|-
|'''Linux''' || /usr/share/Kodi/system/library/
|-
|'''Mac OS X''' || /Applications/Kodi.app/Contents/Resources/Kodi/system/library/
|-
|'''Windows (32bit)''' || C:\Program Files\Kodi\system\library\
|-
|'''Windows (64bit)''' || C:\Program Files (x86)\Kodi\system\library\
|}

To understand nodes a little better, lets take a look at one of the defaults. As an example take a quick look at the ''video/movies/years.xml'' node in its simplest form:

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="3" type="filter">
<label>562</label>
<icon>DefaultYear.png</icon>
<content>movies</content>
<group>years</group>
</node>
</syntaxhighlight>

As you can see we are using standard xml format here so nothing too complicated.

=== XML node components ===
'''Order''' = This is the order that you want to show the nodes. Starts at 1 for the top and goes sequentially so 2 will be the next node down.

'''Label''' = This is the text that will show for the node. In this case it is pointing to an ID in the strings.xml file (for transltion purposes) It can also just be any String you want, just type some text instead of the id number.

'''Path''' = This can be any valid Kodi path, such as a file path. This includes internal Kodi DB paths, such as <code>videodb://movies/genres/</code>. For more on internal paths, see '''[[Opening Windows and Dialogs]]'''.

'''Icon''' = Pretty self explanatory really, this is the icon that will show when the node is navigated over.

== Manually creating or editing a custom node ==
So now we understand how the default nodes work, lets have a look at making a custom node. Custom nodes live inside your [[Userdata]] folder. To create custom nodes, the first step is to copy the whole of the default node file structure from the default library folder to a new folder called ''library'' inside your [[Userdata]] folder.

So, in the case of Windows, copy the 'video' and the 'video_flat' folders from ''C:\Program Files (x86)\Kodi\system\library'' to ''%appdata%\Kodi\userdata\library''.

Why the whole lot? Well, currently it seems that when you have a custom video node in your userdata folder, it's assumed that you are customizing the node structure, and that therefore any nodes that are missing are missing intentionally.

Having copied the node structure, we can now create a new xml file under the relevant directory.

In a vanilla install with the confluence skin, custom nodes in ''/video'' will appear in the sub-list of the Video main menu item.

Custom nodes in the ''/video/movies'' will appear in the sub-list of 'Movies' which in turn appears in the sub-list of Video.

In other skins (notably, Aeon Nox), custom main-menu items can be set to a custom video node, meaning that you can use your custom video nodes to have a main-menu item for your collection of post-modern european arthouse anime, if you so wish.

For now, we're going to place our node under

/userdata/library/video/

Let's call it Custom_Motor_dvds.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="10" type="filter">
<label>(Custom) Motor DVDs</label>
<content>movies</content>
<match>all</match>
<icon>DefaultCars.png</icon>
<limit>20</limit>
<rule field="path" operator="contains"><value>ExtremeSports/Cars/</value></rule>
</node>

As you can see as well as changing the order, we have a few more xml tags this time:

'''Type''' = Can be folder or filter, folder requires path to be set.

'''Match''' = Specifies how many rules should match. In this case we are matching all rules.

'''Rule''' = Any rule created with the smart playlist editor. (See [[Smart Playlists]])

'''Limit''' = Limit the number of results returned (can be excluded altogether for unlimited)

[[File:motordvds.jpg|500px|Custom node in action]]

So there you have it, a simple path filter for our Motor DVDs.

One thing that you may want to do now is edit your "Title" xml file to remove the motor dvds from the main movie library. Though if you are attempting to setup a main movie entrypoint for a path labeled "Movies" it may be best to simply hide the default Movies entry from the main menu and create a "Custom Movies" video node that points to your specific path. Still you can remove paths using the DoesNotContain operator:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="2" type="filter">
<label>Movies</label>
<content>movies</content>
<icon>DefaultMovieTitle.png</icon>
<match>all</match>
<rule field="path" operator="doesnotcontain"><value>/ExtremeSports/Cars/</value></rule>
</node>

There are many other rules you can apply, a simple way to find them is to have a go with the smart playlist editor and copy the rule from the resulting xml playlist. There are many possibilities, you could create a rule for any of the database fields such as genre or year, use paths or combine rules together.

[[File:customnodes.jpg|500px|Various custom video nodes]]

== Manually creating or editing a custom parent node ==
You can also create a nested node structure as can be observed in the "unflattened" default structure from [[Custom video nodes#The default Node|above]] (under video).
Then you simply create a folder containing valid xml node files and also include a "index.xml" file that looks like this (which of course can be adapted to the type of media required):

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="1" visible="Library.HasContent(Movies)">

<label>342</label>
<icon>DefaultMovies.png</icon>
</node>

== Examples ==
[[File:PatK_Nodes.jpg|500px]]

== See also ==
* [[Audio nodes]]
* [[Custom home items]]
* [[Smart playlists]]
* [[Video library tags]]

== Notes ==

{{Updated|16}}

[[Category:Video library]]
[[Category:Manual]]

Video nodes

2016-09-30T20:56:59Z

BobCratchett: /* Video node editor add-on */

{{mininav|[[Video library]]|[[Video management|Management]] }}
<section begin="intro" />Video nodes are defined views that are used to organize your media from the videos menu. In the past Kodi has had a number of standard nodes such as Title, Director, Year, Studios, Countries, Genres that were hard coded. As of v12 Frodo, Kodi introduces the ability to customize these nodes using an XML file. Using XML files really gives great flexibility in how you display your media. Don't want your screaming kids stuff in your main movie node... exclude it. Want documentaries in a separate node, create it. Don't like how recently added is presented, change it.

To get full functionality from custom nodes, you need to use a skin that allows you to deploy them as you would like (e.g. latest builds of Aeon Nox). Confluence will show your nodes, but doesn't allow you to decide exactly where.<section end="intro" />

== Video node editor add-on ==
{{main|Add-on:Library Node Editor}}
Users can now create and edit video and music nodes from within {{kodi}} thanks to the community add-on [[Add-on:Library Node Editor|Lbrary Node Editor]].

== Technical documentation ==

=== Default video nodes ===
[[File:defaultnodes.jpg|right|500px|frame|The standard video nodes]]
You can find a copy of the default nodes in one of two ways. One is to download all or some of the nodes you want form https://github.com/xbmc/xbmc/tree/master/system/library .

The other way is to copy the Kodi system default nodes that come with Kodi, shown in the table below:

{| border="1" cellpadding="4" class="prettytable"
! '''Operative system'''
! '''default nodes paths'''
|-
|'''Android''' || /data/data/org.xbmc.kodi/cache/apk/assets/system/library/
|-
|'''iOS''' - Varied || /Applications/Kodi.frappliance/KodiData/KodiHome/system/library/ <br /> /Applications/Kodi.app/KodiData/KodiHome/system/library/
|-
|'''Linux''' || /usr/share/Kodi/system/library/
|-
|'''Mac OS X''' || /Applications/Kodi.app/Contents/Resources/Kodi/system/library/
|-
|'''Windows (32bit)''' || C:\Program Files\Kodi\system\library\
|-
|'''Windows (64bit)''' || C:\Program Files (x86)\Kodi\system\library\
|}

To understand nodes a little better, lets take a look at one of the defaults. As an example take a quick look at the ''video/movies/years.xml'' node in its simplest form:

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="3" type="filter">
<label>562</label>
<icon>DefaultYear.png</icon>
<content>movies</content>
<group>years</group>
</node>
</syntaxhighlight>

As you can see we are using standard xml format here so nothing too complicated.

=== XML node components ===
'''Order''' = This is the order that you want to show the nodes. Starts at 1 for the top and goes sequentially so 2 will be the next node down.

'''Label''' = This is the text that will show for the node. In this case it is pointing to an ID in the strings.xml file (for transltion purposes) It can also just be any String you want, just type some text instead of the id number.

'''Path''' = This can be any valid Kodi path, such as a file path. This includes internal Kodi DB paths, such as <code>videodb://movies/genres/</code>. For more on internal paths, see '''[[Opening Windows and Dialogs]]'''.

'''Icon''' = Pretty self explanatory really, this is the icon that will show when the node is navigated over.

== Manually creating or editing a custom node ==
So now we understand how the default nodes work, lets have a look at making a custom node. Custom nodes live inside your [[Userdata]] folder. To create custom nodes, the first step is to copy the whole of the default node file structure from the default library folder to a new folder called ''library'' inside your [[Userdata]] folder.

So, in the case of Windows, copy the 'video' and the 'video_flat' folders from ''C:\Program Files (x86)\Kodi\system\library'' to ''%appdata%\Kodi\userdata\library''.

Why the whole lot? Well, currently it seems that when you have a custom video node in your userdata folder, it's assumed that you are customizing the node structure, and that therefore any nodes that are missing are missing intentionally.

Having copied the node structure, we can now create a new xml file under the relevant directory.

In a vanilla install with the confluence skin, custom nodes in ''/video'' will appear in the sub-list of the Video main menu item.

Custom nodes in the ''/video/movies'' will appear in the sub-list of 'Movies' which in turn appears in the sub-list of Video.

In other skins (notably, Aeon Nox), custom main-menu items can be set to a custom video node, meaning that you can use your custom video nodes to have a main-menu item for your collection of post-modern european arthouse anime, if you so wish.

For now, we're going to place our node under

/userdata/library/video/

Let's call it Custom_Motor_dvds.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="10" type="filter">
<label>(Custom) Motor DVDs</label>
<content>movies</content>
<match>all</match>
<icon>DefaultCars.png</icon>
<limit>20</limit>
<rule field="path" operator="contains"><value>ExtremeSports/Cars/</value></rule>
</node>

As you can see as well as changing the order, we have a few more xml tags this time:

'''Type''' = Can be folder or filter, folder requires path to be set.

'''Match''' = Specifies how many rules should match. In this case we are matching all rules.

'''Rule''' = Any rule created with the smart playlist editor. (See [[Smart Playlists]])

'''Limit''' = Limit the number of results returned (can be excluded altogether for unlimited)

[[File:motordvds.jpg|500px|Custom node in action]]

So there you have it, a simple path filter for our Motor DVDs.

One thing that you may want to do now is edit your "Title" xml file to remove the motor dvds from the main movie library. Though if you are attempting to setup a main movie entrypoint for a path labeled "Movies" it may be best to simply hide the default Movies entry from the main menu and create a "Custom Movies" video node that points to your specific path. Still you can remove paths using the DoesNotContain operator:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="2" type="filter">
<label>Movies</label>
<content>movies</content>
<icon>DefaultMovieTitle.png</icon>
<match>all</match>
<rule field="path" operator="doesnotcontain"><value>/ExtremeSports/Cars/</value></rule>
</node>

There are many other rules you can apply, a simple way to find them is to have a go with the smart playlist editor and copy the rule from the resulting xml playlist. There are many possibilities, you could create a rule for any of the database fields such as genre or year, use paths or combine rules together.

[[File:customnodes.jpg|500px|Various custom video nodes]]

== Manually creating or editing a custom parent node ==
You can also create a nested node structure as can be observed in the "unflattened" default structure from [[Custom video nodes#The default Node|above]] (under video).
Then you simply create a folder containing valid xml node files and also include a "index.xml" file that looks like this (which of course can be adapted to the type of media required):

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="1" visible="Library.HasContent(Movies)">

<label>342</label>
<icon>DefaultMovies.png</icon>
</node>

== Examples ==
[[File:PatK_Nodes.jpg|500px]]

== See also ==
* [[Audio nodes]]
* [[Custom home items]]
* [[Smart playlists]]
* [[Video library tags]]

== Notes ==

{{Updated|16}}

[[Category:Video library]]
[[Category:Manual]]