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

Add-ons support #6468

Open
wants to merge 33 commits into
base: master
Choose a base branch
from
Open

Add-ons support #6468

wants to merge 33 commits into from

Conversation

keianhzo
Copy link
Contributor

@keianhzo keianhzo commented Feb 12, 2024

This PR adds support for Add-ons in Hubs. For some background, see here: #6099

There are also a couple demo add-on:

To add add-ons to a client:

  • Install the add-on node module.
  • Add your add-on module to the addons.json file.
{
  "addons": [
    "hubs-duck-addon", 
    "hubs-portals-addon"
  ]
}
  • Create a hubs room
  • Enable the add-on in the room settings

Screenshot 2024-02-12 at 17 22 03

  • The add-on would run in the Hubs client after the client reloads.

@keianhzo keianhzo marked this pull request as draft February 12, 2024 15:37
@keianhzo keianhzo changed the title Initial add-ons API commit Add-ons support Feb 12, 2024
@keianhzo keianhzo force-pushed the addons branch 2 times, most recently from b2d9ae7 to 5ee0ba8 Compare February 15, 2024 10:28
@keianhzo keianhzo marked this pull request as ready for review June 5, 2024 09:47
@dirkarnez
Copy link

@keianhzo hello, may i know is addon ready to use in production please?

@Exairnous
Copy link
Contributor

Exairnous commented Jul 21, 2024

@keianhzo hello, may i know is addon ready to use in production please?

@dirkarnez It is my opinion that the add-ons branch/PR is not yet ready for production use. A list of the current issues can be found in this Discord comment: https://discord.com/channels/498741086295031808/535606666708910101/1255627984400941236

  1. Images, videos, objects cannot be scaled or rotated with the spacebar menu once they have been dragged into a scene
  2. Images, videos, objects do not scale to the size of the media frames when they are pulled into a media frame
  3. Some materials turn black (including avatar materials) in the VR headset. This also happens when you turn down the skybox setting lights, whether or not you are using a headset. (This is only happening in the add-on branch.)
  4. The "follow link" buttons have been scaled down and are very tiny. 🙂
  5. Images are breaking for scenes published from Spoke

@dirkarnez
Copy link

@keianhzo hello, may i know is addon ready to use in production please?

@dirkarnez It is my opinion that the add-ons branch/PR is not yet ready for production use. A list of the current issues can be found in this Discord comment: https://discord.com/channels/498741086295031808/535606666708910101/1255627984400941236

  1. Images, videos, objects cannot be scaled or rotated with the spacebar menu once they have been dragged into a scene
  2. Images, videos, objects do not scale to the size of the media frames when they are pulled into a media frame
  3. Some materials turn black (including avatar materials) in the VR headset. This also happens when you turn down the skybox setting lights, whether or not you are using a headset. (This is only happening in the add-on branch.)
  4. The "follow link" buttons have been scaled down and are very tiny. 🙂
  5. Images are breaking for scenes published from Spoke

@Exairnous Thank you and i see, may i know how to play with addon as experimenting? Is this branch ("addon") dependent on other hubs' repos? Thanks!

@Exairnous
Copy link
Contributor

@dirkarnez If you already have a Hubs Community Edition instance set up, you can rebuild the Hubs client with the addons branch and deploy it[1]. Otherwise, you'll need to work with Hubs-Compose[2]. For both, make sure to do an npm ci after switching to the addons branch to update the node modules and get the actual add-ons to play with. After running bin/init for Hubs Compose, you'll need to go into the hubs client folder it clones and switch the branch to the addons branch. There have been some issues reported about getting the add-ons to work, so if you run into trouble your best bet is probably to ask in the Hubs Discord server.

I hope this helps. Good luck!

[1] https://github.com/Hubs-Foundation/hubs-blender-files/blob/main/creator-labs-files/CL-archive/ghost-to-md-output/2023-10-16-community-edition-case-study-quick-start-on-gcp-w-aws-services.md#deploy-custom-apps
[2] https://github.com/Hubs-Foundation/hubs-compose/

@dirkarnez
Copy link

@Exairnous OMG, thank you so much for your very detailed information that helps a lot!

@Exairnous
Copy link
Contributor

@dirkarnez You're welcome! :)

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.

4 participants