浏览代码

Merge branch 'master' of http://git.gi1dor.ru/Gi1dor/game-client into dev

Ivan Arkhipov 6 年之前
父节点
当前提交
f74a0b1442
共有 5 个文件被更改,包括 69 次插入1 次删除
  1. 57 1
      README.md
  2. 3 0
      include/README.md
  3. 4 0
      include/gui/README.md
  4. 2 0
      include/units/README.md
  5. 3 0
      source/README.md

+ 57 - 1
README.md

@@ -1 +1,57 @@
-## Client for game
+# Клиент игры "Здесь должно быть название, но мы его ещё не придумали"
+
+### Состав команды: 
+* Архипов Иван
+* Батманов Игорь
+* Боков Аркадий
+* Кологерманский Егор
+
+Игра была спроектирована в жанре тактической-rpg пошаговой стратегии. На данный момент готовится реализация первого (и основного) сценария игры: свободного сражения между двумя игроками. Сражение представляет собой последовательные действия игроков над их юнитами (предварительно выбранными) на поле из шестиугольников. За основу была взята (но существенно изменена) механика боёв игры Heroes of Might & Magic III.
+
+На данный момент в "Свободном сражении" доступно 3 расы, из которых игроку предлагается выбор - Люди, Восставшие из мёртвых и Warcraft (тестовая раса). Для каждой расы существует свой уникальный набор юнитов и их веток развития. В более-менее полной мере реализованы юниты только расы Людей (для этой расы прописано уже более 60 классов). Раса Мёртвых требует доработки.
+
+В master находится первая стабильная тестовая версия программы, позволяющая запустить её и пройти путь набора отряда для данного сценария. 
+
+# Установка
+
+### Windows:
+* Скачать сборку, упакованную в .zip архив: http://files.gi1dor.ru/goosehouse-game.zip
+* Распаковать всё содержимое архива в любую папку 
+* Для запуска использовать файл client.exe
+
+### Linux Debian-based (Debian ver. >= 8, Ubuntu ver. >= 16.04 LTS, etc.)
+* Открыть терминал и последовательно выполнять команды:
+
+```bash
+wget http://files.gi1dor.ru/goosehouse-game.deb
+sudo apt-get -f install ./goosehouse-game.deb
+rm goosehouse-game.deb
+```
+
+* Для запуска использовать консольную команду `goosehouse-game`
+
+* В случае, если установка через apt-get -f install не удалась, выполните следующие действия вместо этой команды:
+
+```bash
+sudo apt-get install qt5-default qt5-image-formats-plugins qt5-style-plugins
+dpkg -i ./goosehouse-game.deb
+```
+
+
+## Ветки развития юнитов расы людей:
+
+### Ветка Лучника
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-archer.png)
+
+### Ветка Мага
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-mage.png)
+
+### Ветка Всадника
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-rider.png)
+
+### Ветка Изгоя
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-rogue.png)
+
+### Ветка Воина 
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-warrior.png)
+

+ 3 - 0
include/README.md

@@ -0,0 +1,3 @@
+# Директория /include
+В этой директории находятся и размещаются все текущие заголовочные файлы проекта. 
+Заголовочные файлы одной тематики должны быть сгруппированы в папки (пример: /include/gui, /include/units)

+ 4 - 0
include/gui/README.md

@@ -0,0 +1,4 @@
+# Папка /include/gui
+В этой папке находятся все заголовочные файлы, связанные с отрисовкой и обработкой графической составляющей. Здесь же находятся файлы форм QtDesigner. 
+
+### Ответственный за gui - Архипов Иван

+ 2 - 0
include/units/README.md

@@ -0,0 +1,2 @@
+# Папка /include/units
+В этой папке находятся заголовочные файлы классов *механик* юнитов. Важно понимать, что механики юнитов и классы юнитов - разные вещи. Под классами юнитов понимаются их игровые классы - их на данный момент более 70. Под механиками юнитов понимаются классы c++, реализующие конкретную механику действий юнита. На данный момент подготовлена реализация пяти механик. Каждый игровой класс обязан иметь механику.

+ 3 - 0
source/README.md

@@ -0,0 +1,3 @@
+# Папка /source 
+В этой папке находятся все исходные коды проекта. Они же подключаются в файле проекта /client.pro
+Повторяют структуру директории /include.