ResonitePackage: Difference between revisions

From Resonite Wiki
No edit summary
No edit summary
Line 1: Line 1:
'''ResonitePackage''' is an upcoming package format allowing users to share and import pre-setup avatars and objects easily<ref>Frooxius' comment on the package format on GitHub: https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/950#issuecomment-2153588542</ref>.
'''ResonitePackage''' is an upcoming package format allowing users to share and import pre-setup avatars and objects easily<ref>Frooxius' comment on the package format on GitHub: https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/950#issuecomment-2153588542</ref>.


The name was chosen as it was the most explicit (following in the steps of the Unity engine having the UnityPackage format), and as a way to advertise the platform<ref>Shifty's comment on the name: https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/950#issuecomment-2148464652</ref><ref>Frooxius' comment on the name: https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/950#issuecomment-2148476139</ref>.
== Goals ==
The goals of the ResonitePackage format are to:
* Allow creators to share creations outside of Resonite
** For example an avatar creator adding a ResonitePackage version of their avatar
 
== Non-Goals ==
* Compatibility with Unity/Unitypackage
** Unitypackage is a proprietary format, that we cannot support/emulate
** Therefore Unity will not support ResonitePackage.
* Compatibility with other VR Platforms
** ResonitePackage files will not be suppoted by other VR Platforms


== Contents ==
== Contents ==
Line 20: Line 30:


You can also optionally, export a ResonitePackage with all [[Asset_Variant|asset variants]]. This will result in a larger file size though.
You can also optionally, export a ResonitePackage with all [[Asset_Variant|asset variants]]. This will result in a larger file size though.
== Naming ==
The name was chosen as it was the most explicit (following in the steps of the Unity engine having the UnityPackage format), and as a way to advertise the platform<ref>Shifty's comment on the name: https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/950#issuecomment-2148464652</ref><ref>Frooxius' comment on the name: https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/950#issuecomment-2148476139</ref>.


== Sources ==
== Sources ==

Revision as of 02:10, 7 June 2024

ResonitePackage is an upcoming package format allowing users to share and import pre-setup avatars and objects easily[1].

Goals

The goals of the ResonitePackage format are to:

  • Allow creators to share creations outside of Resonite
    • For example an avatar creator adding a ResonitePackage version of their avatar

Non-Goals

  • Compatibility with Unity/Unitypackage
    • Unitypackage is a proprietary format, that we cannot support/emulate
    • Therefore Unity will not support ResonitePackage.
  • Compatibility with other VR Platforms
    • ResonitePackage files will not be suppoted by other VR Platforms

Contents

ResonitePackages will include everything needed to re-create an object inside Resonite when re-imported. Including:

  • All Assets
    • Images
    • Sounds
    • Meshes
    • Videos
  • Slot Hierarchies
    • Including Bones
    • Including all components
    • ProtoFlux

All assets will be included explicitly, as in as a file within the package.

Variants

You can also optionally, export a ResonitePackage with all asset variants. This will result in a larger file size though.

Naming

The name was chosen as it was the most explicit (following in the steps of the Unity engine having the UnityPackage format), and as a way to advertise the platform[2][3].

Sources