# psd2prefab

**Repository Path**: cgw0827/psd2prefab

## Basic Information

- **Project Name**: psd2prefab
- **Description**: A tool to convert psd to a unity prefab.
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2023-07-04
- **Last Updated**: 2023-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# psd2prefab

#### Description
A tool to convert psd to a unity prefab (nodejs part). This is the nodejs part of psd2prefab for generating the prefab discription file. You should then use the [psd2prefab_unity](https://gitee.com/Halliwood/psd2prefab_unity) to build a real unity prefab.

#### Installation

psd2prefab depends on [canvas](https://www.npmjs.com/package/canvas), which depends on GTK.
You can refer to [intallation guide](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows) or just download [GTK](https://ftp.gnome.org/pub/GNOME/binaries/win64/gtk+/2.22/gtk+-bundle_2.22.1-20101229_win64.zip) and uncompress it to `C:/GTK`.

```
npm i psd2prefab -g
```

#### Command line parameters

* `-p, --project`: unity project root
* `-i, --input`: psd file path
* `-n, --name`: the name of prefab to be generated

#### Configuration

Place a configuration file named `.psd2prefab` under the unity project root:

```
# --- psd2prefab configuration ---

# unity project structure
PNG_ROOT=Assets/AssetSources/ui/atlas/$name$
PREFAB_ROOT=Assets/AssetSources/ui/instruction
NOT_ART_FONTS=MicrosoftYaHei;NotoSansHans-DemiLight;AaGuiQi
```

* `PNG_ROOT`: Where to store images, should be set to be imported as atlas sprites in unity.
* `PREFAB_ROOT`: Where the store prefab description file. As a middle file, don't commit it to SVN/Git.
* `NOT_ART_FONTS`: Not art fonts, slit by semicolon. If set, all text excluded will be generated as images. Otherwise all as texts.