Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/artstorm/xcode-asset-catalog-generator

Batch processing Xcode asset catalog generator for game development.
https://github.com/artstorm/xcode-asset-catalog-generator

asset-catalog game-development gamedev sprite-atlas xcode

Last synced: 2 months ago
JSON representation

Batch processing Xcode asset catalog generator for game development.

Host: GitHub
URL: https://github.com/artstorm/xcode-asset-catalog-generator
Owner: artstorm
Created: 2020-10-06T06:27:16.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2023-11-17T15:48:24.000Z (about 1 year ago)
Last Synced: 2024-10-22T00:57:18.615Z (3 months ago)
Topics: asset-catalog, game-development, gamedev, sprite-atlas, xcode
Language: JavaScript
Homepage: https://blog.bitbebop.com
Size: 7.81 KB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Xcode Asset Catalog Generator

![Swift Gamedev](https://img.shields.io/badge/swift-gamedev-brightgreen.svg?style=flat)
[![Twitter: @artstorm](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/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](https://img.youtube.com/vi/r7ceDi5FQ7c/0.jpg)](https://www.youtube.com/watch?v=r7ceDi5FQ7c)

I recommend watching the [Usage Tutorial Video](https://www.youtube.com/watch?v=r7ceDi5FQ7c) to quickly get an understanding of how the tool works and how to use it.

### Reference

The [wiki](https://github.com/artstorm/xc-assetcat-gen/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](https://formulae.brew.sh/formula/node).
2. Clone or download this repository.
3. Install the dependencies. `npm install`.
4. Configure your asset build. (see [wiki](https://github.com/artstorm/xc-assetcat-gen/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
```