To help developers set up a build system to deploy their applications based on Lucy, an example deployment script is provided in build/lucy/deploy_lucy.xml. It is written in Ant (, which is a Java-based build tool. The deployment process consists of these steps:

  • Compilation: the custom-written source code, additional add-ons for instance, is compiled.

  • Obfuscation: the compiled code and all Luciad JAR files are obfuscated together. You can use the free tool ProGuard for this purpose. Refer to Obfuscating your application for more information.

  • Packaging: everything is zipped together.

The resulting zip file can be unpacked and used with an appropriate end user license. You can find details about the assumptions the deployment script makes — for example, the location of custom written source code — and how it can be adapted, can be found in the top comment of build/lucy/deploy_lucy.xml and build/lucy/

The Ant tool is shipped with Lucy, but you must still download the proguard.jar file and place it in a build/proguard directory. Next, start the script through build/lucy/deploy_lucy.bat or build/lucy/, depending on the operating system.

When you are deploying a custom application based on the Lucy framework, you must take care that the persistent preferences of the custom application and those of the out-of-the-box Lucy application are kept separate, such as the default workspace to load, the frame size and location, and so on. To do so, you must adapt the TLcyPersistentPreferencesAddOn.storagePrefix property of config/lucy/preferences/preferences_addon.cfg. See the persistent preferences documentation for more information.

Because almost each application built on Lucy has a unique configuration, it is highly unlikely that the workspace files written by one application can be loaded by another application.You can make that clear to the end user by using an application-specific file extension for the workspaces. You can configure this extension in the config/lucy/workspace/workspace_addon.cfg file. See the TLcyWorkspaceAddon.fileTypeDescriptor.defaultExtension, TLcyWorkspaceAddon.fileTypeDescriptor.filters and TLcyWorkspaceAddon.fileTypeDescriptor.displayName properties.

The Lucy search add-on TLcySearchAddOn connects to a public web service on to look up the location of place names and country names. Before you can query that web service, you need to create a free account. Each account has a daily limit of requests it can perform. If you want to use this service in your own application, it is highly recommended to create your own account and configure the user name in the config/lucy/search/TLcySearchAddOn.cfg file.