Roku Toolkit

A simple set of Roku development tools to ease and simplify deployment. Tested on OSX and Linux, should work on Windows.

Installation

Add this line to your application's Gemfile:

gem 'roku'

And then execute:

$ bundle

Or install it yourself as:

$ gem install roku

Configuration

In order to use the Roku Toolkit, you must first initialize a roku.yml file. You have two options for placement of the roku.yml file.

Home Directory / Global Configuration (recommended if you only have one project)

This method is recommended if you only have one Roku project because it will allow you to run the roku command from any directory, including sub directories and from paths outside of your project root.

File location:

Unix/OSX: ~/roku.yml or /Users/<username>/roku.yml
Windows XP: <root>\Documents and Settings\<username>
Windows Vista and Up: <root>\Users\<username>\roku.yml

Example File:

ip          : "192.168.1.6"
username    : "rokudev"
password    : "1234"
directory   : "/Users/exampleuser/code/brightscript/example_project"

Note: It is important to note the additional directory key that is required for Global Configuration so that the Roku Toolkit may know where your project lives.

Project Configuration (recommended for multiple projects)

This method is recommended for multiple Roku projects because it allows for per-directory based configuration files. The downside to this method is that you must ensure you run the roku command from the project root where your roku.yml file is located.

File Location:

File location should be the root of your project. (ie: ~/code/brightscript/example_project/roku.yml)

Example File:

ip          : "192.168.1.6"
username    : "rokudev"
password    : "1234"

Build Output

By default builds will output to a temporary directory. You may specify the build output in the roku.yml configuration file with the key output.

Example File:

ip          : "192.168.1.6"
username    : "rokudev"
password    : "1234"
directory   : "/Users/exampleuser/code/brightscript/example_project"
output      : "/Users/exampleuser/code/brightscript/example_project/builds/roku.zip"

Note: You may use Time conversion specifications in the output name.

output      : "/Users/exampleuser/code/brightscript/example_project/builds/roku-%m-%d-%Y.zip"
# Translates into "/Users/exampleuser/code/brightscript/example_project/builds/roku-01-20-2015.zip"

Usage

Depending on your configuration (see above), simply run roku from your command line to build and deploy your project to your Roku development box.

Contributing

Fork it ( http://github.com//roku/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request