Application Submission
From DevWiki
Contents |
Overview
Submitting applications to Boxee is currently done via e-mail to app-submit AT boxee d0t tv. Boxee has the right to refuse submissions to the Boxee Applications Directory if they do not meet the Terms of Use. Boxee will review the submitted applications and once approved, it will be added to the Boxee App Directory and an e-mail response will be sent to the application developer.
At this time, the Boxee API is open to the general public. However, in the future a developer key may be required to access certain portions of the code. As those features are added, the documentation will be updated and clear instructions on the registration process will be posted here.
Registration
While a developer key is not currently required, all that we require for submission is the developer register a jira.boxee.tv. Once you are registerd we ask that you include your jira username in your app submission email. We do this so that we can open a app component on jira for users to post bugs found, if any, with your application.
In the future we hope to have a developer's portal in which you can register and submit apps through the site along wit getting comments and ratings from the boxee community.
Naming Your Application
When naming a Boxee application it's important to be specific - create a name that quickly distinguishes your application from others available on Boxee - this means your collection of great comedy movie scenes from the 90s probably shouldn't just be called "Funny Scenes" :)
Additionally your application name should not be anything that's copyrighted or trademarked. The easiest way to avoid this issue is to do a quick web search for the name of your application. If there's a company, product, or existing show with that name in the first 2-3 pages of results we suggest you change it or reach out to the company to gain permission. If you do obtain permission to use the name please let us know when submitting your application.
Submission
Once your application is ready for submission please perform the following checklist before emailing your app to app-submit AT boxee d0t tv...
- Clear any files/temp files that are not required for you application to run. This includes thumbs.db, hidden files and directories, and any osx hidden folders/files
- Tripple check your descriptor.xml - if your app contains adult content, the adult tag must be present. Make sure you email or support email is included in the descriptor. The default boxee support email should not be used if it wasn't developed by boxee. Your thumbnail MUST be a 200x200 png. For more descriptor musts please read Anatomy of a Boxee App under descriptor section.
- We ask that if your application contains python scripts to please include the py file and not just the compile pyo files. Although the app will still function its best to keep the code as open as possible. However if you are working with a company that requires this you can zip only the pyo but you must include the uncompiled python code in another zip file and send it with submission as all files must be scanned by our QA team for possible malicious code.
- Zip you application folder up in normal zip compression. The zip name is very important. appid-version.zip (example: netflix-1.56.zip)
- Register at jira.boxee.tv
Once you are registered and have you appliction zipped up correctly. Email it to app-submit AT boxee d0t tv - Applications are added to the repository no more then 2 times a week. We try not to make change to the repository when boxee usage is high. You will receive an email once your application has been approved by our QA and submitted to our repository.
