Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 2.04 KB

README.md

File metadata and controls

83 lines (51 loc) · 2.04 KB
Raw

Chess

Maven Release

A Fully Object-Oriented Chess, written in pure Java

Table of Contents

  1. Features
  2. Demo
  3. Documentation
  4. Run Locally
  5. Running Tests
  6. Project Structure Diagrams
  7. License

Features

  • Support Custom FEN
  • Multiplayer
  • Undo Move
  • Plays sound
  • Support Stalemate and Checkmate edge Cases
  • Support En Passant Move

Demo

Demo

Documentation

You can visit the online Documentation on here: Documentation Also the project structure diagrams are available in the Project Structure Diagrams section

Run Locally

  1. Install JRE 21 or higher
  2. Download the latest Chess.jar file from releases page
  3. Run the following command:
  java -jar Chess.jar

Running Tests

The project use Maven as build automation tool. To run tests, run the following command:

  mvn test

Project Structure Diagrams

Logic

  • Game Classes:

Game

  • Pieces Classes:

Pieces

  • Moves Classes:

Pieces

GUI

This project follows the Model-View-Controller design pattern. The GUI part of the project is implemented using Java Swing.

  • GUI Classes:

GUI

License

MIT

This project is licensed under the MIT License - see the LICENSE file for details