ADT Plugin for Eclipse

Android Development Tools (ADT) is a plugin for the Eclipse IDE that is designed to give you a powerful, integrated environment in which to build Android applications.

ADT extends the capabilities of Eclipse to let you quickly set up new Android projects, create an application UI, add components based on the Android Framework API, debug your applications using the Android SDK tools, and even export signed (or unsigned) APKs in order to distribute your application.

Developing in Eclipse with ADT is highly recommended and is the fastest way to get started. With the guided project setup it provides, as well as tools integration, custom XML editors, and debug ouput pane, ADT gives you an incredible boost in developing Android applications.

This document provides step-by-step instructions on how to download the ADT plugin and install it into your Eclipse development environment. Note that before you can install or use ADT, you must have compatible versions of both the Eclipse IDE and the Android SDK installed. For details, make sure to read Installing the ADT Plugin, below.

If you are already using ADT, this document also provides instructions on how to update ADT to the latest version or how to uninstall it, if necessary.

Installing the ADT Plugin

The sections below provide instructions on how to download and install ADT into your Eclipse environment. If you encounter problems, see the Troubleshootingsection.

Preparing Your Development Computer

ADT is a plugin for the Eclipse IDE. Before you can install or use ADT, you must have a compatible version of Eclipse installed on your development computer.

• If Eclipse is already installed on your computer, make sure that it is a version that is compatible with ADT and the Android SDK. Check the System Requirements document for a list of Eclipse versions that are compatible with the Android SDK.
• If you need to install or update Eclipse, you can download it from this location:

  http://www.eclipse.org/downloads/

  A Java or RCP version of Eclipse is recommended.

Additionally, before you can configure or use ADT, you must install the Android SDK starter package, as described in Downloading the SDK Starter Package. Specifically, you need to install a compatible version of the Android SDK Tools and at least one development platform. To simplify ADT setup, we recommend installing the Android SDK prior to installing ADT.

When your Eclipse and Android SDK environments are ready, continue with the ADT installation as described in the steps below.

Downloading the ADT Plugin

Use Update Manager feature of your Eclipse installation to install the latest revision of ADT on your development computer.

Assuming that you have a compatible version of the Eclipse IDE installed, as described in Preparing for Installation, above, follow these steps to download the ADT plugin and install it in your Eclipse environment.

Eclipse 3.4 (Ganymede)

Eclipse 3.5 (Galileo)

Start Eclipse, then select Help > Software Updates.... In the dialog that appears, click the Available Software tab. Click Add Site... In the Add Site dialog that appears, enter this URL in the "Location" field: https://dl-ssl.google.com/android/eclipse/ Note: If you have trouble acquiring the plugin, try using "http" in the Location URL, instead of "https" (https is preferred for security reasons). Click OK. Back in the Available Software view, you should see the plugin listed by the URL, with "Developer Tools" nested within it. Select the checkbox next to Developer Tools and click Install... On the subsequent Install window, "Android DDMS" and "Android Development Tools" should both be checked. ClickNext. Read and accept the license agreement, then click Finish. Restart Eclipse.

Start Eclipse, then select Help > Install New Software. In the Available Software dialog, click Add.... In the Add Site dialog that appears, enter a name for the remote site (for example, "Android Plugin") in the "Name" field. In the "Location" field, enter this URL: https://dl-ssl.google.com/android/eclipse/ Note: If you have trouble acquiring the plugin, you can try using "http" in the URL, instead of "https" (https is preferred for security reasons). Click OK. Back in the Available Software view, you should now see "Developer Tools" added to the list. Select the checkbox next to Developer Tools, which will automatically select the nested tools Android DDMS and Android Development Tools. Click Next. In the resulting Install Details dialog, the Android DDMS and Android Development Tools features are listed. Click Next to read and accept the license agreement and install any dependencies, then click Finish. Restart Eclipse.

Configuring the ADT Plugin

Once you've successfully downloaded ADT as described above, the next step is to modify your ADT preferences in Eclipse to point to the Android SDK directory:

1. Select Window > Preferences... to open the Preferences panel (Mac OS X: Eclipse > Preferences).
2. Select Android from the left panel.
3. For the SDK Location in the main panel, click Browse... and locate your downloaded SDK directory.
4. Click Apply, then OK.

Done! If you haven't encountered any problems, then the installation is complete. Now read Adding Platforms and Other Components for instructions on how to complete the setup of your SDK environment.

Troubleshooting ADT Installation

If you are having trouble downloading the ADT plugin after following the steps above, here are some suggestions:

• If Eclipse can not find the remote update site containing the ADT plugin, try changing the remote site URL to use http, rather than https. That is, set the Location for the remote site to:

  http://dl-ssl.google.com/android/eclipse/

• If you are behind a firewall (such as a corporate firewall), make sure that you have properly configured your proxy settings in Eclipse. In Eclipse 3.3/3.4, you can configure proxy information from the main Eclipse menu in Window (on Mac OS X, Eclipse) > Preferences > General > Network Connections.

If you are still unable to use Eclipse to download the ADT plugin as a remote update site, you can download the ADT zip file to your local machine and manually install it:

1. Download the current ADT Plugin zip file from the table below (do not unpack it).

   Name	Package	Size	MD5 Checksum
   ADT 0.9.9	ADT-0.9.9.zip	8301681 bytes	7deff0c9b25940a74cea7a0815a3bc36

2. Follow steps 1 and 2 in the default install instructions (above).
3. In the Add Site dialog, click Archive.
4. Browse and select the downloaded zip file.
5. In Eclipse 3.5 only, enter a name for the local update site (e.g., "Android Plugin") in the "Name" field.
6. Click OK.
7. Follow the remaining procedures as listed for default installation above, starting from step 4.

To update your plugin once you've installed using the zip file, you will have to follow these steps again instead of the default update instructions.

Other install errors

Note that there are features of ADT that require some optional Eclipse components (for example, WST). If you encounter an error when installing ADT, your Eclipse installion might not include these components. For information about how to quickly add the necessary components to your Eclipse installation, see the troubleshooting topic ADT Installation Error: "requires plug-in org.eclipse.wst.sse.ui".

For Linux users

If you encounter this error when installing the ADT Plugin for Eclipse:

An error occurred during provisioning.
Cannot connect to keystore.
JKS

...then your development machine lacks a suitable Java VM. Installing Sun Java 6 will resolve this issue and you can then reinstall the ADT Plugin.

Updating the ADT Plugin

From time to time, a new revision of the ADT Plugin becomes available, with new features and bug fixes. Generally, when a new revision of ADT is available, you should update to it as soon as convenient.

In some cases, a new revision of ADT will have a dependency on a specific revision of the Android SDK Tools. If such dependencies exist, you will need to update the SDK Tools component of the SDK after installing the new revision of ADT. To update the SDK Tools component, use the Android SDK and AVD Manager, as described in Adding SDK Components.

To learn about new features of each ADT revision and also any dependencies on the SDK Tools, see the listings in the Revisions section. To determine the version currently installed, open the Eclipse Installed Software window using Help > Software Updates and refer to the version listed for "Android Development Tools".

Follow the steps below to check whether an update is available and, if so, to install it.

Eclipse 3.4 (Ganymede)

Eclipse 3.5 (Galileo)

Select Help > Software Updates. Select the Available Software tab. Select the checkboxes next to Android DDMS and Android Developer Tools, then click Update. In the resulting Available Updates dialog, ensure that both Android DDMS and Android Development Tools are selected, then click Next. Read and accept the license agreement and then click Finish. This will download and install the latest version of Android DDMS and Android Development Tools. Restart Eclipse.

Select Help > Check for Updates. In the resulting Available Updates dialog, locate the Android DDMS and Android Development Tools features in the list and ensure that the checkboxes next to them are selected. Click Next. If the Available Updates dialog does not list Android DDMS and Android Development tools, make sure that you have set up a remote update site for them, as described in Installing the ADT Plugin. In the Update Details dialog, click Next. Read and accept the license agreement and then click Finish. This will download and install the latest version of Android DDMS and Android Development Tools. Restart Eclipse.

If you encounter problems during the update of ADT, you can try removing the existing ADT plugin and then performing a fresh installation. To remove the plugin, follow the instructions in Uninstalling the ADT Plugin, below. To reinstall the plugin, follow the instructions in Installing the ADT Plugin, above.

Uninstalling the ADT plugin

If you encounter problems when installing or updating ADT, you can try removing the existing ADT plugin and then performing a fresh installation. To remove ADT, follow these steps:

Eclipse 3.4 (Ganymede)	Eclipse 3.5 (Galileo)
Select Help > Software Updates > Manage Configuration. Expand the list in the left panel to reveal the installed tools. Right-click "Android Editors" and click Uninstall. Click OK to confirm. Restart Eclipse. (Do not uninstall "Android Development Tools".)	Select Help > Install New Software. In the "Details" panel, click the "What is already installed?" link. In the Eclipse Installation Details dialog, select "Android DDMS" and "Android Development Tools" and then click Uninstall. In the next window, confirm that the ADT features are selected for uninstall and then click Finish to uninstall. Restart Eclipse.