ディレクトリ構成とファイル名

このページでは、RealTrainMod (RTM)のモデルパックの全体のディレクトリ（フォルダ）構成について説明します。

全体ディレクトリ構成

モデルパック全体の一般的なディレクトリ構成は以下のようになります。このディレクトリ構成はあくまでも一例であり、完全にこの通りである必要はありませんが、いくつかの必ず従わなければならない制約があります。

また、将来のアップデートや過去バージョンとの互換性を確保するために、この例から大きく外れないようにすることを推奨します。

ヒント

このファイルツリーは、ディレクトリごとに折り畳みをすることができます。

各項目をクリックすると、その傘下のファイルやディレクトリを非表示にすることができます。各項目の左にある三角のアイコンは、その傘下の折り畳み状況を示しており、「▼」の場合には展開中、「▶」は折り畳み中を表しています。

また、色付きでマークされているファイル名やディレクトリは、その名前や配置箇所に制約があることを示しています。

• 目錄[RTM]SomeModelPack.zip モデルパックファイル名 名前制約あり

  • LICENSE.txt 適用するライセンス
  • README.txt 使い方の説明や確認事項など
  • pack.json アップデート通知設定ファイル 名前変更不可
  • 目錄assets 名前変更不可

    • 目錄minecraft 名前変更不可

      • 目錄json JSON配置場所1

        • Model*_*.json モデル設定用JSONファイル（.json） 名前制約あり
      • 目錄models 名前変更不可

        • *.mqo 3Dモデルファイル（.mqo）
        • *.mqoz 3Dモデルファイル（.mqoz）
        • *.obj 3Dモデルファイル（.obj）
        • *.ngto MCTEブロックデータ（.ngto）
        • *.ngtz MCTEブロックデータ（.ngtz）
        • 目錄json JSON配置場所2

          • ModelTrain_*.json 列車モデル設定用JSONファイル（.json） 名前制約あり
          • ModelMachine_*.json 機械モデル設定用JSONファイル（.json） 名前制約あり
          • Model*_*.json モデル設定用JSONファイル（.json） 名前制約あり
      • 目錄scripts

        • *.js スクリプトファイル（.js）
      • 目錄textures 名前変更不可

        • 目錄rrs

          • rrs_*.png 鉄道標識用画像ファイル（.png） 名前制約あり
        • …
        • 目錄train 列車モデルのテクスチャ

          • 目錄* テクスチャファイルのディレクトリ（車両形式ごと）

            • button_*.png ボタンのテクスチャファイル（.png）
            • *.png 車両のテクスチャファイル（.png）
    • 目錄sound_* 名前制約あり

      • 目錄sounds 名前変更不可

        • *.ogg 音声ファイル（.ogg）
      • sounds.json 音声イベント設定ファイル（.json） 名前変更不可
  • 目錄mods

    • 目錄RTM

      • 目錄json JSON配置場所3

        • Model*_*.json モデル設定用JSONファイル（.json） 名前制約あり

ファイル名、ディレクトリ名の制約

ファイル・ディレクトリ名には、マルチバイト文字及び一部を除く記号は使用できません。一部のバージョンでは使用できる例もありますが、使用できないバージョンでの動作を考慮して使用すべきではありません。

安全に使用できる記号としては、ハイフン-（U+002D）やアンダーバー_（U+005F）などがあります。

重要

これら制約は、モデルパックで利用しないファイル、ディレクトリに対しても同様です。使用・不使用にかかわらず、1つでも制約に違反しているファイル・ディレクトリがある場合、ゲームが起動できない可能性があります。

モデルパックファイルの名前

モデルパックファイルの名前は、モデルパックを利用するすべてのユーザーが目にする名前です。多数のモデルパックの中から区別できるように、端的でわかりやすい名前にする必要があります。

また、ファイル名先頭の[RTM]は、ファイルがRTMのモデルパックであることを示す記号として設定されています。この記号を削除してもモデルパックは動作しますが、一部機能が無効になるため、変更しないことを推奨します。

注意

モデルパックファイル名にマルチバイト文字を使用しても動作しますが、環境によって容易に文字化けを発生させモデルパックを識別困難にするため、推奨しません。

各ファイルの詳細

各ファイルの配置場所とファイル名の詳細を説明します。

3Dモデルファイル

制約

必ず/assets/minecraft/models/ディレクトリ内に配置する必要があります。

ベストプラクティス

多くの場合、models/ディレクトリ直下、または車両名や形式名、制作者名などを冠したサブディレクトリに配置します。

ファイル名は、歴史的な理由によりモデル設定用JSONファイルと同様の接頭辞が付けられることもあります。

例

• 目錄assets

  • 目錄minecraft

    • 目錄models 必ずこのディレクトリ以下に配置する必要がある。

      • series-1000_Tc.mqo 直下に配置する例
        小規模なモデルパックで用いられることが多い
      • 目錄series-01 車両形式で分類する例
        複数形式を収録したモデルパックで用いられることが多い

        • series-01_Tc.mqo
        • series-01_M.mqo
        • ModelTrain_series-01_T.mqo モデル設定用JSONファイルと同様の接頭辞を付与する例
          特に古いモデルパックに多い
      • 目錄john-smith 制作者の名前で分類する例
        1000系・01形などありふれた名前の形式の場合には競合する可能性があるため、制作者の名前を付与することがある

        • series-02_Tc.mqo

テクスチャファイル

制約

必ず/assets/minecraft/textures/ディレクトリ内に配置する必要があります。

ベストプラクティス

多くの場合、textures/ディレクトリ直下には配置せず、列車モデルの場合にはtextures/train/ディレクトリ、レールの場合にはtextures/rail/ディレクトリ内など、モデルの種類に対応するサブディレクトリに配置します。これは、バニラのMinecraftディレクトリ構成と同様にするためだと考えられます。

また、3Dモデルファイルと同様に、車両名や形式名、制作者名などを冠したサブディレクトリに配置することもあります。

ボタンテクスチャファイルについては、独立したディレクトリにまとめて配置することもあります。ファイル名には、接頭辞button_を付与し、モデルのテクスチャと区別する例もあります。

例

• 目錄assets

  • 目錄minecraft

    • 目錄textures 必ずこのディレクトリ以下に配置する必要がある

      • 目錄train 列車モデルで使用するディレクトリ名
        ディレクトリ内は3Dモデルファイルと同様の構成にすることが多い

        • 目錄series-01

          • series-01_Tc.png
          • series-01_M.png
          • button_series-01_Tc.png 接頭辞を使用しボタンテクスチャを区別する
        • 目錄john-smith

          • series-02_Tc.png
          • 目錄button ボタンテクスチャを独立したディレクトリにすることもある

            • button_series-02_Tc.png
        • 目錄button ボタンテクスチャを独立したディレクトリにすることもある

          • series-01_M.png

音声ファイルと音声イベント設定用JSONファイル

制約

音声ファイルは、必ず/assets/sound_*/sounds/ディレクトリ内に配置する必要があります。

音声イベント設定用JSONファイルは、必ず/assets/sound_*/ディレクトリの直下に配置する必要があります。また、ファイル名は必ずsounds.jsonである必要があります。
モデルパックの統合などで、複数の音声イベント設定用JSONファイルが必要な場合には、別のsound_*ディレクトリに配置する必要があります。

sound_*ディレクトリは、必ず接頭辞sound_を使用する必要があります。

ノート

RTMでは、複数のsound_*ディレクトリを使用して名前空間（ドメイン）を区別し、音声の競合を防ぐシステムが採用されています。

そのため、音声イベント設定用JSONファイルと、そこで使用する音声ファイルは、同じ名前空間内にある必要があります。

ベストプラクティス

音声ファイルは、多くの場合sounds/ディレクトリ直下にそのまま配置しますが、サブディレクトリに配置して分類することもできます。

音声イベント設定用JSONファイルは、制約が厳しいため、選択の余地はありません。

例

• 目錄assets

  • 目錄sound_series-01 このディレクトリ名は必ず接頭辞sound_を使用する必要がある

    • sounds.json 名前変更不可
    • 目錄sounds 必ずこのディレクトリ以下に配置する必要がある

      • door_open.ogg
      • 目錄announce サブディレクトリに配置することもできる

        • arrive-at-station.ogg
  • 目錄sound_series-02 複数のsound_*ディレクトリを使用することもできるが、相互間での参照は不可能

    • sounds.json この音声イベント設定用JSONファイルから、sound_series-01内の音声ファイルを指定することはできない

スクリプトファイル

制約

必ず/assets/minecraft/ディレクトリ内に配置する必要があります。

ベストプラクティス

多くの場合、minecraft/ディレクトリ直下には配置せず、minecraft/scripts/ディレクトリに配置します。

ファイル名は、スクリプトの種類を表す接頭辞（render_, server_など）を付与して分類することもあります。

例

• 目錄assets

  • 目錄minecraft 必ずこのディレクトリ以下に配置する必要がある

    • 目錄scripts 多くの場合script/ディレクトリ内に配置する

      • render_series-01.js
      • server_series-01.js
      • sound_series-01.js

モデル設定用JSONファイル

制約

ファイルの配置箇所に制約はありません。すべての箇所に配置することができます。

ファイル名は、モデル種類を表す接頭辞Model*_を付与する必要があります。

ベストプラクティス

ほとんどの場合、以下のディレクトリのいずれかの中に配置します。

1. /assets/minecraft/json/ディレクトリ

   他のモデルファイルやテクスチャファイルと同じディレクトリに配置することで、同列に管理できるという利点があります。

   例

   • 目錄assets

     • 目錄minecraft

       • 目錄json

         • ModelTrain_series-01_Tc.json
         • ModelTrain_series-01_M.json

2. /assets/minecraft/models/json/ディレクトリ

   RTM本体で採用されている設定ファイルの配置場所です。

   例

   • 目錄assets

     • 目錄minecraft

       • 目錄models

         • 目錄json

           • ModelTrain_series-02.Tc.json

3. /mods/RTM/json/ディレクトリ

   最も採用モデルパックが多いと思われる配置箇所です。

   例

   • 目錄mods

     • 目錄RTM

       • 目錄json

         • ModelTrain_series-02_M.json

音声イベント設定用JSONファイル

音声ファイルと音声イベント設定用JSONファイルを参照してください。

アップデート通知設定用JSONファイル

制約

必ず最上位のディレクトリに配置する必要があります。

ファイル名は、必ずpack.jsonである必要があります。

• 目錄[RTM]SomeModelPack.zip

  • pack.json
  • …