README_ja.md

AkyuiUnity

AkyuiUnityは、AkyuiのUnity実装です。
AkyuiUnity.Xdと合わせて使うことで、簡単にAdobe XDファイルからUnityのPrefabを生成することが出来ます。

Read this document in other languages: English

---

AkyuiUnity / AkyuiUnity.Xdとは？

そもそも、Akyuiとはkyubunsが作ったUI定義ファイルのフォーマットのことです。
AkyuiUnityは、AkyuiからUnityPrefabを生成することが出来、
AkyuiUnity.Xdは、XDファイルをAkyuiに変換することが出来ます。
この2つを組み合わせることで、Akyuiを意識することなく、XDファイルからUnityPrefabを生成することが出来ます。

特徴

インポートがUnityのみで完結する

• XDファイルをドラッグ&ドロップするだけ。
  • インポートするために、わざわざAdobe XDを開く必要はありません。
• 全てがUnity上で完結するため、ビルドマシンなどに任せることも出来ます。

XDファイルの更新に追従できる

• デザイナーはずっとAdobe XD上でUI制作を続けることが出来ます。
• 差分だけをインポートするので、2回目以降のインポート時間は短縮されます。

ランタイムに関与しない

• AkyuiUnityが行うのは、あくまでPrefabを作るだけでランタイム時には一切コストはかかりません。

カスタマイズ性が高い

• あなたのプロジェクトにあったPrefabを生成出来るように、簡単にトリガー(拡張スクリプト)を書くことが出来ます。
  • 例えば、以下のようなことはパッケージに含まれているトリガーで実現出来ます。
    • 素材を自動的に9SliceSpriteに変換し、テクスチャを節約する。
    • uGUIのTextではなく、TextMeshProを使う。
    • XDファイル上で特定の名前のオブジェクトはUnityに変換しない。

ユーザーマニュアル

• Manual
• FAQ

インストール方法

UnityPackageManager

• AkyuiUnity https://github.com/kyubuns/AkyuiUnity.git?path=Assets/AkyuiUnity
• AkyuiUnity.Xd https://github.com/kyubuns/AkyuiUnity.git?path=Assets/AkyuiUnity.Xd

ターゲット環境

• Unity2019.4 or later

ライセンス

MIT License (see LICENSE)

スペシャルサンクス

• サンプルに使っているXDファイル
  • https://github.com/beinteractive/Public-Game-UI-XD

Buy me a coffee

もしこのプロジェクトが気に入ったなら、ぜひコーヒーを奢ってください！
https://www.buymeacoffee.com/kyubuns

「ゲームに使ったよ！」

「このゲームにこのライブラリ使ったよ！」という報告を貰えるとめっちゃ喜びます！
メールやtwitterでお気軽にご連絡ください。
(MITライセンスのため、報告は義務ではありません。)
メッセージフォーム

https://kyubuns.dev/