Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 3.63 KB

README_jp.md

File metadata and controls

42 lines (29 loc) · 3.63 KB
Raw

言語: 　English　|　日本語

FiguraAvatarTemplate

MinecraftのスキンMod「Figura」のアバターのテンプレートレポジトリです。

レポジトリ構成

avatar.json

アバターのメタファイルです。これがないとFiguraにアバターとして認識されません（逆にこれさえあればアバターとして認識されます）。ファイル内の構造についてはこちらをご覧下さい。

avatar.png

アバターのサムネイル画像です。アバターリストに表示されます。

models

アバターのモデルファイルが格納されるディレクトリです。モデルはBlockbenchで作成します。

textures

アバターのモデルのテクスチャファイルが格納されるディレクトリです。

scripts

アバターのスクリプトファイルが格納されるディレクトリです。言語はLuaです。Figuraが提供するLua APIについてはこちらをご覧下さい。

.github

READMEファイルやGithub Actionsのワークフローファイル等が格納されるディレクトリです。アバターには関係のないディレクトリです。

.gitignore

アバターのディレクトリをGit管理する上で管理対象外にするファイル/ディレクトリの一覧です。アバターには関係のないファイルです。

READMEの編集について

READMEはGithub Actionsによって、.github/README_templatesから.github/README.mdと.github/README_jp.mdが生成されます。.github/README_templates配下のファイルが変更されるとGithub Actionsが動作する為、READMEを編集する場合は、.github/README_templates配下のファイルを編集して下さい。.github/README.mdや.github/README_jp.mdは編集しないで下さい。Github Actionsによって上書きされます。また、.github/README_templates配下のファイルは削除しないで下さい。Github Actionsのワークフローでエラーが発生します。

README内で画像を挿入する場合は、画像を.github/README_images配下に置いて下さい（例：![画像](./README_images/image.jpg)）。これ以外の画像は、Github Actionsによって処理されません（README生成時にリンクが切れる場合があります）。

READMEにはGithub Actionsによって自動的に挿入されるテンプレート文があります。詳しくはこちらをご覧下さい。

アバターを新規作成した後にやること

  1. このレポジトリの変数にTARGET_BRANCHESという名前でREADMEを生成する対象のブランチの配列を定義する（例：["Senko", "Shiro", "Suzu"]）。
  2. レポジトリ"FiguraAvatarsReadmeTemplate"の変数TARGET_REPOSITORIESに新規アバターのレポジトリを追加する（Gakuto1112のみ）。

アバターのブランチを増やした後にやること

  1. .github/workflows/generate_readme.ymlのon->push->branchesに増やしたアバターのブランチを追加する。
    • ワイルドカードによるブランチの指定が可能であれば、そちらの方が後々楽です。
  2. このレポジトリの変数TARGET_BRANCHESに増やしたアバターのブランチを追加する。