Skip to content

Latest commit

 

History

History
215 lines (194 loc) · 7.54 KB

README_TEMPLATE.md

File metadata and controls

215 lines (194 loc) · 7.54 KB

READMEのテンプレート

使い方

  1. 既にあるREADME.mdを消す
  2. このテンプレートをREADME.mdにリネームする
  3. 水平線より上(この使い方の部分)を消す
  4. $REPONAME$をリポジトリの名前に置換する
  5. Todoのところを書く
  6. 保存してコミット&プッシュ

$REPONAME$

BveEXを使ったBve5またはBve6用のプラグイン Todo: プラグインの概要を書く

プラグインの機能

  • Todo: 機能を列挙

導入方法

Todo: 導入方法を必要に応じて変更

1. BveEXの導入

公式のダウンロードページを参照してください

2. 本プラグインの導入

  1. Releasesから最新版がダウンロードできます
  2. Todo: 配置場所をプラグインの種類に応じて下から選択して変更
# 拡張機能の場合
2. BveExの導入場所にある`Extensions`フォルダの中に本プラグインを配置します
    - デフォルト: `C:\Users\Public\Documents\BveEx\1.0\Extensions`
    - プラグインはBveの起動と同時に読み込まれ、必要に応じて他のプラグインから利用されます

# マッププラグインの場合
2. シナリオフォルダの中に本プラグインを配置します  
    ディレクトリ構成例: 
    ```text
    Scenarios
    ├ MyScenario.txt
    └ MyMaps
      └ SampleMap
        ├ MapPlugins
        │ ├ 本プラグイン($REPONAME$.dll)
        │ ├ OtherPlugin.dll
        │ └ ...
        ├ MapPluginUsing.xml
        ├ Image.jpg
        ├ Map.txt
        ├ Signals.csv
        ├ Sounds.csv
        ├ Sounds3D.csv
        ├ Stations.csv
        └ Structures.csv
    ```
3. `MapPluginUsing.xml`を作成し本プラグインの情報を記入します  
    MapPluginUsing.xml(例): 
    ```xml
    <?xml version="1.0" encoding="utf-8" ?>
    <BveExPluginUsing xmlns="http://automatic9045.github.io/ns/xmlschemas/BveExPluginUsingXmlSchema.xsd">
    	<Assembly Path="MapPlugins\$REPONAME$.dll" />
    	<Assembly Path="MapPlugins\OtherPlugin.dll" />
    </BveExPluginUsing>
    ```
4. マップファイルから参照します  
    Map.txt(例): 
    ```text
    BveTs Map 2.02:utf-8
    
    // BveEX
    include '<BveEx::USEATSEX>';                            // BveEXのプラグインを使うという宣言
    include '<BveEx::READDEPTH>1';                          // BveEXのプラグインを探すディレクトリの深さ
    include '<BveEx::MapPluginUsing>MapPluginUsing.xml';    // 使うプラグインの情報を伝えるファイルの位置
    
    Structure.Load('Structures.txt');
    Signal.Load('Signals.csv');
    Sound.Load('Sounds_e.txt');
    Sound3D.Load('Sounds3D.txt');
    Station.Load('Stations.csv');
    
    0;
    ...
    ```

# 車両プラグインの場合
2. 車両アドオンの中に本プラグインを配置します  
    ディレクトリ構成例: 
    ```text
    Scenarios
    └ MyVehicles
    　 └ SampleVehicle
    　 　 ├ Vehicle.txt
    　 　 ├ Ats
    　 　 │ ├ BveEx.Caller.txt
    　 　 │ ├ BveEx.Caller.x64.dll
    　 　 │ ├ BveEx.Caller.x86.dll
    　 　 │ ├ BveEXPlugins
    　 　 │ │ ├ 本プラグイン($REPONAME$.dll)
    　 　 │ │ └ OtherPlugin.dll
    　 　 │ ├ DetailManager.x64.dll
    　 　 │ ├ DetailManager.x86.dll
    　 　 │ ├ detailmodules.txt
    　 　 │ ├ OtherNormalPlugin.dll
    　 　 │ └ ...
    　 　 ├ Notch
    　 　 │ ├ Notch.txt
    　 　 │ └ ...
    　 　 ├ Panel
    　 　 │ ├ Panel.txt
    　 　 │ └ ...
    　 　 ├ Sound
    　 　 │ ├ Sound.txt
    　 　 │ ├ Motor.txt
    　 　 │ └ ...
    　 　 ├ Parameters.txt
    　 　 └ ...
    ```
3. 設定ファイルを作成し本プラグインの情報を記入します  
    - BveEx.Caller.txt
        ```text
        ..\..\..\BveEx
        ```
    - BveEx.Caller.x86.VehiclePluginUsing.xml: x64と同じ
    - BveEx.Caller.x64.VehiclePluginUsing.xml(例): 
        ```xml
        <?xml version="1.0" encoding="utf-8" ?>
        <BveExPluginUsing xmlns="http://automatic9045.github.io/ns/xmlschemas/BveExPluginUsingXmlSchema.xsd">
        	<Assembly Path="BveEXPlugins\$REPONAME$.dll" />
        	<Assembly Path="BveEXPlugins\OtherPlugin.dll" />
        </BveExPluginUsing>
        ```
    - BveEx.Caller.x86.VehicleConfig.xml: x64と同じ
    - BveEx.Caller.x64.VehicleConfig.xml(例): 
        ```xml
        <?xml version="1.0" encoding="utf-8" ?>
        <BveExVehicleConfig xmlns="http://automatic9045.github.io/ns/xmlschemas/BveExVehicleConfigXmlSchema.xsd">
            <DetectSoundIndexConflict>true</DetectSoundIndexConflict>
            <DetectPanelValueIndexConflict>true</DetectPanelValueIndexConflict>
        </BveExVehicleConfig>
        ```
4. ビークルファイルから参照します  
    Vehicle.txt(例): 
    ```text
    BveTs Vehicle 2.00
    PerformanceCurve = Notch\Notch.txt
    Parameters = Parameters.txt
    Panel = Panel\Panel.txt
    Sound = Sound\Sound.txt
    MotorNoise = Sound\Motor.txt
    Ats32 = Ats\BveEx.Caller.x86.dll
    Ats64 = Ats\BveEx.Caller.x64.dll
    ```

   非BveEXなプラグインと両立する場合は次の通りです
   1. Ats32とAts64でDetailManagerを指定する
   2. detailmodules.txtでBveEx.Callerを指定する

Warning

この項目の内容はすべてが正しい保証がありません 正確な情報を得るには以下を参照してください

使い方

  • Todo: 必要に応じて書く

パネル

Todo: 必要に応じて書く

index 型 機能 備考
ats001 uint 速度絶対値 1km刻みで切り捨て

ライセンス

  • Todo: LICENSEの著作権表示を書き換える
  • Todo: ライセンスを変更する場合にはLICENSEを書き換えた後にここも変更する
  • MIT
    • できること
      • 商用利用
      • 修正
      • 配布
      • 私的使用
    • ダメなこと
      • 著作者は一切責任を負わない
      • 本プラグインは無保証で提供される

動作環境

Todo: 動作環境を必要に応じて変更

  • Windows
    • Win10 22H2
    • Win11 23H2 or later
  • Bve
    • BVE Trainsim Version 5.8.7554.391 or later
    • BVE Trainsim Version 6.0.7554.619 or later
  • BveEX

開発環境

Todo: 開発環境を必要に応じて変更

  • BveEX
  • Win10 22H2
    • Visual Studio 2022
      • Microsoft Visual Studio Community 2022 (64 ビット) - Current Version 17.5.3
  • Bve
    • BVE Trainsim Version 5.8.7554.391
    • BVE Trainsim Version 6.0.7554.619

依存環境

Todo: 依存環境を必要に応じて変更

  • BveEx.CoreExtensions (2.0.0)
    • BveEx.PluginHost (2.0.0)

(開発者向け)
間接参照を含めたすべての依存情報については、各プロジェクトのフォルダにある packages.lock.json をご確認ください。