-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into basic-spatial-module-docs
- Loading branch information
Showing
411 changed files
with
4,017 additions
and
616 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| <!-- | ||
| ## Community Assets | ||
| This section will contain a list of third-party assets created by the community. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!-- | ||
| ## Community channels | ||
| - [Twitter](https://twitter.com/xr_engine) | ||
| - [Facebook](https://www.facebook.com/xrengine/) | ||
| - [Discord](https://discord.gg/xrf) | ||
| --> | ||
|
|
||
| You can join Ethereal Engine's community on: | ||
| - [Twitter](https://twitter.com/xr_engine) | ||
| - [Facebook](https://www.facebook.com/xrengine/) | ||
| - [Discord](https://discord.gg/xrf) | ||
|
|
||
| Feel free to ask any questions that may come up. | ||
| We are here to help! | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <!-- | ||
| TODO | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| <!-- | ||
| ## Community Tutorials | ||
| This section will contain a list of third-party tutorials and resources created by the community. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| import Dashboard from '@site/docs/_partials/concepts/creator/dashboard.md' | ||
| import Studio from '@site/docs/_partials/concepts/creator/studio.md' | ||
| import Assets from '@site/docs/_partials/concepts/creator/assets.md' | ||
| import Components from '@site/docs/_partials/concepts/creator/components.md' | ||
| import Avatars from '@site/docs/_partials/concepts/creator/avatars.md' | ||
| import Mastery from '@site/docs/_partials/concepts/creator/mastery.md' | ||
|
|
||
| <!-- core --> | ||
| <Dashboard /> | ||
|
|
||
| <!-- core and advanced --> | ||
| <Studio /> | ||
| <Assets /> | ||
|
|
||
| <!-- advanced only --> | ||
| <Components /> | ||
| <Avatars /> | ||
|
|
||
| <!-- mastery --> | ||
| <Mastery /> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <!-- Concepts List (isolated from guided steps) | ||
| # Core | ||
| ## Dashboard -> (new) | ||
| Project Management | ||
| Installing Projects | ||
| Scene Management | ||
| Admin Panel | ||
| Tutorial Tracks | ||
| ## Studio | ||
| ### Material Editor | ||
| (viewer+editor) | ||
| ## Assets | ||
| Prefabs | ||
| Kits | ||
| Lights | ||
| LookDev Presets (name TBD) | ||
| ### Scripts | ||
| - [ ] Animation Triggers | ||
| - [ ] (tut step) Move object | ||
| - [ ] (tut step) Scale object | ||
| - [ ] (tut step) Change color | ||
| - [ ] (not yet) Animation Timeline | ||
| - [ ] Keying | ||
| - [ ] URL redirect | ||
| - [ ] Ecommerce | ||
| ### Lighting / Look Dev | ||
| Environment Map | ||
| Environment Map Baker | ||
| Lightmaps | ||
| Lightmaps Baker | ||
| ### CMS | ||
| User Library | ||
| Assets Packs (Starter Packs/kits) | ||
| Assets Panel | ||
| Assets Panel Search | ||
| Assets Panel Categories | ||
| ### Scene | ||
| Scene Building | ||
| Ground Plane | ||
| #### Skybox | ||
| Cubemap | ||
| Time of Day (Procedural) | ||
| ### Optimization | ||
| On Import | ||
| On Publish | ||
| Compression | ||
| Dynamic Loading | ||
| Variants & LODs | ||
| # Advanced | ||
| ## Studio | ||
| - [ ] Snapping | ||
| - [ ] Non-default UI layout | ||
| - [ ] Gizmos | ||
| - [ ] Switch origin | ||
| - [ ] Switch obj reference space | ||
| - [ ] Validation/Debug | ||
| - [ ] Tilde menu | ||
| - [ ] How to use stats | ||
| - [ ] Upper limits of drawcalls | ||
| - [ ] Upper limits of triangles | ||
| - [ ] What are drawcalls/etc | ||
| - [ ] Budgets: Not go over the limits, what are they | ||
| - [ ] Debug helpers | ||
| - [ ] Physics helpers | ||
| - ... | ||
| - [ ] Graphics Basics: Glossary and gamedev concepts | ||
| ## Assets | ||
| - [ ] Budgets | ||
| - [ ] Optimization | ||
| - [ ] Variants & LODs | ||
| - [ ] Dynamic Loading | ||
| - [ ] Compression | ||
| ### Web Formats | ||
| - [ ] ee.GLTF + Extensions | ||
| - [ ] Hierarchy | ||
| - [ ] Model components | ||
| - [ ] gltf vs glb | ||
| - [ ] KTX | ||
| - [ ] UVOL | ||
| - [ ] Streaming (Video/Audio) | ||
| ### Important Components | ||
| - [ ] Text | ||
| - [ ] Camera | ||
| - [ ] Animations | ||
| #### Model Component | ||
| - [ ] Animations | ||
| - [ ] Custom Materials (Editing, Setting them up) | ||
| #### Transform Component | ||
| Origin Point | ||
| ## Avatars | ||
| - [ ] Emotes | ||
| - [ ] Mocap | ||
| - [ ] Custom Avatars (currently hardcoded) | ||
| # Mastery | ||
| Project Management | ||
| - [ ] GitHub Docs | ||
| - [ ] Team sync tools | ||
| Model Checkers (websites) | ||
| Visualscript | ||
| GLTF hierarchies (maybe: relationship to USD) | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import Description from '@site/docs/_partials/concepts/creator/assets/description.md' | ||
| import Prefabs from '@site/docs/_partials/concepts/creator/assets/prefabs.md' | ||
| import Kits from '@site/docs/_partials/concepts/creator/assets/kits.md' | ||
| import Lights from '@site/docs/_partials/concepts/creator/assets/lights.md' | ||
| import LookDevPresets from '@site/docs/_partials/concepts/creator/assets/lookdev.md' | ||
| import Scripts from '@site/docs/_partials/concepts/creator/assets/scripts.md' | ||
| import CMS from '@site/docs/_partials/concepts/creator/assets/cms.md' | ||
| import Scene from '@site/docs/_partials/concepts/creator/assets/scene.md' | ||
| import Skybox from '@site/docs/_partials/concepts/creator/assets/skybox.md' | ||
| import Optimization from '@site/docs/_partials/concepts/creator/assets/optimization.md' | ||
| import WebFormats from '@site/docs/_partials/concepts/creator/assets/webFormats.md' | ||
|
|
||
| <Description /> | ||
| <Prefabs /> | ||
| <Kits /> | ||
| <Lights /> | ||
| <LookDevPresets /> | ||
| <Scripts /> | ||
| <CMS /> | ||
| <Scene /> | ||
| <Skybox /> | ||
|
|
||
| <!-- advanced --> | ||
| <Optimization /> | ||
| <WebFormats /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import Description from '@site/docs/_partials/concepts/creator/assets/cms/description.md' | ||
| import Panel from '@site/docs/_partials/concepts/creator/assets/cms/panel.md' | ||
| import Packs from '@site/docs/_partials/concepts/creator/assets/cms/packs.md' | ||
|
|
||
| <Description /> | ||
| <Panel /> | ||
| <Packs /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/cms/description" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/cms/description.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/cms/packs" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/cms/packs.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import Description from '@site/docs/_partials/concepts/creator/assets/cms/panel/description.md' | ||
| import Search from '@site/docs/_partials/concepts/creator/assets/cms/panel/search.md' | ||
| import Categories from '@site/docs/_partials/concepts/creator/assets/cms/panel/categories.md' | ||
|
|
||
| <Description /> | ||
| <Search /> | ||
| <Categories /> |
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/cms/panel/categories.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/cms/panel/categories" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/cms/panel/categories.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/cms/panel/description.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/cms/panel/description" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/cms/panel/description.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/cms/panel/search.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/cms/panel/search" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/cms/panel/search.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/description" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/description.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/kits" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/kits.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/lights" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/lights.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/lookdev" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/lookdev.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
||
| <!-- | ||
| LookDev Presets | ||
| TODO: Name is TBD | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import Description from '@site/docs/_partials/concepts/creator/assets/optimization/description.md' | ||
| import Compression from '@site/docs/_partials/concepts/creator/assets/optimization/compression.md' | ||
| import DynamicLoading from '@site/docs/_partials/concepts/creator/assets/optimization/dynamicLoading.md' | ||
| import Variants from '@site/docs/_partials/concepts/creator/assets/optimization/variants.md' | ||
| import LOD from '@site/docs/_partials/concepts/creator/assets/optimization/lod.md' | ||
|
|
||
| <Description /> | ||
| <Compression /> | ||
| <DynamicLoading /> | ||
| <Variants /> | ||
| <LOD /> |
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/optimization/compression.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/optimization/compression" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/optimization/compression.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/optimization/description.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/optimization/description" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/optimization/description.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/optimization/dynamicLoading.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/optimization/dynamicLoading" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/optimization/dynamicLoading.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/optimization/lod.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/optimization/lod" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/optimization/lod.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
11 changes: 11 additions & 0 deletions
11
docs/_partials/concepts/creator/assets/optimization/variants.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Concept } from '@site/src/components/Concept' | ||
|
|
||
| <Concept | ||
| title = "assets/optimization/variants" | ||
| kind = "Core" | ||
| category = "Creator" | ||
| block = {true}> | ||
| This is a dummy description for `concepts/creator/assets/optimization/variants.md`. | ||
| Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. | ||
| </Concept> | ||
|
|
Oops, something went wrong.