/************************************************************************
* Name: OpenRokn
* Homepage: http://openrokn.sourceforge.net
* Description: Open source Roku channel building kit
* Author: kavulix
*
* Copyright (C) 2011 kavulix
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
************************************************************************/
CONTRIBUTORS
Bruce Rothwell - logo design
http://wordchannel.org
Adilson V. Casula - folder icons
http://burnsplayguitar.deviantart.com
2Shi - original box icon
http://2shi.deviantart.com
PLEASE REPORT BUGS!
If you discover any errors at all in the BrightScript debugger
or if you notice that a specific feature isn't performing as
expected PLEASE report the issue. You can file a bug report at
the url below.
http://sourceforge.net/p/openrokn/tickets/
ANNOUNCE YOUR CHANNEL
If you have created a channel using the OpenRokn software please
consider sharing your channel's installation code with the rest
of the OpenRokn community. Just visit the url below and post a
title, short description and a link that can be used to install
your channel.
http://sourceforge.net/p/openrokn/discussion/announce/
HOW TO INSTALL
* Enter the following button combination on your Roku remote:
Home, Home, Home, Up, Up, Right, Left, Right, Left, Right
* Enable developer mode when prompted and restart Roku.
* Open the Roku Settings screen and select About.
* Write down the IP address listed on that page.
* Open your web browser and navigate to the ip address.
* After the page has loaded click the browse button and
select the openrokn.zip file.
* Click install.
HOW TO VIEW DEBUG OUTPUT
* Open a console window
Linux/Gnome: Alt + F2, gnome-terminal
Linux/KDE: Alt + F2, konsole
Windows: Win + R, cmd
* Type "telnet [ip address] 8085" where the ip address is the
same one that you wrote down in the step above.
* Output should immediately be visible in your console window.
HOW TO EXIT TELNET SESSION
* Ctrl + ], enter, Ctrl + d
HOW TO ADAPT THE OPENROKN PACKAGE FOR YOUR CHANNEL
* Inside the openrokn.zip file you will find all of the files necessary
to build your own channel. The first step is to extract the files from
the examples, php and images folders and upload them to your server.
* Open the "manifest" file located in the root folder and edit it to
reflect your channel's title, version, description and splash screen.
DO NOT edit the manifest.xml file in the control folder. The required
size for the splash images are 1280x720 for hd and 720x480 for sd. The
splash_min_time attribute will set a minimum amount of time in ms that
the splash screen will be displayed before loading your primary
channel feed. To speed up the loading process you can set it to 0.
* Open the preferences.xml file in the control folder and replace each
url with a valid url that points to the file location on your server.
* Open the style.xml file in the control folder and edit the theme
properties to modify the appearance of your channel. If you just want
to use the default style then skip this step.
* Open the failsafe.xml file in the control folder and edit it to provide
users with a fallback feed in the event that the primary channel feed
cannot be retrieved.
* Modify the reportBrokenStream.php, emailInformation.php and search.php
files to handle the data submitted to them if you plan on using any of
the corresponding buttons on the video, slideshow or audio screens. The
scripts included in the package are just examples that are meant to
show you which parameters are used when data is submitted. It is up
to you to code the scripts to handle the data.
* Modify the primary-feed.xml file to design your channel. This xml file
enables you to completely customize your channel from specifying the
type of poster and grid screens to use to specifying external xml feeds
or video and audio streams. Everything that you want your channel to
contain goes in this file. All supported xml elements and attributes
are defined in the openrokn wiki pages. Visit openrokn.sourceforge.net
and click on the "ORML Specification" link.
* Optionally you may also want to customize some of the icons included
in this package to display your own logo or background image. The only
images that you should package with your channel are the main_menu*png,
overhang*png and splash*png files. All other images should be hosted
on your server.
REQUIRED FILES
After adapting the package to create your own channel, the files/folders
listed below are the only ones that should remain in your channel. It's
alright to remove the README and LICENSE files as long as you don't
distribute the source code without them.
manifest
[control]
failsafe.xml
manifest.xml
preferences.xml
style.xml
[images]
main_menu_logo_focus_hd.png
main_menu_logo_focus_sd.png
main_menu_logo_side_hd.png
main_menu_logo_side_sd.png
overhang_bg_hd.png
overhang_bg_sd.png
overhang_logo_hd.png
overhang_logo_sd.png
splash_sd.png
splash_hd.png
[source]
htmlUtils.brs
openrokn.brs
ormlGenerator.brs
orUtils.brs
[templates]
[extensions]
HOW TO ENABLE ADRISE
After you've registered for an adrise account and downloaded their
sdk open the adrise_ad.brs file in a text editor. Check the values
for each variable listed below and make sure they're correct.
pubid = "Your Publisher ID"
zoneid = "The Zone ID"
m.adrise_bg = "#000000"
m.adrise_fontcolor = "#EBEBEB"
m.adrise_loadingurl = "http://cdn.adrise.tv/image/loading.png"
Drop the adrise_ad.brs file along with the generalUtils.brs and
urlUtils.brs files into your channel's source folder. You can find
both of the utils files in the Roku sdk. Then open the preferences.xml
file in the control folder and change the enableadrise pref to true.
That's it! The channel will handle the rest. A status message will be
printed each time the channel loads that will tell you whether it's
enabled or disabled.
HOW TO UPGRADE YOUR CHANNEL TO USE THE LATEST VERSION OF OPENROKN
Beginning with v0.3 all customizable settings have been moved to the
control folder. Make sure that you preserve the preferences.xml,
style.xml and failsafe.xml files along with any custom templates or
extensions that you have created. Open your channel in a program like
7-zip or file-roller and navigate to the source folder. Then do the
same with the latest version of OpenRokn. Select all of the .brs files
in the OpenRokn source folder and drag them onto the other application
window (i.e., your channel's source folder) and drop them. They should
immediately overwrite the existing files in the source folder. Then
open the control folder in both application windows. Drag the
manifest.xml file from the OpenRokn control folder and drop it in your
channel's control folder. That's it! Upgrade done!
I DON'T HAVE A SERVER! HOW CAN I CREATE A CHANNEL WITHOUT A SERVER?
The openrokn.zip file is completely self-contained. It doesn't rely upon
any remote content in order to install or load successfully. That means
that all of the feeds and images required by the package are stored
locally on your Roku box. If you don't have a server and only want to
adapt this software for your own personal use then simply edit the feeds
in this package to point to the remote content that you want to access
with this channel and update the archive when finished.
HOW TO DETERMINE BITRATE AND LENGTH FOR VIDEO OR AUDIO STREAMS
A simple console application is available for free from the url below
that will print numerous video details including bitrate and length.
It does however require a local file to work with so you will need to
first download the video to your local hard drive.
http://mediainfo.sourceforge.net
You can also use VLC to determine bitrate and length. Simply load a
network stream in VLC and the length will be immediately visible in
the bottom right corner of the window. You can then click on
"Tools" > "Codec Information" to view the bitrate.
http://videolan.org
DISTRIBUTION
If you decide to distribute the source code of your channel please make
sure that the original LICENSE and README files are included. Also, if
you have made any changes to the source code make sure that the changes
are noted.
REQUEST FROM THE DEVELOPER
If you decide to build a roku channel using OpenRokn please add the
following statement to your about page (assuming you have one).
Powered by OpenRokn
http://openrokn.sourceforge.net
COMMERCIAL USAGE
This software is licensed under the Apache v2 license and can be used in
personal or commercial projects. If you do happen to build a commercial
channel from this software please consider making a donation to help
support the project.
SUPPORT THE PROJECT
If you have found this software useful please consider making a donation
through flattr to help fund its development. At this point I am the only
developer involved in this project and I have a very limited amount of
spare time to work on it. I can't guarantee that there will be frequent
updates to this software or that any future versions will be released at
all. However, I will continue to develop this softare as long as
donations are being received. You can setup a flattr account to
automatically send a donation to the OpenRokn project every month. After
you've flattr'd OpenRokn just click the Subscribe button to auto-flattr
it each month. Any amount at all would be appreciated whether it's 10
cents or $5. Thanks to everyone for your continued support.
http://flattr.com/thing/404358/OpenRokn
