- Author: Cameron Wright, Spencer Saunders, Madeline Ross
- Class: CS354 [Programming Languages]
- Spring Semester Year 2018
Command line implementation of Chess using the interpreter language Lua.
| Filename | Description |
|---|---|
| README.md | This file |
| FinalReport/ | Directory containing final report |
| proposal/ | Directory contaning proposal |
| src/ | Directory contaning source code |
| src/pieces/ | Directory containing pieces |
| src/pieces/ChessGame.lua | Chess Game implementation |
| src/pieces/Board.lua | Board implementation |
| src/pieces/test.lua | testing program |
| src/pieces/Square.lua | Square implementation |
| src/pieces/Bishop.lua | Bishop implementation |
| src/pieces/King.lua | King implementation |
| src/pieces/Knight.lua | Knight implementation |
| src/pieces/Pawn.lua | Pawn implementation |
| src/pieces/Queen.lua | Queen implementation |
| src/pieces/Rook.lua | Rook implementation |
For the group's Lua implementation of Chess, a Board object is created in the ChessGame class. The Board object call's the function initialize which creates a 2D table, reserves positions for all the pieces, and occupies the reserved positions with piece objects. All of the individual pieces are created using OOP and inheritance from the parent class Piece. The Board object is printed out to the console and the user is prompted to enter a specific character based off of the printed options in order to advance the game. The player can choose to print the board, check if a move is valid, check available moves, make a move, or get the pieces on the board. The game will keep alternating between players until the function isKingCheckMated equates to true.
Lua is an interpreted language, the Lua website allows either the downloading of the source code or binary files. Here is the main website detailing installation but for convince look below for links depending on OS.
This repository on Github gives an exe that allows Lua to be installed and able to be run from Powershell.
From terminal use brew install lua
From terminal use yum install lua
From the directory src containing the .lua source code, run the program:
lua ChessGame.lua
User Commands:
- M to move piece
- P to print board
- V to check if move is valid
- H for help
- Q to quit
Board Setup:
8 7 6 5 4 3 2 1
+ ---------------
8| r k b $ q b k r
7| p p p p p p p p
6| * * * * * * * *
5| * * * * * * * *
4| * * * * * * * *
3| * * * * * * * *
2| P P P P P P P P
1| R K B # Q B K R
p/P = Pawn
r/R =Rook
k/K = Knight
b/B = Bishop
q/Q = Queen
$/# = King
* Open Space
Lowercase is black pieces, Uppercase is white pieces.
Testing was done as simple scripts ran to create and test pieces, board, etc. This was done to make sure that classes did not have any syntax errors and could find other classes in other files.
Choosing Lua to implement Chess turned out to be a harder-than-expected effort given the misleading marketing that claimed Lua supported full-fledged OOP. Without this support, the third-party library middleclass was the backbone of the Chess implementation. Throughout the workload of the project, the good-sized amount of documentation and tutorials the Lua development team put out helped navigate the group through the project. Lua certainly has its niche appeals primarily has a scripting language for popular video games like Roblox, but the group didn't see themselves using Lua again in the foreseeable future.