ZHAW-IT21b_WIN
/
gruppe06-hufflepuff-projekt3-catan
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improved Readme

This commit is contained in:
Leonardo Brandenberger 2021-12-10 21:35:42 +01:00
parent 3740cc175e
commit c8cbd1cacc
1 changed files with 33 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -1,5 +1,5 @@
# Siedler of Catan # Siedler of Catan
Siedler of Catan is a multi-player-roleplay game, that lets you create settlements, Siedler of catan is a multi-player-roleplay game, that lets you create settlements,
build roads and upgrade settlements to cites in the world of catan. build roads and upgrade settlements to cites in the world of catan.
You have to try to get the required amount of winpoints as fast as possible to come out as the winner. You have to try to get the required amount of winpoints as fast as possible to come out as the winner.
You collect winpoints by owning settlements and cities and even get an extra two for owning the longest road. You collect winpoints by owning settlements and cities and even get an extra two for owning the longest road.
@ -18,12 +18,13 @@ There have to be at least two roads between them.
7. The player with the longest road (most roads connecting to one another), which is longer than 4 7. The player with the longest road (most roads connecting to one another), which is longer than 4
will be awarded two additional winpoints. will be awarded two additional winpoints.
8. If a player rolls a 7 on a dice throw, all player that are holding more than 7 resources, 8. If a player rolls a 7 on a dice throw, all player that are holding more than 7 resources,
will lose half of all their resources. The resources that are being taken are chosen will lose half of all their resources. The resources that are being taken are chosen randomly.
by random. 9. Winpoints get awarded as following: (Settlement: 1), (City: 2), (Longest Road: 2)
For a more detailed version of the rules please look here: https://www.catan.de/sites/prod/files/2021-06/CATAN_DasSpiel_Spielregel.pdf For a more detailed version of the rules please look here: https://www.catan.de/sites/prod/files/2021-06/CATAN_DasSpiel_Spielregel.pdf
#Usermanual #How To Play
Setup Phase: Setup Phase:
1. Enter the number of players that will be playing. (min 2, max 4) 1. Enter the number of players that will be playing. (min 2, max 4)
2. Enter the number of winpoints needed to win the game. (min 3) 2. Enter the number of winpoints needed to win the game. (min 3)
@ -38,62 +39,52 @@ Navigate in the Game Phase:
>It is your turn as soon as the console shows it is your turn. >It is your turn as soon as the console shows it is your turn.
>To execute an action type in the associated number of the command, which is showed in the terminal. >To execute an action type in the associated number of the command which is showed in the terminal.
Same applies when asked about resources. Same applies when asked about resources.
> Note that the dice throwing gets done automatically before each turn,
and you get informed in the console which number has been chosen.
The resources will also be added to the corresponding factions automatically.
>You can do as many Commands as you like per turn. If decide to finish your turn, you can do so using the next player command.
#Avaible Commands: #Avaible Commands:
>``next player`` Ends a players turn and the next player turn will be started >``next player`` Ends a players turn and the next player turn will be started
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 choosing
the command the player finishes their turn and the next player is at turn
>``build settlement`` Builds a settlement at the chosen location. >``build settlement`` Builds a settlement at the chosen location.
When it's the players turn, they can build a new settlement by giving the command You will be prompted to give coordinates for the settlement. If the coordinates are valid
build settlement. With that they will be asked where they want to build said settlement and comply with all siedler rules a settlement of your faction will be build on the map.
and to enter the coordinates, then the program will check if those coordinates are available or not. Then the If the coordinates aren't a valid position you will be prompted to input them again.
program will subtract the resources needed to build a settlement. If the player has If there is an illegal move for example not enough resources or invalid field an error will be shown.
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.
>``build city`` Builds a city at the chosen location. >``build city`` Builds a city at the chosen location.
During the players turn they can build a city on the same coordinates that they You will be prompted to give the coordinates for an existing settlement. If the coordinates are valid
have already built a settlement on. To do that they have to enter the command and comply with all siedler rules a city of your faction will be build on the map.
build city. Then they have to add the coordinates that they want the city to be If the coordinates aren't a valid position you will be prompted to input them again.
built at. If the coordinates are available and the settlement at that coordinate is If there is an illegal move for example not enough resources or invalid field an error will be shown.
of the same faction as the player then the city can be built there. The program
will then check if the player has sufficient resources to build the city, then
the program will subtract them of the players resources, otherwise the city won't
be build and the player continues their turn until they end it.
>``build road`` Builds a road at chosen location. >``build road`` Builds a road at chosen location.
During the current players turn, the player can build a new road by choosing the You will be prompted to give two coordinate sets, the first coordinate of the start of the road and the second one
command build road. The player will be asked to give the coordinates of the start corner and the end corner for where of the end of the road.If the coordinates aren't a valid position you will be prompted to input them again.
they want to build the new road after entering the coordinates the program will If there is an illegal move for example not enough resources or invalid field an error will be shown.
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`` Starts the trade with the bank >``trade with bank`` Starts the trade with the bank
The current player can trade resources with the bank by entering the command You will first be prompted to input the resource that you offer.
trade with bank. The player then can enter what and how many resources they want Afterwards you will be prompted to input the resource that you would like to receive.
then they have to enter what resources they will give in return. The trade course The Trade is in a 4 to 1 ratio, meaning that you give 4 resources to receive 1.
for the resources is set to 1:4. That means the player will have to give 4 resources If you own the needed resources the trade will be completed.
trade for one of their choosing from the bank. If they do not have enough resources If the bank doesn't have your desired resource, or you don't own enough resources of the one to give,
to give the trade will not be completed and the player may continue their turn. an error message will be shown.
>``quit`` Quits the game completely. >``quit`` Quits the game completely.