Difference between revisions of "Project Bento Resources and Information"

Latest revision as of 10:22, 28 September 2024

Welcome to Project Bento! As we mentioned in our announcement, Project Bento is adding new bones and attachment points to the avatar skeleton.

Project Bento Testing is now Complete! Project Bento is now Live in all regions on all viewers!

What is Project Bento??

Project Bento is an update to the Second Life Avatar Skeleton which is what allows Second Life Avatars to move and come to life, as well as enabling the creation of more lifelike and intricate rigged mesh attachments.

Bone Updates

The Project Bento Update added bones to the skeleton to expand rigging and animation support in the following areas:

Facial Area (new)
Spine (additional bones)
Hands (new finger bones)
Tail (new)
Wings (new)
Hind Legs for Quadruped Avatars (new)

A full list of the alterations for the skeleton are here.

Slider System / Shape Updates

Additionally Project Bento updated the existing avatar shape system to make the adjustment sliders affect these new bones on top of it's previous (unaltered) shape control functionality.

Scope of slider interactions

While the updates to the slider system made it so that these new bones move with sliders, it does not override, or affect in any way existing behavior on the default Linden Avatar head and hands. The default Linden Avatar depends on morph targets to perform hand poses and facial expressions. This is a completely different system from using bone based rigging on mesh attachments worn in the same regions of the body (which is what Project Bento adds support for). While these two systems are affected similarly by slider manipulation by design, it is good to keep in mind that it is an approximation, and only that. It is fundamentally impossible to exactly mimic the motion of a morph target based system with a bone based rigging system. For example : sliders will affect a mesh attachment head differently than it affects the Linden Avatar head. This is unavoidable due to how both systems differ mechanically.

Animation File Updates

On top of additional bones and slider integration, Project Bento also increased the maximum allowable size of animation files, and also removed the restriction on BVH animation file uploads that prevented translation based bone movement.

Partial Skeletons

Upload of rigged content no longer needs all the bones specified in the DAE file for convenience purposes. For rigged content, simply omitting unused/missing bones from the skinning data is now allowed.

Caveats & Best Practices

Due to the restrictions of the pre-existing Second Life Animation System. Playing animations that affect bone scale will (continue to) not work with Project Bento, however the slider system has been incorporated to adjust bone positions and bone scale.
Any slider controls that affect the position ( translation ) of a specific bone will be overridden if the user plays an animation that moves that bone. Since presently the animation system has no means of knowing the positional offset that the slider is providing, that animation will be played based off of the bones natural ( pre-slider adjustment ) position. However the slider's influence on the affected bones scale will not be altered, as animations presently cannot affect bone scale.

Because of the above two restrictions it is ill advised, to mix content where you want the translation based sliders to work with translation based animations. Because the animation will always override the slider. For a list of all the bones that are influenced by sliders that adjust their position refer to this : https://wiki.secondlife.com/wiki/Project_Bento_Skeleton_Guide#Bones_Currently_Affected_By_Positional_Sliders

This was the best practical alternative to simply not allowing translation based animations at all due to the possibility of them overriding sliders. The community asked for the ability to have translation/position based animations available for greater creative control and it was agreed upon that suffering the confusion from this conflict of behavior was still an overall gain.

Prior to Project Bento, rigging to attachment points was never formally supported, and was strongly discouraged, as once an animation stops playing it often leaves the attachment points in a deformed location that is very difficult for a resident to understand. With the addition of Project Bento, meshes rigged to Attachment points may be rejected by the server since one of the primary reasons for the addition of these new bones was to discourage this process.

Current Content & Resources

Models & Skeleton Files / Test Content

Note: to add new test content to the wiki, you can first attach it to BUG-10981, then post a link to that attachment in the wiki. The wiki does not allow attaching most file formats directly.

Collada (dae) files:

The following model files are compatible with the current project viewer, as of 2016-07-14, and should work with currently implemented sliders. Includes weighting to the new mFaceJawShaper bone.

human female (August 5, 2016) (attention, this rig is broken)
human male (August 5, 2016)
angel (August 5, 2016)

Maya (ma) files:

These are also current with the skeleton of July 14, 2016:

maya human female (August 17, 2016)

(NOTE: Standard Skeleton with bone located in standard positions determined by the avatar_skeleton.xml file.)

maya human male (August 17, 2016)

(NOTE: Standard Skeleton with bone located in standard positions determined by the avatar_skeleton.xml file.)

FBX files:

fbx human female (September 10, 2016)
fbx human male (September 10, 2016)

These are based on the Maya files above.

3ds Max (max) files

All files are saved as 3dsmax2012 files, if your version predates this, they probably won't load.

"Basic" skeleton files contain no additional nodes and will not work for advanced control rigs and animation export, but are simpler, contain less clutter and might be ideal for simple rigging&skinning work. However bone rotation axis will not behave ideally for animations.

"Normal/Animation" Rigs have additional nodes for ease of use with animations, but animation must be done on "mBoneName_DRV" point helper nodes instead of the bones directly. These skeleton files have nodes oriented in a manner that will make joints rotate on their local axis. This is particularly useful for mimicing animation in parts of the bento skeleton such as the hands and face where the bone is not aligned with an axis ( perpendicular to other things in the scene ). Hopefully these skeleton rigs will help understanding of the new joints.

For both skeletons ( both "basic" and "animation" ) the mesh skinning and rigging should be done to the mBoneName or "collision volume" (fitmesh) bones / dummies only. All skeletons are default (female) bone positions ONLY.

basic skeleton bone nodes (December 26, 2016)
basic skeleton dummy nodes (December 26, 2016)
skeleton bone nodes (December 26, 2016)
skeleton dummy nodes (December 26, 2016)

Dec, 2016 update fixes minor rotation issues in the collision volume bones that existed in the initial August 2016 posting.

Test Animations

scramble the positions of all bones and attachments
reset the positions of all bones and attachments to the default.

Animation Export Tools

Maya

The following tools are used for export of BVH animation files from Autodesk Maya Software. The exporter was authored by Aura Linden and is available for free below.

It works ideally with the skeleton included in Mayastar, maintained by Cathy Foil. But should be able to be used as a standalone script as well.

Maya BVH Animation Exporter - mel script --Note: when animating in Maya for export, orient your skeleton in Y+ up , X+ forward orientation.
Maya BVH exporter instructions - text file

Blender

While blender does not have any freely available animation exporters specifically for Second Life, it has an excellently maintained plugin package known as Avastar maintained by Gaia Clary.

3DSMax

Autodesk 3D Studio Max presently does not have any publicly available animation exporters. However, polysail resident is presently working on a plugin that will do so. Completion date is TBD.

Reference

Some helpful models to show the locations of various types of bones can be found at https://marketplace.secondlife.com/p/Avatar-Testing-and-Visualization-Kit/9842033

Scale Locking Option

With Project Bento, the option to have an uploaded mesh attachment completely ignore all slider input was also added.

When you upload a model beneath the standard "Include skin weight" and "Include joint positions" check boxes, there is now an additional check box for "Lock scale if joint position defined". If you check this box, then any joint that has a position defined will also have its scale locked. Scale locking will be enforced whenever a joint would normally be scaled by a slider thus "immunizing" it to all slider influence. To make a bone truly slider-proof, you will have to pay attention to the joint hierarchy. Any change to the scale of a parent bone will also cause the child bone to move, so you will have to make sure the bone's ancestors also have joint positions defined. A joint position will be ignored unless it differs from the bone's default location by at least 0.1 mm (ie, 0.0001 m in the units used by the skeleton definition file). If you want to lock a joint without changing its position, use a very small offset that will not be large enough to have a visual effect (some fraction of a mm).

This feature was primarily included to assist with making "animated attachments" that re-purpose bone sets, such as the hind legs, wings or tail into pets or weapon attachments. Ideally such attachments would not want slider influences due to the fact that the bones comprising them are "borrowed" from another part of the body.

Reset Skeleton Menu Option [Viewer]

With the addition of Project Bento a new menu option was added to the viewer. If you Right-Click another avatar the option to "Reset Skeleton" will appear, along with it's cousin "Reset Skeleton and Animations". This added functionality provides any resident the ability to attempt to visually fix another avatar that looks deformed on their screen.

 Note this option does not send any data to the server.  This means that if you use "Reset Skeleton" on a deformed avatar ( including yourself ) that currently does NOT perform this action for everyone else viewing the deformed avatar.

This was done because visibly deformed avatars aren't always deformed universally. The logic for why this is is long and complex, involving the mechanics of how avatars are loaded. This feature isn't a fix-all, but is a great alternative to completely logging out of the client and reconnecting, which, prior to this update, used to be the only reliable way to resolve this sort of issue.

I found a problem? How can I give feedback?

As always if you discover an undocumented bug please report it at Second Life JIRA with the tag [BENTO] in the summary line for it to be properly addressed!

If you have a display problem, please test to see if there is a difference with with hardware skinning Enabled and Disabled

Me->Preferences->Graphics->Advanced->Avatar Rendering->Hardware skinning checkbox

@@ Line 1: / Line 1: @@
-'''Welcome to Project Bento! As we mentioned in [https://community.secondlife.com/t5/Featured-News/Introducing-Project-Bento-New-Bones-Added-to-Second-Life-Avatar/ba-p/2987206 our announcement], Project Bento is adding new bones and attachment points to the avatar skeleton. Bento is now ready for testing!'''
+{{TOCright}}
-==What is the test period for? How long will it last?==
+'''Welcome to Project Bento! As we mentioned in [https://community.secondlife.com/t5/Featured-News/Introducing-Project-Bento-New-Bones-Added-to-Second-Life-Avatar/ba-p/2987206 our announcement], Project Bento is adding new bones and attachment points to the avatar skeleton.'''
-The testing period is designed to validate the viewer and the new skeleton, and will continue until we are confident that we have a solid release candidate, at least a few weeks.
+'''Project Bento Testing is now Complete!  Project Bento is now Live in all regions on all viewers!'''
-During the course of testing, we may make changes to the project viewer or the skeleton as a result of user feedback. This means test content created during this period may cease to work properly if the skeleton changes.
+== What is Project Bento?? ==
-At the end of the test period, Bento will become a viewer release candidate, and the new skeleton will be enabled on the main grid. Hopefully not long after that, the Bento viewer will be released as the default viewer.
+Project Bento is an update to the Second Life Avatar Skeleton which is what allows Second Life Avatars to move and come to life, as well as enabling the creation of more lifelike and intricate rigged mesh attachments.
-==Where can I find the test viewer?==
+===Bone Updates===
-The latest project viewer is always available on the [[Linden_Lab_Official:Alternate_Viewers|Alternate Viewers]] wiki page..
+The Project Bento Update added bones to the skeleton to expand rigging and animation support in the following areas:
-The first version is [[Release Notes/Second Life Project Bento/5.0.0.309171|here]]
+* Facial Area (new)
+* Spine (additional bones)
+* Hands (new finger bones)
+* Tail (new)
+* Wings (new)
+* Hind Legs for Quadruped Avatars (new)
-==Where can we test Bento? How are the test regions special?==
+A full list of the alterations for the skeleton are [[Project Bento Skeleton Guide|here]].
-Testing Bento will require uploading and using meshes and animations that take advantage of new joints. It will also allow you to take advantage of new attachment points associated with some of the new joints. To do all this, '''''you will need to do your testing in areas of Aditi where such content is specifically enabled for upload, and where the new attachment points are recognized'''''.
+===Slider System / Shape Updates===
+Additionally Project Bento updated the existing avatar shape system to make the adjustment sliders affect these new bones on top of it's previous (unaltered) shape control functionality.
-Most of Aditi should work, but some regions may not - these are the ones we will be sure to keep up to date, so if you have a problem, ''please recheck it here first'':
+'''Scope of slider interactions'''
-* Mesh Sandbox 1
-* Mesh Sandbox 2
-* Mesh Sandbox 3
-* Mesh Sandbox 4
-Also, note that the test regions have some new constraints set for mesh and animation upload:
+While the updates to the slider system made it so that these new bones move with sliders, it does not override, or affect in any way existing behavior on the default Linden Avatar head and hands.  The default Linden Avatar depends on ''morph targets'' to perform hand poses and facial expressions.  This is a completely different system from using ''bone based rigging'' on mesh attachments worn in the same regions of the body (which is what Project Bento adds support for).  While these two systems are affected ''similarly'' by slider manipulation by design, it is good to keep in mind that it is an approximation, and only that.  It is fundamentally impossible to exactly mimic the motion of a morph target based system with a bone based rigging system.  For example : sliders will affect a mesh attachment head differently than it affects the Linden Avatar head.  This is unavoidable due to how both systems differ mechanically.
-* Animations cannot include animation of positions, except for the pelvis.
-*: This has always been enforced in bvh upload, but it has been possible to bypass the constraint by uploading animations as .anim files. In the Bento test regions (and on Agni once Bento is fully released), this will no longer be possible.
-* Meshes rigged to attachment points cannot be uploaded.
-* Animations applied to attachment points cannot be uploaded.
-We understand that any new restrictions may be controversial, and do please note that currently these are only being applied on Aditi. The reason we are putting the restrictions in place is to help with testing and transitioning to the new skeleton:
+===Animation File Updates===
+On top of additional bones and slider integration, Project Bento also increased the maximum allowable size of animation files, and also removed the restriction on BVH animation file uploads that prevented translation based bone movement.
-:The previous approach was never officially supported and has some significant issues. Moving the attachment points means they are no longer in their intended locations, to support attachments in those areas, as originally designed. Animating positions also has its own set of issues, such as making it easy to get your avatar stuck in a distorted shape.
+===Partial Skeletons===
+Upload of rigged content no longer needs all the bones specified in the DAE file for convenience purposes. For rigged content, simply omitting unused/missing bones from the skinning data is now allowed.
-Adding new joints to the skeleton is intended to alleviate the need for workarounds such as rigging to attachment points, so we need to know whether it is succeeding. Are there things the new system still cannot do? We can only find issues with the new skeleton if it is being exercised as designed.
+== Caveats & Best Practices ==
-So please let us know! The most helpful feedback will let us know about problems or limitations encountered with the new skeleton.
+*Due to the restrictions of the pre-existing Second Life Animation System. Playing animations that affect bone scale will (continue to) not work with Project Bento, however the slider system has been incorporated to adjust bone positions and bone scale.
+*Any slider controls that affect the position ( translation ) of a specific bone will be overridden if the user plays an animation that moves that bone.  Since presently the animation system has no means of knowing the positional offset that the slider is providing, that animation will be played based off of the bones natural ( pre-slider adjustment ) position.  However the slider's influence on the affected bones scale will not be altered, as animations presently cannot affect bone scale.
-==How can we test Bento?==
-There are two ways to help with testing Bento:
+Because of the above two restrictions it is ill advised, to mix content where you want the translation based sliders to work with translation based animations. Because the animation will always override the slider.
-* If you are a content creator, please help us exercise the new skeleton. Create your own meshes and animations for facial animation, hand gestures, wings, tails, and so on! Let us know about any problems you encounter, and share your experiences with other creators in the forum (LINK).
+For a list of all the bones that are influenced by sliders that adjust their position refer to this : https://wiki.secondlife.com/wiki/Project_Bento_Skeleton_Guide#Bones_Currently_Affected_By_Positional_Sliders
-* If you are a mesh user, help us test the viewer. Try uploading and using some of the test content). Are there any problems displaying or using it on your system? Do you see a significant impact on performance when using the new skeleton?
-===Test Content===
+This was the best practical alternative to simply not allowing translation based animations at all due to the possibility of them overriding sliders.   The community asked for the ability to have translation/position based animations available for greater creative control and it was agreed upon that suffering the confusion from this conflict of behavior was still an overall gain.
-If you have made test content, edit this page to provide links to it here.
+Prior to Project Bento, rigging to attachment points was never formally supported, and was strongly discouraged, as once an animation stops playing it often leaves the attachment points in a deformed location that is very difficult for a resident to understand.  With the addition of Project Bento, meshes rigged to Attachment points ''may be rejected by the server''  since one of the primary reasons for the addition of these new bones was to discourage this process.
+== Current Content & Resources ==
+=== Models & Skeleton Files / Test Content ===
+Note: to add new test content to the wiki, you can first attach it to [https://jira.secondlife.com/browse/BUG-10981 BUG-10981], then post a link to that attachment in the wiki. The wiki does not allow attaching most file formats directly.
+'''Collada (dae) files''':
+The following model files are compatible with the current project viewer, as of 2016-07-14, and should work with currently implemented sliders. Includes weighting to the new mFaceJawShaper bone.
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/models/collada/female_2016_08_05.dae.zip human female] (August 5, 2016) (attention, this rig is broken)
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/models/collada/male_2016_08_05.dae.zip human male] (August 5, 2016)
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/models/collada/angel_2016_08_05.dae.zip angel] (August 5, 2016)
+'''Maya (ma) files''':
+These are also current with the skeleton of July 14, 2016:
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/models/maya/MayaBentoFemaleAugust2016.ma.zip maya human female] (August 17, 2016)
+(NOTE: Standard Skeleton with bone located in standard positions determined by the avatar_skeleton.xml file.)
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/models/maya/MayaBentoMaleAugust2016.ma.zip maya human male] (August 17, 2016)
+(NOTE: Standard Skeleton with bone located in standard positions determined by the avatar_skeleton.xml file.)
+'''FBX files''':
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/models/fbx/FBXBentoFemaleSeptember2016.fbx fbx human female] (September 10, 2016)
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/models/fbx/FBXBentoMaleSeptember2016.fbx fbx human male] (September 10, 2016)
+These are based on the Maya files above.
+'''3ds Max (max) files'''
+All files are saved as 3dsmax2012 files, if your version predates this, they probably won't load.
+"Basic" skeleton files contain no additional nodes and will not work for advanced control rigs and animation export, but are simpler, contain less clutter and might be ideal for simple rigging&skinning work.  However bone rotation axis will not behave ideally for animations.
+"Normal/Animation" Rigs have additional nodes for ease of use with animations, but animation must be done on "mBoneName_DRV" point helper nodes instead of the bones directly. These skeleton files have nodes oriented in a manner that will make joints rotate on their local axis.  This is particularly useful for mimicing animation in parts of the bento skeleton such as the hands and face where the bone is not aligned with an axis ( perpendicular to other things in the scene ).  Hopefully these skeleton rigs will help understanding of the new joints.
+For both skeletons ( both "basic" and "animation" ) the mesh skinning and rigging should be done to the mBoneName or "collision volume" (fitmesh) bones / dummies only. All skeletons are default (female) bone positions ONLY.
+* [https://bitbucket.org/polysail/bento-max2012-skeletons/raw/bc20e9c13a37b6d834ce92b63339f911f08c2e5b/BentoBones_BonesOnly_2012.max basic skeleton bone nodes] (December 26, 2016)
+* [https://bitbucket.org/polysail/bento-max2012-skeletons/raw/bc20e9c13a37b6d834ce92b63339f911f08c2e5b/BentoBones_DummyNodesOnly_2012.max basic skeleton dummy nodes] (December 26, 2016)
+* [https://bitbucket.org/polysail/bento-max2012-skeletons/raw/bc20e9c13a37b6d834ce92b63339f911f08c2e5b/LocalAnimationOrientation_Bones_2012.max skeleton bone nodes] (December 26, 2016)
+* [https://bitbucket.org/polysail/bento-max2012-skeletons/raw/bc20e9c13a37b6d834ce92b63339f911f08c2e5b/LocalAnimationOrientation_DummyNodes_2012.max skeleton dummy nodes] (December 26, 2016)
+Dec, 2016 update fixes minor rotation issues in the collision volume bones that existed in the initial August 2016 posting.
+=== Test Animations ===
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/animations/anim/bento_randomize_bones_and_attachments.anim scramble the positions] of all bones and attachments
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/animations/anim/bento_reset_bones_and_attachments.anim reset the positions] of all bones and attachments to the default.
+=== Animation Export Tools ===
+'''Maya'''
+The following tools are used for export of BVH animation files from Autodesk Maya Software.  The exporter was authored by Aura Linden and is available for free below.
+It works ideally with the skeleton included in [https://marketplace.secondlife.com/p/MayaStar-Plugin-System-for-Maya-Autodesk/5454253 Mayastar], maintained by Cathy Foil.  But should be able to be used as a standalone script as well.
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/tools/maya/Maya_BVH_Export_Bento_Project.mel Maya BVH Animation Exporter] - mel script --'''Note: when animating in Maya for export, orient your skeleton in Y+ up , X+ forward orientation.'''
+* [https://bitbucket.org/lindenlab/secondlife-creator-resources/raw/master/tools/maya/maya_bvh_export_instructions.txt Maya BVH exporter instructions] - text file
+'''Blender'''
+While blender does not have any freely available animation exporters specifically for Second Life, it has an excellently maintained plugin package known as [https://blog.machinimatrix.org/avastar/ Avastar] maintained by Gaia Clary.
+'''3DSMax'''
+Autodesk 3D Studio Max presently does not have any publicly available animation exporters.  However, polysail resident is presently working on a plugin that will do so.  Completion date is TBD.
+=== Reference ===
+* Some helpful models to show the locations of various types of bones can be found at https://marketplace.secondlife.com/p/Avatar-Testing-and-Visualization-Kit/9842033
+== Scale Locking Option ==
+With Project Bento, the option to have an uploaded mesh attachment completely ignore all slider input was also added.
+When you upload a model beneath the standard "Include skin weight" and "Include joint positions" check boxes, there is now an additional check box for "Lock scale if joint position defined". If you check this box, then any joint that has a position defined will also have its scale locked. Scale locking will be enforced whenever a joint would normally be scaled by a slider thus "immunizing" it to all slider influence.
+To make a bone truly slider-proof, you will have to pay attention to the joint hierarchy. Any change to the scale of a parent bone will also cause the child bone to move, so you will have to make sure the bone's ancestors also have joint positions defined. A joint position will be ignored unless it differs from the bone's default location by at least 0.1 mm (ie, 0.0001 m in the units used by the skeleton definition file). If you want to lock a joint without changing its position, use a very small offset that will not be large enough to have a visual effect (some fraction of a mm).
+This feature was primarily included to assist with making "animated attachments" that re-purpose bone sets, such as the hind legs, wings or tail into pets or weapon attachments.  Ideally such attachments would not want slider influences due to the fact that the bones comprising them are "borrowed" from another part of the body.
+==Reset Skeleton Menu Option [Viewer]==
+With the addition of Project Bento a new menu option was added to the viewer.  If you Right-Click another avatar the option to "''Reset Skeleton''" will appear, along with it's cousin "''Reset Skeleton and Animations''".  This added functionality provides any resident the ability to attempt to visually fix another avatar that looks deformed on their screen.
+  '''Note this option does not send any data to the server.  This means that if you use "Reset Skeleton" on a deformed avatar ( including yourself ) that currently does NOT perform this action for everyone else viewing the deformed avatar.'''
+This was done because visibly deformed avatars aren't always deformed universally.  The logic for why this is is long and complex, involving the mechanics of how avatars are loaded.  This feature isn't a fix-all, but is a great alternative to completely logging out of the client and reconnecting, which, prior to this update, used to be the only reliable way to resolve this sort of issue.
-* Humanoid with wings and tail, rigged to the new joints (blender and dae). From Matrice Laville: [{{filepath:Bento_angel.zip}} Bento Angel]
-* Simple animation to flap the wings and move the tail (anim): [{{filepath:wings_and_tail_anim.zip}} Wings and Tail Animation]
 ==I found a problem? How can I give feedback?==
-# Submit bugs in Jira in the BUG project: please put [Bento] in the summary line.
+As always if you discover an undocumented bug please report it at [https://jira.secondlife.com/ Second Life JIRA] with the tag [BENTO]  in the summary line for it to be properly addressed!
-If you have a display problem, please try with hardware skinning enabled and disabled
+If you have a display problem, please test to see if there is a difference with with hardware skinning Enabled and Disabled
 :Me->Preferences->Graphics->Advanced->Avatar Rendering->Hardware skinning checkbox
-Does changing that setting affect the display?