An open API service indexing awesome lists of open source software.

https://github.com/stacenko-developer/hangman-game


https://github.com/stacenko-developer/hangman-game

Last synced: 11 months ago
JSON representation

Awesome Lists containing this project

README

          

![tbank-logo.svg](img/tbank-logo.svg)
# Академия бэкенда от Т-Банка 2024, 1 семестр, Проект 1: Виселица

## Описание

Разработайте консольную версию игры "Виселица", в которой игрок пытается угадать загаданное слово,вводя буквы по одной за раз. Слово выбирается по уровню сложности, случайно из предварительно заданного списка слов и категории. Количество попыток ограничено, и за каждую неверную догадку визуализируется часть виселицы и фигурки висельника.

## Функциональные требования
- Программа должна выбрать случайную категорию слов, если этого не сделал пользователь.
- Программа должна выбрать уровень сложности, если этого не сделал пользователь.
- Программа должна выбирать случайное слово из заранее определенного списка слов.
- Игрок вводит одну букву за раз, чтобы угадать слово.
- Экран должен обновляться после каждого ввода, показывая уже угаданные буквы и прочерки на местах неуказанных букв.
- Визуализация виселицы должна добавляться постепенно с каждой неправильной попыткой.
- Игра завершается, когда слово угадано полностью или когда висельник полностью нарисован.
- Количество попыток ограничено и должно быть указано в начале игры.
- Реализация механизма подсказки, например, для слова "бабушка" подсказкой может быть "близкий родственник"

## Нефункциональные требования
- Программа должна иметь текстовый интерфейс.

## Описание входных и выходных данных
### Ввод
- Ввод буквы осуществляется через стандартную консоль ввода.
- Ввод не должен быть чувствительным к регистру.
### Вывод
- На каждом этапе игры должно отображаться текущее состояние угадываемого слова и виселицы.
- При успешном угадывании буквы нужно обновить состояние слова на экране.
- При неправильной букве нужно обновить изображение виселицы и указать кол-во оставшихся попыток.

## Начало работы

Для того чтобы собрать проект, и проверить, что все работает корректно, можно
запустить из модального окна IDEA
[Run Anything](https://www.jetbrains.com/help/idea/running-anything.html)
команду:

```shell
mvn clean verify
```

Альтернативно можно в терминале из корня проекта выполнить следующие команды.

Для Unix (Linux, macOS, Cygwin, WSL):

```shell
./mvnw clean verify
```

Для Windows:

```shell
mvnw.cmd clean verify
```

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

Если вы в процессе сборки получили ошибку:

```shell
Rule 0: org.apache.maven.enforcer.rules.version.RequireJavaVersion failed with message:
JDK version must be at least 22
```

Значит, версия вашего JDK ниже 22.

Если же получили ошибку:

```shell
Rule 1: org.apache.maven.enforcer.rules.version.RequireMavenVersion failed with message:
Maven version should, at least, be 3.8.8
```

Значит, у вас используется версия maven ниже 3.8.8. Такого не должно произойти,
если вы запускаете сборку из IDEA или через `mvnw`-скрипты.

Далее будут перечислены другие полезные команды maven.

Запуск только компиляции основных классов:

```shell
mvn compile
```

Запуск тестов:

```shell
mvn test
```

Запуск линтеров:

```shell
mvn checkstyle:check modernizer:modernizer spotbugs:check pmd:check pmd:cpd-check
```