Installing Limelight

From Limelight

Jump to: navigation, search

Contents

Installing as an Application

On the Download Page there are links to download Limelight binaries. These are installer files. They install Limelight on your computer just like any other application.

You would install Limelight as an application if you intend to consume Limelight productions. Or perhaps you've built a Limelight production for a group of people at your company. Users of your production would have to install Limelight.

System Requirements

  • Java 1.5 or higher. The installers should detect whether an acceptable version of Java is installed or not, and help you through Java installation process.

It is possible to build installers that include the Java executable. Perhaps such installers will be provided in the future it there's a demand.

All the needed JRuby files are included in the installer.

Testing Installation

To test your installation, simple double click on the installed Limelight executable. It should open the "Welcome" production.


Installing for Development

If you intend to develop Limelight productions, you will want the limelight gem.

Prerequisites

  • Java 1.5 or higher.
  • JRuby - As of this writing, version 1.1.3 is preferred. Limelight will not work properly with 1.1.4.

Installing

To install the gem:

     jruby -S gem install limelight

Unless you add $JRUBY_HOME/bin to your path, you'll use the limelight command like so:

     jruby -S limelight

Testing Installation

Execute the limelight command above. You should see the following output:

Usage: limelight <command> [options] [params]
commands:
	open		Open a limelight production or scene.
	pack		Pack the designated limelight production into a .llp file.

Source Code

Incase you want to work on Limelight or just want the bleeding edge features.

Prerequisites

  • Git
  • Java 1.5+
  • Ant
  • JRuby 1.1.3+ (except 1.1.4)
  • Rake (installed inside the JRuby instance)

Installing

Assuming you've got all the prerequisites met, the following commands will build Limelight and run the tests.

  git clone git://github.com/slagyr/limelight.git
  cd limelight
  ant
  jruby -S rake init
  jruby -S rake tests

To build a gem...

  jruby -S rake gem

Testing Installation

Run the sandbox Production. Execute the following command from inside the limelight directory.

   bin/limelight open productions/examples/sandbox
Personal tools