├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── sample.gif └── scripts ├── AssetSpec.rb ├── generateAssests.sh └── utils ├── files.rb ├── find_largest.rb └── sips.rb /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: "[BUG]" 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. macOS 10.14.2] 28 | - Xcode: [e.g. 10.2] 29 | 30 | **Additional context** 31 | Add any other context about the problem here. 32 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: "[FEATURE]" 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at mverges3@gatech.edu. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | By submitting a pull request to this project, you represent that you have the right to license your contribution to the community, and agree by submitting a patch to allow your contributions to be redistributed under the project’s license. 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Michael Verges 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Asset Generator 2 | 3 | #### Xcode build phase for generating scaled assets 4 | 5 | ![sample.gif](sample.gif "Generating Assets during build.") 6 | 7 | Xcode users know that scaling image and AppIcon assets is inefficient. Even by using tools that generate icons, precious time is spent dragging and dropping. Asset Generator is a completely automated tool that runs during your project's Build Phase. For every image and icon in .xcassets folders, Asset Generator will find the largest asset and scale it to fill any missing sizes. 8 | 9 | ## Getting Started 10 | 11 | These instructions will show you how to implement Asset Generator as an Xcode build phase in your project. 12 | 13 | ### Adding to Xcode 14 | 15 | 1. Download the scripts folder and place it in your desired Xcode target. 16 | 17 | 2. In project settings: `Target > Build Phases > + > New Run Script Phase` 18 | 19 | 3. In the Run Script Phase, enter: `"$PROJECT_DIR"/"$PROJECT_NAME"/scripts/generateAssests.sh` 20 | 21 | ### Using in Xcode 22 | 23 | Build your project and assets will be generated. 24 | 25 | >For assets, you may provide any size, but you will recieve a build warning unless the largest required scale is provided. 26 | 27 | By default, all assets will be generated from the largest asset during build. To generate only missing assets, change the contents of `generateAssets.sh` by removing the `-a` flag: 28 | 29 | `ruby "$PROJECT_DIR"/"$PROJECT_NAME"/scripts/AssetSpec.rb -a` → `ruby "$PROJECT_DIR"/"$PROJECT_NAME"/scripts/AssetSpec.rb` 30 | 31 | ## Built With 32 | 33 | * [Ruby](https://www.ruby-lang.org/) 34 | 35 | ## Contributing 36 | 37 | The provided scripts are starting points for your own implementation. If you encounter bugs in the provided scripts, please report an issue. 38 | 39 | If you have enhancements or feature requests, report an issue or create a pull request. 40 | 41 | ## Authors 42 | 43 | * [**Michael Verges**](https://github.com/maustinstar) - *Initial work* - mverges3@gatech.edu 44 | -------------------------------------------------------------------------------- /sample.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/maustinstar/AssetGenerator/bb7f0694a80c3ab38be506978d26acff2b7ab2bd/sample.gif -------------------------------------------------------------------------------- /scripts/AssetSpec.rb: -------------------------------------------------------------------------------- 1 | # 2 | # AssetSpec.rb 3 | # 4 | # Created by Michael Verges on 4/17/19. 5 | # 6 | 7 | require 'json' 8 | require_relative 'utils/sips' 9 | require_relative 'utils/files' 10 | require_relative 'utils/find_largest' 11 | 12 | # read argument to generate all assets 13 | # defaults to true 14 | generate_all = ARGV[0] == "-a" 15 | 16 | # Find all image assets 17 | for filename in Dir["**/*.imageset/*.json"] do 18 | 19 | # json object for image set 20 | json = parse filename 21 | # json object for largest image in set 22 | large = find_largest filename, json 23 | largename = "\"#{dir filename}/#{large['filename']}\"" 24 | # base @1x asset width 25 | width = width_of(largename).to_f / large['scale'].to_f 26 | 27 | # generate all images 28 | for image in json["images"] do 29 | next if image["filename"] == large["filename"] 30 | next if !generate_all and !image["filename"].nil? 31 | scale = image["scale"].to_f 32 | out = "#{dir filename}/#{lastdir filename, '.*'}@#{scale.to_i.to_s}#{ext large['filename']}" 33 | scale_to_width largename, (width * scale).to_i.to_s, "\"" + out + "\"" 34 | # add json reference to new asset 35 | image["filename"] = base out, '' 36 | puts out 37 | end 38 | 39 | # update asset json 40 | write filename, json.to_json 41 | end 42 | 43 | # Find all AppIcon assets 44 | for filename in Dir["**/*.appiconset/*.json"] do 45 | 46 | # json object for image set 47 | json = parse filename 48 | # json object for largest image in set 49 | large = find_largest filename, json 50 | 51 | # generate all images 52 | for image in json["images"] do 53 | next if image["filename"] == large["filename"] 54 | next if !generate_all and !image["filename"].nil? 55 | newsize = (((image["size"]).to_s.split 'x').first.to_f * image["scale"].to_f).to_i.to_s 56 | out = "#{dir filename}/#{lastdir filename, '.*'}@#{newsize}#{ext large['filename']}" 57 | scale_to_width "\"#{dir filename}/#{large['filename']}\"", newsize, "\"" + out + "\"" 58 | # add json reference to new asset 59 | image["filename"] = base out, '' 60 | puts out 61 | end 62 | 63 | # update asset json 64 | write filename, json.to_json 65 | end 66 | -------------------------------------------------------------------------------- /scripts/generateAssests.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # AssetGenerator.sh 4 | # 5 | # Created by Michael Verges on 4/17/19. 6 | # 7 | 8 | ruby "$PROJECT_DIR"/"$PROJECT_NAME"/scripts/AssetSpec.rb -a 9 | -------------------------------------------------------------------------------- /scripts/utils/files.rb: -------------------------------------------------------------------------------- 1 | # 2 | # files.rb 3 | # Wrapper functions for Ruby file methods 4 | # 5 | # Created by Michael Verges on 4/18/19. 6 | # 7 | 8 | require 'json' 9 | 10 | # returns the name of the last directory in a filepath 11 | # useful for finding the names of .imageset and .appiconset 12 | def lastdir file, ext; return File.basename dir(file).split('/')[-1], ext end 13 | 14 | # returns filepath 15 | def dir file; return File.dirname file end 16 | 17 | # returns extension 18 | def ext file; return File.extname file end 19 | 20 | # returns basename, removing extension 21 | def base file, ext; return File.basename file, ext end 22 | 23 | # returns object contents of json 24 | def parse json; return JSON.parse File.read json end 25 | 26 | # writes to file 27 | def write file, contents; return File.write file, contents end 28 | -------------------------------------------------------------------------------- /scripts/utils/find_largest.rb: -------------------------------------------------------------------------------- 1 | # 2 | # find_largest.rb 3 | # Search through assets to fing the largest image 4 | # 5 | # Created by Michael Verges on 4/18/19. 6 | # 7 | 8 | def find_largest filename, json 9 | index = -1 10 | maxsize = 0 11 | json["images"].each_with_index do |image, i| 12 | unless image["filename"].nil? 13 | size = width_of "#{dir filename}/#{image['filename']}" 14 | if size > maxsize 15 | maxsize = size 16 | index = i 17 | end 18 | end 19 | end 20 | # Warn users if upscaling assets 21 | unless json['images'][index] == json['images'][-1] 22 | image = lastdir filename, '.*' 23 | puts "warning: Upscaling from #{maxsize}px occured in asset '#{image}'" 24 | end 25 | return json['images'][index] 26 | end 27 | -------------------------------------------------------------------------------- /scripts/utils/sips.rb: -------------------------------------------------------------------------------- 1 | # 2 | # sips.rb 3 | # Ruby function wrapper for sips CLI 4 | # 5 | # Created by Michael Verges on 4/18/19. 6 | # 7 | 8 | # evaluates shell function and returns output string 9 | def run cmd; return `#{cmd}`.to_s end 10 | 11 | # returns width of image (integer) 12 | def width_of image; return run("sips #{image} -g pixelWidth").split(' ').last.to_i end 13 | 14 | # resizes image 15 | def scale_to_width sourcename, new_width, outname 16 | run "sips #{sourcename} --resampleWidth #{new_width} --out #{outname}" 17 | end 18 | --------------------------------------------------------------------------------