Udonarium Axe Backend

はじめに ​

このドキュメントは、Udonarium Axe（以下Axe）を配信する人が、Axeにつなぐサーバーを自分で置くためのものです。サーバーを置くのが初めてでも進められるように書いています。

Axeは、HTMLとJavaScriptのファイルだけでできています。ファイルを置けばブラウザで開けますが、参加者どうしをつなぐには、Axeの外にサーバーが要ります。そのサーバーを置くのが、このドキュメントの目的です。Axe本体の置きかたは、Axeの利用ガイドにあります。

2つの方式 ​

Axeの配信には、2つの方式があります。どちらにするかは、あなたが配信ごとに、Axeのconfig.jsonで決めます（→ Axeの設定）。

方式参加者のつながりかた置くサーバー
SkyWay版参加者どうしが、SkyWayを使って直接つながるトークン発行サーバー（PHP版・Vercel版・Cloudflare版）
サーバー版全員が部屋のサーバーにつながる。部屋のサーバーが卓の状態と画像と音声を持つ部屋のサーバー（Cloudflare版かVercel版）

SkyWay版

参加者どうしが、1人ずつ直接つながる

4人の参加者が、それぞれほかの3人と線でつながっている図SkyWayがつなぐ
  • 卓の中身は、参加者のブラウザだけが持つ
  • 置くのは、許可証を渡すだけのサーバー
  • 全員が抜けると、卓は消える

サーバー版

全員が、部屋のサーバー1つにつながる

4人の参加者が、まん中の部屋のサーバーとだけ線でつながっている図部屋のサーバー卓の状態と画像を持つ
  • 卓の中身は、部屋のサーバーも持つ
  • 置くのは、卓のすべてを受け持つサーバー
  • 全員が抜けても、しばらく卓が残る

サーバー版はAxe v1.68.0から使えます。全員が抜けても卓が残る、裏向きのカードや秘話を見てはいけない人に届けない、などの違いがあります。2つの違いと選びかたは、どれを置くかで詳しく説明しています。

置くまでの流れ ​

  1. 1どれを置くか決める方式と置き場所を選ぶ
  2. 2準備するアカウントとOriginを確かめる
  3. 3サーバーを置く選んだものの手順で
  4. 4Axeにつなぐconfig.jsonにURLを書く
  5. 5公開するなら費用・安全・規約を確かめる

  1. どれを置くかで、方式と置き場所を決めます。

  2. 設置の準備で、要るアカウントと、AxeのOriginを確かめます。

  3. 決めたものの手順で、サーバーを置きます。

    置くもの手順
    Vercel版（トークン発行）SkyWayのアプリを作る → Vercelに置く
    PHP版SkyWayのアプリを作る → レンタルサーバーに置く
    Cloudflare版Discordのアプリを作る → Cloudflareに置く
    Vercel版（部屋のサーバー）Discordのアプリを作る → Vercelに置く

  4. Axeの設定で、Axeのconfig.jsonにサーバーのURLを書きます。

  5. 身内の外にも開くなら、運営するの章で、費用、安全のしくみ、預かるもの、規約を確かめます。

うまくいかないときは、SkyWay版で困ったときかサーバー版で困ったときを見てください。

用語 ​

用語意味
トークン発行サーバーSkyWay版で、AxeにSkyWayの認証トークン（使うための許可証）を作って渡すサーバー。PHP版・Vercel版・Cloudflare版
部屋のサーバーサーバー版で、参加者がつながる先。部屋ごとに卓の状態を持つ。Cloudflare版かVercel版
部屋のアセットサーバー版で、部屋のサーバーが部屋ごとに預かる画像と音声
席部屋に入っている1人ぶんの場所。役割（GM・PL・見学）を持つ
Origin（オリジン）Webページの出どころ。https://axe.example.comのように、スキーム・ホスト名・ポートの組で、パスは含まない
CORSほかのOriginのページからのリクエストを受けるかどうかを、サーバーがブラウザに伝えるしくみ
JWT署名付きの小さなデータ。SkyWayのトークンや、ログインのトークンはJWTの形をしている
WorkerCloudflareの上で動く小さなプログラム。Cloudflare版はWorker
R2Cloudflareのファイル置き場。取り出すときの転送料がかからない
Durable ObjectsCloudflareの、状態を持てるWorker。Cloudflare版では部屋ごとに1つ置く

MITライセンスで公開しています

Udonarium Axe Backend