メインコンテンツへスキップ
見出し画像

PhotoshopのツールにUXPを導入した話 Now In REALITY Tech #141

    アバターシステムチーム エンジニアのうっちーです。

    今回はUXPをPhotoshopのツール開発に導入したので、導入手順について紹介していこうと思います。

    振り返り

    これまでREALITYのPhotoshopのツールはExtendScriptによって作成されていました。
    詳細は下記の記事で紹介していますのでご一読ください。

    UXPの導入経緯

    ある日、ArtからPhotoshopのツールとして以下のような要望が来ました。

    「納品されたアセット用のPSDデータの中に、意図しないレイヤーが混じっていたり、レイヤー情報として描画設定や不透明度が規定値になっていない物が混じっていることがあり、目での確認でも抜け漏れが発生しやすいのでツールとして確認する仕組みを用意してほしい。」

    上記の要望をもとにPSDの状態を確認するだけであればこれまでと同じくExtendScriptで良かったのですが、Artが制作物確認として使用する際、ExtendScriptではレイアウトの制限が強いためツールとして見づらいものになってしまうという話になりました。そこでツールとして見やすいものになるようにレイアウトの自由度が高いUXPを今回導入してみることにしました。

    画像
    UXPで制作されたツールの例

    UXPとは

    UXPとはAdobeがPluginの開発システムとして提供しているもので、JavaScriptを用いて開発することができます。AdobeとしてのPlugin制作なためPhotoshopに限らずIllustrator などの Creative Cloud アプリケーション向けに用いることができます。

    UXPの導入

    開発環境の構築

    まず開発するためにはCreative Cloudで「UXP Developer Tools」のインストールが必要です。Creative Cloud上で検索をかければすぐに見つかると思います。

    画像
    Creative Cloudの検索画面

    IDEはお好みで、VS CodeやWebStorm等使い慣れたもので大丈夫だと思います。

    Pluginのベースを作成

    UXP Developer Toolsを開き, Create Pluginを実行すると画像のような画面が出てくると思います。

    画像
    Plugin制作情報入力画面

    入力情報のポイントは以下の通りです

    • Plugin Name

      • 任意の名称

    • Plugin ID

      • Creative Cloud上で公開前提ですと名前衝突を避ける必要がありますが、メンバー内共有のみで使うなら任意のIDで問題ありません

    • Host Application

      • Creative Cloudのどのアプリケーション向けに制作するか選択します

      • Pluginを作る前に先に対象のアプリを入れておくとHost Application Versionも自動的に設定されるので、先にアプリをインストールしておきましょう

    • Template

      • 制作されるPluginのベースの選択です

      • 複数の選択肢がありますが、推奨は「react-starter」です

    上記の情報を入力後、Select Folderを実行することで指定したフォルダ以下にベースが作成されます。

    実行確認

    まずは作成したPluginのフォルダ直下でnodeのパッケージのインストールを実行します。

    npm -i

    次に実装したものを反映するためにビルドを実行します。

    npm run build

    実行確認はUXP Developer Toolsの対象のPluginにあるLoadを選択することで実際のアプリ上にツールとして表示され動作を見ることができます。

    画像
    Load時のPhotohop上での表示

    デバッグはLoad中のUXP Developer Toolsに表示されているDebugを押すことで別途Windowが表示され、Elementの状態を確認したり、Consoleを見ることができます。

    画像
    Debugのウィンドウ

    ここまでがシンプルなPlugin開発の環境構築になります。

    REALITYとしての一手間

    REALITYではPluginとして「Vite + TypeScript」を導入しています。
    導入した理由としては以下が挙げられます。

    • TypeScriptを導入することで開発効率を上げ、バグの早期発見をしたい

    • Viteを導入することでビルドを早く回せる環境を整えておきたい

    テンプレートではJavaScriptで作られていますが、TypeScriptにすることでコンパイル段階でエラーとしてロジックのおかしいものが発見しやすくなり、Viteもテンプレートではwebpackなのですが、今後ツールが増えていった際にビルド速度を速くしておくことで開発サイクルを回しやすいようにという意図で導入を行いました。今回はその導入手順も記述しておこうと思います。

    Vite + TypeScriptの基盤作成手順

    UXP Developer Toolsでreact-starterを作っておく

    いくつかUXP特有のものを持ってくるために、コピー元としてreact-starterを作成しておく。

    Vite環境を構築する

    作成したいベースとなるVite環境を構築する。
    Project nameはコピー元と揃えておくとスムーズにコピーできます

    $ npm create vite@latest
    │
    ◇  Project name:
    │  uxp-sample
    │
    ◇  Select a framework:
    │  React
    │
    ◇  Select a variant:
    │  TypeScript + SWC

    必要なスクリプトをコピーして持ってくる

    先ほど用意したreact-starterから必要なものを持ってくることで最低限となる最初の構築を済ませてしまいます。

    #以下uxp-sampleフォルダ以下にコピーしたもの
    uxp-sample
      ├─plugin
      │  ├─icons # ツール上に表示されるアイコン
      │  └─manifest.json # Pluginとしての情報やツールパネルに関する情報
      ├─src
      │  ├─components # 具体的なパネル内容物のロジック
      │  ├─controllers # 表示されるパネルの種類の制御
      │  ├─panels # Photoshop上で表示されるパネルごとのスクリプト
      │  ├─index.jsx # manifestで定義したものと表示する実態をつなぐ
      │  └─style.css
      └─index.html # ツール起動時の最初のアクセスポイント

    index.htmlの調整

    Photoshopの環境上、headに「<script src="index.js"></script>」を記載しておくことで実行時読み込まれるように対応します。

    <!doctype html>
    <html>
    <head>
      <script>
        global.screen={};
        window.WebSocket.prototype.OPEN = 1;
      </script>
      <!--  type="module" だとphotoshop経由でスクリプトを連携できないので、別途定義している-->
      <script src="index.js"></script>
    </head>
    <body>
      <script type="module" src="/src/index.jsx"></script>
    </body>
    </html>
    <!DOCTYPE html>

    各configファイルの設定

    ビルド後のフォルダ構成をUXP Developer Toolsのテンプレートと揃えるために各configファイルを設定して出力の状態をそろえつつ、TypeScriptで実装するために型の定義等をしていきます。

    vite.config.js

    import { defineConfig } from 'vite'
    import react from '@vitejs/plugin-react-swc'
    import path from 'path';
    import { viteStaticCopy } from 'vite-plugin-static-copy';
    import commonjs from 'vite-plugin-commonjs';
    
    // https://vite.dev/config/
    export default defineConfig({
      plugins: [
        react(),
        commonjs(),
        viteStaticCopy({
          targets: [
            { src: 'plugin/*', dest: '' }  # manifest.json等そのまま使いたいのでcopyで定義する
          ]
        }),
      ],
      build: {
        outDir: path.resolve(__dirname, 'dist'),
        rollupOptions: {
          output: {
            entryFileNames: 'index.js',
            globals: { # Adobe関連はコードの実態を外部から読む必要があるためグローバル設定にしておく
              photoshop: "photoshop",
              uxp: "uxp",
              os: "os",
            },
            format: 'cjs',
          },
          external: [
            "photoshop",
            "uxp",
            "os",
          ],
        }
      },
      resolve: {
        alias: {
          '~': path.resolve(__dirname, './src')
        },
      },
    })

    tsconfig.json

    {
      "compilerOptions": {
        "types": ["node"],
        "baseUrl": ".",
        "paths": {
          "~/*": ["./src/*"],
        },
        "typeRoots": [
          "node_modules/@types",
          "types"
        ],
      },
      .
      . # 省略
      .
    }

    tsconfig.app.json

    {
      "compilerOptions": {
        .
        . # 省略
        .
        "baseUrl": ".",
        "paths": {
          "~/*": [ "./src/*" ]
        },
        "typeRoots": [
          "node_modules/@types",
          "types"
        ]
      },
      "include": ["src"]
    }

    typesの追加

    TypeScriptで書けるように型の定義ですがその方法がいくつかあり、今回はAdobeXDのtypesから取ってきます。
    https://github.com/AdobeXD/typings/blob/master/types/uxp.d.ts

    取ってきたファイルはtypesの定義として配置することで認識させることができます。

    必要パッケージの追加

    configやTypeScriptとしての型定義が必要なものを追加でパッケージとしてインストールします。

    npm i vite-plugin-static-copy
    npm i vite-plugin-commonjs
    npm i --save-dev @types/node
    npm i --save-dev @types/photoshop

    実行確認

    UXP Developer ToolsのAdd Pluginで今回作成したPluginを追加します。
    1度npmでビルドするとその中にmanifest.jsonがあると思うのでこれを選択することでUXP Developer Toolsに表示されます。以降は通常の実行確認と同等の手順で確認していきます。

    画像
    manifest.jsonを選択する

    これでVite + TypeScriptの環境の構築ができました。REALITYではこの環境でPluginとしてPhotoshop向けのツールを制作しています。

    まとめ

    今回はUXPの導入について紹介していきました。
    UXPを導入しての感想は、レイアウトに自由が聞くようになる分見やすいツールが作れるというのはやはりメリットだと感じました。一方でExtendScriptでは使えるがUXPでは公開されてないAPIがあったりとデメリットもあるためその辺りはまた別の機会に紹介できたらと思います。

    最後に

    前回に引き続き、現在REALITYでは積極的に採用活動を行っております!
    REALITYのサービスや開発にご興味をお持ちの方は、ぜひ以下のリンクからご応募ください。お待ちしております!


     
     
    REALITY株式会社は"なりたい自分で、生きていく。"をビジョンに掲げ、バーチャルライブ配信アプリ「REALITY」の運営やバーチャルライブ制作などのライブエンターテインメント事業を展開しています。 https://reality.inc/