SETUP

  • Location:

All modules are located in the directory of the tv framework app.

You can find the framework directory in:

Windows: “C:\Users\[username]\AppData\Roaming\BOXEE\userdata\apps\com.bart.tv”
Linux: “/home/[username]/.boxee/UserData/apps/com.bart.tv”
MAC: “[username]/Library/Application Support/Boxee/userdata/apps/com.bart.tv”

Make sure you have opened the app at least one time in boxee so that the files are downloaded!

Now in the homedir of the app you can find a directory

‘modules’

inside this directory you will find all the modules installed at that moment.

 

  • Debug mode

I have included a debug mode in the framwork so you can more easily test the modules and read out errors. It is important to set debug mode to ‘True’ when developing modules. You have to edit main.py in the libs directory (com.bart.tv/libs/main.py) in the first few lines of the python file you will find the variable ‘self.debug’. Change it value to ‘True’ to enable local module development and a better error logging in th main boxee log.

It is important to set this value correctly as it will set bartsideeTv to local mode. If it remains on False it will clean/remove all modules not listed in the online database!

As a tip you can use the python ‘print’ command to log variables to the main boxee log to ease debugging. For example print str(“This is an test”) or print variable wil print the content in the boxee log.

 

  • Adding a module

If you want to add a module, please start by adding a new directory to the ‘modules’ folder. When you do this please give the directory a name with ony lowercase letters and no special characters or spaces! Since the latest version of the framework yo also have to add a verson number to the module directory. (example the module ‘youtube’ gets a folder name ‘youtube-1′) The directory name will be used as an internal id for the framework.

Now add 3 files to this new directory:

  1. image file  [example.png]
  2. python file [example.py]
  3. python file [__init__.py]

Make sure you give both the python file and the image file the same name as the directory name for your module. For example if the directory name of the module is called ‘youtube’ the files inside this module should be called ‘youtube.py’ and ‘youtube.png’.

The example file structure will be as seen in the image below:

 

  • Image file

The image file included should be a ‘png’ image file and preferably a 200px by 200px image saved  24-bit png with transparency enabled.

 

  • Python file

All module file should have the same basic template to make sure it can communicate with the framework. When you start building a new module you can start with a template seen below you can download it here.

  1. import mc, re, os, sys
  2. sys.path.append(os.path.join(mc.GetApp().GetAppDir(), ‘libs’))
  3. import ba
  4. from beautifulsoup.BeautifulSoup import BeautifulSoup
  5.  
  6. class Module(object):
  7.     def __init__(self):
  8.         self.name = "Module Name"                   #Name of the channel
  9.         self.type = [‘search’,‘genre’,‘list’]           #Choose between ‘search’, ‘list’, ‘genre’
  10.         self.episode = True                             #True if the list has episodes
  11.         self.filter = []                                    #Option to set a filter to the list
  12.         self.genre = []                                   #Array to add a genres to the genre section
  13.         self.content_type = ‘video/x-ms-asf’      #Mime type of the content to be played
  14.         self.country = ‘NL’                              #2 character country id code
  15.  
  16.     def Search(self, search):
  17.         """Start your code here"""
  18.        
  19.         """End your code here"""
  20.         return streamlist
  21.    
  22.     def List(self):
  23.         """Start your code here"""
  24.        
  25.         """End your code here"""
  26.         return streamlist
  27.    
  28.     def Episode(self, stream_name, stream_id, page, totalpage):
  29.         """Start your code here"""
  30.        
  31.         """End your code here"""
  32.         return episodelist
  33.  
  34.     def Genre(self, genre, filter, page, totalpage):
  35.         """Start your code here"""
  36.        
  37.         """End your code here"""
  38.         return genrelist
  39.        
  40.     def Play(self, stream_name, stream_id, subtitle):
  41.          """Start your code here"""
  42.        
  43.         """End your code here"""
  44.         return play

 

  • Python IDE

Watch out with editing python files in a text editors. Python is a bit picky on iterations and a script can fail very quicly on not setting a tab or space correct. In fact python does not support tabs at all.

Best is to use an IDE editor that takes the burden of looking after the iterations You can find a good manual for installing the IDE netbeans for boxee here.

  • admin
    #1 written by admin  1 year ago

    In the new beta you need next to the debug flag also to set the ‘local’ flag to True before you can see the local modules. (situated in lib/config.py)

    Reply Quote
    • Nofre Munar
      #2 written by Nofre Munar  1 year ago

      I have the same problem, the application is cleaning te module folder on every session. How can I resolve it?

      Reply Quote
  • Wimke
    #3 written by Wimke  7 months ago

    Hi Bart,

    Is it possible to set the module default to enable in stead of disabled? This will help the BoxeeBox users to not having to select the modules over and over again in the settings menu.

    It would be 100% perfect for me if you have a BartsIdeeTV Dutch version where all dutch modules are enabled by default.

    Reply Quote
  • CAPTCHA Image

    *

    You may use these HTML tags: <a> <abbr> <acronym> <b> <blockquote> <cite> <code> <del> <em> <i> <q> <strike> <strong>

  • Comment Feed for this Post
Go to Top