Skip to content

Commit 7c31935

Browse files
authored
Merge branch 'master' into matthewbcool-patch-1
2 parents 7da6d5c + 76d88f5 commit 7c31935

File tree

245 files changed

+28695
-2583
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

245 files changed

+28695
-2583
lines changed

.github/pull_request_template.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## What?
2+
<!-- REQUIRED FOR ALL PULL REQUESTS — Explain what your pull request does -->
3+
4+
5+
## Why?
6+
<!-- REQUIRED FOR ALL PULL REQUESTS — Explain why you're opening this pull request, what limitations does it address, etc.. If you're fixing a bug with an open bug report you can just link to the bug report -->
7+
8+
9+
10+
## Examples
11+
<!-- DO NOT INCLUDE FOR HUBS DOCUMENTATION UPDATES — If applicable, give examples of your changes, screenshots, videos, etc. -->
12+
13+
14+
## How to test
15+
<!-- REQUIRED FOR TECHNICAL PULL REQUESTS; DO NOT INCLUDE FOR HUBS DOCUMENTATION UPDATES — Give the steps required to test your pull request -->
16+
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See '....'
21+
22+
## Documentation of functionality
23+
<!-- REQUIRED FOR TECHNICAL PULL REQUESTS; DO NOT INCLUDE FOR HUBS DOCUMENTATION UPDATES — Link to the accompanying documentation pull request or identify where the documentation is located in this pull request. If no documentation is needed, please specify this here -->
24+
25+
26+
## Limitations
27+
<!-- List anything that isn't addressed, e.g. corner cases, and why they weren't addressed -->
28+
29+
30+
## Alternatives considered
31+
<!-- If there are any alternative ways of implementing this that you thought of, but decided against, list them here along with why they were discarded -->
32+
33+
34+
## Open questions
35+
<!-- List any questions you have -->
36+
37+
38+
## Additional details or related context
39+
<!-- Give any other details that you think the reviewers should be aware of -->
40+

.github/workflows/hubs-docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ on:
77

88
jobs:
99
turkeyGitops:
10-
uses: mozilla/hubs-ops/.github/workflows/turkeyGitops.yml@master
10+
uses: Hubs-Foundation/hubs-ops/.github/workflows/turkeyGitops.yml@master
1111
with:
12-
registry: mozillareality
12+
registry: hubsfoundation
1313
secrets:
14-
DOCKER_HUB_PWD: ${{ secrets.DOCKER_HUB_PWD }}
14+
DOCKER_HUB_PWD: ${{ secrets.DOCKER_HUB_PWD }}

.github/workflows/publish.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: publish
2+
on:
3+
push:
4+
paths-ignore: ["README.md", "CONTRIBUTING.md", "LICENSE"]
5+
pull_request:
6+
paths-ignore: ["README.md", "CONTRIBUTING.md", "LICENSE"]
7+
branches:
8+
- main
9+
workflow_dispatch:
10+
11+
jobs:
12+
build_sync:
13+
runs-on: ubuntu-latest
14+
defaults:
15+
run:
16+
working-directory: ./website
17+
steps:
18+
- name: checkout repo
19+
uses: actions/checkout@v4
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 22
24+
- name: include dependencies
25+
run: npm ci
26+
- name: build HTML
27+
run: npm run build
28+
- name: sync publish
29+
if: ${{ github.ref == 'refs/heads/master' && github.repository == 'Hubs-Foundation/hubs-docs' }}
30+
env:
31+
source: build/hubs-docs/
32+
dest: [email protected]:wordpress/hubs-docs
33+
run: |
34+
env
35+
mkdir -p ~/.ssh
36+
echo "${{ secrets.WEBCONTAINERS_KEY }}" > ~/.ssh/WEBCONTAINERS_KEY
37+
chmod 600 ~/.ssh/WEBCONTAINERS_KEY
38+
echo "${{ vars.KNOWN_HOSTS }}" > ~/.ssh/known_hosts
39+
rsync -v --rsh='ssh -i ~/.ssh/WEBCONTAINERS_KEY' --archive --delete-after $source $dest

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ website/node_modules
1212
website/i18n/*
1313

1414
results
15+
16+
.env

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Mozilla Hubs Docs
1+
# Hubs Docs
22

3-
This repo is for the documentation for [Mozilla Hubs](http://hubs.mozilla.com), and related products such as Hubs Cloud and Spoke.
3+
This repo is for the documentation for Hubs, and related products such as Hubs Cloud and Spoke.
44

55
The documentation is under active development. If there are any changes or updates you recommend, feel free to submit a pull request or let us know in our [Discord Server](http://discord.gg/wHmY4nd).
66

docs/creators-advanced-avatar-customization.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ As described in the [creating custom avatars](intro-avatars.html) page, the most
99

1010
For more advanced customization, you can use the following resources:
1111

12-
* [Photoshop PSD Templates](https://github.com/MozillaReality/hubs-avatar-pipelines/blob/master/Photoshop) - Photoshop templates for a custom Hubs base color skin. You can also use Photoshop's 3D painting tools, using the [Robot OBJ/MAT file](https://github.com/j-conrad/hubs-avatar-pipelines/tree/master/Other%20model%20formats).
13-
* [Substance Painter Project](https://github.com/MozillaReality/hubs-avatar-pipelines/blob/master/Substance)- Full Substance Painter projects for advanced custom skinning. You can also download and modify any of our example texture sets.
12+
* [Photoshop PSD Templates](https://github.com/Hubs-Foundation/hubs-avatar-pipelines/tree/master/Photoshop) - Photoshop templates for a custom Hubs base color skin. You can also use Photoshop's 3D painting tools, using the [Robot OBJ/MAT file](https://github.com/j-conrad/hubs-avatar-pipelines/tree/master/Other%20model%20formats).
13+
* [Substance Painter Project](https://github.com/Hubs-Foundation/hubs-avatar-pipelines/blob/master/Substance)- Full Substance Painter projects for advanced custom skinning. You can also download and modify any of our example texture sets.
1414

1515
![UV Layout example](img/UVLayout.jpg)
1616

@@ -42,23 +42,25 @@ When you upload textures into Hubs The preview will be updated. You do not need
4242

4343
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.
4444

45+
<!-- 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 -->
46+
4547
### Modify Base Robot Template
4648

4749
We offer the following resources if you'd like to modify our base Robot avatar:
4850

49-
* [Blender Source Files](https://github.com/MozillaReality/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/MozillaReality/hubs-avatar-pipelines/tree/master/Blender/AvatarBot) folder.**
51+
* [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.**
5052

51-
* [Exported GLBs](Exported%20GLB%20models)/[Exported OBJ](https://github.com/MozillaReality/hubs-avatar-pipelines/tree/master/Other%20model%20formats) are available if you'd like to bring them into your editor of choice.
53+
* [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.
5254

5355
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)
5456

5557
Hubs avatars are meant for VR, which means that you should work in real world units. A typical avatar height is roughly 1.7 meters. Note: This is typically a 'standing height'. The lack of legs shown here is a part of that overall height.
5658

5759
![avatar height diagram](img/avatarHeight.jpg)
5860

59-
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/MozillaReality/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.
61+
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.
6062

61-
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.
63+
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.
6264
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.
6365

6466
### Use a Regular .glb File

0 commit comments

Comments
 (0)