Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 4.29 KB

README.md

File metadata and controls

100 lines (76 loc) · 4.29 KB
Raw

Logo

ChessMaster

Chess finally makes it to your terminal.
View User Guide · View Developer Guide · About Us

ChessMaster is a command-line interface (CLI) chess game designed to make learning and training accessible for beginners while offering an engaging experience for all skill levels. This simple and user-friendly chess simulator provides a platform for novice players to build their skills and understanding of the game.

This project was created for the CS2113: Software Engineering and Object-Oriented Programming team project and is programmed in 100% Java.

Getting started

  1. Ensure you have Java 11 or above installed in your system.

  2. Download the latest version of ChessMaster.jar from here.

  3. Open a terminal instance and navigate into the folder that contains the downloaded ChessMaster.jar file.

cd PATH_TO_JAR_FILE
  1. Run the jar application with the following command:
java -jar ChessMaster.jar

You should be greeted by a welcome message from ChessMaster:

_________________________________________________________________

Hey there, chess geek! You have stumbled upon the one and only:
    ________                      __  ___           __
   / ____/ /_  ___  __________   /  |/  /___ ______/ /____  _____
  / /   / __ \/ _ \/ ___/ ___/  / /|_/ / __ `/ ___/ __/ _ \/ ___/
 / /___/ / / /  __(__  |__  )  / /  / / /_/ (__  ) /_/  __/ /
 \____/_/ /_/\___/____/____/  /_/  /_/\__,_/____/\__/\___/_/

where CHESS becomes an exciting journey of strategy and skill!
_________________________________________________________________

Usage

A summary of user commands can be found in the table below:

Action Format
Move move [column][row] [column][row]
Show moves moves [column][row]
Show board show
Rules rules
Help help
Pieces legend legend
History history
Step back stepback
List pieces captured
Exit exit

Please visit our User Guide for further details on each of these commands.

Contributing

Contributors Commits Issues PRs

All contributions are greatly appreciated! If you have a suggestion that would make this better, please fork the repo and create a pull request.

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

Contact

Please visit our About Us page for further contact information.

Project Link: https://github.com/AY2324S1-CS2113-T18-1/tp