> For the complete documentation index, see [llms.txt](https://docs.quickclient.cc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.quickclient.cc/en/readme.md).

# Introduction

Welcome to the Quick scripting documentation.

![Quick](https://2876410597-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzfkIlEYchuv9RZGNcoN%2Fuploads%2FfwK88pkeb1PVBV6tUIK8%2Fquick-banner.svg?alt=media)

## About scripts

Scripts let you add your own features to Quick: visuals, combat modules, helpers for specific servers and anything else you come up with. A script is written in Java and placed in the client folder as a `.jar`. Quick compiles it while the game is running, so there is no need to restart Minecraft.

Scripts live in this folder:

```
%APPDATA%\.minecraft\Hex\scripts
```

## What scripts can do

Scripts can use almost everything Quick's own modules use:

* modules with settings, a bind and a toggle in the menu;
* game events: ticks, attacks, key presses, packets, chat messages;
* data about the world, players, inventory and the server;
* actions: attacking, placing and breaking blocks, head rotations, sending packets;
* HUD and in-world rendering, custom fonts and shaders;
* custom chat commands;
* mixins for cases where the API is not enough.

## Where to start

If this is your first script, open [Lessons](/en/start.md) and go through the pages in order: [Setup](/en/start/ide.md), [Your first script](/en/start/first-script.md) and [How a script is built](/en/start/lifecycle.md).

Once the basics are clear, the reference sections will help: [Settings](/en/settings.md), [Events](/en/events.md), [Game data](/en/game.md), [Actions](/en/actions.md) and [Interface](/en/ui.md). Complete scripts with explanations are collected in [Examples](/en/examples.md).

You can also write scripts with an AI agent that connects to the running game. The setup is described on the [MCP for AI agents](/en/extras/mcp.md) page.

## Managing scripts

All scripts are listed on the **Scripts** tab in the Quick menu. Each script has its own row with a toggle, and the "···" button opens settings, reload and the folder. If the code has an error, the row turns red and the details show up in the script console.

The same can be done from chat with the `.script` command:

| Command                           | What it does                               |
| --------------------------------- | ------------------------------------------ |
| `.script list`                    | list scripts and their state               |
| `.script reload`                  | re-read the folder and rebuild the scripts |
| `.script toggle <name>`           | turn a script on or off                    |
| `.script settings <name>`         | show a script's settings                   |
| `.script set <name> <id> <value>` | change a setting                           |
| `.script dir`                     | open the scripts folder                    |
| `.script check`                   | check that the script API matches the SDK  |

## Support

If something does not work or you found a mistake in the docs, message us on [Telegram](https://t.me/quickclient).

## Links

* Official website: [quickclient.cc](https://quickclient.cc)
* Telegram: [t.me/quickclient](https://t.me/quickclient)


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.quickclient.cc/en/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.