A flexible system to import Notion databases into a Unity scriptable object for use in Unity game projects. Note: This is experimental. While functional, there may be issues or edge cases that are not covered. Updates will also be slow/infrequent.
_2022/06/28-critical?style=for-the-badge&color=918f48){kind=icon}
- Features
- Planned Features
- Supported Properties
- Installation
- Setup Guide
- Downloading Data
- API Access
- Usage Example
- Download databases of any size.
- Apply sorting to data to order it just as it is in a Notion database view.
- Automatic parsing of data into their field types.
- Support for most useful Notion data properties.
- Automatic API key removal on build creation for security.
- System to reference assets in code without a direct inspector reference.
- Support for applying filters when downloading a Notion database.
Any string convertible type should also support JSON for custom classes, but the mileage may vary. Best to just store raw data in these assets and convert the data with an override to the PostDataDownloaded() method in the Notion Data Asset.
Note that rollups are supported only when they show a property that is otherwise supported below:
| Property type | Conversion types supported (Unity) |
|---|---|
| Title | string |
| Text | string NotionDataWrapper(GameObject(Prefab)/Sprite/AudioClip), List/Array of string, int, float, double, bool |
| Number | int float double etc |
| Toggle | bool |
| Single-Select | string enum |
| Multi-Select | string[] List<string> enum flags |
| Rollup | Any supported from above types. |
| Date | SerializableDateTime |
Release:
The most up-to-date version of the repo that is considered stable enough for public use.
https://github.com/CarterGames/NotionToUnity.git
Pre-release:
Used to prepare future releases before releasing them, checking for bugs mainly. Will have the latest features but may not be stable just yet. Use at your own risk.
https://github.com/CarterGames/NotionToUnity.git#pre-release
Import the package found in the releases section through the "Import custom package" right-click menu option in Unity's project tab.
Download the repo/clone it and import the files into your project manually.
You need to make an integration in order for the downloading to work. You can make an intergration here. The steps to follow are:
- Make a new integration with the
New integrationbutton. - Select the workspace the integrations can access. This should be the workspace the database(s) you want to download are in.
- Give the integration a name & continue to the next page.
- Navigate to the
Capabilitiestab from the sidebar and ensure the integration has read access. You can disable the rest as you only need the readability. - Navigate to the
Secretstab and copy the key for use in Unity.
Once done you can then enter Notion and add the integration to one or multiple pages to allow the Notion API to access the data. This is done from: ... > Manage Connections > "Find and add your integration from the options"
If you don't see the integration you just made listed, close & open Notion and follow the steps again.
In Unity you use a Notion Data Asset to store the data. This is just a scriptable object which has a custom inspect or to aid with the data download. Each instance you wake will consist of the data asset, a scriptable object class and the data class which holds the data structure for the data asset to store. There is a tool to make these for you which can be found under Tools > Notion To Unity > Asset Creator
The asset creator is an editor window that handles creating the classes for a Notion Data Asset. You just enter a name for the class you want to make and press Create when ready. You'll be able to see a preview of what the classes will be called before your press the Create button. Once pressed you'll be able to select where you want to save each newly generated class. Its best to keep them together in the same directory for ease of use.
Once setup you'll just need to write your data class to have the fields you want. An example of a Persona healing skill data class
[Serializable]
public class DataHealingSkills
{
/* —————————————————————————————————————————————————————————————————————————————————————————————————————————————
| Fields
————————————————————————————————————————————————————————————————————————————————————————————————————————————— */
[SerializeField] protected string skillName;
[SerializeField, TextArea] protected string desc;
[SerializeField] protected NotionDataWrapperSprite icon;
[SerializeField] protected SkillType type;
[SerializeField] protected ActionTarget target;
[SerializeField] protected SkillCost cost;
[SerializeField] protected NotionDataWrapperPrefab effect;
[SerializeField] private float power;
[SerializeField] private StatusAilment cureAilments;
[SerializeField] private bool canRevive;
}
To download your data you will need the link to the database page and the secret key for the integration you made earlier. The Database link can be grabbed from the ... menu on the page the database is on:
Then just fill the fields on the data asset (make one from the CreateAssetMenu if you haven't already) and then press the download button. If all goes well you'll see a dialogue stating so. If it fails you should see the error in the console.
(Image from The Cart implementation of the system, so secret key is in a global field, you'll have to assign it per asset with this setup).
You can apply sorting properties to your download requests by adding them to the sort properties list in the inspector. The text for each entry is the Notion property name you want to sort by, with the tick box set to if you want to sort ascending for that property. The order of the sort properties in the list defines the order they are used, just like in Notion.
The editor for this will be improved at some point.
Some data needs a wrapper class to assign references. This is provided for GameObject prefabs, Sprites & AudioClips should you need it. They are assigned by the name of the asset when downloading the data.
You can also manipulate the data you download after receiving it by writing an override to the method called PostDataDownloaded() on the Notion Data Asset . Note if you need to run editor logic, make sure it is in a #ifdef. An example below:
#if UNITY_EDITOR
protected override void PostDataDownloaded()
{
skillLookup = new SerializableDictionary<string, DataHealingSkills>();
foreach (var data in Data)
{
// Runs a method called PostDownloadLogic() on the data class instance.
data.GetType().GetMethod("PostDownloadLogic", BindingFlags.NonPublic | BindingFlags.Instance)
?.Invoke(data, null);
// Adds the data class to a lookup for easier use at runtime.
skillLookup.Add(data.Name, data);
}
// Saves the changes to the scriptable object.
UnityEditor.EditorUtility.SetDirty(this);
UnityEditor.AssetDatabase.SaveAssets();
}
#endif
You can download all data assets in one process through an additional editor window. The window can be found under Tools > Carter Games > Standalone > Notion Data > Update Data. The window has the option to halt the downloading of assets if an error occurs, by default this true. To download all assets in the project, just press the download button and wait for the process to complete.
If you are using custom assembly definitions you will need to reference the runtime assembly from this asset in-order to access the API such as the DataAccess class. If you are not using custom assemblies, you should be able to access all the API by default. The runtime assembly is called CarterGames.Standalone.NotionData.Runtime
You can reference the assets as you would a normal scriptable object in the inspector. Or you can use the DataAccess class in the project to get them via code. Each Notion Data Asset has a variant id in the inspector. By default the variant id is a new GUID on creation. You can change this to help you identify a single instance of assets of the same type as another. Some example usage below:
private void OnEnable()
{
// Gets the first asset of the type found.
var asset = DataAccess.GetAsset<NotionDataAssetLevels>();
// Gets the asset of the matching variant id.
asset = DataAccess.GetAsset<NotionDataAssetLevels>("MyAssetVariantId");
// Gets all of the assets of the type found.
var assets = DataAccess.GetAssets<NotionDataAssetLevels>();
}
Below is an example using the system to store data for Persona 5 healing skills for persona's
Notion A database of all the skills for healing:
Unity The downloaded data in Unity:
