1 page.title=ADT Plugin for Eclipse
9 <h2>In this document</h2>
11 <li><a href="#notes">Revisions</a></li>
12 <li><a href="#installing">Installing the ADT Plugin</a>
14 <li><a href="#preparing">Preparing for Installation</a></li>
15 <li><a href="#downloading">Downloading the ADT Plugin</a>
16 <li><a href="#configuring">Configuring the ADT Plugin</a></li>
17 <li><a href="#troubleshooting">Troubleshooting</a></li>
20 <li><a href="#updating">Updating the ADT Plugin</a></li>
21 <li><a href="#uninstalling">Uninstalling the ADT Plugin</a></li>
27 <p>Android Development Tools (ADT) is a plugin for the Eclipse IDE
28 that is designed to give you a powerful, integrated environment in which
29 to build Android applications. </p>
31 <p>ADT extends the capabilities of Eclipse to let you quickly set up new Android
32 projects, create an application UI, add components based on the Android
33 Framework API, debug your applications using the Android SDK tools, and even
34 export signed (or unsigned) APKs in order to distribute your application.</p>
36 <p>Developing in Eclipse with ADT is highly recommended and is the fastest way
37 to get started. With the guided project setup it provides, as well as tools
38 integration, custom XML editors, and debug ouput pane, ADT gives you an
39 incredible boost in developing Android applications. </p>
41 <p>This document provides step-by-step instructions on how to download the ADT
42 plugin and install it into your Eclipse development environment. Note that
43 before you can install or use ADT, you must have compatible versions of both the
44 Eclipse IDE and the Android SDK installed. For details, make sure to read <a
45 href="#installing">Installing the ADT Plugin</a>, below. </p>
47 <p>If you are already using ADT, this document also provides instructions on
48 how to update ADT to the latest version or how to uninstall it, if necessary.
51 <p class="caution"><strong>Caution:</strong> There are known issues with the ADT plugin running with
52 Eclipse 3.6. Please stay on 3.5 until further notice.</p>
54 <h2 id="notes">Revisions</h2>
56 <p>The sections below provide notes about successive releases of
57 the ADT Plugin, as denoted by revision number. </p>
59 <script type="text/javascript">
60 function toggleDiv(link) {
61 var toggleable = $(link).parent();
62 if (toggleable.hasClass("closed")) {
63 //$(".toggleme", toggleable).slideDown("fast");
64 toggleable.removeClass("closed");
65 toggleable.addClass("open");
66 $(".toggle-img", toggleable).attr("title", "hide").attr("src", (toRoot + "assets/images/triangle-opened.png"));
68 //$(".toggleme", toggleable).slideUp("fast");
69 toggleable.removeClass("open");
70 toggleable.addClass("closed");
71 $(".toggle-img", toggleable).attr("title", "show").attr("src", (toRoot + "assets/images/triangle-closed.png"));
81 padding: 1em 1em 0 2em;
88 text-decoration:underline;
90 .toggleable.closed .toggleme {
93 #jd-content .toggle-img {
99 <div class="toggleable opened">
100 <a href="#" onclick="return toggleDiv(this)">
101 <img src="{@docRoot}assets/images/triangle-opened.png" class="toggle-img" height="9px" width="9px" />
102 ADT 0.9.9</a> <em>(September 2010)</em>
103 <div class="toggleme">
111 <dt>Dependencies:</dt>
113 <dd><p>ADT 0.9.9 replaces ADT 0.9.8 and is designed for use with SDK Tools r7
114 and later. ADT 0.9.9 includes the ADT 0.9.8 features as well as an important
115 bugfix, so we recommend that you upgrade as soon as possible. If you haven't
116 already installed SDK Tools r7 into your SDK, use the Android SDK Manager to do
119 <dt>General notes:</dt>
122 <li>Fixes a problem in project import, in which source files were deleted in some cases.</li>
123 <li>Includes all other ADT 0.9.8 features (see below).</li>
130 <div class="toggleable closed">
131 <a href="#" onclick="return toggleDiv(this)">
132 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
133 ADT 0.9.8</a> <em>(September 2010)</em>
134 <div class="toggleme">
142 <dt>Dependencies:</dt>
144 <dd><p>ADT 0.9.8 is now deprecated. Please use ADT 0.9.9 instead.</p></dd>
146 <dt>General notes:</dt>
149 <li>Adds a new Action, "Rename Application Package", to the Android Tools
150 contextual menu. The Action does a full application package refactoring.
151 <li>Adds support for library projects that don't have a source folder
152 called <code>src/</code>. There is now support for any number of source folders,
153 with no name restriction. They can even be in subfolder such as
154 <code>src/java</code>. If you are already working with library projects created
156 href="{@docRoot}guide/developing/eclipse-adt.html#libraryMigrating">Migrating
157 library projects to ADT 0.9.8</a> for important information about moving
158 to the new ADT environment.</li>
159 <li>Adds support for library projects that depend on other library
161 <li>Adds support for additional resource qualifiers:
162 <code>car</code>/<code>desk</code>, <code>night</code>/<code>notnight</code> and
163 <code>navexposed</code>/<code>navhidden</code>.</li>
164 <li>Adds more device screen types in the layout editor. All screen
165 resolution/density combinations listed in the <a
166 href="{@docRoot}guide/practices/screens_support.html#range">Supporting
167 Multiple Screens</a> are now available.</li>
168 <li>Fixes problems with handling of library project names that
169 contain characters that are incompatible with the Eclipse path variable.
170 Now properly sets up the link between the main project and the library
179 <div class="toggleable closed">
180 <a href="#" onclick="return toggleDiv(this)">
181 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
182 ADT 0.9.7</a> <em>(May 2010)</em>
183 <div class="toggleme">
186 <dt>Library projects:</dt>
188 <p>The ADT Plugin now supports the use of <em>library projects</em> during
189 development, a capability that lets you store shared Android application
190 code and resources in a separate development project. You can then reference the
191 library project from other Android projects and, at build time, the tools
192 compile the shared code and resources as part of the dependent applications.
193 More information about this feature is available in the <a
194 href="{@docRoot}guide/developing/eclipse-adt.html#libraryProject">Developing
195 in Eclipse with ADT</a> document. </p>
196 <p>If you are not developing in Eclipse, <a
197 href="tools-notes.html">SDK Tools r6</a> provides the equivalent library
198 project support through the Ant build system.</p>
205 <div class="toggleable closed">
206 <a href="#" onclick="return toggleDiv(this)">
207 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
208 ADT 0.9.6</a> <em>(March 2010)</em>
209 <div class="toggleme">
212 <dt>Dependencies:</dt>
214 <dd><p>ADT 0.9.6 is designed for use with SDK Tools r5 and later. Before
215 updating to ADT 0.9.6, we highly recommend that you use the Android SDK and
216 AVD Manager to install SDK Tools r5 into your SDK.</p></dd>
218 <dt>General Notes:</dt>
221 <li>Editing <code>default.properties</code> outside of Eclipse will now
222 automatically update the project.</li>
223 <li>Loads the SDK content only when a project requires it. This will make
224 Eclipse use less resources when the SDK contains many versions of Android.</li>
225 <li>Resolves potential deadlock between modal dialogs, when launching ADT the
226 first time with the SDK Usage panel.</li>
227 <li>Fixes issues with the New Project Wizard when selecting samples.</li>
230 <dt>AVD/SDK Manager:</dt>
233 <li>Adds support for platform samples components.</li>
234 <li>Improves support for dependency between components.</li>
235 <li>AVDs now sorted by API level.</li>
236 <li>The AVD creation dialog now enforces a minimum SD card size of 9MB.</li>
237 <li>Prevents deletion of running AVDs.</li>
243 <li>DDMS plug-in now contains the Allocation Tracker view.</li>
244 <li>New action in the Logcat view: "Go to problem" lets you go directly from an
245 exception trace output to the code.</li>
251 <li>Explode mode in the Visual Layout Editor adds a margin to all layout objects
252 so that it's easier to see embedded or empty layouts.</li>
253 <li>Outline mode in the Visual Layout Editor draws layout outline to make it
254 easier to see layout objects.</li>
255 <li>Several fixes in the configuration selector of the Visual Layout
259 <dt>Application launching:</dt>
262 <li>Applications launched from ADT now behave as if they were clicked from the
264 <li>Fixes issue where add-on with no optional library would not show up as valid
265 targets for application launches.</li>
266 <li>Resolves possible crash when launching applications.</li>
273 <div class="toggleable closed">
274 <a href="#" onclick="return toggleDiv(this)">
275 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
276 ADT 0.9.5</a> <em>(December 2009)</em>
277 <div class="toggleme">
279 <dt>Dependencies:</dt>
281 <dd><p>ADT 0.9.5 requires features provided in SDK Tools r4 or higher. If you install
282 ADT 0.9.5, which is highly recommended, you should use the Android SDK and AVD
283 Manager to download thye latest SDK Tools into your SDK. For more information,
284 see <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</p>
287 <dt>General Notes:</dt>
290 <li>AVD Launch dialog now shows scale value.</li>
291 <li>Fixes potential NPE in SDK Manager on AVD launch, for older AVD with no skin name specified.</li>
292 <li>Fixes XML validation issue in on older Java versions.</li>
293 <li>.apk packaging now properly ignores vi swap files as well as hidden files.</li>
300 <div class="toggleable closed">
301 <a href="#" onclick="return toggleDiv(this)">
302 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
303 ADT 0.9.4</a> <em>(October 2009)</em>
304 <div class="toggleme">
306 <dt>Dependencies:</dt>
308 <dd><p>ADT 0.9.4 requires features provided in SDK Tools r3 or higher. If you install
309 ADT 0.9.4, which is highly recommended, you should use the Android SDK and AVD
310 Manager to download the latest SDK Tools into your SDK. For more information,
311 see <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</p>
314 <dt>Project Creation Wizard:</dt>
317 <li>New option to create a project from a sample by choosing it from a list.</li>
321 <dt>Layout Editor:</dt>
324 <li>Improved Configuration selector that lets you see how your layout will
325 render on different devices. Default device descriptions include ADP1
326 and Google Ion, while SDK add-ons can also provide new descriptions.
327 A new UI allows you to create custom descriptions.</li>
328 <li>Adds a new clipping toggle, to let you see your full layout even if it's
329 bigger than the screen.</li>
333 <dt>DDMS Integration:</dt>
336 <li>Includes the improvements from the standlone DDMS, revision 3.</li>
337 <li>Adds an option to open HPROF files into eclipse instead of writing them on
338 disk. If a profiler such as MAT (<a href="http://eclipse.org/mat">Memory Analyzer
339 Tool</a>) is installed, it'll open the file.</li>
343 <dt>Android SDK and AVD Manager integration:</dt>
346 <li>Includes the improvements from the standalone Android SDK and AVD Manager,
354 <h2 id="installing">Installing the ADT Plugin</h2>
356 <p>The sections below provide instructions on how to download and install
357 ADT into your Eclipse environment. If you encounter problems, see the <a
358 href="#troubleshooting">Troubleshooting</a> section.</p>
360 <h3 id="preparing">Preparing Your Development Computer</h3>
362 <p>ADT is a plugin for the Eclipse IDE. Before you can install or use ADT,
363 you must have a compatible version of Eclipse installed on your development
367 <li>If Eclipse is already installed on your computer, make sure that it is
368 a version that is compatible with ADT and the Android SDK. Check the <a
369 href="requirements.html">System Requirements</a> document for
370 a list of Eclipse versions that are compatible with the Android SDK.</li>
371 <li>If you need to install or update Eclipse, you can download it from this
374 <p style="margin-left:2em;"><a href=
375 "http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a>
378 <p>A Java or RCP version of Eclipse is recommended.</p></li>
381 <p>Additionally, before you can configure or use ADT, you must install the
382 Android SDK starter package, as described in <a
383 href="installing.html#Installing">Downloading the SDK Starter Package</a>.
384 Specifically, you need to install a compatible version of the Android SDK Tools
385 and at least one development platform. To simplify ADT setup, we recommend
386 installing the Android SDK prior to installing ADT. </p>
388 <p>When your Eclipse and Android SDK environments are ready, continue with the
389 ADT installation as described in the steps below. </p>
391 <h3 id="downloading">Downloading the ADT Plugin</h3>
393 <p>Use Update Manager feature of your Eclipse installation to install the latest
394 revision of ADT on your development computer.<p>
396 <p>Assuming that you have a compatible version of the Eclipse IDE installed, as
397 described in <a href="#preparing">Preparing for Installation</a>, above, follow
398 these steps to download the ADT plugin and install it in your Eclipse
401 <table style="font-size:100%">
402 <tr><th>Eclipse 3.4 (Ganymede)</th><th>Eclipse 3.5 (Galileo)</th></tr>
407 <li>Start Eclipse, then select <strong>Help</strong> > <strong>Software Updates...</strong>.
408 In the dialog that appears, click the <strong>Available Software</strong> tab. </li>
409 <li>Click <strong>Add Site...</strong> </li>
410 <li>In the Add Site dialog that appears, enter this URL in the "Location" field:
411 <pre style="margin-left:0">https://dl-ssl.google.com/android/eclipse/</pre>
412 <p>Note: If you have trouble acquiring the plugin, try using "http" in the Location URL,
413 instead of "https" (https is preferred for security reasons).</p>
414 <p>Click <strong>OK</strong>.</p></li>
415 <li>Back in the Available Software view, you should see the plugin listed by the URL,
416 with "Developer Tools" nested within it. Select the checkbox next to
417 Developer Tools and click <strong>Install...</strong></li>
418 <li>On the subsequent Install window, "Android DDMS" and "Android Development Tools"
419 should both be checked. Click <strong>Next</strong>. </li>
420 <li>Read and accept the license agreement, then click <strong>Finish</strong>.</li>
421 <li>Restart Eclipse. </li>
428 <li>Start Eclipse, then select <strong>Help</strong> > <strong>Install
429 New Software</strong>. </li>
430 <li>In the Available Software dialog, click <strong>Add...</strong>.</li>
431 <li>In the Add Site dialog that appears, enter a name for the remote site
432 (for example, "Android Plugin") in the "Name" field.
433 <p>In the "Location" field, enter this URL:</p>
434 <pre>https://dl-ssl.google.com/android/eclipse/</pre>
435 <p>Note: If you have trouble acquiring the plugin, you can try
436 using "http" in the URL, instead of "https" (https is preferred for
437 security reasons).</p>
438 <p>Click <strong>OK</strong>.</p>
440 <li>Back in the Available Software view, you should now see "Developer
441 Tools" added to the list. Select the checkbox next to Developer Tools,
442 which will automatically select the nested tools Android DDMS and Android
444 Click <strong>Next</strong>. </li>
445 <li>In the resulting Install Details dialog, the Android DDMS and Android
446 Development Tools features are listed. Click <strong>Next</strong> to
447 read and accept the license agreement and install any dependencies,
448 then click <strong>Finish</strong>. </li>
449 <li>Restart Eclipse. </li>
456 <h3 id="preparing">Configuring the ADT Plugin</h3>
458 <p>Once you've successfully downloaded ADT as described above, the next step
459 is to modify your ADT preferences in Eclipse to point to the Android SDK directory:</p>
462 <li>Select <strong>Window</strong> > <strong>Preferences...</strong> to open the Preferences
463 panel (Mac OS X: <strong>Eclipse</strong> > <strong>Preferences</strong>).</li>
464 <li>Select <strong>Android</strong> from the left panel. </li>
465 <li>For the <em>SDK Location</em> in the main panel, click <strong>Browse...</strong> and
466 locate your downloaded SDK directory. </li>
467 <li>Click <strong>Apply</strong>, then <strong>OK</strong>.</li>
470 <p>Done! If you haven't encountered any problems, then the installation is
471 complete. Now read <a href="installing.html#components">Adding Platforms and
472 Other Components</a> for instructions on how to complete the setup of your
473 SDK environment. </p>
476 <h3 id="troubleshooting">Troubleshooting ADT Installation</h3>
478 <p> If you are having trouble downloading the ADT plugin after following the
479 steps above, here are some suggestions: </p>
482 <li>If Eclipse can not find the remote update site containing the ADT plugin,
483 try changing the remote site URL to use http, rather than https. That is, set
484 the Location for the remote site to:
485 <pre>http://dl-ssl.google.com/android/eclipse/</pre></li>
486 <li>If you are behind a firewall (such as a corporate firewall), make sure that
487 you have properly configured your proxy settings in Eclipse. In Eclipse 3.3/3.4,
488 you can configure proxy information from the main Eclipse menu in
489 <strong>Window</strong> (on Mac OS X, <strong>Eclipse</strong>) >
490 <strong>Preferences</strong> > <strong>General</strong> > <strong>Network
491 Connections</strong>.</li>
494 <p> If you are still unable to use Eclipse to download the ADT plugin as a
495 remote update site, you can download the ADT zip file to your local machine and
496 manually install it:</p>
499 <li>Download the current ADT Plugin zip file from the table below (do not unpack it).
501 <table class="download">
506 <th>MD5 Checksum</th>
509 <td>ADT {@adtZipVersion}</td>
511 <a href="http://dl.google.com/android/{@adtZipDownload}">{@adtZipDownload}</a>
513 <td>{@adtZipBytes} bytes</td>
514 <td>{@adtZipChecksum}</td>
520 <li>Follow steps 1 and 2 in the <a href="#installing">default install
521 instructions</a> (above).</li>
522 <li>In the Add Site dialog, click <strong>Archive</strong>.</li>
523 <li>Browse and select the downloaded zip file.</li>
524 <li>In Eclipse 3.5 only, enter a name for the local update site (e.g.,
525 "Android Plugin") in the "Name" field.</li>
526 <li>Click <strong>OK</strong>.
527 <li>Follow the remaining procedures as listed for
528 <a href="#installing">default installation</a> above,
529 starting from step 4.</li>
532 <p>To update your plugin once you've installed using the zip file, you will have
533 to follow these steps again instead of the default update instructions.</p>
535 <h4>Other install errors</h4>
537 <p>Note that there are features of ADT that require some optional
538 Eclipse components (for example, WST). If you encounter an error when
539 installing ADT, your Eclipse installion might not include these components.
540 For information about how to quickly add the necessary components to your
541 Eclipse installation, see the troubleshooting topic
542 <a href="{@docRoot}resources/faq/troubleshooting.html#installeclipsecomponents">ADT
543 Installation Error: "requires plug-in org.eclipse.wst.sse.ui"</a>.</p>
545 <h4>For Linux users</h4>
546 <p>If you encounter this error when installing the ADT Plugin for Eclipse:
548 An error occurred during provisioning.
549 Cannot connect to keystore.
552 ...then your development machine lacks a suitable Java VM. Installing Sun
553 Java 6 will resolve this issue and you can then reinstall the ADT
557 <h2 id="updating">Updating the ADT Plugin</h2>
559 <p>From time to time, a new revision of the ADT Plugin becomes available, with
560 new features and bug fixes. Generally, when a new revision of ADT is available,
561 you should update to it as soon as convenient. </p>
563 <p>In some cases, a new revision of ADT will have a dependency on a specific
564 revision of the Android SDK Tools. If such dependencies exist, you will need to
565 update the SDK Tools component of the SDK after installing the new revision of
566 ADT. To update the SDK Tools component, use the Android SDK and AVD Manager, as
567 described in <a href="adding-components.html">Adding SDK Components</a>.</p>
569 <p>To learn about new features of each ADT revision and also any dependencies on
570 the SDK Tools, see the listings in the <a href="#notes">Revisions</a>
571 section. To determine the version currently installed, open the
572 Eclipse Installed Software window using <strong>Help</strong>
573 > <strong>Software Updates</strong> and refer to the version listed for
574 "Android Development Tools".</p>
576 <p>Follow the steps below to check whether an update is available and, if so,
579 <table style="font-size:100%">
580 <tr><th>Eclipse 3.4 (Ganymede)</th><th>Eclipse 3.5 (Galileo)</th></tr>
585 <li>Select <strong>Help</strong> > <strong>Software Updates</strong>.</li>
586 <li>Select the <strong>Available Software</strong> tab.</li>
587 <li>Select the checkboxes next to Android DDMS and Android Developer Tools,
588 then click <strong>Update</strong>.</li>
589 <li>In the resulting Available Updates dialog, ensure that both Android DDMS
590 and Android Development Tools are selected, then click
591 <strong>Next</strong>.</li>
592 <li>Read and accept the license agreement and then click <strong>Finish</strong>.
593 This will download and install the latest version of Android DDMS and
594 Android Development Tools.</li>
595 <li>Restart Eclipse.</li>
601 <li>Select <strong>Help</strong> > <strong>Check for Updates</strong>. </li>
602 <li>In the resulting Available Updates dialog, locate the Android DDMS and
603 Android Development Tools features in the list and ensure that the checkboxes
604 next to them are selected. Click <strong>Next</strong>.
605 <p>If the Available Updates dialog does not list Android DDMS and Android
606 Development tools, make sure that you have set up a remote update site
607 for them, as described in
608 <a href="#installing">Installing the ADT Plugin</a>.
610 <li>In the Update Details dialog, click <strong>Next</strong>.</li>
611 <li>Read and accept the license agreement and then click <strong>Finish</strong>.
612 This will download and install the latest version of Android DDMS and
613 Android Development Tools.</li>
614 <li>Restart Eclipse.</li>
621 <p>If you encounter problems during the update of ADT, you
622 can try removing the existing ADT plugin and then performing a fresh
623 installation. To remove the plugin, follow the instructions in <a
624 href="#uninstalling">Uninstalling the ADT Plugin</a>, below. To reinstall
625 the plugin, follow the instructions in <a
626 href="#installing">Installing the ADT Plugin</a>, above.</p>
629 <h2 id="uninstalling">Uninstalling the ADT plugin</h2>
631 <p><p>If you encounter problems when installing or updating ADT, you
632 can try removing the existing ADT plugin and then performing a fresh
633 installation. To remove ADT, follow these steps: </p>
635 <table style="font-size:100%">
636 <tr><th>Eclipse 3.4 (Ganymede)</th><th>Eclipse 3.5 (Galileo)</th></tr>
641 <li>Select <strong>Help</strong> > <strong>Software Updates</strong> >
642 <strong>Manage Configuration</strong>. </li>
643 <li>Expand the list in the left panel to reveal the installed tools.</li>
644 <li>Right-click "Android Editors" and click <strong>Uninstall</strong>. Click <strong>OK</strong>
647 <p>(Do not uninstall "Android Development Tools".)</p></li>
653 <li>Select <strong>Help</strong> > <strong>Install New Software</strong>.</li>
654 <li>In the "Details" panel, click the "What is already installed?" link.</li>
655 <li>In the <strong>Eclipse Installation Details</strong> dialog, select "Android DDMS" and "Android Development Tools" and then click <strong>Uninstall</strong>.</li>
656 <li>In the next window, confirm that the ADT features are selected for uninstall and then click <strong>Finish</strong> to uninstall.</li>
657 <li>Restart Eclipse.</li>