BansheeGz

Setup guide

Import the package
Starting with Unity version 2022, API updater window should pop up. Make sure to press "Yes".
Open Window->BGDatabase. Click on Create new database file. Choose the loader (Resources or StreamingAssets) and press Create button
Select Configuration tab and create table (called Meta)
Add fields
Select Database tab and create data for tables (called Entities)
Make sure to commit database file to your source control system or make regular backups to prevent the risk of data loss.

Video

Which loader to choose?

Resources loader is a recommended loader to use
Choose StreamingAssets if you want to update database file without rebuilding your game
Choose custom loader if you want to load database from custom location and do not mind to write your own loader

You can switch between Resources/StreamingAssets loaders by simply moving your database file (bansheegz_database.bytes) between Resources/StreamingAssets folders (if you use localization addon, move all localization files as well- bansheegz_database*.bytes). Make sure to move corresponding meta files as well or move files inside Unity Editor.

	Resources	StreamingAssets	Custom
File location	Under one of Resources folders	Under Assets/StreamingAssets folder	Anywhere in your project
Pros	Works everywhere without any extra effort	You can update database file without rebuilding your game	Database file can be put to any place under your project Database content can be loaded from any location at runtime
Cons	If you store many assets under Resources folders (Unity does not recommend to do it), it may lead to slow database loading	WEBGL platform requires custom loader	you need to implement code, which loads database content. You need to load and assign database content using BGRepo.SetDefaultRepoContent method before accessing it
How to enable	File bansheegz_database.bytes should be placed under one of Resources folders	File bansheegz_database.bytes should be placed under Assets/StreamingAssets folder	Read the guide below

More details about database files

There are 2 different files BGDatabase operates with:

file with database data
file with user settings

More details about these files are available in the table below.

↓ Feature\File →	Database file	Settings file
Purpose	Database file	User settings file
Default name	bansheegz_database.bytes	BGS_{database asset GUID}.json
Format	Binary	Json
Available at runtime	Yes	No
Shared between developers	Yes	No, each developer has a separate file
Location	Under Resources / StreamingAssets folders	Under Documents folder
How to change location	Move (not copy) database file along with its meta file	N/A
How file is resolved	Naming convention is used (bansheegz_database.bytes)	File location is resolved using database asset GUID

You can create a single, shared settings file for all team members by placing bansheegz_database_settings.json file next to database file (only resources loader is currently supported). If you use GoogleSheets, make sure to not include bansheegz_database_settings.json into your build by using third-party tools or this package

Custom loader implementation guide

2 steps guide:

Override database location in Unity Editor.
Load database content manually at runtime and pass it to BGDatabase

Overriding database location inside Unity Editor

Exit Unity
Backup your database files
Move all database files (bansheegz_database*.bytes* ) to any location in your project (except Resources and StreamingAssets folders)
Open bansheegz_database.bytes.meta file in text editor and replace its guid with this value 3637ea689da0cff4b8d5c0fb5d609c15
Open up Unity and click on Reload button in BGDatabase window.
Select "Settings->Main>Database files" and make sure database is loaded from custom location and Loader is set to Custom. Also make sure all content is properly loaded.

Loading database content manually at runtime

Load database content from whatever location you want and call BGRepo.SetDefaultRepoContent(byte[] content) method before accessing database followed by BGRepo.Load().
If you use localization addon, you also need to load all localization files as well and use BGRepo.SetDefaultRepoContentModel(BGRepoCustomLoaderModel model) method instead.

    //content is database file content
    byte[] content = someContent; //todo load content
    BGRepo.SetDefaultRepoContent(content);
    BGRepo.Load();

Example projects

There are 2 example projects, demonstrating how to load database file(s) from Addressables.

For BGDatabase: download
For BGDatabase + localization addon : download