psd - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #go #golang #rust #docker #nodejs #cli #security #pytorch #mcp #open-source

psd

(★ 284)

A Rust API for parsing and working with PSD files.

File Explorer

Download Latest Version (.zip)

- config.yml
- - introduction.md
  - SUMMARY.md
- .gitignore
- book.toml
- - build-dev.sh
  - build-release.sh
  - Cargo.toml
  - demo-screenshot.png
  - demo.psd
  - index.html
  - README.md
- README.md
- - file_header_section.rs
  - image_data_section.rs
  - image_resources_section.rs
  - mod.rs
- blend.rs
- lib.rs
- psd_channel.rs
- render.rs
- - 16x16-rle-partially-opaque.psd
  - 3x3-opaque-center.psd
  - fifteen-letters.psd
  - green-1x1.png
  - green-1x1.psd
  - green-chinese-layer-name-1x1.psd
  - green-clipping-10x10.psd
  - green-cyrillic-layer-name-1x1.psd
  - layer-larger.psd
  - luni.psd
  - negative-top-left-layer.psd
  - non-utf8-pascal-string.psd
  - odd-length-pascal-string.psd
  - one-channel-1x1.psd
  - out-of-bounds-layer.psd
  - README.md
  - rle-3-layer-8x8.psd
  - slices-v8.psd
  - transparent-above-opaque.psd
  - transparent-top-layer-2x1.psd
  - two-channel-8x8.psd
  - two-layers-red-green-1x1.psd
  - visibility.psd
- blend.rs
- channels.rs
- compression.rs
- file_header_section.rs
- flatten_layers.rs
- image_data_section.rs
- image_resources_section.rs
- layer_and_mask_information_section.rs
- layer_groups.rs
- README.md
- slices_resource.rs
- transparency.rs
- visibility.rs
.gitignore
Cargo.toml
CHANGELOG.md
LICENSE-APACHE
LICENSE-MIT
README.md

# Installation Guide

1. Get the code

git clone https://github.com/chinedufn/psd

Downloads the entire project code from GitHub to your computer.

cd psd

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

psd
===

[![Build status](https://circleci.com/gh/chinedufn/psd.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/chinedufn/psd) [![docs](https://docs.rs/psd/badge.svg)](https://docs.rs/psd)

> A Rust API for parsing and working with PSD files.

## Live Demo

The `psd` crate can be compiled to WebAssembly and used in a browser.

[In the live demo you can visualize a PSD in the browser](https://chinedufn.github.io/psd/drag-drop-demo/),
toggle layers on and off and drag and drop a new PSD into the demo.

![Demo screenshot](https://raw.githubusercontent.com/chinedufn/psd/master/examples/drag-drop-browser/demo-screenshot.png)

Check out the [examples/drag-drop-browser](examples/drag-drop-browser) directory for instructions on running the demo locally.

## The Psd Book

The _WIP_ [The Psd Book](https://chinedufn.github.io/psd) will contain information about getting started with the `psd` crate,
a description of the architecture and information on how to get started.

## API Docs

Check out the [API documentation](https://chinedufn.github.io/psd/api/psd) to see everything that you can currently access.

## Background / Initial Motivation

I'm working on a game and part of my asset compilation process was a script that did the following:

1. Iterate over all PSD files

2. Export every PSD into a PNG, ignoring any layers that begin with an `_`

3. Combine PNGs into a texture atlas

For a couple of years I was using `imagemagick` to power step 2, but after getting a new laptop and upgrading `imagemagick` versions it stopped working.

After a bit of Googling I couldn't land on a solution for my problem so I decided to make this crate.

My approach was to support as much of the PSD spec as I needed, so there might be bits of information that you'd like to make use of that aren't currently supported.

That said, if there's anything missing that you need [please feel very free to open an issue](https://github.com/chinedufn/psd/issues)!

## Usage

```rust
use psd::{ColorMode, Psd, PsdChannelCompression};

fn main () {
    // .. Get a byte slice of PSD file data somehow ..
    let psd = include_bytes!("./my-psd-file.psd");

let psd = Psd::from_bytes(psd).unwrap();

assert_eq!(psd.color_mode(), ColorMode::Rgb);

// For this PSD the final combined image is RleCompressed
    assert_eq!(psd.compression(), &PsdChannelCompression::RleCompressed);

assert_eq!(psd.width(), 500);
    assert_eq!(psd.height(), 500);

// Get the combined final image for the PSD.
    let final_image: Vec<u8> = psd.rgba();

for layer in psd.layers().iter() {
        let name = layer.name();

let pixels: Vec<u8> = layer.rgba().unwrap();
    }

let green_layer = psd.layer_by_name("Green Layer").unwrap();

// In this layer the red channel is uncompressed
    assert_eq!(green_layer.compression(&PsdChannelKind::Red).unwrap(), PsdChannelCompression::RawData);

// In this layer the green channel is RLE compressed
    assert_eq!(green_layer.compression(&PsdChannelKind::Green).unwrap(), PsdChannelCompression::RleCompressed);

// Combine the PSD layers top to bottom, ignoring any layers that begin with an `_`
    let pixels: Vec<u8> = psd.flatten_layers_rgba(&|(_idx, layer)| {
        !layer.name().starts_with("_")
    }).unwrap();
}
```

## See Also

- [PSD specification](https://www.adobe.com/devnet-apps/photoshop/fileformatashtml/) - the basis of our API

## License

MIT