OpenFairyGUI API
    Preparing search index...

    Interface PublishOptions

    interface PublishOptions {
        atlas?: Omit<AtlasOptions, "encoder" | "basePath" | "outputPath">;
        basePath?: string;
        branch?: string;
        codeGeneration?: boolean;
        compressed?: boolean;
        encoder?: AtlasRasterBackend;
        fileExtension?: string;
        fs?: PublishFileSystem;
        output?: string;
        packages?: string[];
        plugins?: LoadedPlugin[];
    }
    Index
    atlas? basePath? branch? codeGeneration? compressed? encoder? fileExtension? fs? output? packages? plugins?
    atlas?: Omit<AtlasOptions, "encoder" | "basePath" | "outputPath">

    Atlas packing options.

    basePath?: string

    Base path for reading source images (project assets root). Required when encoder is provided.

    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.

    encoder?: AtlasRasterBackend

    Raster backend for atlas image compositing. Required when a filesystem-backed publish has packable resources. Without a filesystem, publish remains an explicit layout-only transform.

    fileExtension?: string

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

    fs?: PublishFileSystem

    FileSystem abstraction for writing output files. Required for actual file output. Calling publish with a resolved output directory but no filesystem is rejected; omit output entirely for a layout-only transform.

    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[]

    Publish hooks supplied by the host adapter.

    Node adapters load project plugins. Browser adapters pass an empty list.

    Settings
    Member Visibility

    On This Page
    Properties