Published on: 2022-11-12

パスワード

筆者作のパスワードライブラリ momoden-password も必要に応じて参照されたい。

セーブデータ

パスワードには以下のゲーム状態が記録される。これを抽象的に「セーブデータ」と呼ぶ。

• 経験値 (16bit)
• 所持金 (16bit)
• 預金 (1000 単位、6bit)
• 年齢 (8bit)
• 加齢タイマー上位バイト (8bit)
• 術習得状態 (8bit)
• イベント進行状態 (8bit)
• 宝物所持状態 (5bit)
• お供存在状態 (3bit)
• ひえんブックマーク (10bit)
• 復活地点 (4bit)
• 装備:兜 (2bit)
• 装備:武器 (4bit)
• 装備:鎧 (4bit)
• 装備:靴 (3bit)
• 装備:いでたち0 (2bit)
• 装備:いでたち1 (2bit)
• 装備:いでたち2 (1bit)
• 装備:いでたち3 (1bit)
• インベントリ (最小 6bit, 最大 48bit)

セーブデータは最小 117bit, 最大 159bit となる。

セーブデータのシリアライズ

セーブデータをビット列に変換することを「シリアライズ」、その逆変換を「デシリアライズ」と呼ぶ。

セーブデータ内の個別の値をシリアライズする際は上位ビットから順に読む。
たとえば、6bit 値 0b111001 はビット列 [1, 1, 1, 0, 0, 1] に変換される。

セーブデータは以下の形式でシリアライズされる:

デシリアライズ時は単にこのビット列をパースすればよい。

なお、ゲーム中ではインベントリは常に先頭に詰められている(アイテムとアイテムの間に空欄が挟まることはない)ので、 シリアライズされたインベントリに空欄が現れることはない。
チートで空欄を含むインベントリをシリアライズした場合は、空欄の内部値が 0 なので、それがインベントリ終端とみなされる。

シリアライズバッファ

シリアライズされたビット列にはさらに 2 種類の 6bit チェックサムが付加される(全体で最小 129bit, 最大 171bit)。
このビット列全体はいったんバイト列に格納される。この格納用バイト列を「シリアライズバッファ」と呼ぶ。

シリアライズバッファ内でのビット列の格納方法を示す。
まず、バッファ内の各バイトの上位 2bit は使われない。つまり各バイトは実質 6bit 値である。
そして、入力ビットは各バイトの上位ビットから順に格納される。図示すると以下のようになる:

+----------+----------+----------+
|  Byte0   |  Byte1   |  Byte2   |
+----------+----------+----------+ ...
| ..012345 | ..6789AB | ..CDEFGH |
+----------+----------+----------+

たとえば、ビット列の先頭 8bit が [1, 1, 1, 1, 0, 0, 0, 1] ならば、以下のように格納される:

+----------+----------+
|  Byte0   |  Byte1   |
+----------+----------+ ...
| ..111100 | ..01.... |
+----------+----------+

シリアライズバッファは可変長である。
セーブデータからシリアライズバッファに変換する場合、その長さは最後のビットが格納されたバイトまでとなる。
よって、この場合は最小 22 バイト、最大 29 バイトとなる(ビット数を 6 で切り上げ除算すると得られる)。

なお、シリアライズバッファはパスワードから変換することでも得られる。
詳細は後述するが、この場合バッファのバイト数はパスワードの文字数と等しくなる(最小 1 バイト、最大 38 バイト)。
これではデシリアライズの際にビット数が不足しうるが、その場合は不足したビット全てを 1 として扱う。
(パスワード「ふ」をロードした状態がほとんど 1 のビットなのはこれが理由)

チェックサム

シリアライズバッファの先頭 2 バイトはチェックサム格納領域となっており、残りはセーブデータをシリアライズしたビット列を格納している。

チェックサムは 2 種類あり、それぞれ「add チェックサム」「xor チェックサム」と呼ぶ。計算方法は次の通り:

• add チェックサムは、チェックサム格納領域 2 バイトを除いた全バイトを mod 64 で加算した総和。
• xor チェックサムは、チェックサム格納領域 2 バイトを除いた全バイトの XOR (下位 6bit のみ)。

いずれも 6bit 値となることに注意。
なお、パスワードから変換したシリアライズバッファで長さが 2 以下の場合、add/xor チェックサムはどちらも 0b111111 とする。

そして、シリアライズバッファの先頭 2 バイトには add チェックサム、xor チェックサムがこの順で格納される。
このチェックサムが一致しているとき、そのときに限り、シリアライズバッファからゲーム状態をデシリアライズできる。

パスワード

まず、0 文字のパスワードおよび文字 '?' (「いれる」などで発生する)を含むパスワードは入力時点で無効となる。
また、以下の「特殊パスワード」の空でない接頭辞であるようなパスワードは音楽室/美術室行きとなる:

• すべてのきよくがききたいな
• すべてのてきがみたいな

以下、このようなケースは除外して考える。

パスワードの各文字は 6bit の内部値を持ち、これを「文字コード」と呼ぶ。対応表を以下に示す:

パスワードをシリアライズバッファに変換することを「デコード」、その逆変換を「エンコード」と呼ぶ。

パスワードのデコード

パスワードのデコードは 2 段階で行われる。以下、パスワードの文字コード配列を password と書く。

第 1 段階では、パスワードの末尾から順に以下の変換を行う(^ は XOR):

• password[i] ^= password[i-1] (i > 0)
• password[0] ^= 0x1F

Rust では以下のように書ける:

for i in (1..password.len()).rev() {
    password[i] ^= password[i - 1];
}
password[0] ^= 0x1F;

これは大まかに言って累積 XOR の逆変換になっている。

第 2 段階では、パスワードの各文字について以下の変換を行う(減算は mod 64。% は剰余):

• password[i] -= [0x05, 0x19, 0x32, 0x21][i % 4]

Rust では以下のように書ける:

for (i, b) in password.iter_mut().enumerate() {
    *b = b.wrapping_sub([0x05, 0x19, 0x32, 0x21][i % 4]);
    *b &= 0x3F;
}

この変換結果がそのままシリアライズバッファとなる。
エンコードについてはこれの逆を行うだけなので省略する。

以上より、1 文字の有効なパスワードは「ふ」しかないことがわかる。
パスワードの先頭 1 文字は add チェックサムに対応しており、これが 0b111111 になる必要があるが、デコード処理の内容から、そのような入力は 1 通りしかないため。
同様にして 2 文字の有効なパスワードが「ふえ」しかないこともわかる(対応するセーブデータは「ふ」と同一)。

また、実は 2 文字目の文字コード (password[1]) が偶数であるパスワードは必ず無効となることが示せる。

不正なセーブデータのロード処理

パスワードとセーブデータの相互変換は以上の通りだが、一部のパスワード(「ふ」など)は変換結果のセーブデータに不正な値が含まれる。
セーブデータが不正でもロード自体はできるが、不正な装備はロード時にある種の(意図しない)変換がなされるので、これについて述べる。

まず、セーブデータ内の各部位の装備の値はアイテムIDそのものではなく、各部位に割り当てられたアイテムテーブル内のインデックスとなっている。
これらのインデックスは固定ビット長で記録されるが、アイテムテーブルは必ずしもサイズが 2 のべき乗になっていないため、不正なインデックスを与えるとテーブルの範囲外を参照してしまう。

各部位のアイテムテーブルは (部位インデックスのビット長、アイテムリスト) の形式で連続して並んでいる。これをダンプしたものを示す:

なお、各部位のインデックスが 0 の場合は無装備となる。

これを見ると、ほとんどのアイテムテーブルはサイズが 2 のべき乗になっていないことがわかる。
たとえば武器インデックスは 4bit だが、値を 15 にすると武器テーブルの範囲外、つまり鎧テーブル内の「むつきのどう」を参照してしまう。

このときの挙動だが、ロード時の装備復元処理は「アイテムIDを受け取り、それを装備可能な部位に装備する」という実装になっている(現在どの部位を復元しているかは見ていない)。
よって、テーブル範囲外を参照した場合、それが別部位に装備可能なアイテムIDならばそのまま別部位に装備される。
どの部位にも装備できないアイテムID(空欄を表す 0 など)は単に無視される。

これだと同部位に重複装備が起こりうるが、その場合は後から装備されたものが優先される。
(各部位は兜、武器、鎧、靴、いでたち0, いでたち1, いでたち2, いでたち3 の順に処理される)

例としてパスワード「ふ」(装備変換前セーブデータの全ビットが 1)の装備復元処理を示す:

• 初期状態は全部位が無装備。
• 兜インデックスは 3 である。これは空欄 0 を指すので無視する。
• 武器インデックスは 15 である。これは「むつきのどう」を指すので鎧枠に装備する。
• 鎧インデックスは 15 である。これは「シシのたび」を指すので靴枠に装備する。
• 靴インデックスは 7 である。これは「じんばおり」を指すのでいでたち0枠に装備する。
• いでたち0インデックスは 3 である。これは空欄 0 を指すので無視する。
• いでたち1インデックスは 3 である。これは空欄 0 を指すので無視する。
• いでたち2インデックスは 1 である。これは「おまもり」を指すので通常通り装備する。
• いでたち3インデックスは 1 である。これは「てっこう」を指すので通常通り装備する。