fastlane: frameit doesn't support iPhone 14 Pro screen size
New Issue Checklist
- [x ] Updated fastlane to the latest version
- [x ] I read the Contribution Guidelines
- [x ] I read docs.fastlane.tools
- [x ] I searched for existing GitHub issues
Issue Description
An error is shown: Unsupported screen size [1290, 2796] for path
Command executed
fastlane frameit
env
✅ fastlane environment ✅
Stack
| Key | Value |
|---|---|
| OS | 12.6 |
| Ruby | 3.0.2 |
| Bundler? | false |
| Git | git version 2.37.0 (Apple Git-136) |
| Installation Source | ~/.rbenv/versions/3.0.2/bin/fastlane |
| Host | macOS 12.6 (21G115) |
| Ruby Lib Dir | ~/.rbenv/versions/3.0.2/lib |
| OpenSSL Version | OpenSSL 1.1.1l 24 Aug 2021 |
| Is contained | false |
| Is homebrew | false |
| Is installed via Fabric.app | false |
| Xcode Path | /Applications/Xcode-14.0.1-Release.Candidate.app/Contents/Developer/ |
| Xcode Version | 14.0.1 |
| Swift Version | 5.7 |
System Locale
| Variable | Value | |
|---|---|---|
| LANG | de_DE.UTF-8 | ✅ |
| LC_ALL | ||
| LANGUAGE |
fastlane files:
No Fastfile found
No Appfile found
fastlane gems
| Gem | Version | Update-Status |
|---|---|---|
| fastlane | 2.210.1 | ✅ Up-To-Date |
Loaded fastlane plugins:
No plugins Loaded
Loaded gems
| Gem | Version |
|---|---|
| did_you_mean | 1.5.0 |
| atomos | 0.1.3 |
| rexml | 3.2.5 |
| CFPropertyList | 3.0.5 |
| claide | 1.1.0 |
| colored2 | 3.1.2 |
| nanaimo | 0.3.0 |
| xcodeproj | 1.21.0 |
| rouge | 2.0.7 |
| xcpretty | 0.3.0 |
| terminal-notifier | 2.0.0 |
| unicode-display_width | 1.8.0 |
| terminal-table | 1.8.0 |
| plist | 3.6.0 |
| public_suffix | 4.0.7 |
| addressable | 2.8.0 |
| multipart-post | 2.0.0 |
| word_wrap | 1.0.0 |
| optparse | 0.1.1 |
| tty-screen | 0.8.1 |
| tty-cursor | 0.7.1 |
| tty-spinner | 0.9.3 |
| artifactory | 3.0.15 |
| babosa | 1.0.4 |
| colored | 1.2 |
| highline | 2.0.3 |
| commander | 4.6.0 |
| excon | 0.91.0 |
| faraday-em_http | 1.0.0 |
| faraday-em_synchrony | 1.0.0 |
| faraday-excon | 1.1.0 |
| faraday-httpclient | 1.0.1 |
| faraday-multipart | 1.0.3 |
| faraday-net_http | 1.0.1 |
| faraday-net_http_persistent | 1.2.0 |
| faraday-patron | 1.0.0 |
| faraday-rack | 1.0.0 |
| faraday-retry | 1.0.3 |
| ruby2_keywords | 0.0.5 |
| faraday | 1.9.3 |
| unf_ext | 0.0.8 |
| unf | 0.1.4 |
| domain_name | 0.5.20190701 |
| http-cookie | 1.0.4 |
| faraday-cookie_jar | 0.0.7 |
| faraday_middleware | 1.2.0 |
| fastimage | 2.2.6 |
| gh_inspector | 1.1.3 |
| json | 2.5.1 |
| mini_magick | 4.11.0 |
| naturally | 2.2.1 |
| rubyzip | 2.3.2 |
| security | 0.1.3 |
| xcpretty-travis-formatter | 1.0.1 |
| dotenv | 2.7.6 |
| bundler | 2.2.22 |
| simctl | 1.6.8 |
| jwt | 2.5.0 |
| uber | 0.1.0 |
| declarative | 0.0.20 |
| trailblazer-option | 0.1.2 |
| representable | 3.1.1 |
| retriable | 3.1.2 |
| mini_mime | 1.1.2 |
| memoist | 0.16.2 |
| multi_json | 1.15.0 |
| os | 1.1.4 |
| signet | 0.16.0 |
| googleauth | 1.1.0 |
| httpclient | 2.8.3 |
| webrick | 1.7.0 |
| google-apis-core | 0.4.2 |
| google-apis-playcustomapp_v1 | 0.7.0 |
| google-apis-androidpublisher_v3 | 0.16.0 |
| google-cloud-env | 1.5.0 |
| google-cloud-errors | 1.2.0 |
| google-cloud-core | 1.6.0 |
| google-apis-iamcredentials_v1 | 0.10.0 |
| google-apis-storage_v1 | 0.11.0 |
| rake | 13.0.3 |
| digest-crc | 0.6.4 |
| google-cloud-storage | 1.36.0 |
| emoji_regex | 3.2.3 |
| jmespath | 1.5.0 |
| aws-partitions | 1.553.0 |
| aws-eventstream | 1.2.0 |
| aws-sigv4 | 1.4.0 |
| aws-sdk-core | 3.126.0 |
| aws-sdk-kms | 1.54.0 |
| aws-sdk-s3 | 1.112.0 |
| tsort | 0.1.0 |
| uri | 0.10.1 |
| set | 1.0.1 |
| forwardable | 1.3.2 |
| logger | 1.4.3 |
| pathname | 0.1.0 |
| shellwords | 0.1.0 |
| cgi | 0.2.0 |
| date | 3.1.0 |
| timeout | 0.1.1 |
| stringio | 3.0.0 |
| securerandom | 0.1.0 |
| openssl | 2.2.0 |
| io-nonblock | 0.1.0 |
| ipaddr | 1.2.2 |
| io-wait | 0.1.0 |
| zlib | 1.1.0 |
| resolv | 0.2.0 |
| digest | 3.0.0 |
| time | 0.1.0 |
| open-uri | 0.1.0 |
| mutex_m | 0.1.1 |
| net-protocol | 0.1.0 |
| ostruct | 0.3.1 |
| english | 0.7.1 |
| erb | 2.2.0 |
| strscan | 3.0.0 |
| abbrev | 0.1.0 |
| io-console | 0.5.7 |
| tempfile | 0.1.1 |
| delegate | 0.2.0 |
| fileutils | 1.5.0 |
| tmpdir | 0.1.2 |
| base64 | 0.1.0 |
| singleton | 0.1.1 |
| net-http | 0.1.1 |
| open3 | 0.1.1 |
| nkf | 0.1.0 |
| prettyprint | 0.1.0 |
| pp | 0.1.0 |
| find | 0.1.0 |
| yaml | 0.1.1 |
| psych | 3.3.0 |
generated on: 2022-09-26
About this issue
- Original URL
- State: closed
- Created 4 years ago
- Reactions: 4
- Comments: 39 (7 by maintainers)
Update
device_types.rb/Users/me/.gem/ruby/2.6.0/gems/fastlane-2.212.1/frameit/lib/frameitand opendevice_types.rbOK I got it working using a combo of the other’s directions above:
1 downloaded new frames from this pull request (my frames are in ~/.frameit/devices_frames_2/latest) https://github.com/fastlane/frameit-frames/pull/31
2 in that same folder ~/.frameit/devices_frames_2/latest edit offsets.rb by adding “iPhone 14 Pro Max”: { “offset”: “+81+68”, “width”: 1290 }, “iPhone 14 Pro Max Black”: { “offset”: “+81+68”, “width”: 1290 }
3 added the following line to device_types.rb in the fastlane gem IPHONE_14_PRO_MAX ||= Frameit::Device.new(“iphone14-pro-max”, “Apple iPhone 14 Pro Max”, 11, [[1290, 2796], [2796, 1290]], 458, Color::BLACK, Platform::IOS)
Not sure if (3) was necessary, as I had to do (2) after that anyway to get things working. but since it was in the same directory as the step 1 I ordered them like such.
After 3 months, I “cooked” another app update, and I needed to make screenshots again. Some things were broken, since I updated “fastlane”, and also I made the mistake to run the default
fastlane frameit download_frames. This all messed up my previous setup. I am writing here the steps I needed to take to fix it and make it work once again, as a reminder for my future self, and also for others who can’t figure it out:1. Prepare your screenshots for iPhone 14 Pro Max (Portrait 1290x2796) 2. Use the
Makefiledescribed previously to round the corners for the iPhone 14 Pro Max screenshots.3. In Terminal, type this command
gem which fastlaneto find out what fastlane version you’re using. 4. Go toFinder -> Go -> Go to folder...and go to your fastlane version folder, ex.:/Users/username/.rvm/gems/ruby-3.0.2/gems/fastlane-2.217.0/then navigate toframeit/lib/frameit/5. Replace the filedevice_types.rbcontent with the following:6. Clone or download ->
https://github.com/fastlane/frameit-frames7. Extract and putlatestfolder in/Users/youruser/.fastlane/frameit/latest8. Run in Terminal:bundle exec fastlane run frameit path:'./screenshots'Enjoy!
@mindthefrog Thank you. Initially your script didn’t want to work. I used your code plus a lot of ChatGPT trial and error until I found a working solution.
Here is a final code if someone is looking for the same script. Create a Makefile, put the code below in it:
Explanation:
find ./screenshots/finds only in this directory recursively-not name '_framed.png'ignores filenames which contain “_framed.png” at the end (the already framed files)-name '*-Screen.png'search only files which end in “-Screen.png” (that’s how I name my original screenshots)Place this Makefile script in the same directory as your project (where your
.xcodeprojresides). Then, in terminal, navigate to the directory with your Makefile and run this command:make process_imagesHi I have own fork where I made it all work if you want I can create PR but it doesn’t use Facebook Device because it is not yet supported but my own. I have support for iPhone 14 Pro and iPhone 14 Pro Max with device frames in Deep purple, Golf, black and silver. But my designs of iPhone 14 Pro and iPhone 14 Pro are slightly modified because the screen doesn’t fit there 😄 Thanks apple.
So I well make the sides bigger to fit the screenshot in next iteration I will play around with adding corner radius to the screen shot to all rounded devices.
But it looks good I think
Yeah no problem.
It’s not very elegant. It’s a simple shell script that rounds the corners using convert which I run before executing frameit. It goes something like this:
#!/bin/zsh
find $1 -not -name *_framed.png -name iPhone\ 14*.png
-exec echo rounding {}
;
-exec convert {}
( +clone -alpha extract
-draw ‘fill black polygon 0,0 0,50 50,0 fill white circle 50,50 50,0’
( +clone -flip ) -compose Multiply -composite
( +clone -flop ) -compose Multiply -composite
) -alpha off -compose CopyOpacity -composite {}
;
Following @yonicsurny I had to go to /opt/homebrew/Cellar/fastlane/2.216.0/libexec/gems/fastlane-2.216.0/bin/fastlane instead of the location he mentioned since I installed my fast lane using home-brew. And then after adding those two lines, it also required me to run
fastlane frameit download_framesfirst But then I got this error “Couldn’t find template for screenshot type ‘Apple iPhone 14 Pro Black’”It was the device_types change that I was missing, great answer @yonicsurny as I was quite lost with Ruby. Thank you!
Yup, no problem. Fastlane can be annoyingly delicate, but it is still always worth the effort.
This mostly deals with the command
fastlane frameitwhich takes the raw screenshots and adds devices frames, a background image, and some localized text. Docs: https://docs.fastlane.tools/actions/frameit/I forgot to include some steps. Sorry about that.
Overview:
1. patching in the missing iphone 14 frames
fastlane frameit download_frameswill download a repository of device frames to your~/.fastlane/frameitfolder. The frames are their own git repo ( https://github.com/fastlane/frameit-frames ) that pull from a Facebook library ( https://design.facebook.com/toolsandresources/devices/ ) The frameit-frames repo is just out of date, but there’s a PR with the newer frames. So just go in to your~/.fastlane/frameitfolder and overwrite your frames folder with a clone at this hash: https://github.com/fastlane/frameit-frames/pull/31Now you’ll have iPhone 14 frames.
2. custom mask script i wrote to deal with iphone 14 corners There is a problem with the iPhone 14 frames… 😅 The corners of the screen are so rounded that the 90° corner of the screenshot sticks outside the device frame. You can see a conversation about it here: https://github.com/fastlane/fastlane/issues/20703#issuecomment-1271173819
I didn’t find a solution to that online, so I made a mask image, and wrote a Bash ImageMagick script ( cropcorners14promax.sh ) that applies the mask to all the screenshots BEFORE you run frameit. This should be pretty easy to edit to support regular 14 Pro (non-Max). You can add more device names in the Snapfile and re-run
fastlane snapshotto generate more. You may have to look up the specific names it’s looking for. (There’s a big array of them somewhere in the fastlane ruby source code.)run runcrop14promax.sh in the fastlane folder.
Then you run
3. Now you should be able to run
fastlane frameitWatch the files it’s generating. If it’s doing something weird, cancel it and make an adjustment. Once you have it set up and working you probably won’t have to change anything with the toolchain until a new device size is released.
The downside to that is that it’s hard to remember how it works when it breaks after 6 months. I highly suggest writing your own notes about this, your personal set up, links to the docs and git repos, and what set of commands works for you.
4. deliver
for uploading all the screenshots you use
fastlane deliverThere’s a .Deliverfile file that has some comments and options (some are commented out). The options are pretty self explanatory, but it’s worth reading the docs too. http://docs.fastlane.tools/actions/deliver/#deliver
This will update every language with whatever is in the metadata folder for each language (i.e. privacy.txt, description.txt), and the localized screenshots.
It can also upload the build for you… but I never trusted it to do that. I did that manually via XCode -> Build -> Archive -> Upload. Sometimes it takes a few minutes for the build to show up in App Store Connect. I wait until it does, then I run
fastlane deliverThat’s a lot… and written quickly. But I think that’s all the missing parts. Sorry I forgot the iPhone 14 support part.
Let me know if you get it working, or have more questions.
Thanks, Kevin
On Wed, May 31, 2023 at 1:48 PM Rodrigo Extremo Tabarés < @.***> wrote:
^I’m having trouble even with that method. Things aren’t sizing correctly.
But this is also a bump to say the Facebook library is updated. All the colors and styles of iPhone 14 / Plus / Pro / Max.
https://design.facebook.com/toolsandresources/devices/
@kmentrobin Thanks you very much for your fast response, i like your name too! 😄
Right now i just updated fastlane with this line in my gemfile to your version:
gem 'fastlane', :git => 'https://github.com/kmentrobin/fastlane.git', :ref => '950bb820237d52e15690408083e328f739ac0ef3'But i just got stuck with the same error message as before. Would it be enough to just download the frame that you sent and put it into the right folder or do i need to do something else like editing the offsets.json file?