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

https://github.com/stacenko-developer/maze


https://github.com/stacenko-developer/maze

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

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

## Описание

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

## Функциональные требования
- Реализация как минимум 2-х алгоритмов для случайной генерации лабиринтов.
- Реализация как минимум 2-х алгоритмов для поиска пути из заданной начальной точки А в конечную точку Б.
- Печать лабиринта в консоль с точками А и Б.
- Отображение пути через лабиринт при его наличии.
- Реализация различных типы поверхностей лабиринта и их учёте при построении маршрута (ухудшающих и улучшающих)

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

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

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

Для того чтобы собрать проект, и проверить, что все работает корректно, можно
запустить из модального окна 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
```