# Installation

### Step 1 — Install the Plugin

Head to the link below and download the plugin:

{% embed url="<https://create.roblox.com/store>" %}

Once installed, the Auxvyn plugin will appear in your **Plugins** toolbar inside Roblox Studio.

***

### Step 2 — Open the Plugin

Click the **Auxvyn** button in your Plugins toolbar. A panel will open on the right side of Studio showing the Auxvyn welcome screen.

Press **Get Started** to begin setup.

***

### Step 3 — Enter Your API Key

The plugin will ask for your Auxvyn API key.

To get your API key:

1. Go to [auxvyn.com](https://auxvyn.com/dashboard) and log in
2. Open the workspace you want to connect to your game
3. Click the **API Keys** tab
4. Generate a new key and copy it

Paste your API key into the plugin and press **Continue**.

{% hint style="warning" %}
**Never share your API key.** It gives full read and write access to your player data. Keep it server-side only, the plugin handles this for you automatically
{% endhint %}

***

### Step 4 — Import Existing Data

If your game already has player data stored, you can import it into Auxvyn at this step.

**Options:**

* **Import my current player data** — migrates your existing DataStore data into Auxvyn automatically
* **Start fresh** — skips import, Auxvyn starts with a clean slate

Select whichever applies to your game and press **Continue**.

{% hint style="info" %}
If you're setting up a brand new game with no existing data, choose **Start fresh**.
{% endhint %}

***

### Step 5 — Review & Install

Read through the Auxvyn Terms of Service and Privacy Policy, then check the box to confirm you agree.

Press **Install** and the plugin will automatically:

* Insert the Auxvyn module into **ServerScriptService**
* Create a pre-configured server Script wired to your API key
* Verify the connection to your workspace

You'll see a confirmation screen once everything is set up.

{% hint style="warning" %}
Make sure HTTP requests are enabled!
{% endhint %}

***

### You're Done

Your game is now connected to Auxvyn. Head back to your dashboard to see your workspace and start managing player data.

***

### Updating or Reinstalling

If a new version of the Auxvyn module is available, or you need to reinstall after something goes wrong:

1. Open the Auxvyn plugin from your Plugins toolbar
2. Your existing configuration is remembered — you won't need to re-enter your API key
3. Click **Update Module** or **Reinstall** depending on what you need
4. The plugin replaces the old module with the latest version without touching your other scripts

{% hint style="info" %}
Updating the module never overwrites your data or changes your API key without your consent.
{% endhint %}

***

### Troubleshooting

**The plugin isn't showing in my toolbar** Make sure you installed it from the Creator Store while logged into the same Roblox account you use for Studio. Try restarting Studio.

**My API key isn't being accepted** Double check you copied the full key from the API Keys tab in your workspace. Make sure the key hasn't been revoked.

**HTTP Requests failed to enable** Go to **Home → Game Settings → Security** and manually turn on **Allow HTTP Requests**, then reopen the plugin and press Reinstall.

**I need to connect a different workspace** Open the plugin and look for **Settings** or **Reconnect** — you can swap your API key at any time to point the game at a different workspace.

***

### What's Next


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://auxvyn.gitbook.io/auxvyn-docs/get-started/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.