cs3520-proj

This is the final project for Joshua (duck_master), Samuel (ay136416), and Andrew (turingproblem) for CS3520: Introduction to C++. It aims to implement the game of chess.

File structure

Files and folders checked in:

• .vscode: VS Code-specific configuration files.
• cxxtest: The CXXTest source code, albeit with a few bugfixes of our own
• include: for header (.hpp) files, looked in for #include
• src: for source (.cpp) files, everything here will get compiled/linked (src/main.cpp provided)
• test: for test source code using CxxTest
• res: for resources (e.g. images); currently only has .gitkeep
• .clang-format
• .clang-format-ignore
• .gitignore
• Doxyfile: configuration for Doxygen (currently unused)
• Makefile
• MoSCoW.txt: short description of completed work
• README.md: this very file
• SETUP_ONCE.sh: currently blank

Folders left out:

• build: where created intermediate (e.g. object) files go
• bin: where created executables go
• doc: where generated documentation (Doxygen) goes

Classes implemented

With the exception of include/Errors.hpp and include/res_path.hpp, every .hpp file declares an eponymous class (for example include/AbstractPlayer.hpp declares the AbstractPlayer class). The include/Errors.hpp file defines two error classes - NotImplementedError and UnknownPiece - that we use downstream for error conditions.

This repo defines the following classes:

• AbstractPlayer
• ChessBoard
• GameStatus
• Move
• Piece
  • Bishop
  • King
  • Knight
  • Pawn
  • Queen
  • Rook
• Player
  • HumanPlayer
  • SamuelEngine
• PlayerState
• Square

Making

The Makefile is set up to build all .cpp files in the src folder and create executables in bin/main. To just build the release executable, run make exe. Note that make -j runs about 2.5x faster than make alone (you can verify this by running time make 1>/dev/null and time make -j 1>/dev/null). Similarly, make -j bin/test runs about 2.5x faster than make bin/test, and this is useful for debugging.

Configurations:

• rel: for speed
• deb: for debugging
• cov: for code coverage (with gcov)
• prf: for performance analysis (with gprof)

SDL (to come later)

Will Usher's SDL 2.0 Tutorial can be found here: https://www.willusher.io/pages/sdl2/.