Шашки с системой контроля версий (СКВ)

Лицензия

Данный репозиторий использует вторую версию Apache License.

Язык разработки

Предполагается, что основной язык разработки: комментариев, коммитов, вопросов - русский.

Навигация

• Используемые технологии
• Запуск проекта
  • Требования к ресурсам
• Примеры работы
  • Управление
    • Взаимодействие с игровой доской
• Правила
• Зачем это было создано?
• В чем польза ознакомления с проектом
• Дальнейшие планы?

---

Используемые технологии

• качестве инструмента создания Retained-GUI была выбрана библиотека iced
• для сериализации используется де-факто стандартная библиотека serde
• формат сериализации - бинарный bincode

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

Данный проект был протестирован на:

• Windows 10
• Ubuntu 23.04

1. Если у вас не устанвлен Rust toolchain, следуйте инструкции

2. Склонируйте данный проект, перейдите в полученную директорию и запустите проект командой:

cargo run --release

Первая компиляция может занять продолжительное время

Требования к ресурсам

Нужно около ~100Мб ОЗУ для комфортной работы с программой. В частности, на ОС Ubuntu 23.04 размер потребляемой памяти составляет ~65Мб, а в ОС Windows 10 - ~85Мб

Примеры работы

Управление

Взаимодействие с игровой доской

Для управления используется мышь. Для выбора фигуры используется ЛКМ, для отмены выбора - ПКМ.

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

Правила

Общие положения

Данная программа не полностью следует всем общепринятым правилам шашек. Так, правило принудительного взятия фигур не реализовано.

• Игроки играют на доске размером 8x8 клеток.
• Изначально у каждого игрока по 12 шашек.
• Игра начинает с хода белых.
• После хода одной стороны следующих ход передаётся противоположной стороне, за исключением случая, когда на текущем ходу сторона превратила пешку в дамку.
• Пешка ходит вперёд по диагонали, занимая свободную клетку, на расстояние в 1 клетку.
• Пешка бьёт по диагонали в любом направлении. Чтобы взять фигуру противника, нужно, чтобы он находился вплотную к вашей фигуре и чтобы за его фигурой была пустая ячейка.
• Дамка ходит и бьёт по диагонали в любом направлении на любое расстояние, при этом за фигурой противника также должна находиться пустая ячейка, чтобы бьющей было куда встать.
• Если после взятия фигуры есть возможность взять еще одну фигуру противника, можно это сделать.
• Как только пешка одной из сторон доходит до противоположного края доски, она превращается в дамку.
• Когда у стороны заканчиваются фигуры, игра заканчивается и перезапускается.

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

Зачем это было создано?

Изначально стояла задача реализовать СКВ для какой-либо игры. Была выбрана относительно примитивная игра - "Шашки". Кроме того, был интерес попробовать использовать для такой цели инструментарий Rust для создания GUI.

Система контроля версий(СКВ) должна была позволять создавать "снимки" состояния доски, различные "ветки" и позволять перемещаться между ними.

Реализованная СКВ большей частью вдохновлена СКВ Git, однако имеются и отличия:

• все объекты СКВ в течение работы программы хранятся в оперативной памяти ЭВМ.
• используется один файл для сохранения СКВ между перезапусками. При запуске программы происходит считывание, а перед закрытием - запись.

На данный момент СКВ удалена из программы.

На данном этапе польза от проекта чисто теоретическая

В чем польза ознакомления с проектом?

В данном проекте активно используется:

• создание GUI с помощью iced, показан один из возможных подходов к разбиению сообщений (Messages) на подтипы
• graceful shutdown, позволяющий перехватить событие закрытия программы и провести некоторые дополнительные действия перед этим (нет дополнительных действий)
• работа с shared ownership (Rc), позволяющая изменять один и тот же участок памяти из разных структур
• продвинутые концепции для работы с итераторами(itertools), в частности, для формирования положений фигур и различных проверок по ходу игры

Дальнейшие планы?

На момент написания этого файла, планируется сделать следующие улучшения:

• Покрыть игровую логику автотестами
• Мигрировать к использованию библиотеки tauri для создания интерфейса
• Оптимизировать использование программой оперативной памяти
• Расширить доступный инструментарий программы
• Внедрить возможность добавления переводов текстовых сообщений
• Добавить возможность собственной стилизации элементов интерфейса

Маловероятно, но вдруг?)

• Добавить возможность игры по сети?