blob: e12dfd8c2a1d8f8fea563303715679b284d6a31f [file] [log] [blame]
Scott Main50e990c2012-06-21 17:14:39 -07001page.title=Installing the Eclipse Plugin
Ricardo Cerveraa28bcbc2014-04-16 16:30:02 -07002adt.zip.version=22.6.3
3adt.zip.download=ADT-22.6.3.zip
4adt.zip.bytes=14590813
5adt.zip.checksum=3982259fd2cc81e53bbbe05dcd6529a7
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>
Ricardo Cervera1da61872014-03-26 14:28:49 -070038 <p class="note"><strong>Note:</strong> The Android Developer Tools update site requires
39 a secure connection. Make sure the update site URL you enter starts with HTTPS.</p>
Scott Main50e990c2012-06-21 17:14:39 -070040 </li>
Ricardo Cervera1da61872014-03-26 14:28:49 -070041 <li>Click <strong>OK</strong>.</li>
Scott Main50e990c2012-06-21 17:14:39 -070042 <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">
Dirk Doughertyd296e252013-11-06 14:33:01 -080077<h2>App Translations in Google Play</h2>
Ricardo Cervera60bec602014-03-19 14:48:37 -070078<p>Google Play <a href="{@docRoot}distribute/googleplay/publish/localizing.html#gp-trans">App
Dirk Doughertyd296e252013-11-06 14:33:01 -080079Translation Service</a> is available in the Developer Console to help you
80localize your app for a global user base. You can browse qualified vendors, get
81estimates, upload strings for translation, and then import the translations directly
82into your app.</p>
83</div>
84</div>
Dirk Doughertyafc02802013-05-08 18:37:11 -070085
86<p>ADT Translation Manager Plugin is an Android SDK Tools plugin that helps
87you work with strings that you are localizing. It's designed to work
88with the translation services built into the Google Play Developer
89Console that let you quickly find and purchase translations of
90your app from a list of pre-qualified vendors. </p>
91
92<p>The plugin simplifies the management of strings
93during translation. It lets you easily export your default strings
94and upload them directly to the Developer Console, from which you
95can get estimates or purchase translations. When your translations
96are ready, the plugin lets you quickly download and import them
97back into your project. During import, it moves all of the translated resources into
98the correct locations under <code>res/values</code>, so that
99localization works instantly.</p>
100
101<p>For more information about translation services in Google Play, see <a
Dirk Doughertyd296e252013-11-06 14:33:01 -0800102href="{@docRoot}distribute/googleplay/publish/localizing.html#gp-trans">Purchase
103professional translations through the Developer Console</a>.</p>
Dirk Doughertyafc02802013-05-08 18:37:11 -0700104
105<p>To install the ADT Translation Manager Plugin follow these steps:</p>
106
107<ol>
108 <li>Install the ADT Plugin, as described above. </li>
109 <li>In Eclipse, select <strong>Help</strong> &gt; <strong>Install New
110Software</strong>.</li>
111 <li>Click <strong>Add</strong>, in the top-right corner.</li>
Joe Fernandez8bb7c632013-05-14 19:27:18 -0700112 <li>In the Add Repository dialog that appears, enter a repository name for the <em>Name</em>
113 and the following URL for the <em>Location</em>:
Dirk Doughertyafc02802013-05-08 18:37:11 -0700114 <pre>https://dl.google.com/alt/</pre>
115 </li>
116 <li>Click <strong>OK</strong>.
Joe Fernandez8bb7c632013-05-14 19:27:18 -0700117 <li>In the Available Software dialog, select the checkbox next to <strong>Android Developer Tools
118 - Translation Manager</strong> and click <strong>Next</strong>.</li>
Dirk Doughertyafc02802013-05-08 18:37:11 -0700119 <li>In the next window, you'll see a list of the tools to be downloaded. Click
120<strong>Next</strong>. </li>
121 <li>Read and accept the license agreements, then click <strong>Finish</strong>.
122 <p>If you get a security warning saying that the authenticity or validity of
123the software can't be established, click <strong>OK</strong>.</p></li>
124 <li>When the installation completes, restart Eclipse. </li>
125</ol>
126
127<h4 id="translation-manager-notes">Installation notes</h4>
128
129<ul>
130<li>The full ADT Plugin must be installed in your Eclipse environment before you install the ADT Translation Manager Plugin.</li>
131<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>
132<li>To use the plugin, you must <a href="{@docRoot}distribute/googleplay/publish/register.html">set up a Developer Console account</a>. </li>
133<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>
134<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
135Software</strong>, uncheck "Contact all update sites during install to find required software" at the bottom and try again. </li>
136</ul>
Scott Main50e990c2012-06-21 17:14:39 -0700137
138
Scott Main50e990c2012-06-21 17:14:39 -0700139
Dirk Doughertyafc02802013-05-08 18:37:11 -0700140<h2 id="Troubleshooting">Troubleshooting ADT Installation</h2>
Scott Main50e990c2012-06-21 17:14:39 -0700141
Ricardo Cervera1da61872014-03-26 14:28:49 -0700142<p>If you are having trouble downloading the ADT plugin after following the
143steps above and you are behind a firewall (such as a corporate firewall), make sure that
Scott Main50e990c2012-06-21 17:14:39 -0700144you have properly configured your proxy settings in Eclipse. In Eclipse,
145you can configure proxy information from the main Eclipse menu in
146<strong>Window</strong> (on Mac OS X, <strong>Eclipse</strong>) &gt;
147<strong>Preferences</strong> &gt; <strong>General</strong> &gt; <strong>Network
Ricardo Cervera1da61872014-03-26 14:28:49 -0700148Connections</strong>.
149</p>
Scott Main50e990c2012-06-21 17:14:39 -0700150
Ricardo Cervera1da61872014-03-26 14:28:49 -0700151<p>If you are still unable to use Eclipse to download the ADT plugin as a
Scott Main50e990c2012-06-21 17:14:39 -0700152remote update site, you can download the ADT zip file to your local machine and
153manually install it:</p>
154
155<ol>
Scott Main607079d2012-08-09 14:13:22 -0700156 <li>Download the ADT Plugin zip file (do not unpack it):
Scott Main50e990c2012-06-21 17:14:39 -0700157
158 <table class="download">
159 <tr>
Scott Main50e990c2012-06-21 17:14:39 -0700160 <th>Package</th>
161 <th>Size</th>
162 <th>MD5 Checksum</th>
163 </tr>
164 <tr>
Scott Main50e990c2012-06-21 17:14:39 -0700165 <td>
166 <a href="http://dl.google.com/android/{@adtZipDownload}">{@adtZipDownload}</a>
167 </td>
168 <td>{@adtZipBytes} bytes</td>
169 <td>{@adtZipChecksum}</td>
170 </tr>
171</table>
172</li>
173
174</li>
Scott Main607079d2012-08-09 14:13:22 -0700175 <li>Start Eclipse, then select <strong>Help</strong> &gt; <strong>Install New
176Software</strong>.</li>
177 <li>Click <strong>Add</strong>, in the top-right corner.</li>
178 <li>In the Add Repository dialog, click <strong>Archive</strong>.</li>
179 <li>Select the downloaded {@adtZipDownload} file and click <strong>OK</strong>.</li>
180 <li>Enter "ADT Plugin" for the name and click <strong>OK</strong>.
181 <li>In the Available Software dialog, select the checkbox next to Developer Tools and click
182<strong>Next</strong>.</li>
183 <li>In the next window, you'll see a list of the tools to be downloaded. Click
184<strong>Next</strong>. </li>
185 <li>Read and accept the license agreements, then click <strong>Finish</strong>.
186 <p>If you get a security warning saying that the authenticity or validity of
187the software can't be established, click <strong>OK</strong>.</p></li>
188 <li>When the installation completes, restart Eclipse. </li>
Scott Main50e990c2012-06-21 17:14:39 -0700189</ol>
190
191<p>To update your plugin once you've installed using the zip file, you will have
192to follow these steps again instead of the default update instructions.</p>
193
194<h4>Other install errors</h4>
195
196<p>Note that there are features of ADT that require some optional
197Eclipse packages (for example, WST). If you encounter an error when
198installing ADT, your Eclipse installion might not include these packages.
199For information about how to quickly add the necessary packages to your
200Eclipse installation, see the troubleshooting topic
201<a href="{@docRoot}resources/faq/troubleshooting.html#installeclipsecomponents">ADT
202Installation Error: "requires plug-in org.eclipse.wst.sse.ui"</a>.</p>
203
204<h4>For Linux users</h4>
205<p>If you encounter this error when installing the ADT Plugin for Eclipse:
206<pre>
207An error occurred during provisioning.
208Cannot connect to keystore.
209JKS</pre>
210<p>
211...then your development machine lacks a suitable Java VM. Installing Sun
212Java 6 will resolve this issue and you can then reinstall the ADT
213Plugin.</p>
Scott Main607079d2012-08-09 14:13:22 -0700214