User:Mint Shock/System Standard: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Add wip disclaimer
 
(5 intermediate revisions by the same user not shown)
Line 8: Line 8:


== Setup ==
== Setup ==
The simplest possible system consists of a single slot with all required variables present.  
The simplest possible system consists of a single slot with all required '''[*]''' variables present.  


== Variables ==
== Variables ==
Line 18: Line 18:
!Purpose
!Purpose
|-
|-
|<code>Root</code>
|<code>Root</code> *
|{{Template:TypeColorCard|Slot}}
|{{Template:TypeColorCard|Slot}}
|Root slot of the avatar.
|Root slot of the system.  
|-
|-
|<code>User</code>
|<code>Name</code> *
|{{Template:TypeColorCard|User}}
|{{Template:TypeColorCard|String}}
|The user that has the avatar equipped as assigned by the [[Component:AvatarUserReferenceAssigner|Avatar User Reference Assigner]].
|Name of the system. Use a [[Component:DynamicField|DynamicField]] with the target being the tag on the system <code>root</code>
|-
|<code>Icon</code>
|{{Template:TypeColorCard|Uri}}
|Icon of the system. (resdb link to the icon texture)
|-
|-
|<code>HasUser</code>
|<code>HasSubsystem</code>
|{{Template:TypeColorCard|bool}}
|{{Template:TypeColorCard|bool}}
|If the avatar is currently equipped.
|If this system has subsystems
|-
|-
|<code>IsAway</code>
|<code>IsAway</code>
Line 37: Line 41:
|{{Template:TypeColorCard|String}}
|{{Template:TypeColorCard|String}}
|Name of the avatar base. Examples: <code>Davali</code>, <code>Mayu</code>.
|Name of the avatar base. Examples: <code>Davali</code>, <code>Mayu</code>.
|-
|<code>Name</code>
|{{Template:TypeColorCard|String}}
|Name of the avatar slot.
|-
|-
|<code>Bone.''Name''</code>
|<code>Bone.''Name''</code>
Line 49: Line 49:
|{{Template:TypeColorCard|Slot}}
|{{Template:TypeColorCard|Slot}}
|All armature body nodes using [[Type:BodyNode|Body Node]] names.
|All armature body nodes using [[Type:BodyNode|Body Node]] names.
|-
|<code>BodyNode.''Name''.Bone</code>
|{{Template:TypeColorCard|Slot}}
|The associated fake bone, if one is being used.
|-
|<code>BodyNode.''Name''.Hidden</code>
|{{Template:TypeColorCard|bool}}
|If the body part should be hidden.
|-
|<code>Proxy.''Name''</code>
|{{Template:TypeColorCard|Slot}}
|Proxies using the [[Type:BodyNode|Body Node]] names.
|-
|<code>RigCollidersEnabled</code>
|{{Template:TypeColorCard|bool}}
|As set by [[Component:VRIKAvatar]] <code>rigCollidersEnabledStates</code>.
|-
|<code>Renderers</code>
|{{Template:TypeColorCard|Slot}}
|All renderers are children of this slot.
|-
|<code>Renderer.''Mesh''</code>
|{{Template:TypeColorCard|SkinnedMeshRenderer}}
{{Template:TypeColorCard|MeshRenderer}}
|
|-
|<code>Renderer.''Mesh''.Enabled</code>
|{{Template:TypeColorCard|bool}}
|Defaults to <code>true</code>.
|-
|<code>Material.''Name''</code>
|{{Template:TypeColorCard|IAssetProvider`1|IAssetProvider&lt;Material&gt;}}
|
|-
|<code>Material.''Name''.Away</code>
|{{Template:TypeColorCard|IAssetProvider`1|IAssetProvider&lt;Material&gt;}}
|Material version when <code>IsAway</code> is true.
|-
|-
|<code>Menu</code>
|<code>Menu</code>
|{{Template:TypeColorCard|Slot}}
|{{Template:TypeColorCard|Slot}}
|Radial menu items root slot.
|Radial menu items root slot.
|-
|<code>Menu</code>
|{{Template:TypeColorCard|colorX}}
|Avatar menu color.
|-
|<code>Menu</code>
|{{Template:TypeColorCard|IAssetProvider`1|IAssetProvider&lt;Sprite&gt;}}
|Avatar menu icon.
|-
|<code>Systems</code>
|{{Template:TypeColorCard|Slots}}
|All systems are children of this slot.
|-
|<code>Voice</code>
|{{Template:TypeColorCard|IWorldAudioDataSource}}
|Assigned by [[Component:AvatarVoiceSourceAssigner|Avatar Voice Source Assigner]].
|-
|<code>VisemeAnalyzer</code>
|{{Template:TypeColorCard|VisemeAnalyzer}}
|
|-
|<code>VisemeAnalyzer.Strength</code>
|{{Template:TypeColorCard|float}}
|Defaults to 1.
|-
|<code>VisemeAnalyzer.VoiceOverride</code>
|{{Template:TypeColorCard|IWorldAudioDataSource}}
|Defaults to <code>Voice</code>.
|}
|}


=== Systems ===
=== Subsystems ===


== Avatar Standard ==
== Avatar Standard ==

Latest revision as of 22:54, 25 September 2025

This is a early draft of this proposal. Please don't use anything in here yet. Everything is still subject to change.

Standardization is required for collaboration and shared assets. This is a proposal made by Mint_Shock which standardizes a list of Dynamic Variables on the "System" namespace to make systems interoperable and portable and enables users to create systems which can easily be installed onto other objects like tools, avatars, and much more. All without using any developer tools.

Systems are anything that goes on top of an base object. This includes ProtoFlux logic and other assets such as slots, meshes, textures and much more.

All variables must be defined including their namespace to avoid them accidentally binding to the wrong namespace: System/VariableName. The namespace must not rely on non-direct binding of variables.

Setup

The simplest possible system consists of a single slot with all required [*] variables present.

Variables

Dynamic Variables
Name Type Purpose
Root * Slot Root slot of the system.
Name * String Name of the system. Use a DynamicField with the target being the tag on the system root
Icon Uri Icon of the system. (resdb link to the icon texture)
HasSubsystem bool If this system has subsystems
IsAway bool If the user of the avatar is shown as away.
Base String Name of the avatar base. Examples: Davali, Mayu.
Bone.Name Slot All bones of the rig using the original bone names.
BodyNode.Name Slot All armature body nodes using Body Node names.
Menu Slot Radial menu items root slot.

Subsystems

Avatar Standard

The System standard is designed primarely as a extension of the Avatar standard. Both proposals are designed to work together seamlessly. Systems can access variables from the Avatar standard by reading variables from the Avatar namespace.

Example: a flight thruster system might need to know the users hand position. Normally you would have to manually find the users hand slots using ProtoFlux. Avatar standard simplifies this by providing Dynamic variable Avatar/BodyNode.HandL and Avatar/BodyNode.HandR of type Slot

le

See also

Retrieved from "https://wiki.resonite.com/index.php?title=User:Mint_Shock/System_Standard&oldid=113264"