カスタム防具装飾のソースを表示

この記事では、[[防具装飾]]をカスタマイズする方法について解説する。

== 概説 ==
''Minecraft''では、[[データパック]]と[[リソースパック]]を用いて任意の模様や色の防具装飾を追加することができる。防具装飾の模様はデータパック内の{{cd|data/<名前空間>/trim_pattern}}に、色は{{cd|data/<名前空間>/trim_material}}に、それぞれ[[JSON]]ファイルとして保存されている。ここで定義された防具装飾は、リソースパックの{{cd|assets/texture/trim}}下のフォルダのテクスチャファイルを参照して実装される。

このままでも[[Player.datフォーマット#防具装飾|防具装飾のNBTタグ]]を編集したアイテムを{{cmd|give}}などのコマンドで与えることでその防具装飾を利用することはできるが、さらに鍛冶から作成できるようにするには[[レシピ (システム)|レシピ]]の定義が必要となる。

== 模様 ==
防具装飾の模様は、{{cd|data/<名前空間>/trim_pattern}}内の[[JSON]]ファイルによって以下のフォーマットに従って定義されている。

<div class="treeview">
* {{nbt|compound}}: ルートタグ。
** {{nbt|string|asset_id}}: この模様に対して参照するテクスチャファイルなどのファイル名に使用する文字列。後項「[[#テクスチャ|テクスチャ]]」も参照。
** {{nbt|string|template}}: この模様を施すために必要なアイテムのID。「[[レシピ_(システム)#smithing_trim|レシピ]]」の記事も参照。レシピを追加しない場合も必須である。
** {{nbt|string}}{{nbt|bool}}{{nbt|list}}{{nbt|compound|description}}: 防具装飾された防具アイテムにカーソルを翳した際に表示される使用素材名のテキストを定義する[[Raw JSONテキスト]]。バニラでは{{cd|trim.pattern.<名前空間>.<asset_id>}}の形式のキーで定義された被翻訳テキストが使用されている。
** {{nbt|bool|decal}}: {{cd|true}}に設定すると元々の防具のテクスチャが透明な部分にも防具装飾の模様を適用する。デフォルトは{{cd|false}}である。
</div>

== 色 ==
防具装飾の模様は、{{cd|data/<名前空間>/trim_material}}内の[[JSON]]ファイルによって以下のフォーマットに従って定義されている。

<div class="treeview">
* {{nbt|compound}}: ルートタグ。
** {{nbt|string|asset_name}}: この色に対して参照するカラーマップのファイル名に使用する文字列。後項「[[#テクスチャ|テクスチャ]]」も参照。
** {{nbt|string|ingredient}}: この色の装飾を施すに必要なアイテムのID。「[[レシピ_(システム)#smithing_trim|レシピ]]」も参照。レシピを追加しない場合も必須である。
** {{nbt|compound|description}}: 防具装飾された防具アイテムにカーソルを翳した際に表示される使用素材名のテキストを定義する[[Raw JSONテキスト]]。バニラでは{{cd|trim_material.<名前空間>.<asset_name>}}の形式のキーで定義された被翻訳テキストが使用されている。
** {{nbt|compound|override_armor_materials}}: 特定の素材の防具に対して使用するカラーマップを変更するためのフィールド。防具の素材名（{{cd|d=and|leather|chainmail|iron|gold|diamond|netherite|turtle}}の何れか）と使用するカラーマップの名前の組を列挙する。
*** {{nbt|string|<防具の素材名>}}: カラーマップの名前。これをもとに{{nbt|string|asset_name}}と同様の仕組みで参照するカラーマップを決定する。
</div>

== テクスチャ ==
{{see also|テクスチャ#palleded_permutations}}
防具装飾には'''模様のテクスチャ'''、'''パレットのキー'''、'''カラーパレット'''の3種類のテクスチャと'''テクスチャアトラス'''の設定ファイルが必要である。
=== 模様 ===
模様のテクスチャは{{cd|assets/<名前空間>/textures/trim/model/armor}}に保存する。模様一種類につき、テクスチャファイルは{{cd|<asset_id>.png}}と{{cd|<asset_id>_leggings.png}}の2つが必要である。前者は最外層に位置するヘルメット、チェストプレート、ブーツの模様、後者はその一つ内側に位置するレギンスの模様を指定するテクスチャである。

これらの模様テクスチャは後述の[[#パレットのキー|パレットのキー]]に使用されている色を用いて描く。
<gallery>
Trim pattern.png|テクスチャファイルの雛形。
Trim pattern description.png|雛形の説明画像。
</gallery>

=== パレットのキー ===
パレットのキーは、模様テクスチャに使用されている色とカラーマップの色を結び付けるための画像である。

模様テクスチャはパレットのキー上に存在する色を用いて描く。カラーマップはパレットのキーと同じ形の画像である。模様テクスチャを色ごとに染色する際には、模様テクスチャの各ピクセルが、パレットのキー上の同じ色のピクセルと同じ位置にあるカラーパレット上のピクセルの色で彩色される。

デフォルトで使用されている{{cd|trim_pallete.png}}は縦1、横8ピクセルの画像であり、色は左から{{cd|d=、|#E0E0E0|#C0C0C0|#A0A0A0|#808080|#606060|#404040|#202020|#000000}}である。

=== カラーマップ ===
カラーマップのテクスチャは{{cd|assets/<名前空間>/textures/trim/colormap}}に{{Cd|<asset_name>.png}}という名前で保存する。上述の通りパレットのキーと同型の画像でなければならない。

=== テクスチャアトラス ===
新しい防具装飾を追加した場合は本来バニラで使用しないテクスチャファイルを使用することになるので、テクスチャアトラスを編集して必要な画像を追加するよう設定しなければならない。テクスチャアトラスの仔細な仕様は[[テクスチャ#テクスチャアトラス|こちら]]を参照。防具装飾の際に必要なファイルとその内容は以下の通り。

; {{cd|assets/<名前空間>/atlases/armor_trims.json}}
<syntaxhighlight lang="JSON">
{
    "sources": [
        {
            "type": "paletted_permutations",
            "textures": [
                "<名前空間>:trims/models/armor/<assets_id>",
                "<名前空間>:trims/models/armor/<assets_id>_leggings"
            ],
            "palette_key": "<使用するパレットのキーのパス>",
            "permutations": {
                "<assets_name>": "<名前空間>:trims/color_palettes/<assets_name>"
            }
        }
    ]
}
</syntaxhighlight>
この[[JSON]]ファイルは追加された色・模様に対応する染色後のテクスチャを生成するのに必要。

模様のみを追加した場合は{{nbt|list|textures}}には追加した模様分を、{{nbt|object|permutations}}にはデフォルト含めたすべての色の分を入力する。色　のみを追加した場合は{{nbt|list|textures}}にはデフォルト含めたすべての模様分、{{nbt|object|permutations}}には追加した色分を入力する。模様と色の両方を追加した場合は全ての模様、色分を入力する必要がある。

; {{cd|assets/<名前空間>/atlases/blocks.json}}
<syntaxhighlight lang="JSON">
{
    "sources": [
        {
            "type": "paletted_permutations",
            "textures": [
                "trims/items/leggings_trim",
                "trims/items/chestplate_trim",
                "trims/items/helmet_trim",
                "trims/items/boots_trim"
            ],
            "palette_key": "trims/color_palettes/trim_palette",
            "permutations": {
                "<assets_name>": "trims/color_palettes/<assets_name>"
            }
        }
    ]
}
</syntaxhighlight>
この[[JSON]]ファイルは、色を追加した場合に対応する防具のアイテムアイコンを生成するために必要である。模様のみを追加した場合は必要ない。{{nbt|object|permutations}}には追加した色分を全て入力する。

== 歴史 ==
{{History|Java}}
{{History||1.19.4|snap=23w04a|データパックにディレクトリ{{cd|trim_material}}と{{cd|trim_pattern}}が追加された。}}
{{History|||snap=23w05a|この素材で防具装飾を施すことが出来ない防具の素材（例：鉄製装飾なら鉄の防具など）を定義していた{{nbt|string|incompatible_armor_material}}が{{cd|trim_material}}から削除された。
|代わりに、防具が特定の素材である際に別のカラーパレットを使用するよう指定するためのフィールド{{nbt|compound|override_armor_materials}}が{{cd|trim_material}}に追加された。}}
{{History||1.20.2|snap=23w33a|元々の防具のテクスチャが透明な部分にも防具装飾の模様を適用するかどうかを設定するフィールド{{nbt|bool|decal}}が{{cd|trim_pattern}}に追加された。}}
{{History|foot}}

== 脚注 ==
{{Data packs}}
{{デフォルトソートキー:かすたむほうくそうしよく}}