AtsExCsTemplate

AtsEXを使ったBve5またはBve6用のプラグインのためのテンプレート

プラグイン開発が初めての人へ

~~全然クイックじゃない~~クイックスタートから取り掛かるのがおすすめです

ライセンス

MIT

このテンプレートの機能

取っ掛かりやすいように3種類のプラグインのファイル
- マッププラグイン
- 車両プラグイン
- 拡張機能
Actionsでのdll自動生成
頑張って書いたwiki

動作環境

AtsEX
- ver1.0-RC7 - v1.0.40209.1 or later
Win10 22H2, Win11 22H2 or later
- Visual Studio 2022
  - Microsoft Visual Studio Community 2022 (64 ビット) - Current Version 17.5.3
Bve
- BVE Trainsim Version 6.0.7554.619

依存環境

AtsEx.CoreExtensions (1.0.0-rc7)
AtsEx.PluginHost (1.0.0-rc7)

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

使い方

Use this template から新しくリポジトリを作成する
githubリポジトリの詳細を設定する
LICENSEの著作権表記を変更する
自分の作りたい機能に合わせて設定する
コードを書く
リリースする

0. 下準備

0.1. テンプレートから新しくリポジトリを作成して設定する

Use this templateボタンから新しいリポジトリの作成画面に入る
- Create a new repositoryで新しくリポジトリを作成する
- リポジトリの名前はお好みで
- Description にプラグインの概要とかを書いておくといい
リポジトリの設定画面でDescriptionやTopicsを設定する
LICENSEの著作権表記を変更する
README.md を消した後 README_TEMPLATE.md を README.md にリネームしてtodoを埋める

0.2. ローカルにクローンする

< > CodeからURLをコピーする
Visual Studio を開いてリポジトリのクローンからコピーしたURLでローカルにクローンする

できないときとかは下のコマンドでできる

git clone https://github.com/USERNAME/REPONAME.git

0.3. Visual Studio でビルドできる状態にする

AtsExCsTemplate.csproj を開いてすべて保存から適当な場所にslnを生成する
NuGetからAtsEx関連のライブラリを入れる（ビルドすれば勝手に入る）
開発するプラグインの種類に応じて要らないファイルを削除する
- MapPlugin/
  - マッププラグイン用のプロジェクト
- VehiclePlugin/
  - 車両プラグイン用のプロジェクト
- Extension/
  - 拡張機能用のプロジェクト

0.4. プラグイン情報の設定

Properties/AssemblyInfo.cs BveからAtsExのバージョン情報を見たときに表示される内容を設定できます AtsExのバージョン情報画面から見えるのはファイル名と下の3項目です

AssemblyTitle
- プラグインの名前
AssemblyDescription
- プラグインの説明
AssemblyVersion
- プラグインのバージョン

1. コードを書く

頑張ってゴリゴリ書きましょう

2. ドキュメントを書く

githubリポジトリの詳細を設定する
LICENSEの著作権表記を変更する
README.md を消した後 README_TEMPLATE.md を README.md にリネームしてtodoを埋める

3. 公開する

公開ができる状態になったらmainにpushしてtag打ってreleaseを作りましょう

デバッグについて

※この項目に書いてあることは環境によって差異があるかもしれないので適宜自分の環境に合わせて読み替えること

1. 生成物がAtsExから読めるようにする

そのままの状態でビルドしてもデバッグできないのでBveからAtsEx経由でビルドしたプラグインが読み込めるようにする必要があります
そのためには大きく次のA,Bで2通りのやり方があります
おすすめはBのシンボリックリンク経由です
シンボリックリンク経由だとpdbなどのごみがBve側のディレクトリに散らばったりしなくて嬉しいです

1.A. 生成物の出力パスをいじる

メニューバー > プロジェクト > (プロジェクト名)のプロパティを選択しプロジェクトのプロパティ画面を開く
サイドバー > ビルドを選択しビルドの設定画面を開く
出力セクションの出力パスをプラグインの出力先に設定する
試しにビルドしてみて出力されるか確認する

1.B.シンボリックリンクを張る

生成物がない場合はビルドしてダミーのdllを生成する
出力ディレクトリ(binの下)にある生成物へのシンボリックリンクをプラグインの配置場所に配置する
- winでシンボリックリンクを簡単に張るにはLink Shell Extensionがおすすめ
試しにビルドしてみて更新されるか確認する

2. Visual Studioでデバッグする

2.1. デバッグの設定をする

メニューバー > デバッグ > (プロジェクト名)のデバッグプロパティを選択しプロジェクトのデバッグプロパティ画面を開く
開始動作を"外部プログラムの開始"を選択しBveのパスを設定する
必要があればコマンドライン引数にシナリオファイルのパスを設定する
- ここでシナリオファイルのパスを設定したらそのシナリオが直接読み込まれる
- 何も指定しなければ普通にシナリオ選択画面が立ち上がる

2.2.実際にデバッグする

適当にブレークとかを張る
デバッグを始める
- F5キー
- メニューバーのデバッグとテストの下あたりの開始ボタン（緑の三角形）
張ったブレークで止まるか見てみる

備考・その他

C#は初めてなのでお作法がわかりません
- ミスとか良くないところがあったらissue立てるなりしてくれればできる範囲で対応します
- PR大歓迎！！！
自分用に作ったので適当です、自分が欲しい機能をとりあえず入れてます
AtsExとAtsEXがどっちもあったのでここでは引用を除いてコードに準じてAtsExとしています
- AtsEXが正式な表記っぽい？

winup-zhou / atsexcstemplate Goto Github PK