Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion developer-api/errors.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Error Handling
title: Error handling
description: Standard error format and common status codes.
---

Expand Down
2 changes: 1 addition & 1 deletion developer-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ curl https://developer.sirius.menu/v1/projects \

## Rate limits

100 requests per minute per API token. See [Rate Limits](/developer-api/rate-limits) for details.
100 requests per minute per API token. See [Rate limits](/developer-api/rate-limits) for details.
4 changes: 2 additions & 2 deletions developer-api/keys.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Key Management
title: Key management
description: List, revoke, and bulk-revoke keys.
---

Expand All @@ -17,7 +17,7 @@

### Query parameters

| Param | Default | Max | Description |

Check warning on line 20 in developer-api/keys.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

developer-api/keys.mdx#L20

Did you really mean 'Param'?
|-------|---------|-----|-------------|
| `limit` | 50 | 100 | Keys per page |
| `offset` | 0 | — | Pagination offset |
Expand Down Expand Up @@ -71,7 +71,7 @@
POST /v1/projects/:id/keys/revoke-bulk
```

Revoke every key with a matching watermark. Use this when a leaked script dump contains a watermark — extract the 16-character hex string from the `WM_` prefix and pass it here.
Revoke every key with a matching watermark. Use this when a leaked script dump contains a watermark. Extract the 16-character hex string from the `WM_` prefix and pass it here.

```bash
curl -X POST https://developer.sirius.menu/v1/projects/a1b2.../keys/revoke-bulk \
Expand Down
2 changes: 1 addition & 1 deletion developer-api/rate-limits.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Rate Limits
title: Rate limits
description: API rate limiting and how to handle 429 responses.
---

Expand Down
4 changes: 2 additions & 2 deletions developer-api/versions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Script Versions
title: Script versions
description: List versions and rollback to a previous release.
---

Expand Down Expand Up @@ -38,7 +38,7 @@
"notes": ""
}
],
"current_version_id": "v3f4a5b6-..."

Check warning on line 41 in developer-api/versions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

developer-api/versions.mdx#L41

Did you really mean 'current_version_id'?
}
```

Expand All @@ -61,4 +61,4 @@
{ "ok": true, "current_version_id": "v2e3d4c5-..." }
```

Use this for CI/CD integrations — if your monitoring detects an error spike after a deploy, automatically roll back to the previous version via the API.
You can use this for CI/CD integrations. If your monitoring detects an error spike after a deploy, roll back to the previous version automatically via the API.
4 changes: 2 additions & 2 deletions developer-api/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Developer Platform API requires a **Business plan**. [Upgrade in your dashbo
GET /v1/projects/:id/webhooks
```

Returns all webhook configurations for a project. Webhooks are managed via the dashboard — this endpoint is read-only.
Returns all webhook configurations for a project. You manage webhooks through the dashboard — this endpoint is read-only.

```bash
curl https://developer.sirius.menu/v1/projects/a1b2.../webhooks \
Expand Down Expand Up @@ -47,7 +47,7 @@ curl https://developer.sirius.menu/v1/projects/a1b2.../webhooks \

## Webhook payload

Webhooks are delivered as Discord embeds. The payload sent to your Discord webhook URL:
Webhooks deliver as Discord embeds. The payload sent to your Discord webhook URL:

```json
{
Expand Down
8 changes: 4 additions & 4 deletions rayfield/anti-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Anti-Detection
title: Anti-detection
description: How to use a custom asset ID to reduce Rayfield's detectability by game anti-cheats.

Check warning on line 3 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L3

Did you really mean 'Rayfield's'?
---

## How Rayfield gets detected

Check warning on line 6 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L6

Did you really mean 'Rayfield'?

Rayfield loads its UI through `game:GetObjects` with a known asset ID. Most anti-cheats hook this function and check the ID against a blocklist — and since Rayfield's default ID (`10804731440`) is public, it's an easy flag.
Rayfield loads its UI through `game:GetObjects` with a known asset ID. Most anti-cheats hook this function and check the ID against a blocklist. Since Rayfield's default ID (`10804731440`) is public, it's an easy flag.

Check warning on line 8 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L8

Did you really mean 'Rayfield'?

Check warning on line 8 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L8

Did you really mean 'Rayfield's'?

The fix is simple: re-upload the UI model to your own account and point Rayfield at your copy. Now every script has its own unique asset ID that anti-cheats don't have on file.
The fix is simple: re-upload the UI model to your own account and point Rayfield at your copy. Your script gets its own unique asset ID that anti-cheats don't have on file.

Check warning on line 10 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L10

Did you really mean 'Rayfield'?

<Note>
This only removes the lowest-hanging detection vector. For full protection, enable [Secure Mode](/rayfield/secure-mode) which blocks all detectable Roblox assets at runtime.
This only removes the lowest-hanging detection vector. For full protection, enable [Secure mode](/rayfield/secure-mode) which blocks all detectable Roblox assets at runtime.

Check warning on line 13 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L13

Did you really mean 'Roblox'?
</Note>

---
Expand All @@ -18,8 +18,8 @@
## Re-upload the UI model

<Steps>
<Step title="Get the Rayfield model in Studio">

Check warning on line 21 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L21

Did you really mean 'Rayfield'?
Open Roblox Studio and grab the model however you prefer:

Check warning on line 22 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L22

Did you really mean 'Roblox'?

- Get it from the [Creator Store](https://create.roblox.com/store/asset/10804731440) and insert it
- Search **Rayfield** in the Toolbox
Expand All @@ -33,7 +33,7 @@
Right-click the model in Explorer → **Save to Roblox** → upload as a new model.
</Step>
<Step title="Enable distribution">
Go to the asset's **Configure** page on the Roblox website and turn on **Distribute on Creator Store** — otherwise `GetObjects` won't be able to fetch it.

Check warning on line 36 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L36

Did you really mean 'Roblox'?
</Step>
<Step title="Copy the new asset ID">
Grab the ID from the asset URL or Asset Manager.
Expand All @@ -44,7 +44,7 @@

## Set your custom asset ID

At the top of your script, **before** loading Rayfield:

Check warning on line 47 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L47

Did you really mean 'Rayfield'?

```lua
getgenv().RAYFIELD_ASSET_ID = 123456789 -- your asset ID here
Expand All @@ -61,7 +61,7 @@

local Rayfield = loadstring(game:HttpGet("https://sirius.menu/rayfield"))()

local Window = Rayfield:CreateWindow({

Check warning on line 64 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L64

Did you really mean 'Rayfield'?
Name = "My Script",
-- rest of your config
})
Expand All @@ -71,7 +71,7 @@

## Good to know

- **Don't touch the model structure.** Upload it as-is. If you rename or rearrange things inside the model, Rayfield won't be able to find what it needs.

Check warning on line 74 in rayfield/anti-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/anti-detection.mdx#L74

Did you really mean 'Rayfield'?
- **Re-upload when Rayfield updates.** If we ship a new UI model, your old copy won't match anymore. Just re-upload the new one.
- **Try to keep your asset ID to yourself.** If it ends up on a blocklist you just re-upload a new one — not a big deal, just extra work you can avoid.
- **Key System UI is separate.** It has its own asset ID and only loads when key system is enabled, so it's less of a priority.
2 changes: 1 addition & 1 deletion rayfield/elements/text.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Text elements
description: How to create labels, paragraphs, and dividers in Rayfield.

Check warning on line 3 in rayfield/elements/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/elements/text.mdx#L3

Did you really mean 'Rayfield'?
---

## Label
Expand All @@ -9,20 +9,20 @@
local Label = Tab:CreateLabel("Label Example", 4483362458, Color3.fromRGB(255, 255, 255), false) -- Title, Icon, Color, IgnoreTheme
```

### Lucide icon support

Check warning on line 12 in rayfield/elements/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/elements/text.mdx#L12

Did you really mean 'Lucide'?

You can use a [Lucide icon](https://lucide.dev/icons/) name in place of a Roblox image ID.

Check warning on line 14 in rayfield/elements/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/elements/text.mdx#L14

Did you really mean 'Roblox'?

```lua
local Label = Tab:CreateLabel("Label Example", "rewind")
```

<Note>
Not all Lucide icons are supported. See the [full list of supported icons](https://github.com/latte-soft/lucide-roblox/tree/master/icons/compiled/48px). Credit to [Lucide](https://lucide.dev/) and [Latte Softworks](https://github.com/latte-soft/).

Check warning on line 21 in rayfield/elements/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/elements/text.mdx#L21

Did you really mean 'Lucide'?
</Note>

<Warning>
Lucide icons and Roblox image IDs are detectable by game anti-cheats. If you need your script to be undetectable, use `getcustomasset()` instead. See [Secure Mode](/rayfield/secure-mode) for details.
Lucide icons and Roblox image IDs are detectable by game anti-cheats. If you need your script to be undetectable, use `getcustomasset()` instead. See [Secure mode](/rayfield/secure-mode) for details.

Check warning on line 25 in rayfield/elements/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/elements/text.mdx#L25

Did you really mean 'Lucide'?

Check warning on line 25 in rayfield/elements/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/elements/text.mdx#L25

Did you really mean 'Roblox'?
</Warning>

### Update a label
Expand Down
2 changes: 1 addition & 1 deletion rayfield/notifications.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Notifications
description: How to send notifications to the user in Rayfield.

Check warning on line 3 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L3

Did you really mean 'Rayfield'?
---

## Send a notification
Expand All @@ -14,9 +14,9 @@
})
```

### Lucide icon support

Check warning on line 17 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L17

Did you really mean 'Lucide'?

You can use a [Lucide icon](https://lucide.dev/icons/) name in place of a Roblox image ID.

Check warning on line 19 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L19

Did you really mean 'Roblox'?

```lua
Rayfield:Notify({
Expand All @@ -28,11 +28,11 @@
```

<Note>
Not all Lucide icons are supported. See the [full list of supported icons](https://github.com/latte-soft/lucide-roblox/tree/master/icons/compiled/48px). Credit to [Lucide](https://lucide.dev/) and [Latte Softworks](https://github.com/latte-soft/).

Check warning on line 31 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L31

Did you really mean 'Lucide'?
</Note>

<Warning>
Lucide icons and Roblox image IDs are detectable by game anti-cheats. If you need your script to be undetectable, use `getcustomasset()` instead. See [Secure Mode](/rayfield/secure-mode) for details.
Lucide icons and Roblox image IDs are detectable by game anti-cheats. If you need your script to be undetectable, use `getcustomasset()` instead. See [Secure mode](/rayfield/secure-mode) for details.

Check warning on line 35 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L35

Did you really mean 'Lucide'?

Check warning on line 35 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L35

Did you really mean 'Roblox'?
</Warning>

### Options
Expand All @@ -50,5 +50,5 @@
</ResponseField>

<ResponseField name="Image" type="number | string">
Icon for the notification. Pass a Roblox image ID (number) or a Lucide icon name (string).

Check warning on line 53 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L53

Did you really mean 'Roblox'?

Check warning on line 53 in rayfield/notifications.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/notifications.mdx#L53

Did you really mean 'Lucide'?
</ResponseField>
6 changes: 3 additions & 3 deletions rayfield/secure-mode.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
title: Secure Mode
title: Secure mode
description: Block all detectable Roblox asset references at runtime so your script stays invisible to anti-cheats.

Check warning on line 3 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L3

Did you really mean 'Roblox'?
tag: "1.74+"
---

## Overview

Starting with Build 1.74, Rayfield automatically loads its internal UI images from an external cache — no Roblox asset IDs involved. That alone makes a difference.

Check warning on line 9 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L9

Did you really mean 'Rayfield'?

Check warning on line 9 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L9

Did you really mean 'Roblox'?

Secure mode takes it further. It strips out every remaining reference that anti-cheats could use to identify your script:

- **Icons.** Lucide names and `rbxassetid://` values are removed at runtime.

Check warning on line 13 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L13

Did you really mean 'Lucide'?
- **Key system UI.** The key prompt loads a detectable model, so it's blocked entirely.
- **Default model ID.** You're warned if you haven't set a [custom asset ID](/rayfield/anti-detection).

The result: with secure mode on and a custom asset ID set, nothing traces back to Rayfield.

Check warning on line 17 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L17

Did you really mean 'Rayfield'?

---

## Get started

Set both flags before loading Rayfield:

Check warning on line 23 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L23

Did you really mean 'Rayfield'?

```lua
getgenv().RAYFIELD_SECURE = true
Expand All @@ -29,13 +29,13 @@
local Rayfield = loadstring(game:HttpGet("https://sirius.menu/rayfield"))()
```

If you skip `RAYFIELD_ASSET_ID`, Rayfield still works — but the default model ID remains detectable. See [Anti-Detection](/rayfield/anti-detection) for how to upload your own copy.
If you skip `RAYFIELD_ASSET_ID`, Rayfield still works — but the default model ID remains detectable. See [Anti-detection](/rayfield/anti-detection) for how to upload your own copy.

Check warning on line 32 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L32

Did you really mean 'Rayfield'?

---

## Icons

In secure mode, Lucide icon names and Roblox image IDs are blocked. They resolve to blank.

Check warning on line 38 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L38

Did you really mean 'Lucide'?

Check warning on line 38 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L38

Did you really mean 'Roblox'?

Use `getcustomasset()` instead — write your images to the executor filesystem and pass the path:

Expand All @@ -59,13 +59,13 @@

## Key system

The key system UI requires a Roblox model to render. In secure mode, that model is never loaded.

Check warning on line 62 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L62

Did you really mean 'Roblox'?

- If the user already has a saved key from a previous session, everything works as expected.
- If there's no saved key, the script is blocked. The key prompt can't be shown.

<Warning>
Secure mode doesn't bypass the key system — it makes it stricter. Users without a saved key are blocked entirely. If you use `KeySystem = true`, make sure users enter their key at least once without secure mode first.
Secure mode doesn't bypass the key system — it makes it stricter. Users without a saved key are blocked entirely. If you use `KeySystem = true`, make sure your users enter their key at least once without secure mode first.
</Warning>

---
Expand Down Expand Up @@ -113,7 +113,7 @@
| Flag | Type | Description |
|---|---|---|
| `RAYFIELD_SECURE` | boolean | Enables secure mode |
| `RAYFIELD_ASSET_ID` | number | Custom asset ID for your copy of the Rayfield model |

Check warning on line 116 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L116

Did you really mean 'Rayfield'?

---

Expand All @@ -122,8 +122,8 @@
| Feature | Normal (1.74+) | Secure mode |
|---|---|---|
| Internal UI images | External cache | External cache |
| Lucide icons | Supported | Blocked |

Check warning on line 125 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L125

Did you really mean 'Lucide'?
| Roblox image ID icons | Supported | Blocked |

Check warning on line 126 in rayfield/secure-mode.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/secure-mode.mdx#L126

Did you really mean 'Roblox'?
| `getcustomasset()` icons | Supported | Supported |
| Key system | Full UI | Saved key only |
| Default model ID warning | No | Yes |
4 changes: 2 additions & 2 deletions rayfield/windows.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Windows
description: How to create and manage windows, tabs, and sections in Rayfield.

Check warning on line 3 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L3

Did you really mean 'Rayfield'?
---

## Create a window
Expand Down Expand Up @@ -53,7 +53,7 @@
</ResponseField>

<ResponseField name="Icon" type="number | string">
Icon shown in the topbar. Pass a Roblox image ID (number), a Lucide icon name (string), or `0` for no icon.

Check warning on line 56 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L56

Did you really mean 'Roblox'?

Check warning on line 56 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L56

Did you really mean 'Lucide'?
</ResponseField>

<ResponseField name="LoadingTitle" type="string">
Expand All @@ -65,7 +65,7 @@
</ResponseField>

<ResponseField name="ShowText" type="string">
Text shown to mobile users to unhide the UI.

Check warning on line 68 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L68

Did you really mean 'unhide'?
</ResponseField>

<ResponseField name="Theme" type="string | table">
Expand All @@ -77,11 +77,11 @@
</ResponseField>

<ResponseField name="DisableRayfieldPrompts" type="boolean">
Suppresses built-in Rayfield prompts.

Check warning on line 80 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L80

Did you really mean 'Rayfield'?
</ResponseField>

<ResponseField name="DisableBuildWarnings" type="boolean">
Prevents Rayfield from emitting warnings when there is a version mismatch between your script and the interface.

Check warning on line 84 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L84

Did you really mean 'Rayfield'?
</ResponseField>

<ResponseField name="ConfigurationSaving" type="object">
Expand Down Expand Up @@ -117,7 +117,7 @@
</ResponseField>

<Warning>
The key system UI loads a detectable Roblox model. In [Secure Mode](/rayfield/secure-mode), the key UI is blocked entirely — users must have a saved key from a previous session or they won't be able to load the script.
The key system UI loads a detectable Roblox model. In [Secure mode](/rayfield/secure-mode), the key UI is blocked entirely. Users must have a saved key from a previous session or they won't be able to load the script.

Check warning on line 120 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L120

Did you really mean 'Roblox'?
</Warning>

<ResponseField name="KeySystem" type="boolean">
Expand All @@ -138,16 +138,16 @@
Instructions for obtaining the key, shown to the user.
</ResponseField>
<ResponseField name="FileName" type="string">
File name used to save the key locally. Use something unique to avoid conflicts with other Rayfield scripts.

Check warning on line 141 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L141

Did you really mean 'Rayfield'?
</ResponseField>
<ResponseField name="SaveKey" type="boolean">
When `true`, the user's key is saved so they don't need to re-enter it. Note: changing the key will invalidate saved keys.
</ResponseField>
<ResponseField name="GrabKeyFromSite" type="boolean">
When `true`, Rayfield fetches the key from the URL specified in `Key`.

Check warning on line 147 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L147

Did you really mean 'Rayfield'?
</ResponseField>
<ResponseField name="Key" type="table">
A list of accepted keys (strings), or RAW file URLs (Pastebin, GitHub, etc.) when `GrabKeyFromSite` is `true`.

Check warning on line 150 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L150

Did you really mean 'Pastebin'?
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -162,20 +162,20 @@
local Tab = Window:CreateTab("Tab Example", 4483362458) -- Title, Image
```

### Lucide icon support

Check warning on line 165 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L165

Did you really mean 'Lucide'?

You can use a [Lucide icon](https://lucide.dev/icons/) name in place of a Roblox image ID.

Check warning on line 167 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L167

Did you really mean 'Roblox'?

```lua
local Tab = Window:CreateTab("Tab Example", "rewind")
```

<Note>
Not all Lucide icons are supported. See the [full list of supported icons](https://github.com/latte-soft/lucide-roblox/tree/master/icons/compiled/48px). Credit to [Lucide](https://lucide.dev/) and [Latte Softworks](https://github.com/latte-soft/).

Check warning on line 174 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L174

Did you really mean 'Lucide'?
</Note>

<Warning>
Lucide icons and Roblox image IDs are detectable by game anti-cheats. If you need your script to be undetectable, use `getcustomasset()` instead. See [Secure Mode](/rayfield/secure-mode) for details.
Lucide icons and Roblox image IDs are detectable by game anti-cheats. If you need your script to be undetectable, use `getcustomasset()` instead. See [Secure mode](/rayfield/secure-mode) for details.

Check warning on line 178 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L178

Did you really mean 'Lucide'?

Check warning on line 178 in rayfield/windows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sirius-b451bfde) - vale-spellcheck

rayfield/windows.mdx#L178

Did you really mean 'Roblox'?
</Warning>

---
Expand Down