Skip to content

Uploading Areas

Only for Administrators

The following guide is only applicable if you are an admin of the space that you are currently in. You are the admin of the space that you have created.

Introduction

When you click the    Places icon in the bottom menu bar, you will have the option to "Upload Areas". This button displays a popup where you can upload a JSON file detailing the places and spaces you would like to add.

What is the difference between a 'Place' and a 'Space'?

Place refers to a position in the current space that you are in, so you can move from one 'place' to another by changing your position.

Space refers to redirecting the user to another space. For example: if you are in the space @alpha-base, adding a space called "Showoff" with alias @nifty will redirect the user from @alpha-base to @nifty.

There are two area types, places and spaces. At least one of them needs to be present in the JSON file that you upload.

places

To specify places that you want to add, include the field "places" as a key in the JSON file, with the value being an object[] with the following fields:

Field Type Required Default Description
name string - Title for the place
description string '' Description of the place
active boolean false true to indicate that the place is currently active, false otherwise
startX number 0 The x co-ordinate of the starting position
startY number 0 The y co-ordinate of the starting position
radius number 0 Radius to spread people around the starting position

spaces

To specify spaces that you want to add, include the field "spaces" as a key in the JSON file, with the value being an object[] with the following fields:

Field Type Required Default Description
name string - Title for the space
alias string - The @ address for the space you want to redirect to
description string '' Description of the space
startX number 0 The x co-ordinate of the starting position
startY number 0 The y co-ordinate of the starting position
startZ number 0 The z co-ordinate of the starting position
radius number 0 Radius to spread people around the starting position

Example

An example JSON file is the following:

{
  "places": [
    {
      "name": "Beanbag",
      "description": "A place to sit and relax after a long day",
      "active": true,
      "startX": 3.1415,
      "startY": -2.718,
      "radius": 1
    }
  ],
  "spaces": [
    {
      "name": "Showoff",
      "alias": "nifty",
      "description": "In a galaxy far far away",
      "startX": -2.9979,
      "startY": 3.43,
      "startZ": 1,
      "radius": 2
    }
  ]
}

Once uploaded, the areas in the "Places" menu will appear as follows:

Uploaded Areas in UI

Back to top