frdt
Resonite の .brson(中身は FrDT 形式)を、JSON へ展開せずに読み、編集し、書き戻す Rust クレートです。
Read and edit Resonite .brson (FrDT) files without expanding them into JSON.
できること
.brsonを開き、スロット、コンポーネント、Types、Assets、FeatureFlags、VersionNumberを読む。- 1回のストリーム読みで、スロット数、コンポーネント数、Dynamic Variable を数える。文書を展開しないので、大きなファイルでも軽く済みます。
- スロットとコンポーネントを足す。フィールドの値や参照を書き換える。同じ文書の中で親を変える。スロットを外す。
- 別の文書のスロット部分木を、コンポーネントとフィールドごと写す。id はすべて振り直し、参照は同じ相手を指したままにします。写した部分木が参照するアセットだけを連れていきます。
TypesとTypeVersionsを、残っているコンポーネントから作り直す。- 書き出す前に id を振り直す。同じ中身なら、同じバイト列になります。
- 2つの文書を構造で比べる。id は比べず、参照は指している先で比べます。
- Resonite が読み込める
.brsonを書き出す。
考え方
- JSON を通さない。 編集の実体は、展開した BSON 1枚と、スロットの位置を指す索引です。全体をオブジェクトの木にはしません。変えていない値はバイト列のままコピーします。
- 知らないものを落とさない。 コンポーネントごとのスキーマは持たず、触ったフィールドだけを読み書きします。未知のコンポーネントやフィールドは、そのまま残ります。
- Resonite の形で書く。 新しく書く値は、Resonite が保存するのと同じ形にします(
{ID, Data}で包んだフィールド、int64、float3/floatQは double の配列)。Infinity、-Infinity、NaNも、文字列にせず IEEE のビットのまま残します。
使い方
[]
= "0.2"
読む
let bytes = read?;
// 展開せずに数える
let summary = summarize?;
println!;
// 開いて辿る
let doc = open?;
let root = doc.root;
println!;
for child in root.children?
編集して書き出す
use ;
let mut doc = open?;
let root = doc.root;
let panel = doc.add_slot?;
let = doc.add_component?;
panel.set_component_value?;
panel.set?;
let mut out = Vecnew;
doc.write_brson?;
別のファイルの部分木を、新しい木にまとめる
let part = open?;
let source = part.slot_by_id?;
let mut out = empty?;
let import = out.import?;
// 写した先の id は import.new_id(元の id) で引ける
out.rebuild_types?;
まとめるときの選択肢と、書き出す前の仕上げ
use ;
let options = ImportOptions ;
let import = out.import_with?;
for m in import.mismatches
out.renumber_ids?; // 同じ中身なら同じバイト列になる
for d in compare?
API の詳細は docs.rs にあります。
対応している範囲
- 圧縮は Brotli(FrDT の圧縮種別
0x03)です。LZ4 と LZMA は読みません。 - BSON の日時型(
0x09)は、まだ扱えません。 - 参照かどうかは、文字列が文書内の id と一致するかで決めます。コンポーネントのスキーマは見ません。
Node.js から
同じ操作を、npm パッケージ @frdt/frdt で Node.js から呼べます。TypeScript の型付きで、Windows x64、Linux x64、macOS arm64 ではネイティブ版、それ以外では同梱の WebAssembly 版が動きます。
import { Document } from '@frdt/frdt'
const doc = Document.open(bytes)
const panel = doc.addSlot(doc.root(), 'Panel')
const out = doc.writeBrson()
使われているところ
もともとは、Resonite 向けの UI フレームワーク MirageX と、アイテム共有サービス UniPocket のために作りました。MirageX は、部品ごとの .brson を1本のクライアントの .brson にまとめる処理に、このクレートの編集と写しを使います。UniPocket は、アイテムの .brson の検証、加工、集計に使う予定です。
生成AI
このクレートのコードと文書は、生成AIの支援を受けて作成しています。
ライセンス
MIT License