electrum18/ktg

Russian web-game based on Next.js about TV game "Who want to be a millonair"

Кто хочет стать геймером? (КТГ)

Браузерная онлайн игра для стриминговых платформ по мотиву "Кто хочет стать миллионером?" в стиле фотошоп флеш игр 2012 года по запросу учителя.

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

Навигация

• Установка и запуск

  • Необходимые программы
  • Установка проекта
  • Запуск проекта

• Использование сайта

  • Этапы запуска игры
  • Процесс игры

• Известные проблемы игры

• Лицензия / License

Установка и запуск

Для запуска сайта необходим рабочий сервер Next.js в режиме "Start" с установленным Node.js.

Необходимые программы

• Node.js 14.x.x или выше
• NPM 7.x.x или выше (устанавливается с Node.js)

Проверьте установленные программы с помощью любой консоли:

> node -v
v14.x.x

> npm -v
7.x.x

Установка проекта

После установки Node.js и NPM скачайте из GitHub и перейдите в папку проекта.

Затем выполните данные команды:

> cd ./KTG/

/KTG/> npm i

Запуск проекта

Необходимо запустить команды в консоли зависимо от ситуации (если запуск первый раз или нету папки .next, то запустите npm run build) и дождитесь компиляции.

Для запуска в любой ситуации выполняйте команду npm run start

Убедитесь что вы выполняете команды в папке проекта!

/KTG/> npm run build # Запуск в первый раз

# логи компиляции...

/KTG/> npm run build # В любом запуске

# логи статического сервера и api...

После запуска npm run build зайдите в корневой адрес запущенного сайта /, для настройки адресов возможно необходим обратный прокси например через nginx.

После перехода в первый раз вам выведется консоле адрес панели ведущего

/KTG/>
# логи статического сервера и api...

----- АДРЕС ДОСТУПА К ПАНЕЛИ ВЕДУЩЕГО: /lead/XXXXXXXXXX -----

Перейдите по предоставленной ссылке через ваш домен /lead/XXXXXXXXXX

Использование сайта

Использование проекта происходит по определенным адресам для определенных участников

• / - для всех участников при ожидании

• /result?score=X - получение результатов игры

• /lead/XXXXXXXXXX - панель ведущего во всем промежутке игры

• /join/XXXXXXXXXX - адрес приглашения игрока в игру (после запуска игры выкидает из адреса) (есть проблема сброс аккаунтов)

• /game/XXXXXXXXXX - адрес игрока (после входа второго клиента заканчивает игру)

• /view/XXXXXXXXXX - адрес просмотра игры и голосования (можно заходить любому количеству клиентов) (есть проблема несоотвествие таймера голосования)

Этапы запуска игры

1. При первом входе получите адрес панели ведущего через первый вход в корневой адрес /
2. Затем перейдите на адрес /lead/XXXXXXXXXX и зарегистрируйте аккаунт ведущего на данную игру
3. Скопируйте и передайте ссылку /join/XXXXXXXXXX для кандидата в игрока
4. Ожидайте регистрации игрока и затем нажмите далее, не торопитесь, игрок может поменять аккаунт
5. Скопируйте и передайте ссылку /view/XXXXXXXXXX для желающих зрителей и для собственного просмотра (стримить данный адрес!), через данный адрес так же происходит голосование

Процесс игры

• Этап 1. Опишите вопрос для участника и нажмите далее
• Этап 2. Дождитесь ответа игрока
  • Вам будет выслано звуковое оповещение если игрок запросет помощь
  • Так же после выбора вопроса будет звуковое оповещение
• Этап 3. После выбора вопроса система сама перейдет на следующих или сразу на страницу итогов /result?score=X

После окончания игры требуется повторное создание игры (перезапуск сервера не требуется).

Известные проблемы игры

• После захода игрока по адресу /join/XXXXXXXXXX возможен сброс аккаунта ведущего
• Таймер голосования при заходе не с начала голосования отсчитывает с старта времени голосования
• Сервер может иметь непредвиденные действия в API
• Ошибки проигрования звуков

Лицензия / License

Данный репозиторий сделан под лицензией MIT

This repository is licensed under the MIT license