コードを書く前に
ここではコードを書き始めるまでの準備などを確認する
本テンプレートはAtsEXの機能を利用するプラグインの開発を簡単に始めることを目的として作成された
そのため、本テンプレートを用いて開発を始めるための手順をここに示す
本テンプレートを用いてプラグインを開発する前に、本テンプレートを適用した Git リモートリポジトリを作成する
本テンプレートのgithubページから Use this template > Create a new repository を選択する
Repository template に本テンプレートが表示されていることを確認し、任意の Repository name を入力して Create repository する
これで自分のアカウントに本テンプレートを適用したリポジトリが作成できた
リポジトリの作成はできたが、このままでは各種表記などがテンプレート作成者のままとなり不都合なのでその部分を書き換える
コードの著作権表記をリポジトリの所有者に変更する
LICENSE ファイルを開いて自分の前に変更したら Commit changes から変更をコミットする
リポジトリの説明などをテンプレート用のものから変更する
README.md を削除し README_TEMPLATE.md を README.md にリネームする
README_TEMPLATE.md に書いてあった使い方の通り、水平線より上を削除し$REPONAME$をリポジトリ名で置換する
Todo と書いてある部分のうち埋められるものを埋めたら Commit changes から変更をコミットする
リモートリポジトリで行える変更は終わったので、次は実際にコードを書ける環境をつくる
手元の環境にリポジトリをクローンして開くために、リモートリポジトリの < > Code からURLをコピーする
Visual Studio を開き リポジトリのクローン からコピーしたURLでローカルにリポジトリをクローンする
無事にリポジトリのクローンが終わると、画面右側のソリューションエクスプローラーにリモートリポジトリと同じディレクトリ構成が見られるはずである
ここまでの手順で導入できない場合は Git Bash などで下のコマンドを実行することでリモートリポジトリをクローンすることができる
git clone https://github.com/USERNAME/REPONAME.gitローカルにクローンしたリポジトリのslnファイルを開くことで Visual Studio からソリューションを開くことができる
クローンしたローカルリポジトリでコミットするための設定を行う
Visual Studio でクローンしたローカルリポジトリを開き、メニューバーから Git > 設定 と進んでGitの設定画面を開く
ユーザー名とメールアドレスを入力し、保存する
ここまでの手順で設定できない場合は Git Bash などで下のコマンドを実行することで代替できる
git config --global user.name USERNAME
git config --global user.email mail@example.comこれ以降はこまめにコミットとプッシュを行うことを推奨する
本テンプレートには Visual Studio を用いた開発用の .gitignore が含まれているため、基本的には下の手順でコミットとプッシュを行えばよい
git add .
git commit # 適宜変更内容を記入する
git push # 初回は -u origin BRANCH とするgitを用いたバージョン管理の方法やgithubの使い方については非本質であるため、ここではこれ以上の内容を扱わない
不明点がある場合は各自で調べられたい
ローカルにリモートからコードをコピーしただけではアセンブリの生成はできない
本テンプレートで参照を行っているパッケージを導入する必要がある
参照されるパッケージはビルドを行うことでパッケージマネージャーが自動で導入してくれる
Ctrl + Shift + B でソリューションのビルドを行い、成功すればパッケージの導入は終了である
このとき、それぞれのプロジェクトのディレクトリに生成されるbin以下にビルドで生成されたアセンブリが存在するはずである
問題なく導入できた場合はコーディングの項へ進んでよい
本テンプレートでは AtsEx.CoreExtensions を参照している
自動でパッケージが導入できなかった場合には、次の手順に従って手動でパッケージを導入する必要がある
- ソリューションエクスプローラーでプロジェクトごとの参照先を確認する
- 黄色三角印のついたパッケージは導入できていない
- ソリューションエクスプローラーから ソリューション を右クリックし、ソリューションのNuGetパッケージの管理 を開く
- 参照から AtsEx.CoreExtensions を検索し、すべてのプロジェクトに対してインストールする
- これを1で確認したすべてパッケージに対して繰り返す
さて、ここまでくると無事にコードを変更し手元の環境でビルドしてアセンブリをAtsEX経由で読むことができるようになった
しかし、現状ではコードを書くことはできてもその動作を確認することができないため、次のページではデバッグの方法について説明する
心の準備ができたら次へ