Giter VIP home page Giter VIP logo

node-photoshop's Introduction

ExtendScript

Adobe Photoshop has an EcmaScript 3 compatible scripting engine.
Its variant of EcmaScript is called ExtendScript.
ExtendScript files use the jsx file extension.
The ExtendScript Toolkit.app will let you experiment with this code.
It's installed at /Applications/Utilities/Adobe Utilities-CC.localized/ExtendScript Toolkit CC/ExtendScript Toolkit.app.

Here's some sample ExtendScript

function setColor_jsx(color){
  app.foregroundColor.rgb.red = color.red
  app.foregroundColor.rgb.green = color.green
  app.foregroundColor.rgb.blue = color.blue
  return app.foregroundColor.rgb.hexValue
}

var color = {
  red: Math.random() * 255,
  green: Math.random() * 255,
  blue: Math.random() * 255
}

setColor_jsx(color)

Photoshop / After Effects scripting with Node.js

Install

npm install photoshop

photoshop.createStream(jsx, [args])

This is almost always what you want to use.

photoshop.createStream creates a Node.js Stream. The first argument to createStream is an ExtendScript jsx function to evaluate in Photoshop. The jsx function will be called with an ExtendScript Socket instance and whatever additional arguments you supply as the second argument to createStream.

Writing to the socket from Photoshop will immediately stream that string back to node.

function streamColorChanges_jsx(writeStream, setColor_jsx, color){
  writeStream.write(setColor_jsx(color));
  alert("Photoshop won't return until this window is closed, but the stream already sent its data!");
}

var readStream = require('photoshop').createStream(streamColorChanges_jsx, [setColor_jsx, color]);

readStream.pipe(process.stdout);

readStream.on('end', function(){
  console.log('Done!')
});

aftereffects.createStream(jsx, [args])

require('photoshop/aftereffects').createStream(function jsx(stream, props){
  stream.writeln(JSON.stringify(props))
  alert("After Effects won't return until this window is closed, but the stream already sent its data!")
}, [{lulz:true}])
.pipe(process.stdout)

JSONify manythings!

require('./aftereffects').createStream(function jsx(stream, props){

  var composition = app.project.ao_comps()[0];
  var layer = composition.layers[1];

  stream.writeln(
    JSON.stringify(layer, null, 2)
  );

  stream.writeln(JSON.stringify(props))

}, [{lulz:Math.random(0)}])
.pipe(process.stdout)

photoshop.invoke(jsx, [args,] callback)

The invoke method evaluates the given ExtendScript script in Adobe Photoshop.
It handles serializing and deserializing the result of your script so you can return pretty much anything.
You can even return Photoshop host objects and it'll do its best to not completely wet its pants.
It includes es5shim and JSON2 so you can use normal JavaScript like Array map in your ExtendScript.

function recentFilesThatExist_jsx(){
  return app.recentFiles.map(File).filter(function(file){return file.exists})
}
require('photoshop').invoke(recentFilesThatExist_jsx, function(error, recentFiles){
  console.log(recentFiles)
})

The args argument is optional.
You can pass JSONable objects as arguments.

require('photoshop').invoke(setColor_jsx, [color], function(error, foregroundColor){
  console.log('#' + foregroundColor)
})

node-photoshop's People

Contributors

loksland avatar subtlegradient avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

node-photoshop's Issues

Windows Version (?)

First of all, thank you so much for node-photoshop.

Have been playing around with it on Mac OSX and it works fantastic.

Yesterday, I wanted to install node-photoshop on a Windows Server and ran into some compatibility issues.

Do you think your version is portable to Windows? I can give it a try if you think it can be done. Tips?

Thanks!

Guillermo

After Effects execution - node does not exit

Hi there,
awesome module. Thanks. I tried to execute your example and ran into an error.

It sends the script to AE und the alert shows up. When I hit the "ok" button I can return to the terminal but node is stuck there. It does not exit.
Take a look at the screenshot if it is unclear what I mean.
stuck-screen

Am I doing something wrong?

node: 0.10.29
npm: 1.4.21
photoshop module: 0.5.0
OS: Mac OSX 10.9.4
AE CC 2014: 13.0.0.214

My index.js taken from your examples:

require('photoshop/aftereffects').createStream(function jsx(stream, props){
  stream.writeln(JSON.stringify(props));
  alert("After Effects won't return until this window is closed, but the stream already sent its data!");
}, [{lulz:true}])
.pipe(process.stdout);

help

Hi,

I need to create a psd file, with very simple options, just background layer with color, and layers with images that can have border and can be clipped too.

I'm wondering if it is possible with your lib?

Thank you

Illustrator compatibility?

Noticed this package is setup for PS and AE. Was curious if there is some kind of tech limitation that prevents it from working with AI, or if it's possible and just hasn't been implemented yet?

Some kind of blocking/return issue.

I'm having a weird issue where Photoshop doesn't seem to want to return anything unless I do something blocking first. Here's some sample code:

var photoshop = require('photoshop');

function recentFilesThatExist_jsx(){
    var files = app.recentFiles,
        fileList = files.map(File).filter(function(file){return file.exists});

    alert(fileList);

    return fileList;
}

photoshop.invoke(recentFilesThatExist_jsx, function(err, recentFiles) {
    console.log(recentFiles);
});

That works as expected, but if I comment out the alert(fileList); part, nothing gets returned. Any idea what could be causing that? (Running Node 0.10.5 and Photoshop CS6).

EDIT: This is inside node-webkit. Oddly, the same code works fine if I just run it directly from a Node REPL. Very strange.

Copy/Usage Rights?

Thanks for creating this! I looked for copyright and usage, but found none. What are the terms if I want to use/edit/redistribute any of the code?

Thanks,
Max

Use PSConnect

PSConnect is part of the Adobe Photoshop CS6 SDK. It is a TCP Socket api. It requires users to enable the server and set a password.

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.