PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience

Roblox Packages – Reusable Game Assets

Roblox Packages – Reusable Game Assets

Nov 16 2018, 1:42 PM PST

Beta Feature

This feature is currently in beta and may change significantly before the full release.


Roblox packages allow you to create an asset once and re-use it in as many games as you’d like. The primary advantage is that you can keep packages in sync by updating any copy within any game to the most current version.

Packages can be easily recognized in the Explorer hierarchy by the “chain link” symbol in the lower-right corner of the icon:

Standard Model
Model converted to a package

Converting Objects to Packages

All reusable objects can be converted to packages. Note that if the intended package contains 3D elements, you should group them into a Model and set the PrimaryPart.

To convert an object into a package:

  1. In the Explorer window, right-click the object and select Convert to Package….
  2. In the dialog window, fill in the requested details.
  3. Click the Publish button.
  4. Once published, you’ll see a new PackageLink object parented to the object.

Accessing Packages

Published packages can be accessed from either the Toolbox or Game Explorer.

Toolbox

Any time you publish a package, it is added to the My Packages sorting in the Toolbox. This serves as a consolidated space to find and insert a package into any place in any game.

Game Explorer

Packages that are used within any place in a game also appear in the Packages folder of the Game Explorer window.

Right-clicking any package in the Game Explorer provides the following options:

Option Description
Insert Adds a copy of the most recent published version of the package under the current selection (or the workspace if nothing else is selected). Double-clicking the package object has the same effect.
View on Website Opens up your browser to the package's asset page.
Copy ID to Clipboard Copies the asset ID of the package to the clipboard.

Publishing/Syncing Packages

Packaged objects can be edited just like any other object. Those with unpublished changes are marked with an orange dot in the Explorer window.

Change Exceptions

Note the following exceptions regarding package changes:

  • If the object is a Model or GUI object, changes to position or rotation do not count as changing the package. This lets you use several copies of the same object in different positions and orientations.
  • Changes are only detected on the edited package, not on parent or child packages. For instance, if you edit a packaged script inside a packaged model, it will not trigger a state change on the parent model.

Publishing Changes

To publish changes to a package and make them available to other package copies:

  1. In the Explorer window, right-click the changed copy and select Publish Changes to Package.
  2. If prompted to publish the changes, click the Publish button.
  3. Once completed, outdated copies of the package will be marked with a green sync icon indicating that a newer version is available.

Syncing Outdated Copies

Outdated package copies marked with a icon can be updated to the most recent version, or you can continue to use the older version. To update to the latest version:

  1. In the Explorer window, right-click the package copy and select Get Latest Package.
  2. If prompted, click the Get Latest button. This will update the package copy to the most recent version.
Syncing Multiple Copies

To sync multiple outdated copies at once, select all of them in the Explorer window, right-click, and choose Get Latest For Selected Packages from the context menu.


Comparing Script Changes

When a converted package object contains scripts — or the script itself is a package — you can compare differences line-by-line against the most recently published version. This can help you decide whether to update as well as explore what else in the game may need edits to make the update compatible.

To compare script changes:

  1. In the Explorer window, right-click an outdated package copy (look for the sync icon). Remember that the package must either be a script or contain packaged scripts!
  2. Select View Script Changes….
  3. In the Diff Result tab that opens, you can compare all of the changes between the current package copy and the latest published version, similar to source control applications.
Tags:
  • package
  • packages
  • asset