@plutovr/multi-app-manager/README.md

Pluto Multi App Manager

# Pluto Multi App Manager
> A collection of events and event handlers that allow your WebXR app to communicate with Pluto Multi App Launcher and Pluto Communications Service when running as an XRPK

## Installation

```sh
npm i pluto-mae 
```

## Running a local version of Multi App Manager 
While there are other ways of running a local version of an NPM module, such as using [NPM link](https://docs.npmjs.com/cli/v7/commands/npm-link), this is the flow that is guarenteed to work.

### Creating a local build of Multi App Manager
1. Make changes to Multi App Manager, then run `npm run archive`
    > This will build the project and create a TGZ archive file, which is what you will use to include Multi App Manager in your local project
2. Copy the path to the TGZ file that was just created (right-click on the file and select "Copy Path")

### Installing the local version of Multi App Manager in your project
1. In your own project, install the local version by running `npm i "<path-to-archive-file>"`
    > For example:
    ```sh
    npm i "C:\Users\<user>\pluto-multi-app-manager\plutovr-multi-app-manager-0.8.2.tgz"
    ```
    > If you already have a remote version of [@plutovr/multi-app-manager](https://www.npmjs.com/package/@plutovr/multi-app-manager) installed, this will replace it with the local version.

Anytime you make changes to Multi App Manager, you will have to go through these steps again (archiving and then installing). 

If you have the local version installed already, it's sufficient to run `npm update @plutovr/multi-app-manager` after archiving, as this will update to the newer archive file.

## Publishing new package and release versions
1. Checkout `main` (which should already have merged any changes for the new version)
2. Use `npm version version-number-or-semantic-level` to add a new commit and tag with the new version (e.g. `npm version v0.10.0` or `npm version patch`)
3. `npm run archive`
4. `npm publish`
5. `git push --tags`
6. Go to https://github.com/PlutoVR/pluto-multi-app-manager/tags
7. Click the tag that you just pushed
8. Click the "Create release from tag" button in the upper right
9. In the description, add relevant notes and an npm link to the just-published version (can find this at https://www.npmjs.com/package/@plutovr/multi-app-manager under the versions tab)
10. Click the "Publish release" button