Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTK Utility updates for sharing services #496

Closed
wants to merge 45 commits into from
Closed

HTK Utility updates for sharing services #496

wants to merge 45 commits into from

Conversation

StephenHodgson
Copy link
Contributor

@StephenHodgson StephenHodgson commented Feb 1, 2017

TL;DR-Cleans up the project for smoother deployment as a fully functional asset package w/sharing services

Resolves #490
Resolves #487
Resolves #374

  • Fixes issue with unreadable dark text in config windows with Editor Pro Skin enabled.
  • Adds options for Sharing Service configuration in HoloLens Project Settings Config Window.
    capture
  • Adds options for Sharing Service capabilities in HoloLens Capabilities Config Window.
    capture
  • Adds a option to manually update External Resources via:
    HoloToolkit -> Configure -> Update External Resources
    capture
  • Removed duplicated text serialization option.
  • Added a duplicate license file at the root of the HoloToolkit so it's included in asset packages.
  • Updated Sharing Menu to notify users to enable sharing services if executable cannot be found.

The main goal of the bundled external resources is to ensure when people import the asset package they have everything they need to get started all in one place. Currently you'd have to go and find the sharing services, download them, then make sure they're in the correct place yourself.

My thoughts that influenced this change:

  1. This project is a simple framework for learning & sharing with the community.
  2. This project is for staging and deploying an asset package that people will download, either from here or the Unity Asset Store, and should contain all the resources needed.
  3. For advanced developers to download and tailor this project by exporting an asset package that fits their needs.

Currently if someone was to create a new project and import the current asset package, and try to use any of the menu items related to the sharing service they will get errors:
image
The second message talking about manually coping some .exe is rather vague. It doesn't even give you a clue where to obtain it, considering that external folder doesn't exist if you've only downloaded just the asset package and not the whole HTK project.

Stephen Hodgson and others added 5 commits February 1, 2017 16:11
Stephen Hodgson and others added 7 commits February 1, 2017 17:15
…xed path.

Good for people who like to move their third party assets into other folders like myself.
Added instructions for setup via HoloToolkit->Config->Apply HoloLens Project Settings
added missing capability
Included environment setup and requirements for project.
removed nit extra line
NeerajW
NeerajW previously requested changes Feb 3, 2017
@@ -0,0 +1 @@
This folder is for the Externals.zip that should alway be up to date.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we doing this? Just because we are unable to add the externals folder into the asset package?
One of the main reasons for making it external was they are binary files that don't compile under Assets.
Adding a zip file with the same stuff does not help that cause.

I think we can come up with a better solution than a zip file under Assets. 
Just for solving the problem of mismatching SharingServer.exe binaries problem, we could always add a check in code in the Launch Sharing Service option to check version numbers. I think that would better than the zip.

What do you think?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps print a message, please download latest sharing binaries or something akin.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was just a placeholder file I meant to delete.

But the purpose of the zip file is so that users have everything they need when they import the asset package the first time. The external binaries are in the zip file and are only unpacked when users opt to use the sharing services in the HoloToolkit/Configure/Apply Project Settings menu.

The inclusion of this zip file shouldn't affect compile time, nor make it into a build.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it does mean there is another copy of this uncompilable code in the repo now right? I guess that's what I'm not sure if the best option. So when someone updates the External folder they also now need to update the zip file.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything would compile fine, lol. This PR would create a duplicate of the External resources but in a zipped format (I would like to discuss exactly how we want to handle that). Ideally this Externals folder should only live in the HoloToolkit and not this repo, with this repo only having the bundled external assets that could, in theory, get updated automatically (pretty much what #279 talks about). Currently it would have to be done by hand, but to be honest, the main HoloToolkit doesn't really change all that often.

I'm thinking about this in a couple of ways:

  1. This project is a simple framework for learning & sharing with the community.
  2. This project is for staging and deploying an asset package that people will download, either from here or the Unity Asset Store, and should contain all the resources needed.
  3. For advanced developers to download and tailor this project by exporting an asset package that fits their needs.

The main goal of the bundled external resources is to ensure when people import the asset package they have everything they need to get started all in one place. Currently you'd have to go and find the sharing services, download them, then make sure they're in the correct place yourself.

Currently if someone was to create a new project and import the current asset package, and try to use any of the menu items related to the sharing service they will get errors:
image
The second message talking about manually coping some .exe is rather vague. It doesn't even give you a clue where to obtain it, considering that external folder doesn't exist if you've only downloaded just the asset package and not the whole HTK project.

Stephen Hodgson and others added 4 commits February 6, 2017 16:53
…plus localuser id.

Updated PrefabSpawnManager to initialize spawnablePrefabs w/null to prevent warning during build.
removed placeholder readme meta file.
@StephenHodgson StephenHodgson changed the title HTK Utilities Update HTK Utilities & Sharing Update Feb 6, 2017
Stephen Hodgson added 6 commits February 7, 2017 17:52
@StephenHodgson
Copy link
Contributor Author

I'm going to resubmit this and break apart the sharing service updates and the update to the utilities stuff.

The new sharing service PR will only contain fixes,
The new utilities PR will only focus on getting the package ready for production.

@StephenHodgson StephenHodgson changed the title HTK Utilities & Sharing Update HTK Utilities Mar 11, 2017
@msftclas
Copy link

@StephenHodgson,
Thanks for having already signed the Contribution License Agreement. Your agreement was validated by Microsoft. We will now review your pull request.
Thanks,
Microsoft Pull Request Bot

@StephenHodgson StephenHodgson changed the title HTK Utilities HTK Utility updates for sharing services Mar 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants