Документация

README.md

@@ -1,3 +1,22 @@
-# ASCII-G
+# ASCII-G - The Cookies Edition
 
-A Super Cool Initial (not so) Interesting Game. Simple and turn-based.
+Текстовый квест в терминале. Игрок исследует подземный лабиринт, решает головоломки, открывает сундуки, взаимодействует с NPC и участвует в боях.
+
+## Возможности
+
+- 5 ASCII-локаций
+- головоломки
+- сундуки
+- инвентарь
+- зелья лечения
+- оружие
+- NPC и диалоги
+- боевая система
+- сохранение и загрузка
+- логирование событий
+
+## Сборка
+
+```bash
+make run
+```

docs/classes.md

@@ -0,0 +1,26 @@
+# Документация классов
+
+## Game
+
+Основной класс игры. Управляет игровым циклом, загрузкой данных, обработкой команд игрока, перемещением, взаимодействием с сундуками, NPC и боевой системой.
+
+### Поля
+
+| Поле | Тип | Описание |
+|---|---|---|
+| player | Player | Игрок |
+| locations | vector<Location> | Список игровых локаций |
+| itemDatabase | vector<Item> | База предметов |
+| isRunning | bool | Флаг работы игры |
+
+### Методы
+
+| Метод | Описание |
+|---|---|
+| run() | Запускает игру |
+| loadLocations() | Загружает локации из файлов |
+| loadItems() | Загружает предметы |
+| processCommand() | Обрабатывает команды игрока |
+| movePlayer() | Перемещает игрока |
+| openChest() | Открывает сундук |
+| startCombat() | Запускает бой |

docs/methods.md

@@ -0,0 +1,29 @@
+# Описание методов
+
+## Game::movePlayer(int dx, int dy)
+
+Перемещает игрока на указанное смещение.
+
+### Входные данные
+
+| Параметр | Тип | Описание |
+|---|---|---|
+| dx | int | Смещение по X |
+| dy | int | Смещение по Y |
+
+### Возвращаемое значение
+
+Метод ничего не возвращает.
+
+---
+
+## Player::usePotion(int itemId, const vector<Item>& itemDatabase)
+
+Использует зелье из инвентаря игрока.
+
+### Входные данные
+
+| Параметр | Тип | Описание |
+|---|---|---|
+| itemId | int | ID предмета |
+| itemDatabase | vector<Item> | База всех предметов |

docs/user_manual.md

@@ -0,0 +1,9 @@
+# Инструкция пользователя
+
+## Запуск игры
+
+### Windows / Linux
+
+```bash
+make run
+```