# Обзор документации

> Документация OpenWar3: что это и что умеет; быстрый старт, первый бот, LLM пишет бота, API и протокол, шлюз и MCP — с какой страницы начать чтение в вашей ситуации.

Источник: https://war3ai.com/ru/docs/

**OpenWar3** — открытый интерфейсный слой War3AI: рантайм, внедряемый в Warcraft III 1.27, плюс Python SDK.

- Каждые **50 ms** рантайм выкладывает в общую память полное состояние всей карты: ресурсы и пищу всех игроков; здоровье и ману каждого юнита, его приказ, кого он сейчас атакует, перезарядку способностей, баффы и инвентарь; предметы на земле, деревья, очереди производства, время суток. Плюс **поток событий**: юниты появляются и гибнут, каждый отдельный удар, завершение производства…
- Внешняя программа отдаёт **семантические команды** с задержкой **около одного кадра**: движение, атака, добыча, строительство, тренировка, применение и изучение способностей, воскрешение, использование предметов, покупки… На каждую команду приходит **квитанция**: принял ли её движок, а если нет — код причины.
- Вы говорите только «что сделать»: юниты задаются четырёхсимвольными кодами, способности — строками приказов, как в самой игре. «Как это сделать» — забота рантайма.

Поэтому LLM не нужны никакие низкоуровневые знания и не нужно смотреть на экран. Прочитав документацию, модель пишет бота, который умеет вести экономику и воевать, а после выхода на карту сама дорабатывает его по квитанциям и событиям.

И не только бои: [холст](https://war3ai.com/ru/docs/canvas/) рисует поверх игрового экрана ваши собственные панели и пометки, с [интерфейсом и вводом](https://war3ai.com/ru/docs/ui-input/) нарисованные кнопки нажимаются, а горячие клавиши срабатывают, [JASS-канал](https://war3ai.com/ru/docs/jass/) позволяет извне вызывать 1291 функцию игры, а на RPG-картах можно взять с собой [ИИ-компаньона](https://war3ai.com/ru/docs/companion/). Готовый ИИ можно оформить как [схему](https://war3ai.com/ru/docs/schemes/) — переключение в один клик, экспорт для обмена; целый новый геймплей можно написать как [игровой мод](https://war3ai.com/ru/docs/mods/).

Подключиться можно и без Python: [шлюз](https://war3ai.com/ru/docs/gateway/) позволяет вызывать те же методы по WebSocket / JSON из любого языка и со страницы в браузере, а [MCP-сервер](https://war3ai.com/ru/docs/mcp/) даёт агентам вроде Claude Code напрямую вызывать инструменты — смотреть обстановку и отдавать команды.

  - [Быстрый старт](https://war3ai.com/ru/docs/quickstart/): Настройте окружение, запустите матч одной командой и посмотрите, как управление берёт пример бота.
  - [Пишем бота с помощью LLM](https://war3ai.com/ru/docs/ai-bot/): Программировать не обязательно: скопируйте промпт, опишите стиль игры и отдайте агенту.
  - [Ментальная модель](https://war3ai.com/ru/docs/concepts/): Снимки, команды, квитанции, события, тик. Пять минут перед тем, как писать бота.
  - [Каталог API](https://war3ai.com/ru/api/): Все методы: у каждого указаны статус проверки, класс задержки и механизм под капотом.

## Выберите путь под свою ситуацию

| Кто вы | С чего начать | Что дальше |
|---|---|---|
| Играете в Warcraft, но не программируете | [Быстрый старт](https://war3ai.com/ru/docs/quickstart/) → [Пишем бота с помощью LLM](https://war3ai.com/ru/docs/ai-bot/) | Если возникнут вопросы — [частые вопросы](https://war3ai.com/ru/docs/faq/) |
| Знаете Python | [Первый бот](https://war3ai.com/ru/docs/first-bot/) → [Ментальная модель](https://war3ai.com/ru/docs/concepts/) → [Пятнадцать правил](https://war3ai.com/ru/docs/rules/) | [Приёмы профи](https://war3ai.com/ru/docs/cookbook/), [Примеры ботов](https://war3ai.com/ru/docs/examples/) |
| Делаете coding-агента или автоматизацию | [Автономные итерации агента](https://war3ai.com/ru/docs/agent-loop/) | [Квитанции и коды причин](https://war3ai.com/ru/docs/reason-codes/), [`llms-full.txt`](https://war3ai.com/ru/llms-full.txt) |
| Хотите, чтобы LLM принимала решения по ходу матча | [LLM как советник](https://war3ai.com/ru/docs/llm-coach/) | [Реплики и локальные модели](https://war3ai.com/ru/docs/speech/) |
| Хотите, чтобы агент сам управлял игрой (Claude Code и т. п.) | [LLM вызывает инструменты (MCP)](https://war3ai.com/ru/docs/mcp/) | [Интерфейс и ввод](https://war3ai.com/ru/docs/ui-input/) |
| Пишете на другом языке (JS, C#, Go, Rust…) | [Шлюз](https://war3ai.com/ru/docs/gateway/) | Уровнем ниже: [протокол W3P](https://war3ai.com/ru/docs/protocol/) |
| Хотите стравить ИИ разных авторов | [Честный режим](https://war3ai.com/ru/docs/fair-mode/) | [Арена](https://war3ai.com/ru/arena/) |
| Хотите придумать свой геймплей на RPG / пользовательской карте | [Игровые моды](https://war3ai.com/ru/docs/mods/) | [Интерфейс и ввод](https://war3ai.com/ru/docs/ui-input/), [Холст](https://war3ai.com/ru/docs/canvas/), [JASS-канал](https://war3ai.com/ru/docs/jass/), [RPG-компаньон](https://war3ai.com/ru/docs/companion/) |
| Хотите поделиться своим ИИ с другими | [ИИ-схемы](https://war3ai.com/ru/docs/schemes/) | [Консоль Farsight](https://war3ai.com/ru/docs/console/) |

## Что лежит в репозитории

```text
start.bat       Единственная точка входа: развёртывание с нуля + открытие Farsight; stop.bat полностью останавливает всё
sdk/python/     Интерфейсный слой. openwar3/ — внешний фасад (Game + Bot), начинайте отсюда
brains/         Слой принятия решений
  examples/       hello_bot (экономика) → rush_bot (армия) → macro_bot (макро) → micro_bot (микро + крипинг); buddy (RPG-компаньон);
                  mod_hero_roguelike / mod_endless_defense (игровые моды)
  xwar3/          Эталонный мозг: стратегический слой (секунды) + рефлекторный слой (4 процесса) + модель шансов на победу
console/        Веб-консоль Farsight (FastAPI + React)
gateway/        Шлюз (WebSocket / JSON) + JS-клиент + демо-страница для браузера
director/       Автооператор камеры, полоски здоровья над юнитами
speech/         Облачка реплик над юнитами + локальная LLM
runtime/        Оркестрация нескольких экземпляров (каждый матч перезапускается по настройкам)
data/           order-ids.txt; инструменты для извлечения данных из вашей собственной игры
schemes/        Ваши ИИ-схемы (mine/) и схемы, которыми поделились другие (installed/); в репозиторий не попадают
tools/          play.py (матч одной командой), run_scheme.py (запуск схем), war3_mcp.py (MCP-сервер), run_tests.py, скрипты проверки в реальной игре
docs/           Каталог API api.json (генерируется из кода), протокол, руководство
```

Между рантаймом и вашим кодом — только версионированный [протокол W3P](https://war3ai.com/ru/docs/protocol/): проще всего работать через Python SDK, но можно подключиться по протоколу и с любого другого языка.

## Что означает «статус проверки» метода

В каталоге API у каждого метода указан один из трёх статусов:

- **Проверено в реальных играх**: низкоуровневый путь (номер действия, форма аргументов, считанный результат) проверен в настоящих матчах, и его охраняют скрипты проверки.
- **Экспериментальный**: новый метод, уже работает на тестовом экземпляре, проверка в реальной игре идёт по пунктам. Пользоваться можно, но детали интерфейса ещё могут измениться.
- **Выведено / не полностью проверено**: механизм повторяет то, как это делает сам движок (например, эквивалентная функция JASS), но ещё не проверен в матчах пункт за пунктом. Перед использованием смотрите на квитанцию.

> **Примечание**
>
> Сейчас поддерживается только **Warcraft III 1.27** (The Frozen Throne). Версии 1.24 ~ 1.28 устроены на одном и том же движке; поддержка нескольких версий запланирована на этапе P4 [дорожной карты](https://war3ai.com/ru/roadmap/). Начиная с 1.29, а также Reforged — это другой движок, и их поддержку мы не обещаем.