> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sentrystudios.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Licensing & Verification

> How to retrieve your license key via Discord account linking or email support, activate plugins via license.yml, and troubleshoot activation.

Sentry Studios plugins validate your license key with BuiltByBit when your server boots. The check runs in the background with a 3-second timeout, so your server starts up without any delays or freezing.

***

## How Licensing Works

The license check runs completely in the background without affecting your server:

**1. BuiltByBit Account Linking**

Purchases on BuiltByBit automatically sync with your account, giving you instant access to your license keys.

**2. Fast Background Check (3s Timeout)**

On server boot, the plugin checks your license key in the background. A strict 3-second timeout ensures server startup is never delayed.

**3. Hardware ID Lock**

A secure hardware ID lock binds the license to your server machine to protect your key against unauthorized sharing.

**4. Network Support**

Your license covers all servers across your BungeeCord or Velocity network (such as Hub, Survival, and Factions).

***

## Retrieving Your License Key

Depending on whether you purchased a standalone plugin or a SentryPremades addon, license retrieval follows these straightforward methods:

### SentryPremades Addons (Automatic Activation)

If you purchased an addon or menu configuration from the **SentryPremades** catalog:

* **Automatic Entitlement:** Your license is applied automatically upon completing your purchase.
* **Fail-Safe Fallback:** If your addon license does not apply automatically for any reason, simply follow the BuiltByBit retrieval steps below (Discord account linking or Email verification) to claim your key.

***

### BuiltByBit Plugins (SentryWipe, SentrySettings, SentryLore)

For software purchases on BuiltByBit, licenses are retrieved by linking your account in our official Discord or contacting our support team:

**Discord Linking (Instant)**

The fastest way to retrieve your license key at any time is by linking your BuiltByBit account in the official Sentry Studios Discord server:

**1. Join the Sentry Studios Discord**

Join our official community server: [discord.gg/sentrystudios](https://discord.gg/sentrystudios).

**2. Link Your BuiltByBit Account**

Head to the `#link-account` or `#claim-license` channel and run the `/link` command (or follow the prompt from our verification bot). Authorize your BuiltByBit profile to sync your purchases.

**3. Receive Your License Key**

Once linked, the bot automatically verifies your transaction, grants your **Customer** role, and delivers your unique license key(s) directly via private message (DM).

**Email Support**

If you do not have Discord or prefer direct communication, our staff can generate and dispatch your license key manually:

* **Support Email:** `support@sentrystudios.org`
* **Subject Line:** `BuiltByBit License Request - [Your Username]`
* **Required Purchase Information:**
  * Your **BuiltByBit Username / Profile Link**
  * **Product Name(s)** purchased (e.g., *SentryWipe*, *SentrySettings*, *SentryLore*)
  * **Transaction / Invoice ID** from your BuiltByBit order receipt
  * The **Email Address** associated with your BuiltByBit account

> [!NOTE]
>
> Email requests are typically processed within 12–24 business hours. For instant 24/7 key generation, use Discord account linking.

***

## Configuring `license.yml`

Upon first startup, each Sentry plugin generates a lightweight `license.yml` in its data folder:

**plugins**

**SentryWipe**

**config.yml**

**license.yml**

**SentrySettings**

**config.yml**

**license.yml**

**SentryLore**

**config.yml**

**license.yml**

Open `license.yml` and paste your key into the `license-key` field:

```yaml license.yml theme={null}
# Sentry Studios - License Verification
license-key: "YOUR_BUILTBYBIT_LICENSE_KEY_HERE"
```

> [!TIP]
>
> Keep your license key confidential. Never commit `license.yml` to public GitHub repositories or share it on public forums.

***

## Server Startup Lifecycle

When your server boots, the plugin reads `license.yml` and verifies your key against our licensing API:

```ansi Server Console theme={null}
[90m[12:04:18 INFO]:[0m [33mVerifying license[0m key (timeout 3s)...
[90m[12:04:19 INFO]:[0m [32mLicense verified![0m Thank you for supporting Sentry Studios.
[90m[12:04:19 INFO]:[0m [33mDependencies checked:[0m [32mVault[0m, [32mLuckPerms[0m, [32mProtocolLib[0m, [32mPlaceholderAPI[0m
[90m[12:04:19 INFO]:[0m [36m[SentryWipe][0m Enabled [32mv1.0.0[0m [90m(HWID: e3b0c44298fc1c14)[0m [34m[Hooks: Vault, PlaceholderAPI][0m
[90m[12:04:19 INFO]:[0m [36m[SentrySettings][0m Enabled [32mv1.0.0[0m [90m(HWID: e3b0c44298fc1c14)[0m [34m[Hooks: ProtocolLib, PlaceholderAPI][0m
[90m[12:04:19 INFO]:[0m [36m[SentryLore][0m Enabled [32mv1.0.0[0m [90m(HWID: e3b0c44298fc1c14)[0m [34m[Hooks: PlaceholderAPI][0m
```

Once successfully validated, `license.yml` automatically updates with an internal `status: ACTIVE` flag.

***

## In-Game Status Verification

Administrators can verify license status, active software versions, and hardware locks in-game using dedicated subcommands:

| Subcommand | Target Plugin | Required Permission | In-Game Verification Output |
| :- | :- | :- | :- |
| `/settings docs` | **SentrySettings** | `settings.admin` | Interactive chat component with clickable docs link and license health badge. |
| `/wipe docs` | **SentryWipe** | `sentrywipe.admin` | Validates active license state and confirms undo token buffer availability. |
| `/lore docs` | **SentryLore** | `sentrylore.admin` | Validates database connectivity, active hardware identifier (HWID), and license status. |
| `/premades reload` | **SentryPremades** | Server Operator | Validates configured addon licenses and reloads active modules. |

***

## Troubleshooting & Common Pitfalls

> **License validation failed: Please set a valid license key in license.yml**
>
> The plugin detected that `license-key` is still set to `"none"`, `"ENTER-KEY-HERE"`, or an empty string. Open `plugins/<PluginName>/license.yml`, paste your real key, save the file, and restart your server.

> **License validation timed out after 3s**
>
> The server's outbound HTTP request exceeded the 3-second fail-safe timeout. This usually happens if your hosting provider enforces strict firewall egress rules or container isolation. Ensure your server can establish outbound connections to HTTPS (`port 443`).

> **Can I use the same license across multiple servers on my network?**
>
> Yes. A single license covers your server network across BungeeCord or Velocity proxy nodes (such as Hub, Survival, and Factions). For multi-owner networks or commercial hosting distribution, separate licenses must be purchased.

> **Need to reset or transfer your HWID binding?**
>
> If you migrated to a new dedicated server or host machine and receive an HWID mismatch error, open a ticket in our [Discord Support Portal](https://discord.gg/sentrystudios) to have your license hardware lock reset instantly.

***

## Next Steps

> **[Core Infrastructure](https://docs.sentrystudios.org/core-concepts/core-infrastructure.md)**
>
> Explore Folia threading, off-thread execution, and H2/MySQL database architecture.

> **[Configuration & Formatting](https://docs.sentrystudios.org/core-concepts/configuration-and-formatting.md)**
>
> Master our Hex colors, toast notifications, and Small Caps Unicode typography.

> **[Bukkit Materials Reference](https://docs.sentrystudios.org/core-concepts/materials.md)**
>
> Complete catalog of modern Minecraft 1.21.x and Paper 26.3 Material enum constants.

> **[Quick Start Guide](https://docs.sentrystudios.org/overview/quickstart.md)**
>
> Complete fast-deployment walkthrough from jar placement to live verification.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.