# Quickstart

{% hint style="warning" %}
The current version of the OBR Compendium Browser is a beta release. The published schema formats are not necessarily stable and may change without warning. Similarly abrupt changes should be expected to the app's functionality.

Some bugs are to be expected while the app is being stress tested by actual users.
{% endhint %}

### What is the OBR Compendium Browser?

The Compendium Browser is a free extension for [Owlbear Rodeo](https://www.owlbear.rodeo/) designed to provide a handy reference tool for GMs running their games on the platform. You can import packs of documents into the application, with each document representing a monster, a weapon, a spell, and so on. These collections of documents are categorised within the browser and can be searched. The application supports fuzzy searching, so little typos won't slow you down.

Currently, there are no pre-configured packs available, but you can create your own packs very easily. Instructions are available [here](../content/custom-content).

### Installing the Compendium Browser

To install this extension, go to your profile and click manage extensions. In the top right corner, you'll see a little plus icon, and hovering over it will reveal a tooltip saying, "Add custom extension".

<figure><img src="https://2330156829-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmktYKxpn7ZDW0VvGDGQr%2Fuploads%2FsqGgTedeLgYjUVEmJuZo%2Fimage.png?alt=media&#x26;token=583f33c3-0e92-4a98-98ac-d77938a9c6ae" alt=""><figcaption></figcaption></figure>

Clicking this button will reveal a small dialog window where you can enter an install link.

<figure><img src="https://2330156829-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmktYKxpn7ZDW0VvGDGQr%2Fuploads%2FAAZ0ZMD9sbBeDcPXNAjS%2Fimage.png?alt=media&#x26;token=53f39481-32ff-42c1-8dbe-fbddd5b29d0e" alt="" width="321"><figcaption></figcaption></figure>

Copy the following URL into the field and wait for Owlbear Rodeo to fetch the extension information.

```url
https://obr-compendium-browser.phillip.best/manifest.json
```

A little card should appear saying "Compendium Browser" alongside an extension version. If you instead get some kind of error notification, doublecheck that you copied the URL correctly. Once the card appears, you should be able to press the "Add" button to install the extension.

Once the extension has been installed, make sure to activate it for any worlds you want to use it for.

Owlbear Rodeo has [their own guide for installing extensions](https://extensions.owlbear.rodeo/guide) if you need additional help.

### The Compendium Browser interface

When you load the extension for the first time, you'll be presented with an interface like this:

<figure><img src="https://2330156829-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmktYKxpn7ZDW0VvGDGQr%2Fuploads%2FBDysltWO0NxUXjFZ3NAE%2Fimage.png?alt=media&#x26;token=feca85f8-fd08-4012-89ee-e77e80a68ea7" alt="" width="375"><figcaption><p>The default Compendium Browser interface with no content loaded.</p></figcaption></figure>

As we don't have any content to display, the browser isn't a lot of use. To add content, click the plus icon, which will open the pack installation interface.

#### Installing packs

The pack installation interface looks like this:

<figure><img src="https://2330156829-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmktYKxpn7ZDW0VvGDGQr%2Fuploads%2FsJroAvPhlO4lm0UuIXWK%2Fimage.png?alt=media&#x26;token=3ddc69a2-8439-4331-bbd4-4bb435e68faa" alt="" width="375"><figcaption><p>The compendium upload interface.</p></figcaption></figure>

The plus icon should turn purple to indicate that the tab is active.

To install a pack, simply drag and drop one or more compendium files into the drop area or click on the box to open your file browser. You can drop any files you like into this interface, and invalid files will be discarded with appropriate warnings.

<figure><img src="https://2330156829-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmktYKxpn7ZDW0VvGDGQr%2Fuploads%2F8fDJDyOD0yS9jnnCsoVh%2Fimage.png?alt=media&#x26;token=00a5e45b-5be8-43a2-875d-a39509cbe410" alt="" width="375"><figcaption><p>Examples of both correct and incorrect documents.</p></figcaption></figure>

Sometimes a pack will be generally valid, but will have invalid documents inside. It's possible to install packs like this, but invalid documents will be ignored.

<figure><img src="https://2330156829-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmktYKxpn7ZDW0VvGDGQr%2Fuploads%2F8CzfeTHdQEBbTeZBJv13%2Fimage.png?alt=media&#x26;token=630f8bd5-22f6-4850-b39c-04acaec65ec2" alt="" width="375"><figcaption><p>Example of a pack that contains some invalid data.</p></figcaption></figure>

Once you've uploaded the packs you wish to install, click the "Install Packs" button to process and install the valid files.

{% hint style="info" %}
You may be wondering where your pack data is stored. Due to limitations with Owlbear Rodeo and my own unwillingness to host user data at the moment, your data is located in browser local storage. A consequence of this is that your data will be unavailable to you should you switch to a new browser, and you'll have to install your packs again. Thankfully, this is a very quick and painless process.
{% endhint %}

#### Managing your installed packs

Once you've installed some packs, you can navigate to the compendium management tab, indicated by a little book icon.

<figure><img src="https://2330156829-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmktYKxpn7ZDW0VvGDGQr%2Fuploads%2F8TPN7aFGpZlcNArTirNw%2Fimage.png?alt=media&#x26;token=9303c771-afca-4dc0-b856-cbe8dda0d702" alt="" width="375"><figcaption></figcaption></figure>

Here, you'll find a list of all of the packs you have installed, their version numbers (if available), how many documents each contains, and whether those packs are currently active. Packs are activated on a per-room basis, so you can have different packs active for different games.

Documents contained in inactive packs are not displayed in the browser, so toggling different packs on and off can be very helpful in cutting down on clutter, especially if you run games for several rulesets.
