File Deployment and Generic Scene Id Migrations #2098
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This has a number of related changes
Package Data Files
I have added a folder xbvr_data. Any files added in here will be included in the install packages in the xbvr_data directory alongside the xbvr executable.
When Xbvr starts, it will check for the xbvr_data directory and copy file contents to the Xbvr Appdir, if the files are new or newer.
Generic Scene Id Migrations.
There is a new generic process to rename Scene Ids that can be used by migrations called RenameSceneIdsFromFile
The mapping of old and new values is stored in a json file that can be package and deployed by placing in the xbvr_data/migrations/release directory
These lists are outside the xbvr executable, using the new Package Data Files above, rather than compiled in
It has Options to
- "custom_mappings": true
- "processed": true, xbvr will change this to true when it has been processed
0086-update-vrporn-ids
vrporn_ids.go has been removed. This was causing compiling xbvr under vscode to fail, possibly other environments as well.
0086-update-vrporn-ids has been rewritten to use the new generic Scene Id re-maping function RenameSceneIdsFromFile and scenes details from vrporn_ids.go are in a new file 0086-update-vrporn-ids.json file in the xbvr_data/migrations/release directory.
Most users are probably already on 0.4.36, so they will already have run the 0086-update-vrporn-ids migrations and this will not be re-run with the new code.
Non standard deployments: It should be noted if you are not using the standard deployment packages and have your xbvr executable in the same directory pointed to by APPDIR, you will need to ensure you update your xbvr_data when needed. This is probably mainly something for developers to be aware of, potentially effecting them depending on their development and testing environment setups
To re-iterate If the xbvr executable is in APPDIR (not standard practice), make sure YOU update xbvr_data