Udonarium Axe

テーマ

設置の流れ ​

このページは、Udonarium Axe（以下Axe）を自分の場所に置いて、仲間うちや公開の場で使いたい人のための案内です。置くまでの流れと、どのページをどの順に読めばよいかを説明します。すでに動いているAxe（デモサイトや、誰かが置いた場所）で遊ぶだけなら、設置は要りません（→ はじめに）。

置くもの ​

Axeを自分の場所で動かすには、次の2つを置きます。

置くもの中身置く場所の例
Axe本体リリースのzipを展開したファイル（HTML・JavaScript・画像など）Cloudflare Pages、レンタルサーバー、Amazon S3
サーバー参加者どうしをつなぐためのサーバー。方式によって、置くサーバーが変わりますVercel、Cloudflare Workers、レンタルサーバー

Axe本体は、ファイルを置くだけで動きます。ソースからビルドし直す必要はありません。サーバーは、udonarium_axe_backendの文書の手順で置きます。このサイトでは、Axe本体を置く手順と、Axeとサーバーをつなぐ設定を説明します。

2つの方式 ​

Axeには、参加者のつなぎかたが2つあります。どちらにするかで、置くサーバーが変わります。

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

参加者から見た違いと選びかたは、方式を選ぶにあります。はじめて置くなら、SkyWay版から試すのが手軽です。トークン発行サーバーは、Vercelのボタンを押すだけでも置けます。

置くまでの流れ ​

  1. 1
    方式を選ぶSkyWay版かサーバー版かを決めるあとから変えられる
  2. 2
    サーバーを置くトークン発行サーバーか部屋のサーバーを置く30分〜1時間
  3. 3
    Axeを置くリリースのzipを静的ホスティングに置くビルド不要
  4. 4
    つないで確かめるconfig.jsonにサーバーのURLを書き、部屋を作る2行だけ
  1. 方式を選ぶ — SkyWay版かサーバー版かを決めます（→ 方式を選ぶ）
  2. サーバーを置く — 方式に合ったサーバーを、バックエンドの文書の手順で置きます（→ サーバーを置く）
  3. Axeを置く — リリースのzipを展開し、静的ホスティングに置きます（→ Axeを置く）
  4. つないで確かめる — assets/config.jsonにサーバーのURLを書き、部屋を作って確かめます（→ config.jsonを書く）

手順1から順に進めてください。用意するアカウントと、作業の前に確かめておくことは設置の準備にまとめてあります。

かかる時間と費用 ​

かかる時間は、アカウント作りを含めたおおよその目安です。

組み合わせサーバーAxe本体費用
SkyWay版（Vercel）＋Cloudflare Pages30分ほど30分ほど無料の範囲に収まることがほとんど
SkyWay版（レンタルサーバー）＋同じレンタルサーバー30分〜1時間30分ほど契約中のサーバー代だけ
サーバー版（Cloudflare）＋Cloudflare Pages1時間ほど30分ほど1日5〜7卓ほどまで無料。支払い方法の登録が要る

サーバーの費用と上限は、バックエンドの文書のどれを置くかと費用と上限にあります。

用語 ​

設置で使う言葉（静的ホスティング・Origin・トークン発行サーバー・部屋のサーバーなど）の意味は、用語集にあります。

次に読むもの ​