PlantUML 編を前回で最終回にできませんでした。大事なことを書いてません。PlantUML のインストールの仕方とソースファイルを画像ファイルに変換するためのプログラムの実行方法です。
PlantUML は Java というプログラミング言語で書かれたプログラムなので Java で書かれたプログラムを実行するための Java の実行環境が必要です。Java の実行環境がパソコンにインストールされていないと通常は PlantUML を動かす方法がありません。
なので本来なら最初に Java の実行環境をインストールするのですが、現時点で一般ユーザ向けとしてはアンオフィシャルではあるものの、実は実行可能形式の PlantUML が GitHub 上の PlantUML 公式リポジトリで提供されています。
ここでのアンオフィシャルという言葉の意味は公式サイトから直接ダウンロードリンクが貼られていないという意味でのアンオフィシャルです。なので公式プロジェクトとしてリリースしていることになんらかわりはありません。
ダウンロードは 公式プロジェクトの GitHub リポジトリのリリースページから行います。
実行可能ファイルなので Java 実行環境のインストールを考えなくてすむので楽チンです。ダウンロードページの "Release - Native Image (バージョン名)" と書かれたもののうち最新のバージョンをダウンロードすれば良いわけです。
表示されているリリースの Assets をクリックすると、あるいはクリックしなくても、各ファイルをダウンロードできるリンクがずらっと出てきます。そこから自分が使っている OS の zip ファイルをダウンロードすればいいわけです。
一般的な Windows ユーザなら以下のいずれかの zip ファイルをダウンロードすればよいでしょう。
1.2025.2 などと書かれたところがバージョンになります。
plantuml-full-******.zip という zip ファイルに実行可能形式の Plantuml-full.exe というファイルと実行に必要な DLL 一式が同梱されています。
zip ファイルを好きなフォルダに展開し、そのフォルダーへのパスを環境変数 PATH に追加すればインストールはおしまいです。
後は
plantuml-full -tsvg ソースファイル名または
plantuml-headless -tsvg ソースファイル名などとしてやればソースファイルから画像ファイルを作ることができます。
この実行ファイルですが、どのレイアウトエンジンが含まれているのかがドキュメントとしては公開されていません。ですからどのレイアウトエンジンが含まれているのか気になるかと思います。ですがどのレイアウトエンジンをサポートしているかを実際に図を作らなくても知る方法があります。
plantuml-full -licenseまたは
plantuml-headless -licenseを実行してください。zip ファイル同梱品のライセンスが表示されます。
2025/04/08 時点でのライセンスが GNU Public License version 2 (GPLv2) であることがわかります。PlantUML の公式サイトのダウンロードページを見ると GPLv2 のパッケージには GraphViz、Ditaa、Jcckit、Sudoku の 4 つのレイアウトエンジンが同梱されていることがわかります。ELK が含まれていないのは恐らく GPLv2 と EPL にライセンス上の互換性がないのでしょう。
full 版と headless 版の違いについても述べておいた方がいいかもしれません。違いはごく僅かで full 版には GUI が同梱されていて、headless 版には GUI が含まれておらず CLI で使うことになるという違いがあります。
ならば full 版一択という気持が湧いてきそうですが GUI と言ってもファイルセレクタがあるだけで出力画像形式すら選ぶこともできません。ソースファイルを選んだ瞬間同一名の png ファイルがいきなり生成されます。他の画像フォーマットを選ぶことはできません。
また隠しフォルダにアクセスすることもできません。隠しフォルダではないフォルダでソースファイルを選ぶことができるだけのかなり寂しい GUI なので、それでもかまわない、それで充分という場合であるのなら選んでもいいかと思います。
full 版であっても headless 版と同じように CLI 環境で CLI のプログラムとして使うこともできます。ですがそれならサイズの小さめの headless 版で充分ではないか？とも思います。
さてもしあなたが ELK レイアウトエンジンを使いたいとします。もしそうであれば少し面倒かもしれませんが Java 実行環境と GPLv3 版あるいは EPL 版の PlantUML をインストールしなければなりません。先程述べたように GPLv2 版にはおそらくライセンスの関係で ELK レイアウトエンジンは含まれていません。ELK レイアウトエンジンを使うなら Java 実行環境をインストールし、GPLv3 版もしくは ELP 版の PlantUML をダウンロードしてインストールする必要があります。
その場合 PlantUML のインストール方法も実行方法も少し変わりますので、以下に説明していきます。
最初に Java 実行環境をインストールします。Java 実行環境には Oracle No-Fee Terms and Conditions (NFTC) 版の JDK と GNU Public License version 2 版の OpenJDK の 2 つがあります。Java の実行環境としては同一だということなのでインストールが楽な NFTC 版の JDK の方を選んでインストールすればよいでしょう。
インストーラ形式としては exe と msi がダウンロード可能になっていますが、どちらをダウンロードしても問題はないでしょう。Java 実行環境はサイズが大きいのでインストールには少し時間がかかります。コーヒーでも飲みながらインストールが終るのを待ちましょう。
JDK のインストールが終ると端末上で jar ファイルを実行することができるようになっています。もしかすると今でもパソコンの再起動が必要かもしれません。もしそのようなメッセージが表示されたのならそのメッセージに従ってください。
次に GPL 版または ELP 版の PlantUML の jar ファイルを PlantUML 公式サイトのダウロードページから好みのフォルダにダウンロードします。ダウンロードしたフォルダがどこなのかを覚えておいてください。
また繰返しますがダウンロードページのサポートレイアウトエンジンの表は最新の状態になっていません。バージョン 1.2024.6 以降の GPL 版 (GPLv3 版)には ELK レイアウトエンジンも含まれています。
実行方法は通常の jar ファイルと同じです。以下のように実行します。
# バージョンが 1.2025.2 の場合
java -jar plantuml-1.2025.2.jar -tsvg ソースファイル名上の例では plantuml-1.2025.2.jar とソースファイルが共にカレントディレクトリにあるという想定になっています。plantuml-1.2025.2.jar やソースファイルが他のディレクトリにある場合はそれぞれパス指定してください。絶対パスでも相対パスでもかまいません。
それがいちいち面倒な場合はバッチファイル化するなど各自工夫してください。
これで今度こそ本当に PlantUML のお話は最終回となります。次回からは GraphViz のお話になります。