OpenFairyGUI API
    Preparing search index...

    Interface PublishNodeOptions

    interface PublishNodeOptions {
        assetsPath?: string;
        atlas?: Omit<NonNullable<PublishOptions["atlas"]>, "readFileRaw">;
        branch?: string;
        codeGeneration?: boolean;
        compressed?: boolean;
        document: Document;
        encoder?: AtlasRasterBackend;
        fileExtension?: string;
        output?: string;
        packages?: string[];
        plugins?: LoadedPlugin[];
    }

    Hierarchy

    • Omit<PublishOptions, "atlas" | "basePath" | "encoder" | "fs" | "plugins">
      • PublishNodeOptions
    Index
    assetsPath? atlas? branch? codeGeneration? compressed? document encoder? fileExtension? output? packages? plugins?
    assetsPath?: string

    Assets directory. Defaults to <document project dir>/assets when available.

    atlas?: Omit<NonNullable<PublishOptions["atlas"]>, "readFileRaw">
    branch?: string

    Active branch name used when branchProcessing is "主干合并活跃分支". Empty or omitted means publishing the main branch.

    codeGeneration?: boolean

    Run generic code generation after runtime artifacts. Default: true.

    compressed?: boolean

    Compress the binary data with zlib raw deflate. Default: false.

    document: Document
    encoder?: AtlasRasterBackend

    Override the standard Sharp raster backend.

    fileExtension?: string

    File extension for the binary output. Default: 'fui'. Unity projects typically use 'bytes'.

    output?: string

    Output directory override for published files (.fui + atlas PNGs). When omitted, publish uses package-level or project-level publish paths.

    packages?: string[]

    Filter which packages to publish by name. If not set, all packages are published.

    plugins?: LoadedPlugin[]

    Supply already-loaded hooks. Pass an empty array to skip project plugin discovery.

    Settings
    Member Visibility

    On This Page
    Properties