> 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/readme.md).

# Вступление

Добро пожаловать в документацию по скриптам Quick.

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

## О скриптах

Скрипты позволяют дописывать в Quick свои функции: визуалы, боевые модули, помощники для серверов и всё остальное, что вы придумаете. Скрипт пишется на Java и кладётся в папку клиента в виде `.jar`. Quick сам компилирует его прямо во время игры, перезапускать Minecraft не нужно.

Скрипты лежат в папке:

```
Hex\scripts
```

## Возможности

Скриптам доступно почти всё, чем пользуются модули самого Quick:

* модули с настройками, биндом и переключателем в меню;
* события игры: тики, удары, нажатия клавиш, пакеты, сообщения в чате;
* данные о мире, игроках, инвентаре и сервере;
* действия: удары, установка и ломание блоков, повороты головы, отправка пакетов;
* отрисовка HUD и объектов в мире, свои шрифты и шейдеры;
* поиск структур по сиду мира: где встанут деревни, крепости или города Энда;
* свои команды в чате;
* миксины для случаев, когда готового API не хватает.

## С чего начать

Если вы пишете скрипт впервые, откройте раздел [Уроки](/start.md) и пройдите страницы по порядку: [Подготовка](/start/ide.md), [Первый скрипт](/start/first-script.md) и [Как устроен скрипт](/start/lifecycle.md).

Когда основа понятна, пригодятся справочные разделы: [Настройки](/settings.md), [События](/events.md), [Данные игры](/game.md), [Действия](/actions.md) и [Интерфейс](/ui.md). Готовые скрипты с разбором собраны в [Примерах](/examples.md).

Скрипты можно писать и с помощью нейросети, которая подключается к запущенной игре. Как это настроить, описано на странице [MCP для нейросетей](/extras/mcp.md).

## Управление

Все скрипты видны на вкладке **Скрипты** в меню Quick. У каждого скрипта своя строка с переключателем, а кнопка «···» открывает настройки, перезагрузку и папку. Если в коде есть ошибка, строка подсвечивается красным, а подробности появляются в консоли скриптов.

То же самое можно сделать из чата командой `.script`:

| Команда                             | Что делает                                 |
| ----------------------------------- | ------------------------------------------ |
| `.script list`                      | список скриптов и их состояние             |
| `.script reload`                    | перечитать папку и собрать скрипты заново  |
| `.script toggle <имя>`              | включить или выключить скрипт              |
| `.script settings <имя>`            | показать настройки скрипта                 |
| `.script set <имя> <id> <значение>` | изменить настройку                         |
| `.script dir`                       | открыть папку скриптов                     |
| `.script check`                     | проверить, совпадает ли API скриптов с SDK |

## Поддержка

Если что-то не работает или вы нашли ошибку в документации, напишите нам в [Telegram](https://t.me/quickclient).

## Ссылки

* Официальный сайт: [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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.