Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 3.64 KB

README.md

File metadata and controls

86 lines (63 loc) · 3.64 KB

SpringNBTLibraryドキュメント

Minecraft Java版26.1以降のワールド/NBTファイルを、複数の言語で同じように読み書きするライブラリのドキュメントです。

まずどこを読むかは次のとおりです。

目的 読むもの
何ができるのか知りたい 機能一覧
とりあえず動かしたい はじめに
使い方を調べたい ガイド
他の言語版の対応するAPIを知りたい API対応表
自分で実装・移植したい 仕様
なぜその設計なのか知りたい 設計判断の記録

目次

機能

はじめに

ガイド

API対応表

仕様(実装者向け)

開発

設計判断の記録 (ADR)


仕様が先にある

実装より先にspec/に仕様を書き、各言語はそれを実装しています。 どの言語版でも同じ入力から同じバイト列が出るかは適合性テストが確かめていて、機能一覧が実装からずれていないかもCIで見ています。

Rustのツールで書いたワールドをJavaのプラグインで読む、といった場面で、ライブラリごとの違いに悩まされずに済むのが狙いです。