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

Packaging (#126) #127

Merged
merged 3 commits into from
Apr 26, 2024
Merged

Packaging (#126) #127

merged 3 commits into from
Apr 26, 2024

Conversation

MarcusLongmuir
Copy link
Contributor

@MarcusLongmuir MarcusLongmuir commented Apr 25, 2024

Resolves #126

This PR overhauls how the 3d-web-experience is packaged and adds two new packages (3d-web-experience-server & 3d-web-experience-client) to provide simplified entry points for client and server that wrap the underlying more modular packages.

This should drastically simplify how easy it is to update to the latest version of the 3d-web-experience as previously the entrypoints were liable to change significantly with each version and leave users of the library with significant conflicts to resolve. Thanks to @tbergmueller for the feedback and suggestions on how to address this.

There have also been significant optimizations to the example mesh and animation assets which takes the initial download size for the client itself down from ~30MB to ~6MB. The files are now also compressed using DRACO and use the new @mml-io/model-loader package to solve the complexity of being able to load compressed assets.

What kind of change does your PR introduce? (check at least one)

  • Feature: New simplified entrypoint packages and DRACO-compression for avatars
  • Refactor

Does your PR fulfill the following requirements?

  • The title references the corresponding issue # (if relevant)

@MarcusLongmuir MarcusLongmuir changed the title Packaging Packaging (#126) Apr 26, 2024
@MarcusLongmuir MarcusLongmuir marked this pull request as ready for review April 26, 2024 10:41
@tbergmueller
Copy link
Contributor

Thank you very much for this!

I should be able to find some time next week to restructure our whole software to this new packaged approach and will then - as discussed - also create a separately packaged third-party authenticator based on ExampleEnforcingUserAuthenticator.ts.

As discussed, I'll likely send another PR your way mentioning this third-party package in README and removing the ExampleEnforcingUserAuthenticator.ts from this repository, as soon as I feel this new package is ready enough for other people to use.

@TheCodeTherapy
Copy link
Contributor

@MarcusLongmuir Approved but as I added 2 new commits myself, we'll also need approval from you.

@MarcusLongmuir MarcusLongmuir merged commit b2c739e into main Apr 26, 2024
5 checks passed
@MarcusLongmuir MarcusLongmuir deleted the feature/packaging branch April 26, 2024 12:42
@MarcusLongmuir MarcusLongmuir mentioned this pull request Apr 26, 2024
2 tasks
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.

3d-web-experience packaging
3 participants