/itc-localized-screenshot-uploader

Helps prepare localized screenshots for delivery to iTunes Connect via the Transporter

Primary LanguagePHPMIT LicenseMIT

iTC Localized Screenshot Uploader

This script helps prepare localized screenshots for delivery to iTunes Connect via the Transporter. Screenshot generation, formatting, and uploading for all languages can be fully automated with these instructions.

Step 1

Open your app in iTunes Connect and create a new version. Ensure your app is listed in the "Prepare for Upload" status. Download your app's metadata package from Apple.

ITMSUSER=YourItunesUsername
ITMSPASS=YourItunesPassword
ITMSSKU=YourAppSKU
PATH="$PATH:/Applications/Xcode.app/Contents/Applications/Application Loader.app/Contents/MacOS/itms/bin/"
iTMSTransporter -m lookupMetadata -u $ITMSUSER -p $ITMSPASS -vendor_id $ITMSSKU -destination ~/Desktop

This will save the .itmsp file to your desktop.

Step 2

Take screenshots and save them to ~/Desktop/screenshots with the format like

cmn-Hans___ios4in___portrait___screen1.png

This is comprised of sections delimited by ___:

  • Device name: correct names are Mac, iOS-3.5-in, iOS-4-in or iOS-iPad
  • Locale: like es-ES, fr-FR, ja-JP, en-US, HELP: NEED HELP FULLY DOCUMENTING LOCALE NAMES IN ITMS

Optional: write a UI script and automate generation of screenshots for all devices and localizations using https://github.com/jonathanpenn/ui-screen-shooter Note: if your screenshots are in the format Locale/Devicename___other.png, fix this with: for a in */*; do d=$(dirname $a); f=$(basename $a); mv $a ${d}___${f}; done; rmdir */

Step 3

Run php screenshots.php – this will add the XML chunks you need and make a fresh copy of your metadata.xml in the screenshots folder.

Step 4

Copy the contents of "screenshots" on your desktop into the itmsp file on your desktop (right-click -> show package contents to access the latter). Or use the following command:

cp ~/Desktop/screenshots/* ~/Desktop/*.itmsp

Step 5

Verify your upload:

iTMSTransporter -m verify -u $ITMSUSER -p $ITMSPASS -vendor_id $ITMSSKU -f ~/Desktop/*.itmsp

Error "software_screenshots cannot be edited in the current state" happens if your app is currently being reviewed.

Step 6

If things went well, execute your upload:

iTMSTransporter -m upload -u $ITMSUSER -p $ITMSPASS -vendor_id $ITMSSKU -f ~/Desktop/*.itmsp

Pro Tips

You can modify Xcode schemes to automatically launch your app in a particular localization. I created a scheme for each language I have setup in iTunes Connect. To do this, duplicate your Debug scheme, edit it, and in the "Run" section under "Arguments", add your localization to "Arguments Passed on Launch" in this format: "-AppleLanguages (it)", where "it" is Italian, or whatever localization you want.

On top of that, I wanted localized users for my screenshots, so I pass an Environment Variable of "USER_ID", then grab that in my code & setup the user programmatically. You can get Environment Variables via: [[NSProcessInfo processInfo] environment]

Heads Up

There's a bug in the Transporter that removes newlines from any textual metadata, so I don't recommend using it for that purpose at this time.

For more info, check out the App Metadata Specs and the Transporter User Guide from https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/resources/download/TransporterQuickStartUserGuide/pdf

License

Released under the MIT license, see the LICENSE file.