MODの書式(Ver0.4 ~ )

MOD用のテキストの書き方とフォルダ構成について解説しています。テキストの書式を理解して手元に３Dモデルがあれば、MODは５分もあれば作成できます。

概要

きりたんキャッスルでは現在「見た目変更MOD」にのみ対応しています。指定された名前のフォルダの中に、txtとglbファイルを入れるだけで簡単に見た目変更MODが作れます。

１,フォルダを作る

親フォルダを１つ作り、その中に３つのフォルダ（Decorations,Buildings,Units）のうちどれか１つのフォルダを作ってください。（３つとも作ってもかまいません）

２,glbファイルを用意する

glb形式の３Dモデルを用意して、今作ったフォルダに入れてください。glbは広く使われている形式なので、blenderなどから簡単に出力できます。MagicaVoxelで作成したボクセルモデルを使いたい場合、一度obj形式で出力した後blenderで読み込み、そのままglbに変換してください。

別のゲームですが、マインクラフトの中で作ったものもglbで出力できます。やり方については「Minecraft ストラクチャーブロック」あるいは「マインクラフト glb」などで検索してみてください。

またSketchfabなどの3Dモデル共有サイトにはCC0もしくはCCBYのライセンスで多くのglbファイルが公開されています。
Sketchfabのリンク[sketchfab.com]
(Sketchfabの場合、このダウンロードボタンを押すとモデルの３D形式を選ぶパネルが出るので、)

（その中からGLBと書かれたものを選び、「DOWNLOAD」ボタンを押すとglb形式のモデルが手に入ります）

３．txtファイルを入れる

glbファイルを入れたフォルダにtxtファイルを入れてください。txtはメモ帳などから作成してください。

最初はUnitsかDecorationsの追加が簡単です（具体的な例はワークショップの中にあるModSampleをダウンロードして、C:\Program Files (x86)\Steam\steamapps\workshop\content\2455610の中にできたフォルダの中を見てみてください）。MODとして公開する前に自分の環境で試したいときは、以下のようにしてください。

例：

• 1:C:\Program Files (x86)\Steam\steamapps\workshop\content\2455610にTestというフォルダを作る。
  
• 2: その中にDecorationsという名前のフォルダを作る。
  
• 3:適当な名前のtxtを作って入れる。txtには以下のように書く
  
• 「Model,test.glb」
  
• 4. Decorationsフォルダの中にtest.glbという名前で３Ｄモデルを入れる。
  
• 5.ゲームを起動して飾り建物を置こうとすると、test.glbを置けるようになっている。

UnitsやBuildingsフォルダの場合でも同様にテストできます。

以下はtxtの書式です。左側にキーワードを書き、カンマで区切ったあと右側にファイル名などを書いてください。

【Decorationsの中に入れるtxtの書式】

• Model, //飾り建物に使うglb形式のモデル
  
• Sprite, // UIに表示するボタン画像(128 * 128)
  
• Scale,　//表示するときの倍率 (float)
  
• Position,　//表示するときの座標補正値 (Vector3)
  
• Rotation,　//表示するときの回転補正値 (Vector3)

【Unitsの中に入れるtxtの書式】

• Base,　//見た目を上書きしたいたユニットの日本語名。刀兵と書くと刀兵の見た目が変わります。
  
• Model,　//見た目に使うglb形式のモデル
  
• Scale,　//表示するときの倍率 (float)
  
• Position,　//表示するときの座標補正値 (Vector3)
  
• Rotation,　//表示するときの回転補正値 (Vector3)
  
• Head,　//頭パーツを個別に使う場合、ここにglb形式のモデル名を書きます
  
• Body,　 //胴パーツを個別に使う場合、ここにglb形式のモデル名を書きます
  
• LeftHand,　 //左手パーツを個別に使う場合、ここにglb形式のモデル名を書きます
  
• RightHand,　 //右手パーツを個別に使う場合、ここにglb形式のモデル名を書きます
  
• LeftFoot,　 //左足パーツを個別に使う場合、ここにglb形式のモデル名を書きます
  
• RightFoot,　 //右足パーツを個別に使う場合、ここにglb形式のモデル名を書きます

【Buildingsの中に入れるtxtの書式】

• Base, //見た目の変更元建物の日本語名。農家と書くと農家建設時にFキーで見た目を変えられます
  
• Model, //見た目に使うglb形式の3Dモデル
  
• Scale, //表示するときの倍率 (float)
  
• Position, //表示するときの座標補正値 (Vector3)
  
• Rotation, //表示するときの回転補正値 (Vector3)
  
• AdditionalY, //ずんだもんたちが建物の上を通るときの高さ補正
  
• DependsTech, //必要技術。「,」で区切ると複数列挙可能です。
  
• UnitPositions, //配置した兵士の位置です。(x,y,z),(x,y,z)のように書きます。
  
• Type, //櫓はYagura,門はGate,壁はWallと書いてください。
  
  
• WorkPositions,　//生産作業時のずんだもんが表示される位置です
  
• WorkMotions,　//生産作業時のずんだもんのモーション名です
  
• WorkRotations, //生産作業時のずんだもんの角度です
  
• WorkerType,農家 //生産ずんだもんの種類です
  
  
• RecipeName,お米を作る, //レシピの名前です。レシピを設定するときは必ずこれを先頭に置いてください。
  
• RecipeNeeds,(水,1),(米,1) //レシピに必要なアイテムです。(アイテム名,個数)で書きます
  
• RecipeProducts,(米,20) //レシピで生産されるアイテムです。(アイテム名,個数)で書きます
  
• RecipeWorkLoad,10 //レシピに必要な労力です。
  
  
• BuildPositions,　//建設時のずんだもんが表示される位置です
  
• BuildMotions,　//建設時のずんだもんのモーション名です
  
• BuildRotations,　//建設時のずんだもんの角度です
  
• BuildNeeds, //建設時の材料 例：(木材,2),(水,3)
  
• BuildWorkLoad, //建設時の必要労力
  
  
  
• CanBeWorkerSpawner, //ワーカーのスポーン地点になるか（1ならtrue）
  
• CanBeStorage,//倉庫になるか（1ならtrue）
  
• Attribution,//建物の属性。農業施設にはagricultureのタグがふられている
  
  
• SpawnCount, //兵士を何人スポーンさせるか
  
• SpawnName, //スポーンさせる兵士の名前
  
• MaxSoldier, //兵士をこの建物に何人配備できるか
  
  
• WorkSpeedAffectTarget,　//労働効率を上げる対象施設。Attribution名で指定
  [*} WorkSpeedAffectValue, //労働効率をどれぐらいの数値上げるか
  
• WorkSpeedAffectRange,//労働効率を上げる範囲
  
  
• Model_Spring,　//春になったときの建物の見た目です
  
• Model_Summer,　//夏になったときの建物の見た目です
  
• Model_Autumn,　//秋になったときの建物の見た目です
  
• Model_Winter,　//冬になったときの建物の見た目です

MODのアップロード

ゲーム内タイトル画面の、宝箱のところから「アップロード」を選び、アップしたいフォルダを選択してください。アップする際はサムネイル画像として"ModMain.png"をフォルダに入れておく必要があります。

アップが完了したらsteamアプリから自分のワークショップを確認してください。そこでMODの説明文や画像を整えて、公開をすると、他のプレイヤーからも利用できる状態になります。

MODの更新

１度MODとしてアップしたフォルダにはWorkshopItemInfo.xmlが生成されます。そのWorkshopItemInfo.xmlを入れた状態で再度そのフォルダをアップロードすると、自動的にすでにアップロード済みのMODが更新されます。もしWorkshopItemInfo.xmlが入ったフォルダを削除してしまった場合は、自身のアップロード済みMODをダウンロードしてもらえれば、中にWorkshopItemInfo.xmlが入っているので、それを更新用のフォルダに入れてください。

オリジナルキャラクターをゲームに追加しよう

以下のテンプレートをtxtファイルに保存し、そのtxtをUnitsフォルダに入れてください。そのうえで一部を変えることで簡単にユニットを追加できます。

• ①Baseのところに元にしたいキャラクターの日本語名を書いてください。基本的にはモーションと背中の旗の有無が変わるだけです。破城槌のようなキャラクターは選択しないでください。
  
• ②Nameのところにオリジナルキャラクターの名前を入れます。現時点では他の方とかぶると上書きされますが、いずれ上書きされないように修正します。
  
• ③Modelのところにglbファイルの名前を書きます。そのglbファイルはUnitsフォルダに入れてください。
  
• ④EnemyAttributionsのところに、オリジナルキャラクターがどの襲撃に参加するか書きます。Bandit,Ashigaru,Samurai,Ninjaがあります。複数書いた場合、どちらの襲撃にも参加します。現時点で仲間キャラクターにオリジナルキャラクターを入れることはできません。

[テンプレート]

Base,野盗弓
Name,
Model,
Scale,1
Position,(0,0,-0.6)
Rotation,
Head,
Body,
LeftHand,
RightHand,
LeftFoot,
RightFoot,

WeaponPosition
HeadPosition
BodyPosition
LeftHandPosition
RightHandPosition
LeftFootPosition
RightFootPosition
HeadScale
BodyScale
LeftHandScale
RightHandScale
LeftFootScale
RightFootScale
ColliderScale

HP,100
Atk,4
AtkToBuilding,2
AtkSpeed,100
MoveSpeed,100
SwimSpeed,10
ClimbSpeed,30
FrontDefense,10
SideDefense,0
BackDefense,0
TopDefense,0
Penetration,0
WeaponType,4
Range,8
RaidCost,2
EnemyAttributions,Bandit

[テンプレート終わり]

※RaidCostが低いと襲撃にたくさん登場します。高いと登場する数が少なくなります。弱いキャラはRaidCostを低くし、強いキャラはRaidCostを高くするとバランスが取れます。RaidCostが高いとゲームがある程度進まないと敵として登場しません。
※WeaponTypeは1が刀,2が槍,3が槌,4が弓,5が銃,6が大砲,７が破城槌です。武器種にあった数字を入れてください。
※Modelのところを空白にする代わりにHeadなどに各パーツのglbを読み込ませることができます。

[Graiton306]

作成できました。回答ありがとうございます！

[KC Project]

ポートレイトというのはMODのトップ画像のことでしょうか。ModSample.pngという名前の画像をアップするフォルダに入れておけばそれが自動でポートレイトの画像になります。特にサイズの決まりなどはありません。
またアップ完了時は最初は非公開状態でアップされるので、一度Steamに上げたあと、Steam上で画像を変えたり、説明文を書くなど自由に形を整えてから公開することが可能です。

[Graiton306]

ゲーム内でポートレイトを表示する用の画像ファイルを指定するテンプレートはありますでしょうか？
またその場合の画像ファイルのサイズ等のどういった形式のものを用意すればいいでしょうか？