WEKIT ECS

See what’s new
in MirageXR

Release v.2.4.2 11 Oct 2023

Added

We added a logout button for Sketchfab for the worldspace UI.

Changed

Character model triggers can now trigger any step by using the “%%trigger:step=X%%” (where X is the step number to jump to) key word in a Watson output.
We cleaned up code for glyph, image, and audio augmentations.

Fixed

We fixed a bug where Sketchfab models containing the “/” character would cause the app to crash.
We removed world space UI remnants from mobile builds.
We fixed a bug for the custom 3D models in the Pick and place augmentation.
We fixed a bug with triggers, causing the jump to action step to interpret the wrong step index.

Developer

The default unity Debug.Log() is now replaced by a new custom logging system which filters messages based on their importance level. The changes to the UI for setting the desired filter level will be added in a later version. For now, it is possible to change the filter level using Debug.MinimumLogLevel.
Release v.2.3 26 Jul 2023

Added

We rewrote the calibration routines for both edit mode and view mode, adding a floor manager to allow setting the floor plane.
We added gallery upload functionality on mobiles for the step marker feature of task stations and for the image/video augmentations.
We added a player tutorial for mobiles and smart glasses which uses a tutorial activity that is written out internally every time the tutorial is started to ensure the viewer tutorial is not modified by the user.
The marker feature of task stations now shows up with a preview thumbnail button in view mode.
We added auto-saving of the activity title.

Changed

We simplified the functionality of the pick and place augmentation, added a trigger for incorrect placement, and improved its manipulation when using a 3D model instead of the default arrow.
We added auto-detection of orientation for images.
We removed the ‘Search’ button from the bottom panel on all screens except the ‘Home’ screen.
The ARETE learning record store has now been taken offline, so we removed this LRS option. Please switch to WEKIT learning record store.

Fixed

We fixed the bug that prevented re-editing of effect augmentations.
The bottom panel now always shows the current step, and we fixed a bug here throwing an error when minimizing the curtain.
We made SketchFab authentication a tad more robust.
The calibration marker is now no longer orientation sensitive (hanging upright vs laying flat).
Deleting an action step now removes it from the workplace model.

Enterprise

We added new settings to BrandManager and BrandConfiguration, now allowing for the activation and deactivation of augmentation types, as well as for setting the calibration marker.

Developer

We retired Vuforia on mobile platforms and replaced it with ARfoundation.
We updated OpenXR and Vuforia in the HoloLens implementation.
We fixed the action linux and windows workflows to support LFS.
We added a debug log window to the smart glasses implementation (click person icon, click “{}”).
We added tutorial manager facilities for ‘world space’ hints on mobile.
We now have a new bottom multiline dialog with toggles.
Long tap on mobiles now brings up the context menu (see new model augmentation editor).
Release v.2.2 05 May 2023

Added

New search screen has been added.
Horizontal scrolling has been added to the StepList View.

Changed

The operation of the bottom navigation bar has been changed.
Activity settings have been updated.

Fixed

We fixed bugs related to Image Marker Augmentation.
Content in records no longer appears upside down.
We fixed bugs related to Pick & Place.
The spawn position has been corrected.

Developer

We fixed the handling of screen press events.
Bottom multiline dialogue with toggles has been added.
Vuforia has been removed from the mobile version of the app.
iPad: the display of the debug console has been fixed.
Application crashes due to Vuforia initialization have been fixed.
The work with 3D models has been optimized.
Playmode tests have been updated.
Debug log messages have been improved.
Release v.2.1 01 Mar 2023

Added

New warning message is displayed when selecting public upload from the publishing menu.
We brought back the Sketchfab web-based single-sign on.
“Get Calibration Image” in the calibration tab now opens a sharing dialogue.
We added a feature to capture the new position of the calibration image which is useful when the user moves the calibration marker but wants to keep the position of AR content.

Changed

We made minor changes to improve the uniformity of the mobile UI.
Changing an activities name or description will now auto-save the activity.
Changing an action step’s name or description will now auto-save the activity.
Changing an augmentation’s ‘keep alive’ settings will now auto-save the activity.
The VFX augmentation is now referred to as ‘Effects’.
We renamed “Activity settings” to “Publish”.
Locate now targets the Pick and place arrow rather than the sphere.

Fixed

Logging out is now persisted on application re-launch.
Recalibration button is no longer visible when minimizing the calibration menu.
Publish toggle is now inactive when neither local nor cloud upload is selected.
Activity settings are remembered when re-launching the app.
Illegal characters of filenames (\ / : * ? ” < > |) of 3D models no longer prevent their use.
We fixed a bug changing the content type of augmentations if their name contained the name of another augmentation type.
The pick and place ‘reset on action step’ option now works correctly.
Delete augmentation now works.
Recalibration now deactivates the active action step before starting the first action step.

Enterprise

The privacy policy is now linked from the profile page.

Developer

We changed the predicate for the visual effects augmentation from ‘vfx’ to ‘effects’.
We added a verbose logging system to improve debug outputs.
We added a debug console to mobile builds for listing log messages at run-time to improve device specific debugging.
Release v.2.0 05 Feb 2023

Added

Onboarding: We added onboarding swipe-thru slides on first app launch, explaining the key concepts of mirageXR with text and animations.
Bottom bar: We added a new bottom tab bar with icons for quickly switching between activity stream, profile, search, and the new dynamic context help.
Quick edit toggle: We introduced a new edit toggle button in the top right corner of the mobile user interface for quickly switching from viewing to editing.
Collapsable main panel: Users can now minimize the main menu, providing ‘prev’/’next’ quick navigation buttons in the collapsed view for moving forwards and backwards between action steps. Especially on smaller screen phones, this frees valuable screen real estate up for a less cluttered view of the activity.
Model augmentation: We added boundary box handles for the model augmentation as alternative to the direct manipulation with pinch and rotate.
Pick & place augmentation: We added trigger functionality to allow jumping to the specified step if the pick object is placed in the correct target location, and we added reset options for placement.
Pick & place augmentation: We added sound effects for the pick & place augmentation (for correct and incorrect placement).
Character models: We added trigger functionality to character models, moving on to the next action step, when audio or animation are finished playing (whichever takes longer).
Character models: The AI mode of character models now supports the use of “%%trigger%%” control commands in the text string of their dialogue responses, triggering to move on to the next action step.
Audio augmentation: We added a ‘jump to’ option for audio triggers (not just ‘next step’).
Action augmentation: We added gaze trigger functionality for action augmentations.
Preview: We added a preview button from the publish settings to remind content authors to test their activities before uploading to the cloud.
Marker augmentation: We improved the marker augmentation to display the target image with a ‘find this’ instruction and we worked on the anchor stability of the task station during tracking.
Locate: We reintroduced the locate functionality to activate a red arrow viewfinder pointing to the augmentation it is activated for.
Acknowledgements: We added logos of new collaborators to the acknowledgements.

Changed

Login at the start: The app starts now with the login, also adding buttons for registering (opens browser for web registration) and anonymous guest login.
Activity stream: We upgraded the activity list to a swipeable activity stream on mobiles and improved the sorting and search functionality.
Publish dialogue: We created a new ‘Publish…’ dialogue to simplify data handling for content authors, with quick access for saving locally and saving to the cloud in public (or private).
Image and video augmentations: We added boundary box handles for easier manipulation to the image and video augmentations.
Step order: We improved the process of adding action steps during editing.
Best augmentations first: We reordered the list of augmentations in the editor by popularity.
Content selection: We improved support for content selection, adding a short description and additional context help to the augmentation list on mobiles.
Calibration dialogue: We created a new calibration guide and dialogue, which now starts automatically when a user opens an activity to view.
Highlight current step: We are now visually highlighting the current step in the step list also on mobiles.
Keep alive: We created a new dialogue with from/to dials on mobiles for the ‘keep alive’ functionality of augmentations, simplifying setting from which action step to which action step an augmentation shall remain visible.
Updated views: We implemented new views for activity settings, steps, list of step contents, content selection, step settings, and profile.
Activity: We improved the process of deleting activities.
Screen layout: We improved the basic screen layout for tablets and large screen phones (e.g. Motorola Edge Pro). We increased icon resolutions.

Fixed

We updated the reference resolution for the new mobile user interface, which was causing crashes on some devices.
We extended the audio trigger functionality to work also with the GhostTrack augmentation.
Fixed portrait mode for video augmentation player.
We fixed bugs with the AI mode for character models.
We fixed bugs causing the image augmentation to crash (iOS), reset (Android), or not display (all).
We suppressed the calibration video instructions from displaying during the editing tutorial, so that the optional dialogue does not occlude the tutorial.
We fixed issues with the appearance of character models (‘zombie mode’) and improved the appearance for some.
We fixed issues with calibration.
We fixed a bug causing label augmentations to crash when using the trigger.
We fixed a bug with pick & place objects forgetting their orientation.

Enterprise

We updated the base URI for xAPI statements, retiring ‘wekit-community.org’.
We removed the Android advertising SDK package from project (it was never used).
We added a new profile setting for selecting repository servers from a dropdown list of preconfigured endpoints.
We added new profile settings for selecting the learning record store from a dropdown list, automatically configuring their xAPI endpoint URL, replacing the free text entry.
We fixed issues with the Sketchfab API direct login and authentication.
We reinstated the broken deep link launch from QR codes in Moodle (allowing MirageXR to launch from any QR-code enabled mobile camera app).
We added new app icons.

Developer

We migrated to Unity 2021 LTS and updated the CI pipelines to use the corresponding images.
We updated the ARfoundation versions.
We created a new UI kit to unify the presentation layer.
We introduced a new dialogue manager for presenting interactive dialogues.
We implemented a new drag & drop controller for ordering of UI elements.
We added CONTRIBUTING.md instructions, replacing the agile development wiki page.
We updated the CI pipeline badges in the README.md.
We excluded workspace layout settings from git index and added to gitignore.
We removed the UserSettings folder from git index and added it to gitignore.
We removed some ghost meta files that were still tracked by git.
We updated the cache action on the Android build pipeline.
We fixed the Android CI pipeline signing error and left a note in the CONTRIBUTING.md about not ticking the developer key option in the build settings.
We fixed the problem of the Android build pipeline running out of space before concluding the build.
We added missing standard Windows fonts on the Android build pipeline, which were causing many dialogues to not display type in automated preview builds.
We added StyleCop support and adjusted the rules to our needs, also reformatting large parts of the code to fix some of the warnings.
Release v.1.9.2 16 Jun 2022

Added

We added new animations for the character models.
Pick & place now allows setting whether location resets or is remembered when repeating the activity. We also added contextual help to explain configuration better.
The model augmentation now has a log-out button, which allows forcing to reauthenticate with Sketchfab.

Changed

We fixed a bug in the activity list, which prevented displaying and searching the title.
We improved the built-in tutorial for the world space smart glasses user interface, changing wording, adding steps, and fixing a bug.
Several improvements to the character augmentation ensure that: the position marker does not slip so easily underneath the spatial map; handling of triggers; and a bug causing the edit panel to stay visible in the viewer.
The app version is now passed through via the IEEE P1589-2020 activity model to the repository.

Fixed

We fixed cross-platform issues with the image and video augmentations.
The pick & place augmentation on iOS was missing the sphere indicating the target zone.
In the settings screen on mobile platforms, the labels are now displayed correctly.
We fixed an issue causing glyph, character model, and drawing sometimes to forget size or position.
We fixed an issue with the activity thumbnail not resetting, when creating a new activity.

The activity list now correctly updates when returning to it after a new activity was created. 

“https://” is now added automatically to the Moodle URL.
On the smart glasses UI, the grid augmentation menu now stays open when browsing to an empty action step and back.
The pointless ‘relocate activity list’ icon is no longer displayed on mobile platforms, only on smart glasses.
Some QR links were broken due to a bug in the Moodle repository plugin. This is now fixed.
We added support for non-Latin characters to TextMeshPro, fixing issues with special characters in passwords and usernames.
We did some improvement to lighting of holograms.

Enterprise

We added a possibility to automatically build multiple apps with separate config files.
We added an option in the BrandConfiguration class that allows now to specify which augmentation editors shall be made available (with different configurations possible for mobile / smart glasses).
It is now possible to configure the xAPI authentication and the Moodle URL via config file.

Developer

We migrated the project from GitLab provided by XR4ALL to a new code hosting platform on GitHub.
We setup new Github runners for Windows and Linux, and refactored our CI pipelines, migrating to GitHub actions, finally also adding a dedicated Android CI build pipeline.
We introduced formal reviews as part of the changed approval process: every merge request is now reviewed and upon acceptance the original developer has to merge. This improves capacity of sprint masters, shifting workload back to the originating party.
We improved documentation, including with UML, in particular of the core and the connected augmentation system.
We implemented automatic syntax checking with StyleCop.
We cleaned the repository of some 3D models that are no longer used.
On mobile platforms, we replaced Vuforia with AR Foundation.
Notifications on slack now include the merge request details.
Pipeline preview builds now display the correct version number.
Release v.1.8 12 Nov 2021

Added

MirageXR now uses voice prompts “Hey Presto”, “Hey Mirage” and “Sim Sala Bim” to start voice interaction. Voice interaction has also been improved by adding visual cues for spoken words.

Character augmentations can now be fitted with an IBM Watson assistant, improving user interaction.

MirageXR now includes the popular XR painting tool Tiltbrush! The new augmentation allows adding 3D-painting elements to the training procedures.

Most visual augmentations can now be used as a trigger for the next action step.

Gaze triggers can now be used to jump to any action step.

Near-touch interaction added for dialogues on HoloLens2.

3D object manipulation is now possible through widgets at the object’s boundaries.

Added a toggle to the mobile video editor panel that allows a user to input the orientation of a video augmentation.

Changed

The MirageXR in-app tutorial has been updated, improving performance and maintainability.

Special characters like ampersand (&) are now disallowed in activity names, as this could cause problems with Moodle.

Some unnecessary voice lines were removed from the MirageXR voice assistant Maggie.

The glyph trigger option was moved to the editor panel.

On loading or creating a new step, the step will be labeled as the current step (in orange, not gray).

Disabled shadows on HoloLens and improved their quality on other platforms.

Icons and splash screens were updated.

The rotation of the character augmentation was improved on mobile devices.

The default placement of UI elements on HoloLens was optimized.

The drawing augmentation button was removed on mobile platforms.

The augmentation panel on task stations was changed from list to a grid view.

Fixed

A bug where audio would not replay on ghost augmentations was fixed.

The spawn point is now correctly visible on HoloLens 2 for both eyes. The custom shader was replaced with a wireframe sphere.

Editing ghost augmentations will now also replace old audio with the new one.

The Home button on the Aura has been moved slightly up to avoid being under the floor line.

The Pick&Place augmentation no longer forgets the target sphere size.

Deleting a model used by Pick&Place now works correctly.

The GhostTrack animation and its sound are now synchronised.

The Sketchfab thumbnail is now correctly displayed.

The video editor now opens correctly for editing.

A visual bug where action steps could not be deleted was fixed.

An issue with the audio augmentation where the loop and trigger options would interact badly was fixed.

The rotation and scale of the Image augmentation are no longer resetting on load.

An issue where the Aura would jump up when sitting was fixed.

The calibration guide is no longer causing errors when selecting “Don’t show again”.

Private activities are now displayed correctly on Android.

The bounding box on the measure tool was disabled, as it was causing errors.

Enterprise

No changes

Developer

Some old folders and files have been removed or moved.

Dropdown and guide text of character augmentations is replaced by Unity native UI elements.

Release v.1.7 07 Oct 2021

Added

Auto progression to the next action step has been added as an option to the audio and video augmentations, complementing the already existing auto progression option for character models.

New ‘stand here’ glyph added.

Improved xAPI support now adds context and results where needed.

New xAPI vocabulary now logs learner behavior data for all augmentations.

Changed

The task station’s context menus are now rotated slightly towards the user, bringing the outer panels closer to the eye (Windows Holographic).

Hover guide text has been added to the character augmentation menus to explain its components.

Unavailable character augmentation animations will no longer be shown in the drop-down menu.

Augmentation spawn point is now visualized (known bug: renders only on one eye on Hololens).

Image marker size can be set allowing for more accurate image tracking.

Ghost augmentation can be replayed without changing the action step (audio replay option still to follow).

Empty rows of the action list no longer block interaction with virtual objects behind.

The audio augmentation editor was simplified.

Fixed

Improved virtual keyboard on windows holographic platforms, including resolving a bug that caused the keyboard to close prematurely.

Pick and place no longer forgets the 3D model when there are multiple action steps.

Activity thumbnail images can be previewed again.

Augmentation buttons are now correctly deleted for an action step if the corresponding augmentation has been deleted.

Video recorded on a mobile device no longer plays back distorted on Hololens.

Enterprise

No changes

Developer

Updated Unity version to 2020.3.13f1

Updated MRTK version to 2.7.2

Reduced the space requirements for pipeline builds

Updated NuGet package

Release v.1.6 09 Aug 2021

Added

Female avatar for the ghost track augmentation.

Voice commands “next” and “back” allow switching between steps (only on Hololens).

Label trigger functionality now available also on iOS and Android.

Characters now process 3D models as obstacles and will avoid bumping into them.

Characters are now resizable.

‘Loading’ interstitial when loading or creating an activity.

Character models will now be included in the ARLEM zip file.

Auto-progression for character augmentation: checkbox now allows moving automatically to the next action step once animation or audio finished playing (whichever takes longer).

Changed

The activity will be reset when the last step is completed.

Deadline date format is corrected.

Orkestra support removed (for now).

Improved glyphs for ‘act’ augmentation (scissors, all box glyphs).

Fixed

Reduced loading time for new activities.

Marker augmentation now also works on Android and iOS.

The Pick and place augmentation now also supports 3D models (alternative to the standard ‘arrow’ shape).

Improved character movement on mobile devices.

Closing the augmentation panel now brings up the list of augmentations again.

Character position will no longer break when switching between action steps.

Next task station is again locked in edit mode.

Floor line from the aura to the activity list is visible again.

Ghost origin will be loaded correctly.

Model augmentation (Sketchfab) now also works on mobile devices.

Mobile UI icons are now no longer hidden by android system icons.

The image presentation animation no longer appears only with keep alive over several action steps.

Enterprise

New ‘support’ button (in the Moodle login panel) opens a defined support forum in a browser.

New plugin augmentation allows packaging of 3rd party mini-apps as prefabs in the ARLEM zip file.

Developer

Android CI pipeline added.

Separate TestFlight link for development builds.

Sketchfab client secret now in untracked config file ‘SketchfabClient.json’ (excluded from tracking via .gitignore; you need to manually copy the SketchfabClient.json to your project folder).

Release v.1.5 10 Jun 2021

Added

Augmentations can now be kept alive between action steps.

New character models were added to the character augmentation.

Changed

The ghost model is replaced with a better avatar model.

Calibration now restarts the current activity.

A warning is given when a user tries to download a model with a large file size.

Character augmentation settings panel has been refactored.

Character models now handle occlusion by the spatial map.

It is possible to add different audio, animation, path and movement to the character in each action step.

The Image Marker augmentation has been re-enabled on Hololens 1 and Hololens 2 However, it is still disabled on iOS and Android.

Fixed

The iOS or android apps no longer show a Vuforia license error when first launched.

Pick and place now stays in edit/play mode when changing action steps.

Keyboard predictive text now works correctly for Hololens 1 and Hololens 2.

The Keyboard no longer dismisses itself on Hololens 1 and Hololens 2.

A bug causing some sketchfab models to not be loaded has been resolved.

Task stations are correctly spaced apart when loading an activity without calibrating.

Task stations no longer rotate when they are moved.

Fixed Moodle repository upload limit to allow for activity models with more than 64kb.

Enterprise

No changes

Developer

Vuforia License key has been changed.

Release v.1.4 06 May 2021

Added

New voice commands for moving the action list: “Move action list” and the activity list: “Move activity list” (Only on Hololens)

Pagination for the model augmentation

Dialog recorder for character augmentation

Basic lip-sync for character augmentation

Authors of activities can delete them from the server directly from the app (only on Hololens)

Improved update of activities stored in the cloud.

Activities from course assignments listed first now (with deadlines displayed).

A new animation “Image Display” added to the character augmentation. The user can assign an image annotation to this animation, and the character will show up the image.

Gaze trigger for label augmentations.

Changed

The ghost model is replaced with a better avatar model.

Terms of use and privacy policy are updated.

Fixed

Sketchfab models do not remain in the ARLEM folder anymore after deleting.

Only the first video could be displayed in each step even if the users had several video augmentations.

First/Last step buttons and the next and previous step buttons of the Action list now function correctly.

Login UI is now placed in the correct place at the start of the app.

The annotation menu is no longer crashing when all steps are deleted.

Character augmentation models without a dialog recorder function are no longer causing a crash after loading the activity.

Ghost is no longer losing arms on Android and iOS

Enterprise

Terms of use added

Improved repository functionality

Developer

Vuforia updated to version 9.8.5.

xAPI updated and tincan removed.

The empty dialogues in CI pipeline build were fixed.

Platform compatibility is updated for iOS Version 11.0+ (ARKit required), for Android Version 7.0+, and UWP (Windows Holographic) 10.0.17134.0+

Release v.1.2 18 Mar 2021

Added

Support for iOS

Near interaction support for UI

3D Model augmentation

Sketchfab connection for importing models

Additional action glyphs and a scrollable grid for selecting them

Activity cover thumbnail

Walkthrough tutorial introduces to the basic functionality on first start

Optional thumbnail photo now provides preview of Learning Experiences

Config panel for Moodle login information

Display app version number on activity list

OpenID connect support for Sketchfab

Realign button near aura to recentre panels if lost / stuck in wall

Image and video augmentation support added for iOS and Android

Display file size before cloud download of Learning Experiences

Changed

Connects to Moodle server for ARLEM files and content

UI panels more compact

New UI for image and video players

Improved mesh display of spatial map in edit mode on Android / iOS

Improved activity list paging to improve display performance

Task card closer to task station

Video always uses audio

new icons and splash screen

Fixed

Surface magnetism solvers added to keep holograms out of the walls

Workplace calibration fixed, activities now can again be transferred across devices / places

Activity List properly refreshes now when new activities are created

Improved keyboard handling (device specific and improved Hololens keyboards)

Fixed all offsets of all augmentations

Ghost sometimes got stuck when moving to next action

Sometimes small spheres appeared randomly scattered in the activity

Upload uses Activity Title

Glyphs can be rotated

Loading previously saved ARLEM failed

In some situations, labels would be empty

Enterprise

New repository service (via Moodle)

White Label capability

Developer

Developer workflow documented in Wiki

Updated to MRTk 2.5

Intelligent rendering via PlatformManager allows building platform-specific UI

BrandManager allows customising look and feel via config file

CI release pipeline and notifications

CI installer builds for HoloLens 1 and 2

Automatic build version numbering

More unit tests added

Platform compatibility is updated for iOS Version 11.0+ (ARKit required), for Android Version 7.0+, and UWP (Windows Holographic) 10.0.17134.0+

Release v.1.0 23 Oct 2020

Added

Support for HoloLens 2

Support for Android

Unit tests

CI pipeline

Home pathway that leads to the main menu

Task stations are now visualized as a diamond

Changed

Updated to MRTK

Combined player and recorder into one common editor

Redesigned user interface: updated aura visuals, updated pathway visuals, redesigned the action list menu, updated text label visuals

Streamlined activity download and activity starting with an activity download menu

Replaced circular edit menu with own editor menus for each annotation

Menus do not follow the user’s head movement anymore but can be placed in a fixed position in space

Tweaked scaling of objects

Updated to new logo

Fixed

Annotation positions can now be saved in the correct format independent of the user’s culture settings

Event order of central event manager improved

Performance improvements & code refactoring

Enterprise

No changes

Developer

No changes

Scroll to Top