Configuring Corporate Design settings - WEKIT-ECS/MIRAGE-XR GitHub Wiki

MirageXR supports white labelling: The user interface and app presentation can be skinned via config files and mapping tables. This is implemented via the BrandManager class in lib-lee.

[!CAUTION] The default configuration for Hololens and for mobile is different for the list of ContentTypes (Hololens includes type 'Drawing'). To reset to default configuration, delete the config.json file, and it will be filed out automatically when run.

The lib-lee class Settings provides an editor window under the Unity menu MirageXR/Settings/, which helps setting the key corporate design elements into a configuration file residing in Assets/MirageXR/Config/Resources/MirageXRconfig.json. This is what the resulting file should look like:

{
    "Version": "$appVersion",
    "CompanyName": "WEKIT ECS",
    "ApplicationName": "MirageXR",
    "MoodleURL": "https://learn.wekit-ecs.com",
    "XApiURL": "https://lrs.wekit-ecs.com/data/xAPI",
    "SplashScreenPath": "Assets/MirageXR/Logo/wekit-logo-v7.png",
    "LogoPath": "Assets/MirageXR/Logo/wekit-logo-v7.png",
    "SplashBackgroundColor": "000000",
    "PrimaryColor": "2EC4B6",
    "SecondaryColor": "FF9F1C",
    "TextColor": "FFFFFF",
    "TaskStationColor": "FF9F1C",
    "IconColor": "FFFFFF",
    "PathColor": "FFFFFF",
    "CalibrationMarkerPath": "Assets/MirageXR/Config/Resources/CalibrationImage/MirageXR_calibration_image_scaled.jpg",
    "PdfCalibrationMarkerPath": "Assets/MirageXR/Config/Resources/CalibrationImage/MirageXR_calibration_image_pdf",
    "TermsOfUsePath": "Assets/MirageXR/Config/Resources/TermsOfUseDefault.txt",
    "ContentTypes": [
        "image",
        "audio",
        "video",
        "ghosttracks",
        "label",
        "act",
        "effect",
        "model",
        "char",
        "pickandplace",
        "plugin",
        "imagemarker",
        "virtualinstructor"
    ]
}

Configurable elements:

This includes:

  • App name
  • Version number
  • Splash Screen image
  • Logo image
  • Primary colours
  • Repository server (MoodleURL)
  • Learning Analytics server (xAPI LRS)
  • Calibration marker file as image (for screen)
  • Calibration marker file as PDF (for print)
  • List of Content Augmentations to offer in the editor (this allows restricting editing to specific types only)

Default servers

The servers are set via the BrandManager (see above). This includes:

  • xAPI: The learning record store URL (LRS URL) is set in MirageXRServiceBootstrapper.cs
  • LMS: The URL to Moodle is set

End User License Agreement

Terms of Use: The end user license agreement is stored in Assets/MirageXR/Config/Resources/TermsOfUseDefault.txt and is filed in by the BrandParser class.