diff --git a/.gitignore b/.gitignore index 0291b04..d10520e 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,6 @@ website/node_modules website/i18n/* results + +.env +package.json diff --git a/docs/creators-advanced-avatar-customization.md b/docs/creators-advanced-avatar-customization.md index b646da6..16d72cf 100644 --- a/docs/creators-advanced-avatar-customization.md +++ b/docs/creators-advanced-avatar-customization.md @@ -42,7 +42,7 @@ When you upload textures into Hubs The preview will be updated. You do not need To customize your avatar's shape, you can modify our basic robot template, or upload a .glb file of your choice. If you use the robot template, your avatar will have hands and a body and a head that grows/shrinks when you speak. If you use a plain .glb file, this item is considered the head of the avatar and the whole object will grow and shrink when you speak. -You can follow along with Jim and Dom in this recorded live stream here to walk through the whole process: https://youtu.be/qBvZhh6KVcg?t=561 + ### Modify Base Robot Template @@ -50,7 +50,7 @@ We offer the following resources if you'd like to modify our base Robot avatar: * [Blender Source Files](https://github.com/Hubs-Foundation/hubs-avatar-pipelines/tree/master/Blender/AvatarBot) are available of our Robot avatar. **For specific information about how to use these .blend files, be sure to check out the readme within the [Blender/AvatarBot](https://github.com/Hubs-Foundation/hubs-avatar-pipelines/tree/master/Blender/AvatarBot) folder.** -* [Exported GLBs](Exported%20GLB%20models)/[Exported OBJ](https://github.com/Hubs-Foundation/hubs-avatar-pipelines/tree/master/Other%20model%20formats) are available if you'd like to bring them into your editor of choice. +* [Exported OBJ Files](https://github.com/Hubs-Foundation/hubs-avatar-pipelines/tree/master/Other%20model%20formats) are available if you'd like to bring them into your editor of choice. We recommend using [Blender 2.83](https://builder.blender.org/download/) (or whatever the most recent release is) for custom models since we have provided example files that you may use as a guide. (Typically, skeleton setup varies between modeling appications which can make importing/exporting skeletons a bit tricky due to unexpected changes in bone rotations, but it is still possible to use something other than Blender.) Note: the .blend files were created with [Blender 2.8](https://builder.blender.org/download/) due to the built-in glTF exporter. The glTF importer/exporter for Blender is currently in development. Expect some bugs and [please report them!](https://github.com/KhronosGroup/glTF-Blender-IO/issues) @@ -60,7 +60,7 @@ Hubs avatars are meant for VR, which means that you should work in real world un Files with the suffix *_base* refer to the most barebones, basic robot avatar template that can be used as a reference when creating new avatar models. Typically, the Blender workflow would be to either 'Link' or 'Append' the objects from [AvatarBot_base_for_export.blend](https://github.com/Hubs-Foundation/hubs-avatar-pipelines/tree/master/Blender/AvatarBot) in order to use the existing armature (skeleton) and any animations that go along with it, using them as a basis for your own model that you would attach to it. -The armature is based largely upon the same hierarchy and naming conventions of the skeleton provided by [High Fidelity](https://docs.highfidelity.com/en/rc80/create/avatars/avatar-standards.html#skeleton). This also happens to have a similar structure to VRChat in terms of bone orientations. +The armature is based largely upon the same hierarchy and naming conventions of the skeleton originally provided by High Fidelity. This also happens to have a similar structure to VRChat in terms of bone orientations. However, in our current implementation in Hubs, we have eliminated some of the bones within the hierarchy, namely the lower body and arm joints since we are not using any sort of inverse kinematics (IK) at the moment. This may change in future iterations. ### Use a Regular .glb File diff --git a/docs/creators-optimization.md b/docs/creators-optimization.md index 2ee3cd9..dd72cda 100644 --- a/docs/creators-optimization.md +++ b/docs/creators-optimization.md @@ -39,7 +39,9 @@ We've also made a [video of other things you can do to optimize the size of your #### Reduce number of triangles -There is no golden rule of thumb for what number of triangles in a model is ideal, however, we recommend using models with only tens of thousands, rather than hundreds of thousands of triangles. Many complex 3D models can have their triangle count reduced without greatly impacting the way that the model looks. You can do this using the Mesh Decimation tool in Blender. For instructions, check out [this video](https://www.youtube.com/watch?v=IIQNj-6_tQE_) +There is no golden rule of thumb for what number of triangles in a model is ideal, however, we recommend using models with only tens of thousands, rather than hundreds of thousands of triangles. Many complex 3D models can have their triangle count reduced without greatly impacting the way that the model looks. You can do this using the Mesh Decimation tool in Blender. + +For instructions, check out [this video](https://www.youtube.com/watch?v=IIQNj-6_tQE_) ## Oculus Quest & Mobile Notes diff --git a/docs/dev-contributing.md b/docs/dev-contributing.md index 0aa57c1..59a5768 100644 --- a/docs/dev-contributing.md +++ b/docs/dev-contributing.md @@ -24,8 +24,6 @@ We are happy to receive contributions to the Hubs platform in a number of differ ### đŸ’» Code Contributions Hubs has a client-server architecture that gives multiple users the ability to connect to a shared room on the server. If you are interested in contributing to the Hubs client, follow the instructions in the [Readme](https://github.com/Hubs-Foundation/hubs#readme) to get started. If you want to contribute to the networking or infrastructure, consider looking at the [reticulum](https://github.com/Hubs-Foundation/reticulum) or [Dialog](https://github.com/Hubs-Foundation/dialog) repositories. If you are interested in working on the code for Spoke, the 3D editor used to create custom environments for Hubs rooms, explore the [Spoke](https://github.com/Hubs-Foundation/spoke) repository. -For more information on the inner workings of Hubs and the architectural decisions behind the project, check out [this presentation on the Hubs Code Base](https://vimeo.com/365531296) by Engineering Lead Greg Fodor. - Issues that are open are tagged. If you explore a bug or feature request that you'd like to fix, make a comment on the case so we know you're looking into it! We try to use the '[good first issue](https://github.com/Hubs-Foundation/hubs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)' tag to identify some cases that may be easier than others to begin with as you get started with the code base. Steps to contributing code to the Hubs project: diff --git a/docs/hubs-cloud-customizing-look-and-feel.md b/docs/hubs-cloud-customizing-look-and-feel.md index 5df7428..0736a8b 100644 --- a/docs/hubs-cloud-customizing-look-and-feel.md +++ b/docs/hubs-cloud-customizing-look-and-feel.md @@ -4,22 +4,6 @@ title: Customizing Look and Feel sidebar_label: Customizing Look & Feel --- -# An announcement about the Hubs user interface - -On January 25, 2021, we released a significant update to the user interface for Hubs on hubs.Hubs-Foundation.com. This change will not go live on new Hubs Cloud deployments until on or after March 25, 2021. Before the update is released to Hubs Cloud, we encourage administrators of Hubs Cloud deployments to consider their own releases and determine a plan of action for updating to the new UI. - -- If you have not made any changes to your Hubs Cloud client look and feel, your Hubs Cloud instance will be updated on or after March 25th to have the new UI. - -- If you added your own logos or chosen new colors within the Hubs Cloud admin console, these will be applied to the new UI. You may need to review and confirm your color choices when the update is live. - -- If you are using a custom CSS sheet for styles, you may need to modify this CSS file to account for the new user interface styles. Check this page in the coming weeks for additional information. - -- If you are running a custom Hubs Cloud client, you will not automatically receive the new update. You will need to pull in the client changes to your own fork of the client codebase or undeploy your Hubs Cloud custom client to get the new UI automatically. - -- If you do not want to be updated to the new UI, you can deploy a custom client to your Hubs Cloud instance. This will remove your Hubs Cloud instance from the automatic update path, and you will stop receiving updates to the client when we release new Hubs Cloud updates. - -Please note that we are working on tools and documentation to help streamline the transition to the new UI from older versions of the Hubs client. Check this page for updates and additional information, or check out the Hubs Cloud channels in Discord. - # Deprecated: Updating the look and feel for the original Hubs Client UI You can completely completely customize the look and feel of your hub by adding custom colors and branding. diff --git a/docs/hubs-cloud-getting-started.md b/docs/hubs-cloud-getting-started.md index 815555a..e90de4b 100644 --- a/docs/hubs-cloud-getting-started.md +++ b/docs/hubs-cloud-getting-started.md @@ -4,11 +4,11 @@ title: Getting Started With Hubs Cloud sidebar_label: Getting Started --- -After successful Hubs Cloud deployment on AWS or DigitalOcean, navigate to your hub's hosted domain name (eg. myhub.com or hub.mydomain.com). +After successful Hubs deployment, navigate to your hub's hosted domain name (eg. myhub.com or hub.mydomain.com). -In the upper right corner, click "Sign In" and enter your admin email address you specified during CloudFormation. In your email inbox, click the received "magic link" to login (Issues with login? Check out the [AWS Troubleshooting Guide](./hubs-cloud-aws-troubleshooting.md)). +In the upper right corner, click "Sign In" and enter your admin email address you specified during CloudFormation. In your email inbox, click the received "magic link" to login. -Once you've logged into Hubs Cloud for the first time, you should see the Hubs Cloud Admin Console. It should look like this: +Once you've logged into Hubs for the first time, you should see the Hubs Admin Console. It should look like this: ![Hubs Cloud Admin Landing](img/hubs-cloud-admin-landing.jpeg) @@ -32,6 +32,5 @@ Here's some things you can do to continue setting up your hub: - [Customize the Look and Feel](./hubs-cloud-customizing-look-and-feel.md) to make your hub fit your brand or style. - [Enable the Scene Editor](./hubs-cloud-enable-scene-editor.md) to let visitors create their own scenes. - [Enable permissive rooms](./hubs-cloud-permissive-rooms.md) to let visitors add media to their rooms. -- [Set up the media browser](./hubs-cloud-enable-media-browser.md) so visitors can add content from sites like Sketchfab. - [Learn how to manage content](./hubs-cloud-managing-content.md) so visitors can contribute content to your hub. - [Add Administrators](./hubs-cloud-adding-administrators.md) if you'd like others to help you set up your hub. diff --git a/docs/hubs-cloud-importing-content.md b/docs/hubs-cloud-importing-content.md index e12e15a..467f2e5 100644 --- a/docs/hubs-cloud-importing-content.md +++ b/docs/hubs-cloud-importing-content.md @@ -6,7 +6,7 @@ sidebar_label: Importing Content The two forms of content you can import into Hubs Cloud are **avatars** and **scenes**. Avatars are 3D figures like robots, humans, and ducks that can be worn by visitors to represent themselves, and scenes are 3D environments like interiors and landscapes that provide visual grounding for a room. -Hubs-Foundation offers a number of [Asset Packs](./hubs-cloud-asset-packs.md) you can import to add some initial content to your hub. Additionally, you can import any custom content you've created, either on [hubsfoundation.org](https://hubsfoundation.org), or using the tools like the [Scene Editor](./hubs-cloud-enable-scene-editor.md) available on your hub. For more information about the Scene Editor, see [Spoke Documentation](http://hubs.local:3000/docs/docs/spoke-creating-projects.html)[^1]. +You can import any custom content you've created, either on [hubsfoundation.org](https://hubsfoundation.org), or using the tools like the [Scene Editor](./hubs-cloud-enable-scene-editor.md) available on your hub. For more information about the Scene Editor, see [Spoke Documentation](http://hubs.local:3000/docs/docs/spoke-creating-projects.html)[^1]. ### Admin Import Tool diff --git a/docs/hubs-cloud-intro.md b/docs/hubs-cloud-intro.md index 67f19cf..8ae56a0 100644 --- a/docs/hubs-cloud-intro.md +++ b/docs/hubs-cloud-intro.md @@ -6,26 +6,6 @@ sidebar_label: Introduction ![Hubs Cloud](img/hubs-cloud-logo.jpeg) -**NOTICE: HUBS CLOUD WILL BE REPLACED BY COMMUNITY EDITION. -PRO TIER IS AVAILABLE NOW TO EASILY DEPLOY CUSTOM CLIENTS ON YOUR OWN DOMAINS - +**NOTICE: HUBS CLOUD HAS BEEN REPLACED BY COMMUNITY EDITION.** - - -**Currently, Hubs Cloud is offered on AWS and DigitalOcean.** - -**Note: If you're looking for community Edition, which is the replacement for hubs cloud that you can bring anywhere as a dev, read [Hubs Community Edition](./hubs-community-edition-intro.md)** +**Note: If you're looking for community Edition, which is the replacement for hubs cloud that you can bring anywhere as a dev, checkout [Hubs Community Edition](https://github.com/Hubs-Foundation/hubs-cloud/tree/master/community-edition)** diff --git a/docs/hubs-create-join-rooms.md b/docs/hubs-create-join-rooms.md index 8ac64f0..9cb223d 100644 --- a/docs/hubs-create-join-rooms.md +++ b/docs/hubs-create-join-rooms.md @@ -5,11 +5,12 @@ title: Create and Join Rooms ## Create a New Room -To create your own room, head to [Hubs-Foundation's Demo Hub](https://hubs.Hubs-Foundation.com/demo) and click "Create a Room". Your new space is private; no one else can join until you invite them. +To create your own room click "Create a Room". Your new space is private; no one else can join until you invite them. ## Join an Existing Room -You can join an existing Hubs room using either a URL or a numeric code. If you have a URL, navigate to the URL in your browser. If you have a numeric code, visit [hubs.link](https://hubs.link) to use it. +You can join an existing Hubs room using either a URL or a numeric code. If you have a URL, navigate to the URL in your browser. + ## Enter a Room @@ -19,23 +20,25 @@ Before entering a Hubs room you are in the room's lobby. You can see and hear wh Click "Enter Room" and follow the prompts to select a username/avatar and set up your mic. On the final prompt select "Enter on Screen", or "Enter on Phone" if on mobile. -