Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.59 KB

INSTALL.md

File metadata and controls

63 lines (41 loc) · 2.59 KB
Raw

System Requirement

OCaml 4.11.1

The game may work on other versions, but we have only tested it on this version.

Packages needed

  • ANSITerminal
  • Lablgtk
  • Graphics
  • Camlimages

Package Installation Instructions

To install lablgtk, graphics and camlimages on MacOS:

brew install gtk+
export PKG_CONFIG_PATH=/opt/X11/lib/pkgconfig
opam install lablgtk
opam install graphics camlimages

You might get an error saying that you need pkg-config. In that case, you should run

sudo chown -R $(whoami) /usr/local/lib/pkgconfig /usr/local/share/info

To install lablgtk, graphics and camlimages on Windows:

  • Create a new switch using the instructions on the 3110 Canvas site
  • When you reach the opam install... part of the instructions, replace that command with
opam install -y utop ounit qcheck ocaml-lsp-server ocamlformat yojson ansiterminal csv bisect_ppx-ocamlbuild menhir graphics lablgtk camlimages user-setup

How to run this game locally

  • Clone this repository
  • cd to the cloned folder
  • run make play to start the game in terminal
  • run make gui to start the GUI

To run the GUI on Windows:

  • Install Xming, Xming fonts, and PuTTY
  • Follow the instructions on this website.
  • Instead of typing "textbox" as host name (as detailed in the above instructions), run nslookup <ip address> where <ip address> is your IP address. You can find your IP address by googling "what is my IP address?"
  • Copy the text that follows "name:" and paste it into the host name field (instead of "textbox").
  • Open the session in PuTTY, and you should be able to run the gui by running make gui in terminal.

How to play the game in terminal

Once the game is started, you can move a piece by entering move <starting position> <ending position> where the start/end positons are strings that contain a character followed by an integer. To determine the correct starting postion and ending position of your move, use the board's grid system.

For example move c3 c4 moves the piece located in square c3 to square c4.

To end the game, you can run forfeit when your player is prompted to make a move.

How to play the game in the GUI

The white player starts. Move a piece by clicking on the square that has the piece that you want to move on it, and then click on the square that you want to move that piece to.