vnite-plugin-sdk/dist/types/models/config.d.ts

Vnite Plugin Development SDK

export interface configDocs {
    general: {
        openAtLogin: boolean;
        quitToTray: boolean;
        language: string;
        hideWindowAfterGameStart: boolean;
    };
    game: {
        scraper: {
            common: {
                defaultDataSource: 'steam' | 'vndb' | 'bangumi' | 'ymgal' | 'igdb' | 'dlsite' | string;
            };
            vndb: {
                tagSpoilerLevel: 0 | 1 | 2;
            };
        };
        showcase: {
            sort: {
                by: 'metadata.name' | 'metadata.releaseDate' | 'record.lastRunDate' | 'record.addDate' | 'record.playTime';
                order: 'asc' | 'desc';
            };
        };
        gameList: {
            sort: {
                by: 'metadata.name' | 'metadata.releaseDate' | 'record.lastRunDate' | 'record.addDate' | 'record.playTime';
                order: 'asc' | 'desc';
            };
            selectedGroup: 'none' | 'collection' | 'metadata.genres' | 'metadata.developers' | 'record.playStatus';
            highlightLocalGames: boolean;
            markLocalGames: boolean;
            showRecentGames: boolean;
            showCollapseButton: boolean;
            playingStatusOrder: string[];
            playStatusAccordionOpen: string[];
            allGamesAccordionOpen: boolean;
            recentGamesAccordionOpen: boolean;
        };
        gameHeader: {
            showOriginalName: boolean;
        };
    };
    appearances: {
        sidebar: {
            showThemeSwitcher: boolean;
            showNSFWBlurSwitcher: boolean;
        };
        background: {
            customBackground: boolean;
        };
        showcase: {
            showPlayButtonOnPoster: boolean;
        };
        glass: {
            dark: {
                blur: number;
                opacity: number;
            };
            light: {
                blur: number;
                opacity: number;
            };
        };
        enableNSFWBlur: boolean;
        font: string;
    };
    hotkeys: {
        library: string;
        record: string;
        scanner: string;
        config: string;
        goBack: string;
        goForward: string;
        addGame: string;
        randomGame: string;
    };
    updater: {
        allowPrerelease: boolean;
    };
    metadata: {
        transformer: {
            enabled: boolean;
            list: {
                id: string;
                name: string;
                note: string;
                processors: {
                    name: {
                        match: string[];
                        replace: string;
                    }[];
                    originalName: {
                        match: string[];
                        replace: string;
                    }[];
                    description: {
                        match: string[];
                        replace: string;
                    }[];
                    developers: {
                        match: string[];
                        replace: string;
                    }[];
                    publishers: {
                        match: string[];
                        replace: string;
                    }[];
                    platforms: {
                        match: string[];
                        replace: string;
                    }[];
                    genres: {
                        match: string[];
                        replace: string;
                    }[];
                    tags: {
                        match: string[];
                        replace: string;
                    }[];
                    director: {
                        match: string[];
                        replace: string;
                    }[];
                    scenario: {
                        match: string[];
                        replace: string;
                    }[];
                    illustration: {
                        match: string[];
                        replace: string;
                    }[];
                    music: {
                        match: string[];
                        replace: string;
                    }[];
                    engine: {
                        match: string[];
                        replace: string;
                    }[];
                };
            }[];
        };
    };
}
export interface configLocalDocs {
    userInfo: {
        name: string;
        email: string;
        role: string;
        accessToken: string;
        refreshToken: string;
    };
    sync: {
        enabled: boolean;
        mode: 'official' | 'selfHosted';
        officialConfig: {
            auth: {
                username: string;
                password: string;
            };
        };
        selfHostedConfig: {
            url: string;
            auth: {
                username: string;
                password: string;
            };
        };
    };
    game: {
        linkage: {
            localeEmulator: {
                path: string;
            };
            visualBoyAdvance: {
                path: string;
            };
            magpie: {
                path: string;
                hotkey: string;
            };
        };
        scanner: {
            interval: number;
            ignoreList: string[];
            list: {
                [key: string]: {
                    path: string;
                    dataSource: 'steam' | 'vndb' | 'bangumi' | 'ymgal' | 'igdb' | 'dlsite' | string;
                    depth: number;
                };
            };
        };
    };
}
export declare const DEFAULT_CONFIG_VALUES: Readonly<configDocs>;
export declare const DEFAULT_CONFIG_LOCAL_VALUES: Readonly<configLocalDocs>;
//# sourceMappingURL=config.d.ts.map