Skip to content

Latest commit

 

History

History
106 lines (83 loc) · 3.37 KB

README.md

File metadata and controls

106 lines (83 loc) · 3.37 KB
Raw

Overview

Image of Helmets Demo World

Helmets is an MRE app that allows Altspace users to "wear" objects. It began as a way to play dress-up by wearing space helmets but it's been used for wings, hula hoops, and even legs with roller skates. Having a birthday party? Put together a quick set of party hats for your guests.

There's a demo Altspace world here: https://account.altvr.com/worlds/1046572460192825569/spaces/1183034043432698356

Usage

Built-in Content

You can configure the app to load different sets of data to load by specifying the "kit" parameter. For example:

wss://mres.altvr.com/helmets?kit=city_helmets

Here are the built-in sets of helmets:

  • "city_helmets"
  • "space_helmets"
  • "galaxy_flyin_3"
  • "star_wars_scout_helmet"
  • "samurai_helmets"
  • "town_helmets"
  • "viking_helmets"

If you don't pass a "kit" parameter, it will load all of the built-in ones together.

Controls

These are the controls that appear at the end of the list. Users attach an object to themselves by clicking on the preview object. The preview object has an invisible cube.

  • (click on an item) - attach
  • X Button - unattach
  • +/- Buttons - scale up/down
  • Up/Down Arrows - move up/down
  • Forward/Back Arrows - move forward/back

Content Packs

Alternatively, you can use the Content Pack feature by creating one on altvr.com and passing a "content_pack" parameter:

wss://mres.altvr.com/helmets?content_pack=1187493048011980938

This allows you to customize your own set of helmets from one or more Altspace World-Building Kits. The JSON field should contain a top-level key for each helmet with a "resourceId", usually an Artifact ID. That is the only required field. You can find these by browsing through your Kit's artifacts. Example:mµ

{
    "businessman": {
        "resourceId": "artifact:1167890491962818802"
    },
    "businesswoman": {
        "resourceId": "artifact:1167890476561334511"
    },
    "femalecoat": {
        "resourceId": "artifact:1167890502222086388"
    }
}

See more examples in the public/data folder.

Options

You can optionally set options like "scale" and "position" and "attachPoint" (where the object attaches to your avatar skeleton).

{
    "spacehelmetship": {
        "resourceId": "artifact:1166530075533771277",
        "scale": {
            "x": 7.5,
            "y": 7.5,
            "z": 7.5
        },
        "position": {
            "x": 0,
            "y": -0.48,
            "z": 0
        },
        "attachPoint": "spine-middle"
    }
}

Sometimes you need to adjust the scale or position of a helmet if it's a weird shape. You can find a full list of attach points here: https://microsoft.github.io/mixed-reality-extension-sdk/index.html#attachpoint

You can also adjust the spacing between each preview object. The default is 1.5 meters:

{
    "spacehelmetship": {
        "resourceId": "artifact:1166530075533771277"
    },
    "options": {
        "previewMargin": 10
    }
}

The order doesn't matter for where you put the "options" entry.

Development

  • Fork this repo
  • Create a Heroku app and link it to your github repo
  • Enable auto deploys from github
  • In Altspace:
    • Open World Editor > Altspace > Basics > SDK App
    • ws://<your subdomain>.herokuapp.com (port 80)
    • Click Confirm