VRTK.Prefabs icon indicating copy to clipboard operation
VRTK.Prefabs copied to clipboard

Split each prefab out into its own repo

Open thestonefox opened this issue 6 years ago • 5 comments

This repo will then just be a list of all the prefab repos in the package.json

Done? Prefab Repo name Dependencies Notes
CameraRig/UnityXRCameraRig XX.CameraRigs.UnityXR NA
CameraRig/SimulatedCameraRig XX.CameraRigs.Simulated NA
CameraRig/Switcher XX.CameraRigs.Switcher NA needs a clean up
CameraRig/TrackedAlias XX.CameraRigs.TrackedAlias NA
Pointers XX.Indicators.Pointers NA
Helpers/ObjectFollower XX.Mutators.ObjectFollower NA
Helpers/CollisionIgnorer XX.Mutators.CollisionIgnorer NA
ObscuranceQuery XX.Trackers.ObscuranceTracker Needs a new prefab
Locomotion/Teleporters XX.Locomotors.Teleporter NA
Interactions/Interactors & Interactions/Interactables XX.Interactions.Interactor NA this would include the Interactor Prefab and all of the Interactable Prefabs (not the climbing one though)
Helpers/TrackedCollider XX.Trackers.TrackedCollider ObjectFollower
Interactions/Controllables XX.Interactions.ControllableDrive NA
Locomotion/Movement/AxisToVector3 XX.Converters.AxesToVector3 NA
Helpers/AxisRotator XX.Mutators.AxisRotator NA
Interactions/InteractableSnapZones XX.Interactions.SnapZones Interactor
Locomotion/BodyRepresentation XX.Trackers.BodyRepresentation CollisionIgnorer
Locomotion/Movement/Climb XX.Locomotors.Climbing BodyRepresentation, Interactor
Locomotion/DestinationLocations XX.Indicators.SpatialLocation NA
Interactions/Haptics XX.Interactions.Haptics Interactor
Helpers/Tooltip XX.Visuals.Tooltip NA
Interactions/InteractorVisibilityModifier XX.Interactions.InteractorVisibilityModifier Interactor
Helpers/CollisionFader XX.Visuals.CollisionFader CollisionIgnorer
Locomotion/Movement/MovementAmplifier XX.Mutators.MovementAplifier NA
⬜️ Locomotion/Movement/SpatialManipulation XX.Mutators.SpatialManipulator NA needs code moving into zinnia
Helpers/SceneConsole XX.Visuals.SceneConsole NA
⬜️ CameraRig/PlayAreaRepresentation XX.Visuals.PlayAreaOutline NA

thestonefox avatar Oct 18 '19 14:10 thestonefox

All repos will have the following structure:

.devops/
--azure-pipelines.yml
.github/
--ISSUE_TEMPLATE/
----bug_report.md
----feature_request.md
--CODE_OF_CONDUCT.md
--CONTRIBUTING.md
Documentation/
--HowToGuides/
----HowToInstall/
------README.md
----HowToAdd/
------README.md
Editor?/
Runtime/
--Prefabs/
----Prefab.prefab
--SharedResources/
----Materials?/
----NestedPrefabs?/
----Scripts?/
Tests/
--Editor?/
--Runtime/
LICENSE.md
README.md

thestonefox avatar Oct 18 '19 14:10 thestonefox

the ability to write independent tests for each prefab would be great too, we should strive to have that, even if it requires a full build test

thestonefox avatar Oct 18 '19 14:10 thestonefox

Upon the repo being built into a package, the Documentation/ directory will be pushed to https://github.com/ExtendRealityLtd/Academy automatically

thestonefox avatar Oct 18 '19 15:10 thestonefox

namespaces

  • CameraRigs - specific usage of setting up camera rigs
  • SDK - wrappers for 3rd party SDKs
  • Input - anything that provides input
  • Visuals - anything that has a simple visual output
  • Mutators - anything that changes the properties of something
  • Indicators - anything that identifies/indicates an point/area in space
  • Converters - anything that converts one data type into a different datatype without mutation
  • Trackers - anything that tracks the state of something and lets know of any specific changes
  • Interactions - anything where something can be interacted and manipulated in space
  • Locomotors - anything that moves the camera rig through space
  • Utilities - anything that is purely a helper class

thestonefox avatar Dec 07 '19 20:12 thestonefox

Suggestion to have a tilia for GameObjectStateMirror although mirror requires only two observerable list, it is an IProcessable that might need a moment processor setup to work as-in. also a tilia can let folks know its presence and can add a guideline

fight4dream avatar Jul 21 '20 19:07 fight4dream