+ def Material, desc fields: icon ; improved rev history description and introduction

Florian CUNY 2019-07-19 16:30:27 +02:00
parent b9c7c14200
commit f3356d86b2

@ -8,14 +8,20 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
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.
The goal of the BentoBox Blueprint format is to grant us the ability to serialize regions of a Minecraft world to disk or to any user-chosen storage method to be later placed back in the world, while avoiding to rely on third-party softwares or plugins to provide us the serialization and deserialization capabilities.
## 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
| 1 | 2019-06-09 | [1.5.0](https://github.com/BentoBoxWorld/BentoBox/releases/tag/1.5.0) | Initial version, derivative of the BentoBox Schem format
## Definitions
### <a name="defMaterial"></a>Material
A [Material](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html) is an ID provided by the [Bukkit API](https://dev.bukkit.org/) that defines the literal type of a block or an item. It affects various rendering options client-side such as light, transparency or display. They represent a programmatical shortcut to the actual corresponding NamespacedKey.
## Specifications
### Format
@ -34,8 +40,8 @@ All field names in the specification are **case sensitive**.
| Field name | Type | Description |
|---|---|---|
| name | `String` | Name of the Blueprint |
| icon | `String` | |
| name | `String` | Display name of the Blueprint |
| icon | `String` | [Material](#defMaterial) of the item representing the Blueprint in game as an icon |
| attached | `Array` | |
| entities | `Array` | |
| blocks | `Array` | |