Find file History
Latest commit 0d94870 Jan 10, 2017 @KrauseFx KrauseFx committed on GitHub Update StackOverflow and RubyGems links to use https (#7795)
* Update all RubyGems to https

* Update all StackOverflow links to https

README.md


fastlane

deliver β€’ snapshot β€’ frameit β€’ pem β€’ sigh β€’ produce β€’ cert β€’ spaceship β€’ pilot β€’ boarding β€’ gym β€’ scan β€’ match


frameit

Twitter: @KauseFx License Gem

Quickly put your screenshots into the right device frames

frameit allows you to put a gorgeous device frame around your iOS and macOS screenshots just by running one simple command. Use frameit to prepare perfect screenshots for the App Store, your website, QA or emails.

Get in contact with the developer on Twitter: @FastlaneTools


Features β€’ Installation β€’ Usage β€’ Tips β€’ Need help?


frameit is part of fastlane: The easiest way to automate beta deployments and releases for your iOS and Android apps.

Features

Put a gorgeous device frame around your iOS and macOS screenshots just by running one simple command. Support for:

  • iPhone, iPad and Mac
  • Portrait and Landscape modes
  • Several colors

The complete and updated list of supported devices and colors can be found here

Like this tool? Be the first to know about updates and new fastlane tools

Here is a nice gif, that shows frameit in action:

assets/FrameitGit.gif

Results

assets/ScreenshotsBig.png


assets/ScreenshotsOverview.png


assets/MacExample.png

The frameit 2.0 update was kindly sponsored by MindNode, seen in the screenshots above.

Installation

Make sure, you have the commandline tools installed

xcode-select --install

Install the gem

sudo gem install fastlane

The first time that frameit is executed the frames will be downloaded automatically. Originally the frames are coming from Facebook frameset and they are kept on this repo: https://github.com/fastlane/frameit-frames

More information about this process and how to update the frames can be found here

Usage

Why should you have to use Photoshop, just to add a frame around your screenshots?

Just navigate to your folder of screenshots and use the following command:

fastlane frameit

To use the silver version of the frames:

fastlane frameit silver

To download the latest frames

fastlane frameit download_frames

When using frameit without titles on top, the screenshots will have the full resolution, which means they can't be uploaded to the App Store directly. They are supposed to be used for websites, print media and emails. Check out the section below to use the screenshots for the App Store.

Titles and Background (optional)

With frameit 2.0 you are now able to add a custom background, title and text colors to your screenshots.

A working example can be found in the fastlane examples project.

Framefile.json

Use it to define the general information:

{
  "device_frame_version": "latest",
  "default": {
    "keyword": {
      "font": "./fonts/MyFont-Rg.otf"
    },
    "title": {
      "font": "./fonts/MyFont-Th.otf",
      "color": "#545454"
    },
    "background": "./background.jpg",
    "padding": 50,
    "show_complete_frame": false
  },

  "data": [
    {
      "filter": "Brainstorming",
      "keyword": {
        "color": "#d21559"
      }
    },
    {
      "filter": "Organizing",
      "keyword": {
        "color": "#feb909"
      }
    },
    {
      "filter": "Sharing",
      "keyword": {
        "color": "#aa4dbc"
      }
    },
    {
      "filter": "Styling",
      "keyword": {
        "color": "#31bb48"
      }
    }
  ]
}

The show_complete_frame value specifies whether frameit should shrink the device and frame so that they show in full in the framed screenshot. If it is false, then they can hang over the bottom of the screenshot.

The filter value is a part of the screenshot named for which the given option should be used. If a screenshot is named iPhone5_Brainstorming.png the first entry in the data array will be used.

You can find a more complex configuration to also support Chinese, Japanese and Korean languages.

The Framefile.json should be in the screenshots folder, as seen in the example.

.strings files

To define the title and optionally the keyword, put two .strings files into the language folder (e.g. en-US in the example project)

The keyword.strings and title.strings are standard .strings file you already use for your iOS apps, making it easy to use your existing translation service to get localized titles.

Note: These .strings files MUST be utf-16 encoded (UTF-16 LE with BOM). They also must begin with an empty line. If you are having trouble see issue #1740

Note: You MUST provide a background if you want titles. frameit will not add the tiles if a background is not specified.

Uploading screenshots to iTC

Use deliver to upload all screenshots to iTunes Connect completely automatically πŸš€

Mac

With frameit 2.0 it's possible to also frame macOS Application screenshots. You have to provide the following:

  • The offset information so frameit knows where to put your screenshots
  • A path to a background, which should contain both the background and the Mac
  • titleHeight: The height in px that should be used for the title
Example
{
  "default": {
    "title": {
      "color": "#545454"
    },
    "background": "Mac.jpg",
    "offset": {
      "offset": "+676+479",
      "titleHeight": 320
    }
  },
  "data": [
    {
      "filter": "Brainstorming",
      "keyword": {
        "color": "#d21559"
      }
    }
  ]
}

Check out the MindNode example project.

Tips

fastlane Toolchain

  • fastlane: The easiest way to automate beta deployments and releases for your iOS and Android apps
  • deliver: Upload screenshots, metadata and your app to the App Store
  • snapshot: Automate taking localized screenshots of your iOS app on every device
  • pem: Automatically generate and renew your push notification profiles
  • sigh: Because you would rather spend your time building stuff than fighting provisioning
  • produce: Create new iOS apps on iTunes Connect and Dev Portal using the command line
  • cert: Automatically create and maintain iOS code signing certificates
  • spaceship: Ruby library to access the Apple Dev Center and iTunes Connect
  • pilot: The best way to manage your TestFlight testers and builds from your terminal
  • boarding: The easiest way to invite your TestFlight beta testers
  • gym: Building your iOS apps has never been easier
  • scan: The easiest way to run tests of your iOS and Mac app
  • match: Easily sync your certificates and profiles across your team using git
Like this tool? Be the first to know about updates and new fastlane tools

Generate localized screenshots

Check out snapshot to automatically generate screenshots using UI Automation.

Alternative location to store device_frames

Device frames can also be stored in a ./fastlane/screenshots/devices_frames directory if you prefer rather than in the ~/.frameit/device_frames directory. If doing so please be aware that Apple's images are copyrighted and should not be redistributed as part of a repository so you may want to include them in your .gitignore file.

White background of frames

Some stock images provided by Apple still have a white background instead of a transparent one. You'll have to edit the Photoshop file to remove the white background, delete the generated .png file and run fastlane frameit again.

Use a clean status bar

You can use SimulatorStatusMagic to clean up the status bar.

Gray artifacts around text

If you run into any quality issues, like having a border around the font, it usually helps to just re-install imagemagick. You can do so by running

brew uninstall imagemagick
brew install imagemagick

Uninstall

  • sudo gem uninstall fastlane
  • rm -rf ~/.frameit

Need help?

Please submit an issue on GitHub and provide information about your setup

Code of Conduct

Help us keep frameit open and inclusive. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.