EngineItem

EngineItem provides information of a engine.

Syntax

type EngineItem = {
    name: string
    source?: string
    version: 13
    title: Text | (string & {})
    subtitle: Text | (string & {})
    author: string
    authorUser?: UserItem
    tags: Tag[]
    skin: SkinItem
    background: BackgroundItem
    effect: EffectItem
    particle: ParticleItem
    thumbnail: Srl
    playData: Srl
    watchData: Srl
    previewData: Srl
    tutorialData: Srl
    rom?: Srl
    configuration: Srl
}

name

Unique name which identifies the engine.

source

Address of the source server.

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

skin / background / effect / particle

Default items to use with the engine.

Examples

{
    "name": "bandori",
    "version": 13,
    "title": "BanG Dream!",
    "subtitle": "BanG Dream! Girls Band Party!",
    "author": "Burrito",
    "tags": [
        // ...
    ],
    "skin": {
        // ...
    },
    "background": {
        // ...
    },
    "effect": {
        // ...
    },
    "particle": {
        // ...
    },
    "thumbnail": {
        // ...
    },
    "playData": {
        // ...
    },
    "previewData": {
        // ...
    },
    "tutorialData": {
        // ...
    },
    "configuration": {
        // ...
    }
}