# Quick Start Guide

### Before You Begin

Make sure you have:

* A free Auxvyn account at [auxvyn.com](https://auxvyn.com)
* Roblox Studio installed
* The Auxvyn plugin installed from the Creator Store

If you haven't installed the plugin yet, see the Installation page first.

***

### 1. Create a Workspace

A workspace is a container for one game's data. Each game you want to connect to Auxvyn needs its own workspace.

* Log in to your Auxvyn dashboard
* Click **New Workspace**

<figure><img src="/files/RJ2Icj582niwqAFAYzLf" alt=""><figcaption></figcaption></figure>

* Give it a name (usually your game's name)
* Enter your **Roblox Universe ID**

<figure><img src="/files/SbRZmvc3yrOxW5WsHfPj" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
To find your Universe ID, go to your game's page on Roblox, click the three dots → **Copy Universe ID**. It's also visible in the URL of your Creator Dashboard game page.
{% endhint %}

Once created, you'll land inside your new workspace.

<figure><img src="/files/cWV0bGSlI1obigAUyat8" alt=""><figcaption></figcaption></figure>

***

### 2. Generate an API Key

Your API key is how your Roblox game authenticates with Auxvyn.

* Inside your workspace, click the **API Keys** tab
* Click **Generate new key**
* Give it a label like `Production`&#x20;

<figure><img src="/files/5ajlvMEbPqmoncc4qxVW" alt=""><figcaption></figcaption></figure>

* Copy the key (**you won't be able to see it again after closing this dialog)**

<figure><img src="/files/nRwjs1dQPVhCywnye8Xg" alt=""><figcaption></figcaption></figure>

Keep this key safe. You'll need it in the next step.

***

### 3. Connect Your Game

Open Roblox Studio with your game, then open the Auxvyn plugin from your Plugins toolbar. Paste your API key when prompted and click **Install**.

The plugin will automatically:

* Add the Auxvyn module to **ServerScriptService**
* Create a pre-configured server Script

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

Once done, you should see a confirmation screen in the plugin.

***

### 4. Verify the Connection

Press **Play** in Studio to start a playtest. In the Output window you should see:

{% hint style="success" %}
\[Auxvyn] Connected. Workspace: Your Workspace Name Plan: free
{% endhint %}

If you see this, your game is successfully connected to Auxvyn.

{% hint style="danger" %}
If you see a warning instead, make sure **Allow HTTP Requests** is enabled under **File → Game Settings → Security**.
{% endhint %}

***

### 5. Save and Load Player Data

Open the server Script the plugin created. You'll see it's already set up with `Auxvyn.init()`. Now you can start reading and writing player data.

**Save a value:**

```lua
Auxvyn.set(player.UserId, "coins", 500)
```

**Load a value:**

```lua
local coins = Auxvyn.get(player.UserId, "coins")
print(coins) -- 500
```

**Increment a value:**

```lua
local newCoins = Auxvyn.increment(player.UserId, "coins", 10)
print(newCoins) -- 510
```

**Delete a value:**

```lua
Auxvyn.delete(player.UserId, "coins")
```

***

### 6. View Your Data in the Dashboard

Go back to your Auxvyn dashboard and click the **Database** tab inside your workspace. You'll see every player record your game has written, with the ability to view, edit, and delete values directly from the browser.

***

### 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/quick-start-guide.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.
