1.1 2D Inscription

This chapter is the Metaverse Resources Inscriptions specifically defined for all 2D resources as the founding resource inscription standard. Although it's experimental and may not be perfect, it already meets most of the key attribute requirements for a wide range of 2D resources to satisfy the needs of most applications and engines.

This 2D resource inscription standard is still in the beta phase and does not represent its final level of completion.

This chapter mainly describes the basic attributes related to the attribute block of metaverse in 2D Res Inscriptions. For detailed explanations about metaversepreview, please see the corresponding section chapter 1.1.1.

Single Image Resource

This is the relevant inscription attribute keyword required when the resource is a single 2D image resource. We take a pixel image chair as an example.

<metaverse
	name="chair"
	description="This is a pixel chair, you can use it anywhere"
	src="/content/2a42c7779edi04591981ec0c1253cdd68de55205bb7e9f04ffacc0756921efc0c7"
	srctype="PNG"
>
</metaverse>

<metaversepreview
	backgroundcolor="0b9db7"
	>
	<previewimg 
		src="/content/2a42c7779edi04591981ec0c1253cdd68de55205bb7e9f04ffacc0756921efc0c7"
	/>
	<previewimg 
		src="/content/6f7c28ce0f87f498ab4be1dc4e498c206b85a2646285609fd4392i0178090cf70d"
	/>
	<previewimg 
		src="/content/2c777cc0756d5bb198153cdde9f00c779edi0ef0594ffa692ec18c4e5522a40c12"
		size="[1,1]"
		position="[0.5,0.8]"
	/>
</metaversepreview>
<script  src="/content/5a24d6d8d12794e88d2c76e321081939295ad73add3820834757b7914a34acfai0"></script>

Inscribing a single-image resource is straightforward; there are no complex attribute settings. The complete attribute reference table is as follows. Please read carefully.

This attribute set is just a reference and description for resources in the form of a single image. Some non-essential attributes are not aligned here. For details on these non-essential attributes, please refer to the metaverse attribute key list.

Properties marked as "No Required" may not necessarily have to be set. However, not setting these attributes will affect games and applications that reference them. Different games and applications might need to establish their default loading attributes to dynamically assign values to these attributes. Setting these attributes helps to standardize the ecosystem and also facilitates a uniform standard between different applications.

key	required?	description
name	Yes	Resource name, which serves as the identifier for the resource.
description	No	Description related to the resource.
src	Yes	The source file of the resource that has already been uploaded to the chain, such as an image for 2D resources or a model for 3D resources.
srctype	Yes	The file format of the original resource, such as PNG, JPEG for image resources, or OBJ, FBX, GLB for model resources.
any keys you want	No	You can, of course, add any custom attributes you like. The recommended key format is "custom_yourtypename." Attributes without the "custom" keyword are either genesis attributes of the protocol or attributes related to subsequent community voting.

key

required?

description

name

Yes

Resource name, which serves as the identifier for the resource.

description

Description related to the resource.

src

Yes

The source file of the resource that has already been uploaded to the chain, such as an image for 2D resources or a model for 3D resources.

srctype

Yes

The file format of the original resource, such as PNG, JPEG for image resources, or OBJ, FBX, GLB for model resources.

any keys you want

You can, of course, add any custom attributes you like. The recommended key format is "custom_yourtypename." Attributes without the "custom" keyword are either genesis attributes of the protocol or attributes related to subsequent community voting.

Atlas Image Resource

When the resource is an atlas, and the resource only references images at a specific location within the atlas, here are the related attributes. We use this Christmas tree as an example for inscribing reference:

<metaverse
	name="christmas tree"
	description="This is a christmas tree"
	src = "/content/085a2646285118ce090cf70d6f7c2bf87f498ab4be788c4392i02dc4e406609fd9"
	srctype="PNG"
	isatlas="true"
	atlasrange="[0,96,32,48]"
>
</metaverse>

<metaversepreview
	backgroundcolor="0b9db7"
	>
	<previewimg 
		src="/content/085a2646285118ce090cf70d6f7c2bf87f498ab4be788c4392i02dc4e406609fd9"
		isatlas="true"
		atlasrange="[0,96,32,48]"
	/>
	<previewimg 
		src="/content/6f7c28ce0f87f498ab4be1dc4e498c206b85a2646285609fd4392i0178090cf70d"
	/>
	<previewimg 
		src="/content/1d98ab4bc17826462e8786f7c28806b5609fd4392i0090cf70df45ace0f4e498c2"
		size="[0.4,0.4]"
		position="[0.8,0.25]"
		rotation="30"
	/>
</metaversepreview>
<script  src="/content/5a24d6d8d12794e88d2c76e321081939295ad73add3820834757b7914a34acfai0"></script>

Here, only the unique attribute keys are explained; for other attributes, please refer to the description of keys for single 2D image resources.

key	required?	description
isatlas	Yes	If the referenced resource is an image from an atlas, then this attribute must be filled out. Setting 'isatlas' to true marks it as an atlas.
atlasrange	Yes	This attribute marks an area within the atlas, represented by [x,y,z,w]. Where x,y are the starting pixel coordinates of the referenced area, and z,w are the length and width of that area, respectively. For more details, see "Atlas Range Area".

key

required?

description

isatlas

Yes

If the referenced resource is an image from an atlas, then this attribute must be filled out. Setting 'isatlas' to true marks it as an atlas.

atlasrange

Yes

This attribute marks an area within the atlas, represented by [x,y,z,w]. Where x,y are the starting pixel coordinates of the referenced area, and z,w are the length and width of that area, respectively. For more details, see "Atlas Range Area".

Animation Sheet Resource

When the resource is a 2D animation sequence, the related attribute settings for this resource are described. Here, we take a cute little dog as an example to illustrate:

<metaverse
	name="CuteDoge"
	description="This is a cute dog with animation, you can use it anywhere"
	src = "/content/4acc4304ab4b62855ad8540c4effd6f70410ce3gg50e7886109ad985dc2ba2642"
	srctype="PNG"
	issheetanimate="true"
	sheetlayout="[8,5]"
>
	<animate name="idle-down" range="[0, 0]" duration="0.9" />
    	<animate name="idle-up" range="[1, 1]" duration="0.9" />
    	<animate name="idle-right" range="[2, 2]" duration="0.9" />
	<animate name="idle-left" range="[3, 3]" duration="0.9" />
	<animate name="move-right" range="[8, 15]" duration="0.9" />
    	<animate name="move-up" range="[16, 23]" duration="0.9" />
    	<animate name="move-down" range="[24, 31]" duration="0.9" />
	<animate name="move-left" range="[32, 39]" duration="0.9" />
</metaverse>

<metaversepreview
	backgroundcolor="0b9db7"
	>
	<previewimg 
		src="/content/4acc4304ab4b62855ad8540c4effd6f70410ce3gg50e7886109ad985dc2ba2642"
		issheetanimate="true"
		sheetlayout="[8,5]"
		sheetindex="14"
	/>
	<previewimg 
		src="/content/6f7c28ce0f87f498ab4be1dc4e498c206b85a2646285609fd4392i0178090cf70d"
	/>
	<previewimg 
		src="/content/2c777cc0756d5bb198153cdde9f00c779edi0ef0594ffa692ec18c4e5522a40c12"
		size="[1,1]"
		position="[0.5,0.25]"
	/>
	<previewimg 
		src="/content/1d98ab4bc17826462e8786f7c28806b5609fd4392i0090cf70df45ace0f4e498c2"
		size="[0.4,0.4]"
		position="[0.8,0.8]"
		rotation="-30"
	/>
</metaversepreview>
<script  src="/content/5a24d6d8d12794e88d2c76e321081939295ad73add3820834757b7914a34acfai0"></script>

Here, only the unique attribute keys are explained; for other attributes, please refer to the description of keys for single 2D image resources.

Single Basic Attributes:

key	required?	description
issheetanimate	Yes	If the referenced resource is an animation sequence, then this attribute must be filled out. Setting issheetanimate to true marks it as a 2D sheet animation resource.
sheetlayout	Yes	The horizontal and vertical tiling division of the animation sequence frames [x, y] where x is the number of frames horizontally and y is the number of frames vertically.

key

required?

description

issheetanimate

Yes

If the referenced resource is an animation sequence, then this attribute must be filled out. Setting issheetanimate to true marks it as a 2D sheet animation resource.

sheetlayout

Yes

The horizontal and vertical tiling division of the animation sequence frames [x, y] where x is the number of frames horizontally and y is the number of frames vertically.

The attribute block is divided by <animate ... />. The sub-attributes are as follows:

key	required?	description
name	Yes	Animation name
range	Yes	Animation starting frame and ending frame [x, y]. The starting and ending frames are grid numbers divided in the sheet image, from left to right and from top to bottom. The upper left corner is 0, and the lower right corner is the last number. x: start number, y: end number.
duration	Yes	Playback speed, (total time of the entire animation in seconds)
loop	No	Whether it loops or not

key

required?

description

name

Yes

Animation name

range

Yes

Animation starting frame and ending frame [x, y]. The starting and ending frames are grid numbers divided in the sheet image, from left to right and from top to bottom. The upper left corner is 0, and the lower right corner is the last number. x: start number, y: end number.

duration

Yes

Playback speed, (total time of the entire animation in seconds)

loop

Whether it loops or not

PreviousBRC-420 Metaverse Standard Next1.1.1 2D Preview Template

Last updated 10 months ago