📜NebX-Spec.

Specification

Users who upload their collections according to NebX's specifications will be able to showcase them in 3D on NebX-Land. We will utilize 2D animation resources as case studies to elaborate on their attribute specifications.

Single Image Resource

This is the essential attribute keyword necessary when the resource is a solitary 2D image file. Let's use [Send it] as a pixel image for illustration.

< sprite
    < !--required-- >
    name = "Send it"
    infos = "It is an NFT of Send it"
    src = "/content/41X4EqpiBr7detx3EEF4euNAJuAL16nQtW6EvcQYjUeB"
    format = "JPG"
    model_type = "truck"
    rect = (2.5, 10.3, 20, 20)
< sprite />

Single Basic Attributes

The attributes reference table is provided below. Please review it thoroughly.

Key
Required?
Description

name

Yes

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

infos

No

Description related to the resource.

src

Yes

On-chain address.

format

Yes

The file format of the original resource, supported formats include PNG, JPG, JPEG, TGA, BMP, TIFF.

model_type

Yes

Type of model the image is bound to (optional: wall, billboard, screen, standing sign...).

rect

Yes

Coordinates and dimensions of the image displayed on the model, parameters in sequence are x-coordinate, y-coordinate, width, height.

Multiple Image Resources

If you have multiple 2D NFTs that you want to showcase in the same model, you can choose this approach. We will use [Frogana] collection as an example to provide an in-depth explanation of the attributes associated with multiple Image Resource Preview Templates.

< sprite
    < !--required-- >
    name = "Frogana Collection"
    infos = "It is a collection of Frogana"
    src_map = { 
        "/content/G3QoVj8757CiSSHNgNWozq9UWgiTTwy73sG5Jxykm2tq",
        "/content/349gnggik8x2xz4Rw1SBYFuo7jbD8rNfLPX4aFHHLqd8",
        "/content/DjUYo7cMMURsCoVT2SHBdTSnEZ4s5jzWqi8P688HYPZJ",
        "/content/8K7mffqQPb2Wwp2n2J4XDc4Ueoe4pgmUaGUCMvRsb99e"
        }
    format = "JPG"

    < !--rect = (x, y, w, h)-- >
    model_type = "billboard"
    rect = (2.5, 10.3, 20, 20)
    interval = 0.5

< sprite />

Multiple Attributes

The attributes reference table is provided below. Please review it thoroughly.

Key
Required?
Description

name

Yes

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

infos

No

Description related to the resource.

src

Yes

On-chain address.

format

Yes

Supported formats include PNG, JPG, JPEG, TGA, BMP, TIFF.

model_type

Yes

Type of model the image is bound to (optional: wall, billboard, screen, standing sign...).

rect

Yes

Coordinates and dimensions of the image displayed on the model, parameters in sequence are x-coordinate, y-coordinate, width, height.

interval

Yes

Animation playback speed.

Last updated