VRMでブラウザで動くメタバースVZeroを作った

# VZero ～ Reborn Virtual from Zero. ～

<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">誰でもブラウザで入れるVRMのオープンワールド&quot;VZero&quot;を作りました。<br>アバターがなくても、自分のアバターでも手軽に入場できます。<br>チャット・ボイスチャットもあります。<br>マップを探検したり、フォトグラメトリで取り込まれたモデルを見たり、のんびりと楽しんでください。<a href="https://t.co/FxK6dPu007">https://t.co/FxK6dPu007</a></p>&mdash; FaceVTuberOfficial (@FaceVTuber) <a href="https://twitter.com/FaceVTuber/status/1323627634606051328?ref_src=twsrc%5Etfw">November 3, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">ブラウザで入れるオープンワールド&quot;VZero&quot;<br>ツイートで見かけて早速入ってみたぴょん<br>自分のVRMアバターが使えるのが嬉しい<br><br>フォトグラメトリな商店街や難波の町並みを探検してたらちょうど作者の方もログインしてたのでフォトスポットを教えてもらった<br>今度みんなで行こ～<a href="https://t.co/OiRQdYvCmj">https://t.co/OiRQdYvCmj</a> <a href="https://t.co/4NVQ6jUmyu">pic.twitter.com/4NVQ6jUmyu</a></p>&mdash; ドコカノうさぎ🐰VIVEアンバサダー&amp;VR開発系アイドルVTuber (@patsupyon) <a href="https://twitter.com/patsupyon/status/1324420909294219264?ref_src=twsrc%5Etfw">November 5, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

URL：
https://facevtuber.com/vzero/index.html

- ブラウザで動く
- VRMで自分のアバターが持ち込める
- 多人数で入れる
- ボイスチャット・チャット機能
- オープンワールド

のゲームを作りました(ゲームといっても、ただ歩き回れるだけですが)。
今回は、このVZeroの作ったコンセプトや、オンライン同期の部分を自作したときのはまったバグや、実際に作った内容について書きたいと思います。

# 基本コンセプト　～キー入力同期型～

以前、[「[CEDEC 2010]ネットゲームの裏で何が起こっているのか。ネットワークエンジニアから見た，ゲームデザインの大原則」](https://www.4gamer.net/games/105/G010549/20100905002/)という記事を読んでおり、オンラインゲームは大変そうだなぁ。という実感だけはあり、なんかのタイミングで作ってみようか。と思っていました。そこで、たまたまハッカソンに誘われたので、じゃあ作ってみるか。と思って、作ったのがこれになります。基本的には、

- キー入力を1フレームごとにサーバーへ送る
- 定期的に位置座標・回転情報を送る

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/418eb86b-625d-57cf-ea92-f10b8cf16cf9.png)

という、とてもシンプルな実装を考えます。
上記の記事の「バーチャファイター5 Live Arena」の事例で、キー入力をフレーム単位で送り、同期するタイプのオンラインゲームの実装の話が掲載されています。記事では、遅延を少なくする。といった視点で書かれており、そのために必要な複雑な工夫が書かれています。しかし、遅延に目をつむり、キー入力さえ送られていれば、そこそこ同期したものが作れるのでは？という発想に至りました。というわけで、今回のナイーブな実装を試みました。
**"このような実装を行った場合、どんな不具合があるのか？どんなバグが起こるのか"を体験する**というのが主な狙いでした。
そして、今回は、同期のプロトコルとしてwebsocketを選定しました。これは「ハッカソンで動いて、みんなに体験できるものを提示したい。」という思いがありました。しかし、デモの時間や評価の都合上、審査員にapkやexeの配布をするのは難しいと判断しました。そのため、ブラウザで動くことを目標にしました。そうすると、選択肢として、udpや生のtcpなどは選択できず、webRTCやwebsocketあたりが候補にあがります。その中で、webRTCをUnityのwebGLで動かしているのを見たことがなく、自分としてもサーバー側の経験もありませんでした。そういった経緯から、消去法的ではありますがwebsocketに決まりました。
ちなみに、似たようなプロダクトとしてclusterがありますが、[clusterはプロトコルとしてMQTTを選んでいる](https://qiita.com/johnson65t/items/230360b4cec41e8aafa4)そうです。

# WebsocketとBestHttpの相性問題

今回、Unity側に注力したいためサーバー側の実装はとてもシンプルにしました。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/c21269a2-8e0a-902a-207b-e912d094892f.png)

そのため、図のように、Clientが何かメッセージ(hello)を送る①と、すべてのつながったクライアントにメッセージ(hello)を送り返す②とても簡単なものにしました。

そして、**websocketを選定した理由として大きかったのが、クライアントアプリの存在**でした。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/a87de70b-20dc-30f8-3a14-d391ccd61628.png)

いわゆるクライアント・サーバーをどちらも自作する場合、何が原因で動かないかを判定するのか難しい問題があります。一般的なREST APIだと、簡易的にcurlなどでhttpのリクエストを作り、問題の切り分けをすることは容易です。しかし、websocketだとどうするのか？と思っていました。そんな中で、

- [websocat](https://github.com/vi/websocat)
- [wscat](https://github.com/websockets/wscat)

というOSSを見つけました。これはwebsocket版のcurlともいえるもので、簡単にwebsocketのサーバーへクライアントとして接続出来たり、そもそもwebsocketの簡易サーバーとして動かすこともできます。そのため、自作クライアントが正確なリクエストを送ることができているかの検証も行えます。しかも、websocatに至っては、今回作ろうとしたサーバーはコマンドラインオプションのみで実行可能です。そのため、サーバー側は自作する必要がありません。

**しかし、その発想が間違いでした。WebSocketのサーバーに、つながらないのです。**

今回、Unity側は[BestHttp](https://assetstore.unity.com/packages/tools/network/best-http-2-155981)というアセットを使いました。有料のアセットだけあり、使いやすく、ドキュメントもあるので重宝していました。しかし、今回、websocat等への接続がうまくいきませんでした。
　何がどううまくいかないのか。というと難しいのですが、そもそもコネクションが貼れていない。という感じがします。websocat側には何も表示されず、一方的にBestHttpがwebsocketのopenの時点でUnityのConsoleLogにエラーが出て、動かない。という挙動でした。正直な話、BestHttpのwebsocketの内部実装を修正する。というのはハードルが高すぎるので、色々な実装を試しました。
　[websockets](https://websockets.readthedocs.io/en/stable/)はPythonによる実装で、[ws](https://www.npmjs.com/package/ws)はnode.jsによる実装です。それぞれを試した結果は以下のようになっています。

| client \ server|websocat|wscat|websockets|ws|
|:-:|:-:|:-:|:-:|:-:|:-:|
|websocat|〇|〇|〇|〇|
|wscat|〇|〇|〇|〇|
|BestHttp|×|×|×|〇|

BestHttpでつながったのは、wsのみで、その他のサーバーは動きませんでした。しかし、これだけだと、そもそもサーバーの実装がまずいのではないか？という疑念はあります。そこで、websocatやwscatでもつないでみましたが、それらではきちんとつながりました。したがって、BestHttpの実装がクロかなぁ。ということがわかりました。


# 分裂するアバター

![ss.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/91fba54a-8730-2d39-0b5c-30f92204361f.png)

他のユーザーが参加する部分を作っていたとき、奇妙なバグに遭遇しました。それは、ユーザー参加時にアバターが複数表示される。というバグです。今回作ったVZeroに関しては、ユーザーの出現と位置の同期は同じ命令になっています。そのため、

1. 位置の同期命令を受け取る
2. 現在、画面内にユーザーが居るか？
3. 居る場合は、キャラクターの位置と回転を同期させる
4. 居ない場合は、キャラクターをロードし、位置と回転を同期させる

という処理になっています。そのため、**基本的に排他制御は必須で、序盤から措置はとっていました。しかし、分裂する。というバグを引きました。**
当初、ユーザーの出現は以下のようなコードになっていました。

```cs
class CharacterManager {
    private Dictionary<string, GameObject> characters;

    async void sync(SyncCommand syncCmd) {
        if( !characters.ContainsKey(syncCmd.userId) ){
            var vrm = await LoadVRM(syncCmd);
            characters.Add(syncCmd.userId,vrm);
        } else {
            syncState(characters[syncCmd.userId],syncCmd);
        }
    }
}
```

`characters.ContainsKey`でユーザーのモデルが出現済みかどうかを判定しており、一見、問題なさそうなコードに見えます。脳内では以下のようなフローを想定していました。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/29ec7e80-12fa-fa69-1365-fe6208adde62.png)

しかし、これが問題になった理由は2つあります。1点目は、「同期は3秒ごとに行われる」という仕様と、2点目は「VRMのロードには時間がかかる」ということです。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/c1b714ad-5dcf-9bb9-d2e8-3509bc05435d.png)

ContainsKeyからLoadVRM、Addの流れは、ごく短時間で行われる想定でした。しかし、実際には3秒以上かかっていました。また、「同期は3秒ごとに行われる」という仕様のため、次の同期命令がAddより前に追い付いてしまう。という現象が発生しました。その場合、もちろん`characters`にデータは入っていないため、そのまま出現の処理が走ってしまい、2体目のアバターが出現してしまう。というバグが発生しました。そこで、実装を修正しました。

```cs
class CharacterManager {
    private HashSet<string> exists;
    private Dictionary<string, GameObject> characters;

    async void sync(SyncCommand syncCmd) {
        if( !exists.Add(syncCmd.userId) ){
            var vrm = await LoadVRM(syncCmd);
            characters.Add(syncCmd.userId,vrm);
        } else {
            if( !characters.ContainsKey(syncCmd.userId) ) {
                syncState(characters[syncCmd.userId],syncCmd);
            }
        }
    }
}
```

多分C#っぽい書き方ではないのですが、このような形で実装しました。HashSetのAddは、引数に該当するデータがある場合はfalseを返し、データがない場合はtrueを返す仕様です。HashSetのAddをいわゆる[CAS](https://ja.wikipedia.org/wiki/%E3%82%B3%E3%83%B3%E3%83%9A%E3%82%A2%E3%83%BB%E3%82%A2%E3%83%B3%E3%83%89%E3%83%BB%E3%82%B9%E3%83%AF%E3%83%83%E3%83%97)のように使い、1アクションで排他制御ができるようにしています。このようにロックをするために必要な時間を短くすることで、アバターの分裂を防いでいます。
しかし、これには副作用もあり、syncStateの前に、ContainsKeyを呼ぶ必要があります。これは、先ほどの解説と同じで、VRMをロードしている間に、同期命令が飛んでくる場合があります。今回は、HashSetのおかげで分裂はしませんが、アバターの準備が整っていないのに、位置を同期をしようとする問題が発生します。そのため、ContainsKeyでアバターの情報を確認し、準備が整っていない場合は無視する。というルーチンにしています。

# 位置がズレる

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/5420cabb-511e-3305-5d58-dc609098d09a.png)

　最初から想定はしていましたが、他人のキャラクターの位置がズレる。ということが発生しました。図にあるように、キー入力だけを送っている場合、間にあるパケットが消失して、うまく動かない。ということは考えられます。こういう現象はVRChatや他のオンライン系のゲームでも発生していて、歩き出して、止まったと思ったら、突然、別の位置にワープする。ということはよくあるように思います。しかし、ちょっと今回は事情が違います。
　今回、プロトコルとしてWebSocketを使っています。これはTCPの上にある実装なので、必ず相手までパケットが到達するハズです。他のオンラインゲームであれば、採用されているプロトコルがUDPベースなので、パケットの到達順序や、そもそも到達保証がないので位置がズレることは想像に難くありません。しかし、今回はTCPベースでも、このようなズレが起こり、しかも、割と大きい。ということが起こりました。
　これはおそらく実装に問題があると思います。私は以下のように実装しています。

```cs
class CharacterController {
    private bool isForward = false;
    
    public void forward(){
        isForward = true;
    }

    public void Update() {
        if(isForward){
            //前進処理
        }
        
        isForward = false;
    }
}
```

想定では以下の画像のようなフローを考えていました。サーバーから、前進の命令(Forward)を受けたとき、`CharacterController`にあるforwardを呼ぶことで、そのアバターの前進のフラグを立てておき、それをUpdateで拾い上げ、処理したのち、前進のフラグを下す。ということを行っていました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/649197fa-3c0f-b39a-69d2-40e665c06586.png)

この実装は、実はサーバーがローカル環境にある場合は、そこまで問題になりませんでした。しかし、実際のクラウド環境にサーバーを置くと、誤差がひどくなる。という現象が起こりました。これは、"おそらく"、以下のような現象が起こっているように思います。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/30b1e967-1ecf-ce5f-b9bb-9025451b701e.png)

ネットワークの遅延により命令が遅延し、別々のフレームに到達してほしい命令が、同一のフレームにまとまって到達することで、一部の命令を消失させている気がしています。基本的に、ローカル環境は性質が良く、ネットワークの遅延等もそれほど大きくありません。[ネットワークはなぜ遅延が生じるのか](https://www.slideshare.net/junkato1272/ss-70431661)に書かれていますが、もしサーバーが東京に置かれて、クライアントが大阪にいるならば5ms程度の遅延は必須になります。これは、1フレームの1/3程度です。それに、自宅のルータの性能や、ISPのネットワーク機器の性能、ネットワークの混雑の具合によっても遅延は発生します。そうすると、1フレーム1パケットで遅延を想定しない。という仕様はかなり無理のあるものだということがわかります。そういった遅延が如実に表れ、今回のような大幅なずれが発生したように思います。
　これは流石に実装が雑だろう。と思われるかもしれませんが、実際、雑な実装をすると、どれくらいダメか？というのは、よくわからないものです。あと、真面目にバッファリングや遅延などを考慮すると割と実装はめんどくさいと思います。今回は、ハッカソンで出したものなので、雑実装で動けばラッキー。とりあえずやってみた。というぐらいのものです。
当初、同期は3秒に一度でしたが、最終的には1秒間に1回、位置・回転の同期のための情報を送っています。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/139643/e861b969-3fd2-c65f-1b0d-cf23e37616ab.png)

おそらくVRChatなども似たような感じで、定期で情報を送ることで位置ずれを補正しているのではないかなぁ。と思います。そのため、ドラゴンボールの武空術のようなワープが発生しているのではないか。と思います。

# VRMのセキュリティ

最近は一時期ほどは聞くことも少なくなってきましたが、VRChatなどでのアバターのコピー(ぶっこぬき)が問題になっていた時期がありました。VZeroはブラウザで動いており、アバターフォーマットとしてVRMを使っています。そのため、簡単な実装をしていると、ブラウザのdevToolなどで通信内容を見て、アバターの情報を取り出すことが出来るようになります。そのため、今回、VZeroでは、アバターデータの暗号化を施しています。そのため、devToolで見るぐらいであれば、アバターのデータのコピーは出来ないような仕掛けにしています。そのようにしてアバターデータの防護策も施行しています。もし、コピー方法がわかってしまった場合、Qiitaに記事を書くのではなく、[私のTwitter](https://twitter.com/kotauchisunsun)のDMへ送ってもらい、一緒に安全な方法を考えていただけたら幸いです。

# エンジン部分の工数感

大体、3日ぐらいでした。

1日目：

 - WASDでのキャラクターの移動(オフライン)
 - Websocketサーバーの自作
 - BestHttpによるWebsocketのサーバー接続の試行

2日目

 - BestHttpでのWebsocketへのメッセージ送信・受信
 - WebGLビルドでのBestHttpでのWebsocketの動作の確認
 - Websocketのサーバーを外部ドメインに置いた時の動作確認
 - WebGLビルドを外部ドメインに置いた時の動作確認

3日目：

 - メッセージ受信とキャラクターの移動のつなぎ込み
 - Windowsビルドでの動作確認
 - WebGLビルドでの動作確認

という感じでした。経験上、UnityのWebGLビルドは時間がかかる割にハマる。という辛いことはわかっていたので、色々と動かない可能性を序盤に楽につぶせたのは良かったです(しかし、BestHttpのWebsocketの相性問題には参った)。こういうクライアント・サーバーの両方を自作する場合は、デバッグが困難になることが多いのですが、websocat等のツールを知ってることで、割と楽にデバッグができて良かったです。これらのツールがいいところは、メッセージのフォーマットを知っていれば、適当なテキストをwebsocketに流すことで、クライアントを作らずに動作のチェックができることです。また、サーバーも全クライアントにメッセージを流す実装なので、ゲーム側が正確にメッセージを流せているかが一目瞭然なことです。この辺りが、開発効率が良かったなぁ。と思うことでした。
　現在のオンライン同期のエンジン部分は、800～1,000行なので、最小で動く範囲だと500行くらいだと思います。今回は、WebGLで動くか？といったことだったり、ドメインがlocalhost以外で動くか？という検証をやっているため時間はかかっていますが、こだわらなければ1日あれば割と動く範囲まで作れると思います。


# 感想

エンジニアあるあるかもしれませんが、

**理屈上は出来るのは分かる。しかし、実際作ってみないと、どんなバグが起こるかわからないし、作ったことないから分からない。**

みたいなことってよくあると思います。「他人が動かしてるキャラクターの入力を何らかのサーバー経由して、受信して動かしたらネトゲって作れるよね？」と言われると、確かに"理屈上は"動くよね。じゃあ、作ったことはある？いやない。みたいな。オンラインの同期はそういう類のもので、サーバーも用意しなくちゃいけないから、Unityエンジニアからはハードルが高いし、サーバーエンジニアからすると、そもそもUnityがハードルが高い。みたいな。どっちがやるか押し付け合いになりそうな話ではあると思います。そういうわけで、なんかやりたくはあるけど、色々勉強すること多いし、まぁ、今やんなくていいよね？とか適当な理由をつけてやらない内容だなぁと。しかし、**"こだわらず、完成度を求めず"技術的試行の範囲でゆるくやってしまえば、そこそこ動くものなのだなぁ**と感じました。
　今回、Unityでまともなプロダクトっぽいものを作るのは初めてでしたが、本当に"何も作らなくていい"感じはしますね。それこそ、昔はDXライブラリや、SDL、pygameなんかも触ってましたが、そこからすると雲泥の差です。初期化書いてスプライト表示するまで大分長かったですが、今では、GUIでポンポンポンで出来てしまう。大規模開発だったり、多人数開発、リソースのマネジメントとかを考え始めると、おそらく今でも大変でしょうが、個人がちょこちょこ作る分にはUnityは楽だなぁ。と思いました。
　あとVRChatだったり、VTuberからUnityを触ると、かなり亜流な入門になってしまい、Unityの良さ。みたいなものは、かなり感じにくかったんだな。と痛感しました。私自身、ゲームっぽいものを作るのは10年ぶりぐらいでしたが、なるほど。これが本来のUnityなのか。と感じました。しかし、やはり作り方はスクリプトに寄ってしまうので、その辺はうまく作れるようにならないと。
　最近、FallGuysが流行ってますが、自分でオンラインゲームを作ってみると、マジで仕組どうなってんだ。とか思うようになりました。普段は、漫然と、「60人が同時でやるくにおくんの運動会みたいなゲームだなー」とか思ってましたが、作った後だと、「これシステム辛そう。」みたいな視点になります。それとか、[「[CEDEC 2010]ネットゲームの裏で何が起こっているのか。ネットワークエンジニアから見た，ゲームデザインの大原則」](https://www.4gamer.net/games/105/G010549/20100905002/)も、ふーん。技術的に面白いなー。とか思って読んでいましたが、作った後だと、あーなるほど。そう作ればよかったのかー。と腹落ちする部分が増えてきたりしてきます。これは、ちょっと新鮮な感覚でした。
　そういうわけで、「やはり技術ってのは広いなぁ。」と改めて実感した、オンラインゲーム製作でした。