WebPrefs v0.2

← Back to WebPrefs

WebPrefs is a package which serves as a replacement to Unity's PlayerPrefs saving system, made to integrate much better into WebGL games. WebPrefs makes your save data harder to lose after publishing new game builds, and gives you much more power and flexibility with the data you are saving.

By default, PlayerPrefs simply store data inside the IndexedDB, but this is not great because we lose access to this data if we ever make a new build of the game. Instead this gets around that by using a JavaScript bridge to save to the browser's localStorage instead, along with keeping backups and fallbacks inside the IndexedDB, so your data is super hard to lose!

Even though this was made for WebGL games, simply calling WebPrefs to save your data will also properly channel it through PlayerPrefs, using the custom serialization to allow for all of the more advanced data types this lets you save, so don't worry about any PC port headaches for your web game.

How To Install

  1. Open the Package Manager inside Unity.
  2. Click on the '+' icon in the top-left corner, then click 'Install package from git URL'.
  3. Paste the following URL into the textbox:
https://github.com/obradev/WebPrefs.git

It should be installed now. You can head over to Samples for an optional demo scene.

Getting Started

Add the using directive to the top of your script:

using ObraDev.WebPrefs;

After this you can instantly start using the package to save data.

Saving Values

WebPrefs.Save(string key, object value);

key is the name you will know the data by (e.g. "coins"), and value can be various types: string, int, float, bool, etc. 

WebPrefs.Save("coins", 100);

Loading Values

There are two ways to load data:

  1. Generic method: 
    int coins = WebPrefs.Load<int>("coins");
// With a default fallback:
int coins = WebPrefs.Load<int>("coins", 0);
  2. Premade typed methods: 
    int coins = WebPrefs.LoadInt("coins");

Checking Values

WebPrefs.HasKey(string key); // returns bool

Deleting Values

WebPrefs.DeleteKey(string key); // clears one key
WebPrefs.ClearAllData();        // clears everything

Other Methods

WebPrefs.Reload();                   // reloads from IndexedDB backup (or saves via PlayerPrefs on non-web)
WebPrefs.GetRawData();               // returns the full serialized localStorage string (useful for debugging)
WebPrefs.GetAllKeys();               // returns a string array of all currently saved keys
WebPrefs.GetKeyType(string key);     // returns the Type a key was saved as, or null if not found

Events

Subscribe to these events to react to internal WebPrefs actions from anywhere in your code:

WebPrefs.OnKeySaved    += (string key) => { };  // fires after any successful save
WebPrefs.OnKeyDeleted  += (string key) => { };  // fires after a key is deleted
WebPrefs.OnDataCleared += () => { };            // fires after ClearAllData()
WebPrefs.OnDataRestored += () => { };           // fires when localStorage is recovered from IDB backup
WebPrefs.OnSaveFailed  += () => { };            // fires when localStorage write fails
WebPrefs.OnStorageFull += () => { };            // fires when the 10KB localStorage cap is reached

Example usage:

void Start()
  {
      WebPrefs.OnKeySaved += key => Debug.Log("Saved: " + key);
      WebPrefs.OnDataRestored += () => ShowRestoredMessage();
  }

Available Data Types

Final Notes

← Back to WebPrefs