Migrating to Place names


Place Name Migration

The old location system allowed users to find worlds by domain and location. The Place Name system has dramatically simplified the process, but it also means that some users will need to update their information in order to be found in the new system.

The APIs now look at Place Names instead of domains and locations, so there are a few steps to follow depending on the situation.

Pointing a new Place to an old Domain

This will be the most common scenario for current and former Alpha users. This process lets other users find an existing domain simply by using the Place Name. To assist in this transition, domain names will temporarily remain in the “My Domains” tab on the website.

  1. Find, select, and copy the ID for the existing domain. (locate on
    the “My Domains” tab of the website or from the local domain
    settings page)
  2. On the “My Place Names” page, open the Edit page. (click the pencil
    icon on the row of the chosen Place Name)
  3. On the Edit page, paste the Domain ID in the box labeled “Points
  4. Enter other relevant Place information. (name, path,
    description, image)
  5. Click “Update Place”.

Adding a path will cause users to appear at a specific position and orientation. This may be useful for some worlds, but is not required. For more information on how paths work, see the section labeled “Defining Paths” below.

Pointing a new Place to another Place
If a new Place Name needs to point to an existing Place — meaning a Place that was previously purchased in the new system — follow these steps:

  1. On the “My Place Names” page, open the Edit page. (click the pencil
    icon on the row of the chosen Place)
  2. On the Edit page, enter the existing Place Name in the “Points to”
  3. Enter other relevant Place information. (name, path, description,
  4. Click “Update Place”.

The Place Name is all that’s needed; no Domain ID is necessary in the “Points to” box, as long as the target Place has already been set up. For example, to point to High Fidelity’s existing Place “alpha” (which in turn points to one of our domains), simply enter the name “alpha” in the “Points to” box.

Please note that when pointing a new Place to an old one, any path information for the new Place will override the path specified in the old Place. For instance, if a new Place points to “alpha” and defines a new path, avatars will follow the new path rather than the path defined for “alpha”. Likewise, if the path for a new Place is left blank, it will inherit the path of the Place it points to.

Listing a new Place in the Directory
The new system still has a Directory of open worlds, and requirements for a Place to be listed in the Directory are very similar to the old system. To be listed, a Place must:

  1. Have an image.
  2. Be inside a domain that is open and not restricted.
  3. Be Online with a valid Access Token in your Stack Manager. (Here is how you create an Access Token https://alphas.highfidelity.io/t/creating-an-access-token/1282)

To select an image for a Place, go to the Edit page (see instructions in previous sections) and upload an image.

Bookmarking a location within a Place

In the old system, the location names were often used as a sort of bookmarking feature. Now there is a dedicated bookmarks feature in the client. Users can store the address of their current location and give it a name. These names aren’t synced with the main database and remain local to the specific client where they were created.

This feature is available under the File menu in the Interface client.

The “My Locations” page is no longer supported, although it will remain temporarily to let users migrate old locations to globally named Places in the new system. It’s no longer possible to add new locations on this page or edit existing ones, but it is possible to copy the path and name the location for migration. The location image can also be used for the Place image.

Defining Paths

The path dictates where a user will appear and which direction they face. The path is defined in this format: /x,y,z

Example: /23,42,125

The x, y, and z values are the coordinates of the user’s position. This can be approximated manually, or it can also be done by placing an avatar in the desired location and copying the path. Go to the File menu in the Interface client and click “Copy Path to Clipboard”. Then paste this information in the Edit page of the appropriate Place.

Users can also enter with a specific orientation by adding additional information to the path. Here is an example of a path containing both position and orientation values: /6270,211,6000/0,-0.707107,0,0.707107

The orientation is a quaternion, so it can be quite difficult to enter manually. Use the Copy Path feature described above to define a position and orientation together.