Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
- Fixed poor writing
- Added sections/subsections
- More information about usage, setup and software.
  • Loading branch information
mailtelenko authored Nov 14, 2018
1 parent 3be48ec commit 396adc3
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
# TuringCatan
The Settlers of Catan board game as a Turing program.
*A local multiplayer Settlers of Catan computer game written in Turing.*

This was a final Engineering assignment.
Have fun I guess.
## About
TuringCatan was a final grade 10 engineering assignment designed to be educational for children aged 10+. The game teaches resource management, communication skills, and risk management in a fun and simple manner.

**Note**
You must hit the enter key after typing a name on the setup screen.
You can play with either 3 or 4 players, however to play with 3 you must click enter on the player 4 input field.
## Usage
### Installation
1. Download the repo and unzip all files into the same folder.
2. Download and run Holtsoft's Turing compiler (tested & working on version 4.1.1)
3. Open ```The Settlers of Catan.t``` and click "Run"

Get the Turing compiler here:
http://compsci.ca/holtsoft/
The (discontinued) Turing compiler can be downloaded for free from: http://compsci.ca/holtsoft/.

### Setup
When entering player names the enter key must be hit within ever player name input field before continuing.
To play the game with only 3 users, enter the player names and then hit enter in the blank player 4 input field before clicking continue.

### Gameplay
The game is played locally with 3-4 players using keyboard and mouse input. General game rules are included in the game, however they are not always followed exactly in gameplay. Exceptions include:
- Resources are not lost when a 7 is rolled
- The robber moves randomly
- There are no development cards

## License
TuringCatan is licensed under the MIT License. For more information please see the LICENSE.md file located in the root of this repository.

0 comments on commit 396adc3

Please sign in to comment.