Code Monkey home page Code Monkey logo

xcode-asset-catalog-generator's Introduction

Xcode Asset Catalog Generator

Swift Gamedev Twitter: @artstorm

Xcode asset catalog generator for game development. It's a batch processing command line tool that builds the asset catalog from source assets and generates images with optimized sizes for iPad, iPhone, AppleTV and Mac.

Features

  • Creates sizes in @1x, @2x and @3x per device type.
  • Saves the output directly to the asset catalog in Xcode.
  • Handles numbered image sequences.
  • Handles Sprite Atlas generation.
  • Handles vector images as Universal, Single Scale. PDF and SVG (Xcode 12+).
  • Specifically targets game development with SpriteKit.
  • Tracks converted images so on each re-generation only new or updated source images are generated to the asset catalog.
  • In early development, available as-is. The same goes for the documentation.

I've developed the tool for personal usage, so everything is subject to change between versions and it does have quite a few rough edges.

Usage

Xcode Asset Catalog Generator - Usage Tutorial

I recommend watching the Usage Tutorial Video to quickly get an understanding of how the tool works and how to use it.

Reference

The wiki has more detailed documentation of how to configure and use the tool.

Installation

  1. Node.js is required for the tool to work which can easily be installed using Homebrew.
  2. Clone or download this repository.
  3. Install the dependencies. npm install.
  4. Configure your asset build. (see wiki).

Generate

Once the tool is installed and configured, assets can be generated from the command line. The tool provides a dev mode to try the generation to an output folder in the tool's installation folder.

# Builds the assets to a target folder for dev purposes.
npm run dev

# Builds the assets to the assets folder in Xcode.
npm run prod

xcode-asset-catalog-generator's People

Contributors

artstorm avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

rudedogg

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.