ParticleItem

ParticleItem provides information of a particle.

Syntax

type ParticleItem = {
    name: string
    source?: string
    version: 3
    title: Text | (string & {})
    subtitle: Text | (string & {})
    author: string
    authorUser?: UserItem
    tags: Tag[]
    thumbnail: Srl
    data: Srl
    texture: Srl
}

name

Unique name which identifies the particle.

source

Address of the source server.

Providing a source allows Sonolus to update the item in collection and use the item in multiplayer.

Examples

{
    "name": "bandori-1",
    "version": 3,
    "title": "Effect Type 1",
    "subtitle": "BanG Dream! Girls Band Party!",
    "author": "Sonolus",
    "tags": [
        // ...
    ],
    "thumbnail": {
        // ...
    },
    "data": {
        // ...
    },
    "texture": {
        // ...
    }
}