Installation¶
VixTools packages are installed through Unity Package Manager from the VixVoid scoped registry.
Choose one setup method:
- Easy Way: install
VixRegistryInstalleronce and let it add the scoped registry for you. - Manual Way: edit
Packages/manifest.jsonyourself.
Easy Way¶
Use this method for new projects unless you specifically want to manage the manifest by hand.
1. Add VixRegistryInstaller¶
In Unity:
- Open
Window > Package Manager. - Click
+. - Choose
Add package from git URL.... - Paste this URL:
https://m7q4r9x2p6k3f8n1.forgejo.viktorp04.com/ViktorP04/VixTools.git?path=/Packages/com.vixvoid.vixregistryinstaller#main
When Unity loads the package, VixRegistryInstaller automatically adds the VixVoid scoped registry to Packages/manifest.json.
You can also run the installer manually from:
Vix > Installer > Install Vix Registry
2. Add Vix Packages¶
After the registry is installed, open Window > Package Manager.
Use the package list or Add package by name... to install the packages you need:
| Package | Package name |
|---|---|
| VixCore | com.vixvoid.vixcore |
| VixGizmos | com.vixvoid.vixgizmos |
| VixSettings | com.vixvoid.vixsettings |
| VixSteamBuilder | com.vixvoid.vixsteambuilder |
Manual Way¶
Use this method if you do not want to install VixRegistryInstaller.
Edit your Unity project's Packages/manifest.json and add the VixVoid scoped registry:
{
"scopedRegistries": [
{
"name": "VixVoid",
"url": "https://registry.viktorp04.com/",
"scopes": [
"com.vixvoid"
]
}
],
"dependencies": {
"com.vixvoid.vixcore": "latest",
"com.vixvoid.vixgizmos": "latest",
"com.vixvoid.vixsettings": "latest",
"com.vixvoid.vixsteambuilder": "latest"
}
}
If your manifest already has scopedRegistries or dependencies, merge the entries instead of replacing the whole file.
Only add the packages you actually need. For example, a project that only needs VixCore can add just:
{
"dependencies": {
"com.vixvoid.vixcore": "latest"
}
}
Notes¶
VixRegistryInstaller is only needed for the easy setup path. It does not need to stay in every project after the scoped registry has been added.
VixGizmos requires Universal Render Pipeline. Unity Package Manager installs declared package dependencies automatically when they are available.
VixSteamBuilder depends on VixCore. Unity Package Manager installs declared dependencies automatically when they are available from the configured registries.