SDK_Build_Environment_for_J2SE_Platform

This page discusses how to build the Magic Lantern SDK for Java Standard Edition platforms using Eclipse and Ant.

• Dependencies
• Assumptions
• Environment Variables
  • MLE_HOME Environment Variable
  • MLE_ROOT Environment Variable
  • MLE_WORKPRINTS Environment Variable
• Details
  • Eclipse Build Environment
  • Ant Build Environment

Dependencies

This section identifies dependencies for building the Magic Lantern SDK.

1. Eclipse for RCP/Plug-in Developers, version 3.5.2
2. Apache Ant, version 1.8.0

Assumptions

These instructions assume the following

• The dependencies above are installed under a Windows drive labeled "M" (e.g. M:).
• The Magic Lantern software has been downloaded into the "M:\projects\MagicLantern" directory and the MLE_HOME environment variable is set to "M:\projects\MagicLantern".
• You already know how to use the Eclipse IDE
• You already know how to create and use Ant build scripts

Environment Variables

MLE_HOME Environment Variable

Set the variable MLE_HOME to reference the home of the Magic Lantern source. This document assumes that it is set to "M:\projects\MagicLantern".

MLE_ROOT Environment Variable

Set the variable MLE_ROOT to reference the root directory where the Magic Lantern components will be installed. This document assumes that it is set to "M:/projects/MagicLantern".

Note that this variable uses the UNIX-style path delimiter ('/').

MLE_WORKPRINTS Environment Variable

Set the variable MLE_WORKPRINTS to the root directory where Magic Lantern Digital Workprints can be located. This document assumes that it is set to //M/projects/MagicLantern.

The Magic Lantern Studio assumes that the Digital Workprints will be located under the $MLE_WORKPRINTS/workprints directory.

Note that this variable uses a canonical path style for the drive (i.e. //M/).

Details

This section discusses how to build the Magic Lantern SDK components targeting the Java Standard Edition (J2SE) platform. The Magic Lantern SDK is comprised of the following components:

Component Description Location

com.wizzer.mle.runtime
The Magic Lantern Runtime Engine
M:\projects\MagicLantern\Core\mlert\java\com.wizzer.mle.runtime

com.wizzer.mle.math
The Magic Lantern Math Library
M:\projects\MagicLantern\Core\math\java\com.wizzer.mle.math

com.wizzer.mle.parts
The Magic Lantern Core Parts Library
M:\projects\MagicLantern\Parts\base\java\com.wizzer.mle.parts

com.wizzer.mle.parts.actors
The Magic Lantern Core Actor Library
M:\projects\MagicLantern\Parts\actors\java\com.wizzer.mle.parts.actors

com.wizzer.mle.parts.props
The Magic Lantern Core Property Library
M:\projects\MagicLantern\Parts\props\java\com.wizzer.mle.parts.props

com.wizzer.mle.parts.roles
The Magic Lantern Core RoleLibrary

com.wizzer.mle.parts.mrefs
The Magic Lantern Core Media Reference Library
M:\projects\MagicLantern\Parts\mediaref\java\com.wizzer.mle.parts.mrefs

com.wizzer.mle.parts.sets
The Magic Lantern Core Set Library

com.wizzer.mle.parts.stages
The Magic Lantern Core Stage Library

Eclipse Build Environment

Each component provides an Eclipse project to facilitate building the component in Eclipse. To build the component, use the following instructions:

Ant Build Environment