Respack: Difference between revisions

Latest revision as of 19:34, 5 September 2025

Respack is a community driven project that aims to make importing and creating .resonitepackage avatars simple.

The Respack system is a collection of UI and tools that assists in creating custom, modular avatars for creators and artists. Once exported as a .resonitepackage, the file can be provided to users as a download option when obtaining or purchasing an avatar.

What is Respack?

Respack is...

A community driven project. Anyone is free to create edits and adjust the system, or provide add-ons.
A simple way to provide avatars to users as a single file that can be imported into Resonite.
A way of allowing user customization of avatars without Resonite knowledge, such as using the inspector or creating new materials.

Respack is not...

An avatar standard. There is no hard requirements to create a package using the Respack system.
A requirement of creating an avatar .resonitepackage. An avatar without the use of Respack can be exported and imported the same way.

Creating a Respack

To start creating a ResPack, spawn out the UI, and parent the avatar to the avatar pedestal. Ensure its position is also placed in a good place onto the pedestal for the best results.

Each section of the left panel (Edit ResPack) is to be setup by the avatar artist or creator. Upon import of the .resonitepackage, the Edit ResPack UI will be disabled.

Avatar information

The avatar information tab is the basic information of the avatar, including the name, original 3D artist, images, and a link to the artist's webpage.

Setting

The settings tab is where any float or boolean values are customized on the avatars. Generally, these include:

Body blendshapes (float slider)
Corrective blendshapes (float toggle)
Clothes visibility (bool)

Textures

The textures tab is for adding textures from the avatar materials. This allows for preset textures to be included with the avatar for the user to choose from, and allows an easy drop-in for custom textures.

Add-ons

The add-ons tab is for adding Resonite specific inclusions to the avatar that are not generally included by default. This can be avatar add-ons such as a grabbable system, or a booper. These are slots, which can be toggled on or off. There is also an option to "Destroy on unused", which will destroy the slot when the setting is disabled and once the avatar is equipped. This is ideal for heavy systems that a user might not want.

Best practices

When creating a Respack, there are some considerations that can be made to have a high quality avatar package. While none of these these are a necessity, they are nice to include.

Simple Avatar Protection

Having the SimpleAvatarProtection component already on the avatar is ideal, as it ensures only the user who imported the package has permissions to save and equip the avatar. Without this, anyone in the same session can accidentally equip an avatar from another user who is in the process of customizing it.

Avatar Standard for future support

Including the community Avatar Standard dynamic variables onto the avatar preconfigured allows future additional items to be easily equipped. For example, if a clothing item were made with in the future, using the avatar standard variables would make adding it to the avatar effortless.

Baking blendshapes

Including a setting to bake blendshapes allows avatars to be more performant. This is most noticeable on avatars that have extensible customization via body blendshapes. This would be done using Protoflux, using a Dynamic Impulse Receiver with the tag onFinished parented under the avatar (detailed instructions to be added soon).

Posing

Having a nice pose makes the avatar more presentable, and can give it personality. While it is purely aesthetic, you can also ensure your pose doesn't occlude large parts of the body, so that all of the textures are easily seen.

Respack Team

The Respack team are all community members that have contributed to the Respack system.

@@ Line 2: / Line 2: @@
 The Respack system is a collection of UI and tools that assists in creating custom, modular avatars for creators and artists. Once exported as a <code>.resonitepackage</code>, the file can be provided to users as a download option when obtaining or purchasing an avatar.
-----
 == What is Respack? ==
 === Respack is... ===
-* A community driven project. Anyone is free to create edits and adjust the system, or provide add-ons.
-* A simple way to provide avatars to users as a single file that can be imported into Resonite.
-* A way of allowing avatar user customization without Resonite knowledge, such as using the inspector or creating new materials.
+* <strong>A community driven project.</strong> Anyone is free to create edits and adjust the system, or provide add-ons.
+* <strong>A simple way to provide avatars to users</strong> as a single file that can be imported into Resonite.
+* <strong>A way of allowing user customization of avatars without Resonite knowledge</strong>, such as using the inspector or creating new materials.
 === Respack is not... ===
-* An official Resonite tool. There is no expectation of support from the Resonite team.
-* An avatar standard. There is no hard requirements to create a package using the Respack system.
+* <strong>An avatar standard.</strong> There is no hard requirements to create a package using the Respack system.
-* A requirement of creating an avatar <code>.resonitepackage</code>. An avatar without the use of Respack can be exported and imported the same way.
+* <strong>A requirement of creating an avatar <code>.resonitepackage</code>.</strong> An avatar without the use of Respack can be exported and imported the same way.
-----
 == Creating a Respack ==
 [[File:Respack_editor_pedestal.jpg|thumb|An avatar parented to the avatar pedestal.]]
 To start creating a ResPack, spawn out the UI, and parent the avatar to the avatar pedestal. Ensure its position is also placed in a good place onto the pedestal for the best results.
 Each section of the left panel (Edit ResPack) is to be setup by the avatar artist or creator. Upon import of the <code>.resonitepackage</code>, the Edit ResPack UI will be disabled.
-== Avatar Information ==
+=== Avatar information ===
 [[File:Respack_information.webp|frameless|300px]]
 The avatar information tab is the basic information of the avatar, including the name, original 3D artist, images, and a link to the artist's webpage.
-== Setting ==
+=== Setting ===
 [[File:Respack_settings.webp|frameless|300px]]
@@ Line 30: / Line 37: @@
 * Corrective blendshapes (float toggle)
 * Clothes visibility (bool)
-== Textures ==
+=== Textures ===
 [[File:Respack_textures.webp|frameless|300px]]
 The textures tab is for adding textures from the avatar materials. This allows for preset textures to be included with the avatar for the user to choose from, and allows an easy drop-in for custom textures.
-== Add-ons ==
+=== Add-ons ===
 [[File:Respack_addons.webp|frameless|300px]]
-The add-ons tab is for adding Resonite specific inclusions to the avatar that are not generally included by default. This can be avatar add-ons such as a grabbable system, or a booper. These are slots, which can be toggled on or off. There is also an option to "Destroy on unused", which will destroy the slot upon completing the avatar. This is ideal for heavy systems that a user might not want.
+The add-ons tab is for adding Resonite specific inclusions to the avatar that are not generally included by default. This can be avatar add-ons such as a grabbable system, or a booper. These are slots, which can be toggled on or off. There is also an option to "Destroy on unused", which will destroy the slot when the setting is disabled and once the avatar is equipped. This is ideal for heavy systems that a user might not want.
+== Best practices ==
+When creating a Respack, there are some considerations that can be made to have a high quality avatar package. While none of these these are a necessity, they are nice to include.
+=== Simple Avatar Protection ===
+Having the [[Component:SimpleAvatarProtection|SimpleAvatarProtection]] component already on the avatar is ideal, as it ensures only the user who imported the package has permissions to save and equip the avatar. Without this, anyone in the same session can accidentally equip an avatar from another user who is in the process of customizing it.
+=== Avatar Standard for future support ===
+Including the community [[Avatar_standard|Avatar Standard]] dynamic variables onto the avatar preconfigured allows future additional items to be easily equipped. For example, if a clothing item were made with in the future, using the avatar standard variables would make adding it to the avatar effortless.
+=== Baking blendshapes ===
+Including a setting to bake blendshapes allows avatars to be more performant. This is most noticeable on avatars that have extensible customization via body blendshapes. This would be done using Protoflux, using a [[ProtoFlux:AsyncDynamicImpulseReceiver|Dynamic Impulse Receiver]] with the tag <code>onFinished</code> parented under the avatar (detailed instructions to be added soon).
+=== Posing ===
+Having a nice pose makes the avatar more presentable, and can give it personality. While it is purely aesthetic, you can also ensure your pose doesn't occlude large parts of the body, so that all of the textures are easily seen.
 == Respack Team ==
-The Respack team are all community memebers that have contributed to the Respack system.
+The Respack team are all community members that have contributed to the Respack system.
 * [[User:AmasterAmaster|AmasterAmaster]]
 * [[User:Colin_The_Cat|Colin The Cat]]
 * [[User:darbdarb|darbdarb]]
 * [[User:Decoy|Decoy]]
+* [[User:Jack|Jack]]
 * [[User:Sharkmare|Sharkmare]]
+[[Category:Community tools]]