https://github.com/itsamirhn/chess

OOP Chess in Java
https://github.com/itsamirhn/chess

Last synced: 25 days ago
JSON representation

OOP Chess in Java

• Host: GitHub
• URL: https://github.com/itsamirhn/chess
• Owner: itsamirhn
• License: mit
• Created: 2022-03-15T05:40:08.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-08T11:23:30.000Z (5 months ago)
• Last Synced: 2024-06-08T12:34:52.771Z (5 months ago)
• Language: Java
• Homepage: https://itsamirhn.github.io/Chess/
• Size: 1.25 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Chess

![Maven](https://github.com/itsamirhn/Chess/actions/workflows/maven.yml/badge.svg)

![Release](https://github.com/itsamirhn/Chess/actions/workflows/release.yml/badge.svg)

A Fully Object-Oriented Chess, written in pure Java

## Table of Contents

1. [Features](#features)

2. [Demo](#demo)

3. [Documentation](#documentation)

4. [Run Locally](#run-locally)

5. [Running Tests](#running-tests)

6. [Project Structure Diagrams](#project-structure-diagrams)

7. [License](#license)

## Features

- Support Custom [FEN](https://en.wikipedia.org/wiki/Forsyth–Edwards_Notation)

- Multiplayer

- Undo Move

- Plays sound

- Support Stalemate and Checkmate edge Cases

- Support [En Passant](https://en.wikipedia.org/wiki/En_passant) Move

## Demo

![Demo](demo.gif)

## Documentation

You can visit the online Documentation on here: [Documentation](https://itsamirhn.github.io/Chess)

Also the project structure diagrams are available in the [Project Structure Diagrams](#project-structure-diagrams) section

## Run Locally

1. Install JRE 21 or higher

2. Download the latest `Chess.jar` file from [releases page](https://github.com/itsamirhn/Chess/releases)

3. Run the following command:

```bash

  java -jar Chess.jar

```

## Running Tests

The project use [Maven](https://maven.apache.org/) as build automation tool. To run tests, run the following command:

```bash

  mvn test

```

## Project Structure Diagrams

### Logic

- Game Classes:



- Pieces Classes:



- Moves Classes:



### GUI

This project follows the [Model-View-Controller](https://en.wikipedia.org/wiki/Model–view–controller) design pattern. The GUI part of the project is implemented using Java Swing.

- GUI Classes:



## License

![MIT](https://img.shields.io/badge/license-MIT-blue)

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details