blob: 66b1c435cd2b7f213a794bb8381762e339ae5745 [file] [log] [blame]
Scott Main50e990c2012-06-21 17:14:39 -07001page.title=Installing the Eclipse Plugin
Joe Fernandez2ef08f62013-09-18 13:10:09 -07002adt.zip.version=22.2.1
3adt.zip.download=ADT-22.2.1.zip
4adt.zip.bytes=14476845
5adt.zip.checksum=97176754a1e86adf2e5e05f44dc7229e
Scott Main50e990c2012-06-21 17:14:39 -07006
7@jd:body
8
9
10
11<p>Android offers a custom plugin for the Eclipse IDE, called Android
Scott Main52bfaaf2012-11-12 19:39:58 -080012Development Tools (ADT). This plugin provides a powerful, integrated
Scott Main607079d2012-08-09 14:13:22 -070013environment in which to develop Android apps. It extends the capabilities
Scott Main50e990c2012-06-21 17:14:39 -070014of Eclipse to let you quickly set up new Android projects, build an app
15UI, debug your app, and export signed (or unsigned) app packages (APKs) for distribution.
16</p>
17
Scott Main50e990c2012-06-21 17:14:39 -070018<p>If you need to install Eclipse, you can download it from <a href=
Scott Main89beba52013-05-24 09:38:57 -070019"http://www.eclipse.org/downloads/">eclipse.org/downloads/</a>.</p>
Scott Main50e990c2012-06-21 17:14:39 -070020
21
22<p class="note"><strong>Note:</strong> If you prefer to work in a different IDE, you do not need to
23install Eclipse or ADT. Instead, you can directly use the SDK tools to build and
Scott Main6453dfb2012-10-23 14:14:18 -070024debug your application.</p>
Scott Main50e990c2012-06-21 17:14:39 -070025
26
27
28<h2 id="Download">Download the ADT Plugin</h2>
29
30
31<ol>
32 <li>Start Eclipse, then select <strong>Help</strong> &gt; <strong>Install New
Scott Main607079d2012-08-09 14:13:22 -070033Software</strong>.</li>
Scott Main50e990c2012-06-21 17:14:39 -070034 <li>Click <strong>Add</strong>, in the top-right corner.</li>
35 <li>In the Add Repository dialog that appears, enter "ADT Plugin" for the <em>Name</em> and the
36following URL for the <em>Location</em>:
37 <pre>https://dl-ssl.google.com/android/eclipse/</pre>
38 </li>
Scott Main607079d2012-08-09 14:13:22 -070039 <li>Click <strong>OK</strong>.
40 <p>If you have trouble acquiring the plugin, try using "http" in the Location URL,
Scott Main50e990c2012-06-21 17:14:39 -070041instead of "https" (https is preferred for security reasons).</p></li>
42 <li>In the Available Software dialog, select the checkbox next to Developer Tools and click
43<strong>Next</strong>.</li>
44 <li>In the next window, you'll see a list of the tools to be downloaded. Click
45<strong>Next</strong>. </li>
46 <li>Read and accept the license agreements, then click <strong>Finish</strong>.
Scott Main607079d2012-08-09 14:13:22 -070047 <p>If you get a security warning saying that the authenticity or validity of
Scott Main50e990c2012-06-21 17:14:39 -070048the software can't be established, click <strong>OK</strong>.</p></li>
49 <li>When the installation completes, restart Eclipse. </li>
50</ol>
51
52
53
Scott Main50e990c2012-06-21 17:14:39 -070054<h2 id="Configure">Configure the ADT Plugin</h2>
55
Scott Mainb86b7f02012-09-11 15:20:53 -070056<p>Once Eclipse restarts, you
Scott Main50e990c2012-06-21 17:14:39 -070057 must specify the location of your Android SDK directory:</p>
58
59<ol>
Scott Mainb86b7f02012-09-11 15:20:53 -070060 <li>In the "Welcome to Android Development" window that appears, select <strong>Use
61existing SDKs</strong>.</li>
62 <li>Browse and select the location of the Android SDK directory you recently
Scott Main6453dfb2012-10-23 14:14:18 -070063downloaded and unpacked.</li>
Scott Mainb86b7f02012-09-11 15:20:53 -070064 <li>Click <strong>Next</strong>.</li>
Scott Main50e990c2012-06-21 17:14:39 -070065</ol>
66
Scott Main6453dfb2012-10-23 14:14:18 -070067<p>Your Eclipse IDE is now set up to develop Android apps, but you need to add
68the latest SDK platform tools and an Android platform to your environment.
69To get these packages for your SDK, continue to
70<a href="{@docRoot}sdk/installing/adding-packages.html">Adding Platforms and Packages</a>.</p>
Scott Main50e990c2012-06-21 17:14:39 -070071
72
Dirk Doughertyafc02802013-05-08 18:37:11 -070073<h2 id="tmgr">Download the ADT Translation Manager Plugin</h2>
74
75<div class="sidebox-wrapper">
76<div class="sidebox">
77<h2>Join the translation pilot</h2>
78<p>Google Play is offering <a
79href="{@docRoot}distribute/googleplay/publish/localizing.html#gp-trans">
80translation services</a> as part of a pilot program. If you are interested,
81sign up for the pilot program on the APK page in your Developer Console.</p>
82</div></div>
83
84<p>ADT Translation Manager Plugin is an Android SDK Tools plugin that helps
85you work with strings that you are localizing. It's designed to work
86with the translation services built into the Google Play Developer
87Console that let you quickly find and purchase translations of
88your app from a list of pre-qualified vendors. </p>
89
90<p>The plugin simplifies the management of strings
91during translation. It lets you easily export your default strings
92and upload them directly to the Developer Console, from which you
93can get estimates or purchase translations. When your translations
94are ready, the plugin lets you quickly download and import them
95back into your project. During import, it moves all of the translated resources into
96the correct locations under <code>res/values</code>, so that
97localization works instantly.</p>
98
99<p>For more information about translation services in Google Play, see <a
100href="{@docRoot}distribute/googleplay/publish/localizing.html#gp-trans">Purchase professional translations through the Developer Console</a>.</p>
101
102<p>To install the ADT Translation Manager Plugin follow these steps:</p>
103
104<ol>
105 <li>Install the ADT Plugin, as described above. </li>
106 <li>In Eclipse, select <strong>Help</strong> &gt; <strong>Install New
107Software</strong>.</li>
108 <li>Click <strong>Add</strong>, in the top-right corner.</li>
Joe Fernandez8bb7c632013-05-14 19:27:18 -0700109 <li>In the Add Repository dialog that appears, enter a repository name for the <em>Name</em>
110 and the following URL for the <em>Location</em>:
Dirk Doughertyafc02802013-05-08 18:37:11 -0700111 <pre>https://dl.google.com/alt/</pre>
112 </li>
113 <li>Click <strong>OK</strong>.
Joe Fernandez8bb7c632013-05-14 19:27:18 -0700114 <li>In the Available Software dialog, select the checkbox next to <strong>Android Developer Tools
115 - Translation Manager</strong> and click <strong>Next</strong>.</li>
Dirk Doughertyafc02802013-05-08 18:37:11 -0700116 <li>In the next window, you'll see a list of the tools to be downloaded. Click
117<strong>Next</strong>. </li>
118 <li>Read and accept the license agreements, then click <strong>Finish</strong>.
119 <p>If you get a security warning saying that the authenticity or validity of
120the software can't be established, click <strong>OK</strong>.</p></li>
121 <li>When the installation completes, restart Eclipse. </li>
122</ol>
123
124<h4 id="translation-manager-notes">Installation notes</h4>
125
126<ul>
127<li>The full ADT Plugin must be installed in your Eclipse environment before you install the ADT Translation Manager Plugin.</li>
128<li>ADT Translation Manager Plugin is designed for use with the translation services offered through the Google Play Developer Console. It is not designed for general purpose import/export of strings. </li>
129<li>To use the plugin, you must <a href="{@docRoot}distribute/googleplay/publish/register.html">set up a Developer Console account</a>. </li>
130<li>Currently, translation services are available through the Developer Console only as part of a pilot program. To use the plugin, you must first sign up for the pilot program by visiting the Developer Console.</li>
131<li>If you downloaded ADT as part of the SDK ADT bundle, you may encounter an error when attempting to download the ADT Translation Manager Plugin from the remote repository. In that case, open the <strong>Install New
132Software</strong>, uncheck "Contact all update sites during install to find required software" at the bottom and try again. </li>
133</ul>
Scott Main50e990c2012-06-21 17:14:39 -0700134
135
Scott Main50e990c2012-06-21 17:14:39 -0700136
Dirk Doughertyafc02802013-05-08 18:37:11 -0700137<h2 id="Troubleshooting">Troubleshooting ADT Installation</h2>
Scott Main50e990c2012-06-21 17:14:39 -0700138
139<p> If you are having trouble downloading the ADT plugin after following the
140steps above, here are some suggestions: </p>
141
142<ul>
143 <li>If Eclipse can not find the remote update site containing the ADT plugin,
144try changing the remote site URL to use http, rather than https. That is, set
145the Location for the remote site to:
146<pre>http://dl-ssl.google.com/android/eclipse/</pre></li>
147<li>If you are behind a firewall (such as a corporate firewall), make sure that
148you have properly configured your proxy settings in Eclipse. In Eclipse,
149you can configure proxy information from the main Eclipse menu in
150<strong>Window</strong> (on Mac OS X, <strong>Eclipse</strong>) &gt;
151<strong>Preferences</strong> &gt; <strong>General</strong> &gt; <strong>Network
152Connections</strong>.</li>
153</ul>
154
155<p> If you are still unable to use Eclipse to download the ADT plugin as a
156remote update site, you can download the ADT zip file to your local machine and
157manually install it:</p>
158
159<ol>
Scott Main607079d2012-08-09 14:13:22 -0700160 <li>Download the ADT Plugin zip file (do not unpack it):
Scott Main50e990c2012-06-21 17:14:39 -0700161
162 <table class="download">
163 <tr>
Scott Main50e990c2012-06-21 17:14:39 -0700164 <th>Package</th>
165 <th>Size</th>
166 <th>MD5 Checksum</th>
167 </tr>
168 <tr>
Scott Main50e990c2012-06-21 17:14:39 -0700169 <td>
170 <a href="http://dl.google.com/android/{@adtZipDownload}">{@adtZipDownload}</a>
171 </td>
172 <td>{@adtZipBytes} bytes</td>
173 <td>{@adtZipChecksum}</td>
174 </tr>
175</table>
176</li>
177
178</li>
Scott Main607079d2012-08-09 14:13:22 -0700179 <li>Start Eclipse, then select <strong>Help</strong> &gt; <strong>Install New
180Software</strong>.</li>
181 <li>Click <strong>Add</strong>, in the top-right corner.</li>
182 <li>In the Add Repository dialog, click <strong>Archive</strong>.</li>
183 <li>Select the downloaded {@adtZipDownload} file and click <strong>OK</strong>.</li>
184 <li>Enter "ADT Plugin" for the name and click <strong>OK</strong>.
185 <li>In the Available Software dialog, select the checkbox next to Developer Tools and click
186<strong>Next</strong>.</li>
187 <li>In the next window, you'll see a list of the tools to be downloaded. Click
188<strong>Next</strong>. </li>
189 <li>Read and accept the license agreements, then click <strong>Finish</strong>.
190 <p>If you get a security warning saying that the authenticity or validity of
191the software can't be established, click <strong>OK</strong>.</p></li>
192 <li>When the installation completes, restart Eclipse. </li>
Scott Main50e990c2012-06-21 17:14:39 -0700193</ol>
194
195<p>To update your plugin once you've installed using the zip file, you will have
196to follow these steps again instead of the default update instructions.</p>
197
198<h4>Other install errors</h4>
199
200<p>Note that there are features of ADT that require some optional
201Eclipse packages (for example, WST). If you encounter an error when
202installing ADT, your Eclipse installion might not include these packages.
203For information about how to quickly add the necessary packages to your
204Eclipse installation, see the troubleshooting topic
205<a href="{@docRoot}resources/faq/troubleshooting.html#installeclipsecomponents">ADT
206Installation Error: "requires plug-in org.eclipse.wst.sse.ui"</a>.</p>
207
208<h4>For Linux users</h4>
209<p>If you encounter this error when installing the ADT Plugin for Eclipse:
210<pre>
211An error occurred during provisioning.
212Cannot connect to keystore.
213JKS</pre>
214<p>
215...then your development machine lacks a suitable Java VM. Installing Sun
216Java 6 will resolve this issue and you can then reinstall the ADT
217Plugin.</p>
Scott Main607079d2012-08-09 14:13:22 -0700218