Year 2 Sussex Settlers
This project is a version of the Settlers "Catan" game written in Python for the team15 Software Engineering Project. The game itself is turn based similar in parts to monopoly but mainly more focused on resources and building roads across the world map. For a detailed explanation of the game rules and concepts please refer to this document. Please read the documentation here before starting the game on your machine and playing the game.
In order to run this on your personal machine be sure to download the repository as a zip file and save on your own machine. Then unzip the folder and open using an IDE of your choice, for example VSCode. Alternatively you can just clone the repository and input the link in the appropriate section within your IDE. Finally run main.py to start the game and display the pygame window from which you can play the game.
In order to install the correct modules run this code in the terminal.
pip install -r requirements.txt
There are several unit tests that have been written for this project stored inside the testing folder. The tests in the aforementioned files are unit tests that test all functionality of the relevant classes , in order to run these tests follow this instruction:
- Write the command
pytest 'test_file.py'
The terminal will then output the test results detailing how many tests have passed/failed and any accompanying error messages. But if you wish to run all tests at once enter this command into the terminal:
pytest
- Morgan Plant
- Eddie Jones
- Yash Magane
- Noah Davy
- Ryan Moss
- Wai Hang Nelson Chan