Skip to content

samizdam/Kingdom

 
 

Repository files navigation

Государство

Build Status Scrutinizer Code Quality

"Государство" это мир браузерной игры открытый для исследований и приключений, сражений и завоеваний, ремесла и производства, свободной экономики и рынков, общения и дипломатии, управления городами и армиями. Захвати власть в Государстве!

Особенности

  • Большой мир для исследований и поиска новых земель, куда не ступала нога другого игрока.
  • Средневековая городская жизнь или путешествие по дальним краям в поисках квестов.
  • Все предметы и постройки в игре могут быть произведены игроками.
  • Выбор пути развития: возможности игрока определяются одетыми на него вещами.
  • Свободный рынок, цены на котором определяются игроками.
  • Свирепые монстры, охраняющие ценные ресурсы.
  • Политическая жизнь - возможность управлять городом, или целым регионом.
  • Войны с другими городами и феодами.

Установка

  1. Установить Docker:
    • Для linux: curl -sSL https://get.docker.com/ | sh
    • Для MacOS
    • Для Windows рекомендуется использовать виртуальную машину с linux
  2. Скачать этот репозиторий: git clone https://github.com/MagicGreenHat/Kingdom.git
  3. Перейти в директорию с проектом cd Kingdom
  4. Запустить скрипт установки: ./kingdom.sh start dev
  5. Тестовый персонаж с вещами будет создан автоматически. Логин/Пароль: test/test

Установка под Windows (версия для разработки)

  1. Установить Vagrant: https://www.vagrantup.com/downloads.html
  2. vagrant plugin install vagrant-triggers
  3. Из директории проекта выполнить vagrant up
    • Для загрузки необходимо время.
  4. После загрузки игра будет доступна на 8000 порту (http://localhost:8000)
  5. Серверная консоль доступна внутри виртуальной машины, подключиться к которой можно командой vagrant ssh. Затем, внутри виртуальной машины нужно переместиться в директорию с игрой cd /kingdom где затем можно вызвать консоль ./kingdom.sh
  6. Если сервер не может подключиться к базе данных, необходимо выполнить внутри виртуальной машины команду /kingdom/kingdom.sh drop-database и заново перезапустить образ.

Совместная работа над проектом

  • Если вы хотите присоединиться к разработке, взгляните на доску задач и идей.
  • Выберите интересную задачу, или предложите свою идею. Участвуйте в обсуждениях в комментариях к задачам.
  • При работе над кодом, создайте форк репозитория через интерфейс гитхаба, и новую ветку командой git checkout -b название-ветки, руководствуясь правилами именования, указанными ниже.
  • Отметьте на доске то что вы начали заниматься задачей, чтобы ее не начал делать кто-то другой
  • Со структурой проекта и принципами его функционирования можно познакомиться в разделе технической документации.
  • После того как работа в ветке будет завершена, создайте Pull Request в гитхабе и сообщите о своих успехах в комментариях к своей задаче на доске.

Техническая документация

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

Дизайн документ (наброски)

Сырой вариант, требующий переработки

Именование веток

  • t-НОМЕР_ЗАДАЧИ-короткое_описание_новой_функции - для нового функционала
  • fix-НОМЕР_ЗАДАЧИ_ЕСЛИ_ЕСТЬ-короткое_описание_исправляемой_ошибки - для багфикса

Номера задач можно посмотреть на доске: https://github.com/MagicGreenHat/Kingdom/issues

Releases

No releases published

Packages

No packages published

Languages

  • PHP 65.7%
  • JavaScript 20.0%
  • HTML 6.1%
  • Shell 4.5%
  • CSS 3.3%
  • Nginx 0.2%
  • ApacheConf 0.2%