The Overlay Image feature allows you to add a transparent image on top of the Interactive Map mode. This image can be used to enhance the experience, add more data, instructions, templates, etc.
Location
You can find the images in KinectSandbox\KinectSandbox_Data\StreamingAssets\OverlayImages folder. They have been divided into three subfolders for easier navigation. If you decide to add your own files, place them in one of the existing folders, make a new one, or simply save them to the main folder. The files have to be transparent image .png files.
The image being used is defined in the currently loaded preset file, or chosen on the secondary screen (touchscreen/tablet).
Naming
Up until KinectSandbox_v2.1:
In the settings… file you’ll find this line:
“OverlayImage”: 0 – where ‘0’ is the alphabetic index of file from KinectSandbox\KinectSandbox_Data\StreamingAssets\OverlayImages [0, 1, 2, 3…];
All images are named according to the pattern: [0_image…, 1_image…, 2_image…]. This way it’s easy to assign a numer to a file. Take it into account if you decide to change file names or upload your own files.
Since KinectSandbox_v2.1:
In the settings… file you’ll find this line:
“OverlayImage”: “0_maps/00_castles.png”, – name of the subfolder and file from the images folder;
All images are named according to the same pattern as before [0_image…, 1_image…, 2_image…], with the difference that they are now divided into subfolders; to change the image, in the settings… file you have to enter its full name and location; the same applies to the images and folders you created yourself; when choosing an image located outside the subfolders, simply drop the first part of the file description and remove the slash (“OverlayImage”: “0_folder/0_image.png“);
When adding your own subfolders, consider adding captions to the localization file.
Parameters
In order for the images to be projected correctly, they must meet a few requirements. First, they must be transparent (no background, .png image), otherwise they will cover the map completely. Second, they should have the same resolution as your projection (e.g. 1920x1200px). The images will be scaled to the size of your sandbox, so keeping the same resolution and proportions will ensure no quality loss or distortion.