> For the complete documentation index, see [llms.txt](https://fiveo-development.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fiveo-development.gitbook.io/docs/nixqueue-guide.md).

# NixQueue User Guide

<h2 align="center"><a href="https://www.twitch.tv/products/nixstah"><mark style="color:blue;">Twitch</mark></a> <mark style="color:blue;">|</mark> <a href="https://www.youtube.com/c/nixstah"><mark style="color:blue;">YouTube</mark></a> <mark style="color:blue;">|</mark> <a href="https://www.tiktok.com/@nixstah"><mark style="color:blue;">TikTok</mark></a> <mark style="color:blue;">|</mark> <a href="https://discord.gg/nixstah"><mark style="color:blue;">Discord</mark></a></h2>

***

### <mark style="color:green;">Features</mark>

* ✅ Slash command support
* ✅ Interactive button support
* ✅ Role-based access control
* ✅ Real-time queue updates
* ✅ Auto DM help system

***

### <mark style="color:purple;">Commands & Button Guide</mark>

#### `/createq [#channel] [# of slots]`

**Who Can Use:** `@Twitch Mods` role and above\
**Purpose:** Initializes a new queue with an interactive embed.

**Parameters:**

* `#channel` – Required. The Discord text channel to post the embed.
* `# of slots` – Optional. Sets how many player names are visible in the embed.
  * Defaults to `3`
  * This **does not limit** how many users can join — it only controls **visible slots**.

**Effect:**

Creates the queue, posts the embed with Join/Update/Stop/Help buttons, and tracks queue data in the system.

***

#### ~~`/joinq` or **Join Button**~~**&#x20;**<mark style="color:$primary;">**(No longer available, use button)**</mark>

~~**Who Can Use:**~~ ~~`@SUB` and `@Twitch Mods` roles~~\
~~**Purpose:** Adds the user to the current queue.~~

~~**Effect:**~~

* ~~Automatically adds the user to the end of the queue.~~
* ~~Prevents duplicate entries.~~
* ~~Embed updates in real time (if the user is within visible slots).~~

***

#### `/updateq` or **Update Button**

**Who Can Use:** `@Twitch Mods` role and above\
**Purpose:** Cycles the embed to the next visible group of queued users.

**Effect:**

* Players shown in the embed are rotated out.
* The next group of players in line is displayed.
* Current visible players are removed from the queue.

***

#### `/stopq`

**Who Can Use:** `@Twitch Mods` role and above\
**Purpose:** Disables new joins without affecting current queue members.

**Effect:**

* Disables the **Join** button.
* Blocks `/joinq` from functioning.
* Does **not** remove or alter existing queue members.

***

#### `/resetq`

**Who Can Use:** `@Twitch Mods` role and above\
**Purpose:** Fully resets and clears the active queue and deletes the embed.

**Effect:**

* Deletes the queue embed from the original channel.
* Removes all users from the internal queue database.
* Completely shuts down the queue system until `/createq` is used again.

> 💡 **Best Practice:** Use this at the start or end of stream to clear queue system.

***

#### Help Button (❓)

**Who Can Use:** Everyone\
**Purpose:** Sends the user private instructions.

**Effect:**

* When clicked, the bot sends this guide (a condensed version) via DM.
* Prevents cluttering the channel with how-to messages.

***

### <mark style="color:purple;">Common Use Cases</mark>

<table><thead><tr><th>Situation</th><th width="175">Action</th><th width="206">Result</th><th width="115">Can Use<select multiple><option value="Pxy3NhsHW5lJ" label="Moderator" color="blue"></option><option value="zfk9HZ3wQbzS" label="Sub" color="blue"></option></select></th></tr></thead><tbody><tr><td><strong>Starting a new queue</strong></td><td><code>/createq #queue 5</code></td><td>Queue embed appears in #queue with 5 visible slots</td><td><span data-option="Pxy3NhsHW5lJ">Moderator</span></td></tr><tr><td><strong>Mod rotates to next group</strong></td><td><code>/updateq</code> or click <strong>Update</strong></td><td>Next group in queue becomes visible</td><td><span data-option="Pxy3NhsHW5lJ">Moderator</span></td></tr><tr><td><strong>Mod halts queue temporarily</strong></td><td><code>/stopq</code></td><td>New joins blocked, current queue remains intact</td><td><span data-option="Pxy3NhsHW5lJ">Moderator</span></td></tr><tr><td><strong>Mod fully resets after stream</strong></td><td><code>/resetq</code></td><td>Embed removed, queue wiped, system reset</td><td><span data-option="Pxy3NhsHW5lJ">Moderator</span></td></tr></tbody></table>

***

### <mark style="color:red;">Required Bot Permissions</mark>

*<mark style="color:yellow;">To function correctly, the bot must have the following permissions in any channel where queues are created:</mark>*

* `Send Messages`
* `Embed Links`
* `Read Message History`
* `Manage Messages`

***

### <mark style="color:blue;">Notes & Best Practices</mark>

* Only **one active queue** is supported at a time.
* Join button is user-friendly and does not require command usage.
* Moderators can use buttons or slash commands interchangeably.
* The embed updates dynamically — no need to recreate it manually.
* Use `/resetq` before starting a new game session or stream block.

***

### <mark style="color:green;">Coming Soon</mark>

> Stay tuned for new features in future releases:

* Multiple simultaneous queue support
* Stream dashboard integration
* Queue export & history logs
* Web UI to manage and monitor queue state
* Twitch-linked auto-role synchronization

***

### <mark style="color:orange;">Support & Contact</mark>

Need help or want to suggest features? Join our [Discord support server](https://discord.gg/rc3FXthyzD) or submit feedback directly to the FiveO Development team.