From 75d8d5220c5ad163cffbad2da90ddd8eb47a51ee Mon Sep 17 00:00:00 2001 From: Speedy Gonzalez Date: Fri, 10 Dec 2021 09:08:31 +0100 Subject: [PATCH] the readme of Siedler of catan has been written. --- README.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a33f4b7..9871bab 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,8 @@ number that the player rolled with the dice. Now as for the commands a player has to put in while it's their turn: #Build Settlement When it's the players turn, they can build a new settlement by giving the command -build settlement. with that they will be asked where they want to build said settlement -and the program will check if those coordinates are available or not. Then the +build settlement. With that they will be asked where they want to build said settlement +and to enter the coordinates, then the program will check if those coordinates are available or not. Then the program will subtract the resources needed to build a settlement. If the player has insufficient resources the settlement will not be built and an error message will appear. The turn of the current player will continue until the player ends it. @@ -53,5 +53,33 @@ the program will subtract them of the players resources, otherwise the city won' be build and the player continues their turn until they end it. #Build Road -build road +During the current players turn, the player can build a new road by giving the +command build road. Then the player will be asked to give the coordinates for where +they want to build the new road after entering the coordinates the program will +check to see if they are valid coordinates and if they aren't occupied. +If the coordinates are checked and there was no error message, then the program +will check if the player has enough resources to build the road if they do the +program will then subtract the amount of resources of the player. If they do not +have enough resources the road will not be built and the player will receive +an error message. The player continues their turn until they end it. + +#Trade with Bank +The current player can trade resources with the bank by entering the command +trade with bank. The player then can enter what and how many resources they want +then they have to enter what resources they will give in return. The trade course +for the resources is set to 1:4. That means the player will have to give 4 resources +trade for one of their choosing from the bank. If they do not have enough resources +to give the trade will not be completed and the player may continue their turn. + +#Next Player +When the current player has done all the building and trading they wanted and now +want to end their turn they can end it by entering the command next player. By entering +this command the player relinquishes their turn and the next player may start their +turn. + +#Quit +If a player wants to quit the game they can enter the command quit while it's their +turn to quit the game. + +#Class Diagram