term-monopoly

A CS 3110 project by

• Anmol Kabra: Frontend GUI Developer
• Jehron Petty: Frontend GUI Developer
• Jared Junyoung Lim: Backend AI Developer
• Marina Chang: Backend State Developer

Special thanks to CS 3110 Fall 2017 course staff for the course.

What is this?

term-monopoly is a terminal-based framework in OCaml for the Monopoly game, using which upto 8 users can play Monopoly. We also provide 3 AI agents with differing difficulty, and it is possible for multiple AI agents to play with each other. Developers could program new AIs based on the framework, and edit the source code to challenge the players.

Some monopoly boards (classic.json and 3110.json) are provided to get you started on the game.

Salient features:

• Terminal-based framework to allow customizable Monopoly boards.
• The terminal GUI provide a user-friendly interface to actions and views in the game.
• 3 AI agents with AI3 as the most advanced game player.
• Modular structure for developers to add more AI agents.

How to play?

UPDATE: The game has switched to compiler version 4.06.0 and OUnit 2.0.7.

Tested with OPAM 1.2.2, OCaml 4.06.0 compiler, and OUnit 2.0.7 on Linux and OSX platforms.

To install dependencies:

Install OPAM version 1.2.2 and OCaml 4.06.0 compiler as described here. The game might work on other versions as well. Then install the third-party dependencies for the game (most should have been installed by the OCaml install as described in that page):

make install-dep

To compile and run the game:

From the directory containing all the files,

make
# or
make game

Instructions:

The game is played by pressing the keys corresponding to the actions displayed in the GUI. The key presses are case sensitive, for example a capital 'N' is entered by pressing the 'n' and 'shift' keys simultaneously. Windows with scroll bars can be scrolled Using the page up/page down keys. In some terminals, scrolling also works using a mouse.

Upon starting a new game, the GUI will request a game file. The available full game files to play are:

• classic.json – (based on the American monopoly board)
• 3110.json – (based on the CS 3110 Fall 2017 schedule)

The following small testing files are also available:

• test_board.json – (minimal file containing one of each type)
• test_board_2.json - (slightly extended version of test_board)
• test_board_railroads.json - (file with only railroads and jail)
• test_board_jail.json - (file with only spaces and cards related to jail)

All the game board files are required to be in the boards/ directory.

The players for the game can be selected from the following types of controllers:

• Human Player - uses key inputs to determine which actions to take
• AI1 - uses a very simple AI to determine which actions to take
• AI2 - uses a smarter AI to determine which actions to take
• AI3 - uses a complex AI to determine which actions to take

How to simulate AI's?

In order to simulate AI game play, follow the make command written in the bottom of this readme.

Upon starting the simulation, the simulation module will ask for a simulation file.

A simulation file should follow the following template:

[json file name]
[number of simulations]
[number of players]
[player1 type]:[AI level]
[player2 type]:[AI level]
[player3 type]:[AI level] # optional
...
[player8 type]:[AI level] # optional

One example of simulation file can be:

classic.json
1000
2
battleship:AI1
racecar:AI2

All the simulation files are required to be in the sim_files/ directory, and all the simulation results are suggested to be in the sim_results/ directory.

Makefile usage

1. make or make game -> Make and run the game.
2. make check -> Check the OPAM env and types, and compile the game.
3. make clean -> Clean the _build/ directory.
4. make test -> Make the test file and run it.
5. make sim -> Simulate the game using AI.
6. make install-dep -> Install dependencies for this project.