# gh05t cursor

> **Folder:** `gh05t-cursor` · **Type:** NUI overlay · **Frameworks:** Standalone (works with everything) · **Latest:** v1.0.0

## Overview

Replaces the default FiveM mouse cursor with a premium **animated, theme-colored cursor** — glowing arrow, motion trail, click ripple + ring, and a precise hotspot dot. Ships with all **7 GH05T themes**.

It tracks the mouse **globally** (the position is read in Lua and pushed to the overlay), so the themed cursor follows your mouse over **any** menu — it doesn't need to own NUI focus.

## Requirements

| Dependency           | Required? |
| -------------------- | --------- |
| FiveM artifact 5181+ | ✅         |
| Framework            | ❌         |

## Installation

{% stepper %}
{% step %}

### Place `gh05t-cursor` in `resources/`

Place **`gh05t-cursor`** in `resources/`.
{% endstep %}

{% step %}

### Add to `server.cfg`

```cfg
ensure gh05t-cursor
```

> 📌 Put it **near the bottom** of `server.cfg` (after your menu/inventory/HUD resources) so its overlay renders **on top** of them.
> {% endstep %}

{% step %}

### Edit `config.lua` and restart

Edit `config.lua` (color / keybind) and restart.
{% endstep %}
{% endstepper %}

## Configuration (`config.lua`)

```lua
Config.Theme    = "gh05t-toxic" -- any of the 7 themes
Config.Command  = "ghcursor"
Config.Keybind  = "F7"          -- rebindable in Settings ▸ Key Bindings
Config.ShowWithPauseMenu = false
Config.ShowHint = true
```

## Modes

| Mode      | When                              | Behavior                                        |
| --------- | --------------------------------- | ----------------------------------------------- |
| **on**    | toggle key / `Show()`             | takes focus, hides system cursor, full tracking |
| **ghost** | another menu / pause menu is open | draws over it, **click-through**                |
| **off**   | no cursor on screen               | hidden                                          |

## Exports

```lua
exports['gh05t-cursor']:Show()
exports['gh05t-cursor']:Hide()
exports['gh05t-cursor']:Toggle()
exports['gh05t-cursor']:IsActive()
exports['gh05t-cursor']:SetTheme("gh05t-blue")
```

## 🛠️ Known Issues & Fixes

| Issue                                                               | Fix                                                                                     |
| ------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| The **default arrow** still shows under the themed cursor in a menu | Add `*{cursor:none!important}` to that menu's CSS (each NUI controls its own cursor)    |
| Cursor renders **behind** a menu                                    | `ensure gh05t-cursor` **after** your menu resources in `server.cfg`                     |
| Cursor doesn't appear in gameplay                                   | By design — it shows when a cursor/menu is active; use `/ghcursor` for a manual session |
| Folder renamed error                                                | Rename back to `gh05t-cursor`                                                           |

## Changelog

### v1.0.0

* Initial release — global tracking, 7 themes, pause-menu support, exports, build packer.

***

💬 Need help? See [Support & Updates](broken://pages/7024a209202c582820636f1116976aedeb2d64d4).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://gh05t-labs.gitbook.io/gh05t-labs/resources/gh05t-cursor.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.