Project Bento Resources and Information

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