A general purpose Photoshop file parser written in Ruby. It allows you to work with a Photoshop document in a manageable tree structure and find out important data such as:
- Document structure
- Document size
- Layer/folder size + positioning
- Layer/folder names
- Layer/folder visibility and opacity
- Font data (via psd-enginedata)
- Text area contents
- Font names, sizes, and colors
- Color mode and bit-depth
- Vector mask data
- Flattened image data
Add this line to your application's Gemfile:
gem 'psd'
And then execute:
$ bundle
Or install it yourself as:
$ gem install psd
Loading a PSD
require 'psd'
psd = PSD.new('/path/to/file.psd')
psd.parse!
Traversing the Document
To access the document as a tree structure, use psd.tree
to get the root node. From there, you can traverse the tree using any of these methods:
root
: get the root node from anywhere in the treeancestors
: get all ancestors in the path of this node (excluding the root)siblings
: get all sibling tree nodes including the current one (e.g. all layers in a folder)descendants
: get all descendant nodes not including the current onesubtree
: same as descendants but starts with the current nodedepth
: calculate the depth of the current node
For any of the traversal methods, you can also retrieve folder or layer nodes only by appending _layers
or _groups
to the method. For example:
psd.tree.descendant_layers
Accessing Layer Data
To get data such as the name or dimensions of a layer:
psd.tree.descendant_layers.first.name
psd.tree.descendant_layers.first.width
PSD files also store various pieces of information in "layer info" blocks. Which blocks a layer has varies from layer-to-layer, but to access them you can do:
psd.tree.descendant_layers.first.type.font
# Returns
{:name=>"HelveticaNeue-Light",
:sizes=>[33.0],
:colors=>[[255, 19, 120, 98]],
:css=>
"font-family: \"HelveticaNeue-Light\", \"AdobeInvisFont\", \"MyriadPro-Regular\";\nfont-size: 33.0pt;\ncolor: rgba(19, 120, 98, 255);"}
Exporting Data
When working with the tree structure, you can recursively export any node to a Hash.
pp psd.tree.to_hash
Which produces something like:
{:children=>
[{:type=>:group,
:visible=>false,
:opacity=>1.0,
:blending_mode=>"normal",
:name=>"Version D",
:left=>0,
:right=>900,
:top=>0,
:bottom=>600,
:height=>900,
:width=>600,
:children=>
[{:type=>:layer,
:visible=>true,
:opacity=>1.0,
:blending_mode=>"normal",
:name=>"Make a change and save.",
:left=>275,
:right=>636,
:top=>435,
:bottom=>466,
:height=>31,
:width=>361,
:text=>
{:value=>"Make a change and save.",
:font=>
{:name=>"HelveticaNeue-Light",
:sizes=>[33.0],
:colors=>[[255, 19, 120, 98]],
:css=>
"font-family: \"HelveticaNeue-Light\", \"AdobeInvisFont\", \"MyriadPro-Regular\";\nfont-size: 33.0pt;\ncolor: rgba(19, 120, 98, 255);"},
:left=>0,
:top=>0,
:right=>0,
:bottom=>0,
:transform=>
{:xx=>1.0, :xy=>0.0, :yx=>0.0, :yy=>1.0, :tx=>456.0, :ty=>459.0}},
:ref_x=>264.0,
:ref_y=>-3.0}]
}],
:document=>{:width=>900, :height=>600}}
You can also export the PSD to a flattened image. Please note that, at this time, not all image modes + depths are supported.
png = psd.image.to_png # reference to PNG data
psd.image.save_as_png 'path/to/output.png' # writes PNG to disk
There are a few features that are currently missing from PSD.rb.
- Global layer mask
- Individual layer image exporting
- More image modes + depths for image exporting
- A few layer info blocks