Documentation

Unity Engine

Download Unity

Unity Engine

Package name guidelines

Review the guidelines and restrictions for package display names and technical names.
Read time 3 minutesLast updated 3 days ago

Make sure your package name meets the required guidelines and restrictions.
There are two names for a package:
  • The display name is the user-facing name that appears in the Unity Editor. This name appears in multiple places, including the list panel and details panel of the Package Manager window and within the
    Packages
    folder of the Project window.
  • The technical name (sometimes referred to as the official name) is an identifier that you register the package with. The technical name maps to the name property of the package manifest. The base folder for your package in your computer's file system also uses the technical name.
When you create your package with the Package Manager window, the Package Manager sets the technical name based on the display name you provide. Both of these names display in the details panel of the Package Manager window. These names also appear in the
Inspector

?

window when you view the package manifest. If you want to edit these names, follow the guidelines and restrictions.

About the technical name

By default, the technical name is a three-part name in reverse domain format. When you create a package using the add menu (+ > Create package), Package Manager assembles the technical name by concatenating the following items:
  1. com.
  2. One of the following options, in order:
    • A modified version of the organization name linked to your project, followed by a period. You can check the organization name in
      Project Settings

      ?

      > Services.
    • The first organization listed in Unity Cloud's My organizations, followed by a period.
    • The Username of the Unity ID you signed in with, followed by a period.
    • If Package Manager can't determine these values, it sets the second part as
      undefined.
      .
  3. A modified version of the display name you provided when creating the package.
The full string prevents name conflicts between packages from separate organizations.
You can edit the technical name generated by the package creation operation. The technical name typically consists of the following three or four elements:
  • The top-level domain for your company or organization, such as
    com
    or
    net
    .
  • Your organization name.
  • An optional product name. If your package is one of multiple packages you want to group into a single product namespace, you can include an optional, third identifier as the product name. For example,
    com.example.product
    .
  • Your package name, usually a modified version of the display name, without spaces or punctuation.
If the technical name conflicts with the technical name of an existing package, Package Manager appends a digit at the end.

Examples of technical names

Recommended formats:
  • com.organization.input
  • com.organization.2d.physics
  • com.organization.2d.tools
Other valid formats:
  • individual.name.product
  • ca.my-company.my-product
  • product.package-name

Guidelines and restrictions for the technical name

After you create your package, you can edit its technical name by editing the package manifest.
If you edit the technical name, it must conform to the following guidelines and restrictions:
  • The recommended best practice is to use a 3-part or 4-part reverse domain name notation, which follows the format <top-level-domain>.<organization-name>.<package-name>
  • Don't use
    com.unity
    at the beginning of your package's technical name.
  • Don't use
    unity
    anywhere in your package name.
  • The technical name can contain only lowercase letters, digits, hyphens(-), underscores (_), and periods (.)
  • The recommended limit for the technical name is 50 characters. Package Manager imposes a strict limit of 214 characters.
Note
These naming restrictions apply only to the package names themselves and don't need to match the namespace in your code. For example, you can use
Project3dBase
as a namespace in a package called
net.example.3d.base
.

Next steps

Now that your package has valid names, you can proceed with other activities in the package development workflow. Typical activities at this stage of package development include:

Additional resources