caching

An image, string, and audio clip caching system for Unity.

The first time you "request" a url from the cache, it downloads it and stores a copy on-disc (in Application.persistentDataPath and in-memory). Future "requests" use the in-memory version (if it has already been loaded), or the on-disc version (which then gets stored in-memory for faster access in the future).

How To Install

The caching package uses the scoped registry feature to import dependent packages. Please add the following sections to the package manifest file (Packages/manifest.json).

To the scopedRegistries section:

{
    "name": "DSS",
    "url": "https://registry.npmjs.com",
    "scopes": [ "com.dss" ]
}

To the dependencies section:

"com.dss.core-utils": "1.6.6",
"com.dss.caching": "1.1.3"

After changes, the manifest file should look like below:

{
    "scopedRegistries": [
    {
        "name": "DSS",
        "url": "https://registry.npmjs.com",
        "scopes": [ "com.dss" ]
    }
    ],
    "dependencies": {
        "com.dss.core-utils": "1.6.6",
        "com.dss.caching": "1.1.3"
        ...

Usage

The Cache component can be accessed as a singleton from any script as follows:

// Grab a reference to the singleton
DSS.Caching.Cache cache = DSS.Caching.Cache.Instance;

// Request a sprite from the given url
cache.RequestSprite("https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png",
(Sprite sprite) =>
{
    // Do something with the sprite once it loads
},
(string errorMessage) =>
{
    Debug.LogError(errorMessage);
});

// Request text content from the given url
cache.RequestString("https://raw.githubusercontent.com/github/gitignore/master/Unity.gitignore",
(string text) =>
{
    Debug.Log(text);
},
(string errorMessage) =>
{
    Debug.LogError(errorMessage);
});

// Request an audio clip from the given url
cache.RequestAudioClip("https://file-examples-com.github.io/uploads/2017/11/file_example_MP3_700KB.mp3",
(AudioClip clip) =>
{
    // Do something with the clip once it loads
},
(string errorMessage) =>
{
    Debug.LogError(errorMessage);
});

Alternatively, if you want to download a collection of files and be notified when all downloads are complete, you can do the following:

// Create a new download manager
DSS.Caching.DownloadManager dm = new DSS.Caching.DownloadManager();

// Add files to download to the manager
dm.AddSprite("https://www.example.com/A.png",
(sprite) =>
{
    // do something with sprite A
},
(error) =>
{
    Debug.LogError(error);
});

dm.AddSprite("https://www.example.com/B.png",
(sprite) =>
{
    // do something with sprite B
},
(error) =>
{
    Debug.LogError(error);
});

dm.AddSprite("https://www.example.com/C.png",
(sprite) =>
{
    // do something with sprite C
},
(error) =>
{
    Debug.LogError(error);
});

// And actually begin downloading
dm.Download(() =>
{
    Debug.Log("all files downloaded!");
});