Skip to content

Latest commit

 

History

History
126 lines (90 loc) · 4.1 KB

README.md

File metadata and controls

126 lines (90 loc) · 4.1 KB

Contributors Forks Issues


Table of Contents
  1. Abstract
  2. Team Members
  3. Downloads
  4. Getting Started

Abstract

Virtual Chess is a Java based application that allows two players to play against each other and also allows a single user to play a game against a computer opponent. Users have the options to select customizable settings such as a turn timer of adjustable length, the option to undo moves, and option to select their favourite theme for the chess board. Users can also turn on hints for an ideal move while playing the game. After finishing the game, users can also see their results from the leaderboard. For users, who are new to chess have the option to learn chess from this application. Our application provides a good user experiece, and is ideal for players from all skill levels.

(back to top)

Team Members

Aidan Cuff

Kenneth Fonseca

Matt Gibson

Nick Rucinski

Toker Ahmed

Downloads

  1. Make sure Java 21 is installed on your machine https://www.oracle.com/java/technologies/downloads/#java21
  2. Go to the releases and download the latest release https://github.com/cis3296s24/03-VirtualChess/releases
  3. Run the chess.jar and play!
  4. If you plan to use Stockfish you may need to download the Stockfish executable from https://stockfishchess.org/download/ As of now, there are executables for some Macs, Windows, and Ubuntu currently If you need to add one place it in the Stockfish folder in the same directory as VirtualChess.jar and rename it the same as one of the other ones

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

  1. Make sure Java 21 is installed on your machine https://www.oracle.com/java/technologies/downloads/#java21
  2. Clone the repo 
    git clone https://github.com/cis3296s24/03-VirtualChess.git
  3. Run the maven build script to download all dependencies

(back to top)

Contributing

How to contribute to the project

  1. See Installation
  2. Create your Feature Branch (git checkout -b YourName/Feature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Documentation

Click here to view the full documentation for Virtual Chess: https://github.com/cis3296s24/03-VirtualChess/tree/main/documentation

(back to top)