docfxをいろいろ調べてみる

Microsoft公式サイトは、docfxをもとに作られています。https://docs.microsoft.com/ja-jp/aspnet/core/tutorials/

またオープンソースでgithubに公開もしています。https://github.com/aspnet/Docs.ja-jp

docfxを使うとMicrosoft公式サイトのように、APIドキュメントと、Markdownで記事を用意できます。docfxの場合は、Markdownの拡張がありプロジェクトのソースコードのリンクなどが簡単にできます。

docfxのインストール

Windowの場合は、chocolateryでインストールするのが簡単。

https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool

ワークスルー(チュートリアル)

https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_overview.html

このワークスルーで、通常のMarkdown記事とAPIドキュメントの作成方法と組み込みサーバーを起動してブラウザで確認する方法がわかります。

ソースコードと画像を追加した記事

 

srcディレクトリーに配置したC#プロジェクトのAPIドキュメントを表示

作業の流れ

上記のサイトを試しに作ってみて一通り作業の流れが分かりました。

最初にdocfx init -qを実行し、必要なディレクトリーを生成します。srcフォルダーが作られるのでここにC#プロジェクトを作ります。docfx.jsonで、metadataのところにsrc/**.csprojと書かれているため配下の*.csファイルがすべてAPIドキュメントの対象になります。

次に、APIドキュメントを作るためdocfx metadaを実行します。C#ソースコードの変更などがあったら作り直す必要があります。

Markdownを書いたらbuildして、serveコマンド後にブラウザーで動作確認です。デフォルトでは、http://localhost:8080/です。

 

UnityのTilemap機能のGameObjectBrushの使い方

Unity2017.3では、githubから2d-extrasを取得して2d-extras/Tilemapフォルダーを自分のプロジェクトにコピーするといろんなブラシやタイル機能が追加されます。この中に、GameObjectBrushがあります。以下訳してみましたが、ちょっとわかりづらいので実際に使ってみます。

GameObject: This Brush instances, places and manipulates GameObjects onto the scene. Use this as an example to create brushes which targets objects other than tiles for manipulation.

GameObject: このブラシは、シーン上のオブジェクトのインスタンス化、配置、操作をします。タイル以外のオブジェクトを操作対象とするブラシを作成します。

使ってみる

以下画像は、パレットやブラシを使わず、Tilemapの子要素に、スプライトを直接配置して、Transformでグリッド上に配置したところです。画像ファイルをHierarchyにドロップして、Transfromのx,yの値を変更しました。

HierarchyでTilemapオブジェクトを選択し、GameObjectBrushを選択します。そうすると、タイルマップで用意されている他のブラシと同様に、このGameObjectBrushで、pickして、ペーストすることが可能です。またGameObject をこのブラシで扱えるようにするためには、グリッドに合わせる必要があります。

まとめ

  • GameObjectBrushで、任意のオブジェクトをブラシ操作できるようになる
  • 任意のオブジェクトはあらかじめグリッド上に合わる必要がある。

UnityでTilemap機能のカスタムブラシ(custom brush)を作成する

Unity 2017.2から2Dのタイルマップ機能が追加されました。スプライトからパレットを作成して、グリッド上で簡単にマップを作れるようになりました。Prefabをタイルマップに塗る場合は、現時点ではブラシを作成するようです。

sokobanパレット作成して、壁と地面をグリッドに塗ったところ

ブラシを一から作成するのは大変ですが、既にgithubにサンプルがあります。

https://github.com/Unity-Technologies/2d-extras

また、2d-extrasを使った簡単な2Dプラットフォームのデモもあります。

https://unity3d.com/jp/learn/tutorials/topics/2d-game-creation/intro-2d-world-building-w-tilemap?playlist=17093

このデモを動作させると、GameObject BrushとPrefab Brushがソースコード付きでありました。GameObjectBrushはグリッド上でゲームオブジェクトを配置したりするようです。またPrefab Brushはプレハブからブラシを作成するようです。

ブラシを作る必要があると思ったのですが、調べていくと2d-extrasを使えばよさそうなのが分かってきました。

ブロック崩しサンプル

https://github.com/Unity-Technologies/2d-techdemos

2d-extrasを使ったタイルベースのブロック崩しサンプルです。ブロックが消える時の衝突判定とタイル座標の求め方などがBallスクリプトから分かります。

ここまで調べて分かったこと

Unity 2017.2でタイルマップ機能がリリースされたので、まだ2d-extrasなど細かい機能はUnity本体に取り込まれてないようです。初めて使う場合は、上記のプロック崩しサンプルと、2d-extrasを用意して、似たようなプロジェクトを作ってみるのがよさそうです。

 

Unity公式2d-techdemo

Prefab custom brush(プレハブカスタムブラシ)の作り方

ダウンロード

https://github.com/Unity-Technologies/2d-extras をgit cloneまたはzipファイルでダウンロードして展開します。2d-extras/Assets/Tilemapフォルダーがあるので、これを自身のプロジェクトにコピーします。

ブラシ作成

コンテキストメニューからCreate->Prefab Brushでブラシを作成します。

ブラシにプレハブを設定

Tile Paletteタブから作成したブラシ(CoinBrush)がを選択します。

Prefabsのsizeを1にして、Element 0にプレハブを設定します。今回は、コインの画像からあらかじめCoinプレハブを作っておいたのでこれをブラシに設定します。

プレハブブラシで塗る

HierarchyでGridにタイルマップを用意して、それを選択します。以下画面中央の、Active Tilemapが選択されたものになります。この場合は、ItemTilemapになります。また、画面右下のブラシがCoinBrushになっていることを確認し、あとは、Sceneタブ画面で通常のブラシと同じように塗ることが可能です。

まとめ

プレハブ用のブラシを作成できるようになりました。プレハブだと、スクリプトで処理ができるので、OnTriggerEnter2Dでコイン取得後に削除などの処理をつくれます。またGameObject用のブラシもあるようです。

現時点では、2d-extrasを別途インストールしないといけませんが、Unityのバージョンが上がれば初期で対応されると思います。