マイクラMODメモ九条へいしの開発ノート
柱 1・プラグイン開発

サイトで描いたドット絵をマイクラに読み込む:6 文字のコードと、上書きされないデータベースのルール

ブラウザのドット絵エディタ。16 × 16 のマスに赤いハートを描いているところと、ブロックを選ぶパレット

この記事でわかること

  • サイトの絵をゲームに持ち込む流れ(描く → コード → /rkgk dot)
  • データベースに置く絵の形と、6 文字のコードの決め方
  • 「あとから書きかえられない」ルールの書き方
  • サーバー側で全部検査してから保存する理由

ラクガキ王国では、ゲームの中のキャンバスにブロックで絵を描くと、それが家具やペットになります。でも、細かい絵を描くなら、ブラウザのほうがずっと楽です。マス目を一つずつ塗れて、間違えたら「元に戻す」が押せて、手元にある画像を読み込むこともできます。

そこで、ブラウザで描いた絵をゲームに持ち込む仕組みを作りました。この記事は、その作り方の記録です。使う側からは「サイトで描く → 6 文字のコードが出る → ゲームで /rkgk dot コード」の 3 歩だけですが、間にデータベースがあるので、「他の人に書きかえられないか」「変なデータが入ったらどうなるか」を気にして作りました。

描くページは ラクガキ街 ドット絵エディタ にあります。ブラウザだけで使えて、ログインは要りません。

全体の流れ

ブラウザで描く、Realtime Database に置く、ゲームで読み込む、の 3 つの箱を矢印でつないだ図
流れの図。コードと名前は例です。
  1. ブラウザのエディタで絵を描き、名前をつけて「保存してコードを出す」を押す。
  2. 絵のデータが Firebase の Realtime Database の rakugakiDots/コード に置かれ、6 文字のコードが出る。
  3. ゲームで /rkgk dot コード と打つ(ラクガキ帳のメニューの「サイトの絵を読み込む」でも同じ)。プラグインがデータベースから絵を取ってきて、自分のラクガキの保存に入れる。

保存に入ったあとは、ゲームの中で描いた絵と同じ扱いです。メニューの「保存したラクガキ」から選んで、家具やペットにできます。

エディタでできること

ブロックの絵を描く道具として、最低限のものをそろえました。

ブロックの一覧は、プラグインが読み込みを許すブロックの一覧と同じものにそろえてあります。エディタで選べるものは、必ずゲームで読み込めるということです。

データベースに置く絵の形

絵は、次の 6 つの項目だけの小さなデータにして置きます。

項目中身
v形の版(いまは 1)。形を変えるときの目印
n絵の名前(16 文字まで)
s大きさ(3〜48)。s × s の正方形
p使ったブロックの名前を、カンマでつないだもの
ds × s 文字の文字列。1 マス 1 文字で、「.」は空、ほかは p の何番目のブロックか(0〜9、A〜Z、a〜z、-、_ の 64 文字で数える)
ts保存した時刻

たとえば 16 × 16 で赤・白・桃の 3 色だけのハートなら、p は 3 つのブロック名、d は 256 文字の文字列になります。ブロックを 1 マスずつ「場所と名前」で並べるより、ずっと短くなります。いちばん大きい 48 × 48 でも、d は 2,304 文字です。

6 文字のコードの決め方

コードは、ブラウザの中で、乱数を使って 6 文字を作ります。使う文字は、数字の 2〜9 と、英字の大文字から I・L・O を抜いたもの(0 と 1 も使いません)の 31 種類です。0 と O、1 と I と L は、口で言ったり打ち間違えたりしやすいので外しました。31 の 6 乗で、約 8.9 億通りです。

保存するときは、新しいコードを作り、「そのコードにもう絵が置いてないか」を先に確かめます。置いてあれば作り直し、最大 6 回まで試します。そのうえで、データベースのルールが、もう一段ガードしています。

「あとから書きかえられない」ルール

Realtime Database のルールは、こう書いています(ここに関係する部分だけ)。

"rakugakiDots": {
  "$code": {
    ".read": true,
    ".write": "!data.exists() && newData.exists()",
    ".validate": "$code.matches(/^[2-9A-HJKMNP-Z]{6}$/) && newData.hasChildren(['v','n','s','p','d','ts'])",
    ...
  }
}

このルールは「サイトの中のプログラムが正しく動く」ことをあてにしていません。誰かが自分でデータベースに直接書きにきても、同じルールで止まります。逆に言うと、絵そのものは秘密ではなく、コードを知っている人なら誰でも読めます。コードは「絵のあて先」であって、パスワードではない、という考え方です。

ゲームの側:全部検査してから保存する

プラグインの DotImport は、コードを受け取ると次の順で動きます。

  1. コードの形を確かめる(空白と「-」は無視して、大文字にそろえる)。形がちがえば、その場で「コードは 6 文字です」と返す。
  2. 同じ人が 3 秒以内にもう一度打ったら、「ちょっと待ってね」と返す(連打で通信が増えないように)。
  3. データベースから、別のスレッドで取ってくる(通信を待つあいだ、サーバー本体を止めないため)。待つのは最大 8 秒で、リダイレクト(別の場所への転送)には従いません。
  4. 返ってきたデータの大きさが 12,000 文字を超えていたら断る。
  5. 中身を全部検査する。v が 1 か、大きさが 3〜48 か、d の長さが大きさの二乗と合っているか、p の数が 64 以内か、p のブロックが「許可リスト」に入っているか、d の文字が p の範囲に収まっているか。
  6. 名前が使える名前かを確かめる。使えない名前なら「サイトの絵」という名前にする。
  7. 保存は、その人の持ち場のスレッドに戻ってから行う。サーバー設定の上限(canvas.max-size)より大きい絵、保存がいっぱいのときは、理由を書いて断る。

データベースのルールがあっても、ゲーム側でもう一度検査するのは、役目がちがうからです。ルールは「データベースに何を置けるか」を決めるもの、検査は「ゲームに何を持ち込むか」を決めるものです。たとえば、許可リストにないブロックの名前は、データベースのルール上は文字として正しくても、ゲームでは受け取りません。

どこかが失敗したときは、人に見せる文で理由を返します。「そのコードの絵は見つかりません」「サイトにつながりませんでした」「その絵は大きすぎて読み込めません」といった言い方です。データベースの URL は設定(dot.url)で変えられます。コンソールから打ったときは、読めるかの検査だけをして、保存はしません。

読み込んだ絵は「うすい 1 枚」になる

サイトの絵は、横と縦だけの平らな絵です。そこで、ゲームの保存に入れるときは、奥行きのない 1 枚のブロックの絵として入れます。正面(顔が向いている +Z 側)から見て絵になるように、上の段ほど高い場所へ、s の半分の奥行きの位置に並べます。保存の中では、1 ブロックずつ「横・高さ・奥行き・ブロック名」の行になります。

つまり、読み込んだ直後の絵は、パネルや看板のような「正面から見る絵」です。立体の形にしたいときは、ゲームの中のキャンバスで足していきます。

学んだこと

ブラウザとゲームのあいだに公開のデータベースを置くときは、「誰でも読める・書き足せるけれど、上書きはできない」と決めると、とても単純に守れます。そのうえで、受け取る側がもう一度、全部検査する。この 2 段にしておくと、片方の考えもれがあっても、もう片方が止めてくれます。

この記事は、九条へいしが自分のサーバー「ラクガキ街」と撮影用サーバーで実際に試したことをもとに書いています。気づいたことや間違いは お問い合わせ から教えてください。