Game Files

Assets are files your game downloads at runtime — textures, audio, bundles, config blobs, and more. Flock hosts them and serves them to your game through the SDK, so you can update content without shipping a new build.

Scope: assets belong to your game; asset configurations describe and group them.

Dashboard
Unity
Unreal

Two pages work together:

Assets — upload and manage the files themselves.
Asset Configuration — define each asset’s metadata and grouping, so your game can resolve the right file at runtime.

Assets and configurations — Manage files on the Assets page and describe them on Asset Configuration.

Read the list of assets, find one by the name you gave it in your asset configuration, then download it through FlockClient.Instance.Asset. DownloadAsync<T> turns the file into a Unity type: T is one of Texture2D, Sprite, AudioClip, string or byte[]. Downloads are cached on disk by asset and version, so the second request for the same version is a local read rather than a transfer.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Flock;
using Flock.Models;
using UnityEngine;

public class TitleBanner : MonoBehaviour
{
    [SerializeField] private SpriteRenderer bannerRenderer;

    private async void Start()
    {
        // The whole index: for a manifest, or to drive a preload screen.
        List<AssetSchema> assets = await FlockClient.Instance.Asset.GetAllAsync();
        Debug.Log($"{assets.Count} assets in this game version");

        // By name, exactly as the dashboard shows it; throws FlockException when no asset has that name.
        AssetSchema banner = await FlockClient.Instance.Asset.GetByNameAsync("title_banner");

        // Already on disk at this version? Then no download happens.
        Debug.Log($"Cached: {FlockClient.Instance.Asset.IsCached(banner)}");

        // Download it as a Sprite, reporting progress from 0 to 1.
        Progress<float> progress = new Progress<float>(done => Debug.Log($"Downloading {done:P0}"));
        bannerRenderer.sprite = await FlockClient.Instance.Asset.DownloadAsync<Sprite>(banner, progress);
    }

    // Behind a loading screen: download into the cache without turning the files into Unity types.
    public Task PreloadSmallAssetsAsync()
    {
        return FlockClient.Instance.Asset.PreloadAsync(asset => asset.SizeBytes.HasValue && asset.SizeBytes.Value < 1_000_000);
    }
}

bannerRenderer is a SpriteRenderer you assign in the Inspector. GetUncached(assets) returns the assets of a list that are not on disk yet, and ClearCache() deletes every cached download. Asset reads and downloads work signed out.The cache is set on the Advanced Settings tab of Flock → Settings, Asset Cache card: Enable Asset Cache, Asset Cache Directory, Asset Cache Max Size MB (100 by default; past it the least recently used downloads are deleted), Asset Download Timeout Seconds and Asset Download Retry Count.

WebGL: untick Enable Asset Cache (and Enable Offline Cache, in the Offline Cache card) before you build for WebGL: a browser’s storage cannot take the synchronous file writes the caches make. Assets then download each time they are asked for.

Resolve each asset by the name you gave it in your asset configuration, then download it through the asset provider. Downloads stream straight to disk and are cached there, so the second request for the same version is a local read rather than a transfer.

UFlockSubsystem* Sdk = UFlockSubsystem::Get(this);
FFlockAssetProvider* Assets = Sdk->GetAssetProvider();

// The whole index — for a manifest, or to drive a preload screen.
Assets->GetAll([](TFlockResult<TArray<FFlockAsset>> Index) {});

// Download by name, straight into a texture.
Assets->DownloadTexture(TEXT("title_banner"), FFlockAssetProgress(),
    [](TFlockResult<UTexture2D*> Result)
    {
        if (Result.IsSuccess())
        {
            // Result.Value is ready to use.
        }
    });

Four download flavours cover the common cases: DownloadTexture, DownloadText, DownloadBytes, and DownloadFile, which hands back a path on disk. Each takes either an FFlockAsset or an id-or-name string, plus an FFlockAssetProgress delegate that reports bytes received against bytes total while the transfer runs.Audio. There is no texture-style helper for sound. Use DownloadFile and load the path through your own audio pipeline — the engine has no runtime importer for the compressed formats a CDN usually holds.Preloading. Preload and PreloadWhere fetch a batch behind a loading screen and report how many landed. A preload is best-effort by definition: one unreachable asset does not fail the batch.In Blueprint the same calls are Flock Get Assets, Flock Get Asset, Flock Download Asset Texture / Text / Bytes / File, and Flock Preload Assets, under Flock | Assets. The download nodes add an On Progress pin that fires repeatedly as bytes arrive. Cache questions need no network, so they are plain functions: Flock Is Asset Cached, Flock Get Uncached Assets, Flock Get Cached Asset Path, Flock Clear Asset Cache.Sign-in. Asset reads and downloads work signed out.

Keep large or frequently-changing content out of your build and deliver it as Flock assets — you can update it without a client release.

Getting Started

Concepts

Features

Reference