Fluid Database
A simple key value pair database for int, float, string, and bool. Easily extendable to custom database types via generics.
Installation
Fluid Database is used through Unity's Package Manager. In order to use it you'll need to add the following lines to your Packages/manifest.json
file. After that you'll be able to visually control what specific version of Fluid Database you're using from the package manager window in Unity. This has to be done so your Unity editor can connect to NPM's package registry.
{
"scopedRegistries": [
{
"name": "NPM",
"url": "https://registry.npmjs.org",
"scopes": [
"com.fluid"
]
}
],
"dependencies": {
"com.fluid.database": "1.0.0"
}
}
Releases
Archives of specific versions and release notes are available on the releases page.
Nightly Builds
To access nightly builds of the develop
branch that are package manager friendly, you'll need to manually edit your Packages/manifest.json
as so.
{
"dependencies": {
"com.fluid.database": "https://github.com/ashblue/fluid-database.git#nightly"
}
}
Note that to get a newer nightly build you must delete this line and any related lock data in the manifest, let Unity rebuild, then add it back. As Unity locks the commit hash for Git urls as packages.
Development Environment
If you wish to run to run the development environment you'll need to install the latest node.js. Then run the following from the root once.
npm install
If you wish to create a build run npm run build
from the root and it will populate the dist
folder.
Making Commits
All commits should be made using Commitizen (which is automatically installed when running npm install
). Commits are automatically compiled to version numbers on release so this is very important. PRs that don't have Commitizen based commits will be rejected.
To make a commit type the following into a terminal from the root
npm run commit
This project was generated with Oyster Package Generator.