From b9c7c14200287777c3aa26d1360de902d758da6e Mon Sep 17 00:00:00 2001 From: Florian CUNY Date: Thu, 18 Jul 2019 11:15:22 +0200 Subject: [PATCH] started creating the specification for the current version of blueprints --- Blueprint-Specification-v1.md | 45 +++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 Blueprint-Specification-v1.md diff --git a/Blueprint-Specification-v1.md b/Blueprint-Specification-v1.md new file mode 100644 index 0000000..d37731b --- /dev/null +++ b/Blueprint-Specification-v1.md @@ -0,0 +1,45 @@ +# BentoBox Blueprint Specification + +**Version 1** + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt). + +## Introduction + +This specification defines a format that describes a region (made up of blocks and entities) of a [Minecraft](https://minecraft.net) world for the purpose of serialization and storage to disk or to JSON-based database. It is designed in order to allow maximum cross-compatibility between platforms, versions, and various states of modification. + +## Revision history + +| Version | Date | BentoBox version | Description +|---|---|---|---| +| 1 | 2019-06-09 | [1.5.0](https://github.com/BentoBoxWorld/BentoBox/releases/tag/1.5.0) | Initial version + +## Definitions + +## Specifications + +### Format + +The structure specified by this specification is persisted to the user-chosen storage method using the [JavaScript Object Notation](https://json.org) (JSON) format. The data must then be compressed using the ... data compression algorithm. + +Files using this specification must use one of the following file extensions: +* `.blueprint` ; +* `.blu` + +All field names in the specification are **case sensitive**. + +### Schema + +#### Fields + +| Field name | Type | Description | +|---|---|---| +| name | `String` | Name of the Blueprint | +| icon | `String` | | +| attached | `Array` | | +| entities | `Array` | | +| blocks | `Array` | | +| xSize | `integer` | | +| ySize | `integer` | | +| zSize | `integer` | | +| bedrock | `Array` | | \ No newline at end of file