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

Improved Readme a little, more room for improvement still.

This commit is contained in:
Leonardo Brandenberger 2021-12-10 19:37:37 +01:00
parent 8a5dab76e4
commit 204025662d
1 changed files with 42 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -1,53 +1,58 @@
# Siedler of Catan # Siedler of Catan
Siedler of Catan is a multi-player-roleplay game, that lets you build roads, Siedler of Catan is a multi-player-roleplay game, that lets you create settlements,
settlements and cites in the world of region of catan. You have to try to build build roads and upgrade settlements to cites in the world of catan.
as many roads, settlements and cities as you can to get points. It is also a You have to try to get the required amount of winpoints as fast as possible to come out as the winner.
strategic game where you have to choose wisely where to build your structures, You collect winpoints by owning settlements and cities and even get an extra two for owning the longest road.
to be able to dominate your friends. It is also a strategic game, so you will have to choose wisely where to place your Structures.
#Rules #Rules
1. The minimum Player amount is 2 and the maximum Player amount is 4. 1. The minimum Player amount is 2 and the maximum Player amount is 4.
2. The minimum amount if win points is 3. 2. The minimum amount if win points is 3.
3. Each Player can build two roads and two settlements free of cost at the beginning of 3. Each Player can build two roads and two settlements free of cost at the beginning of
the game. After the placement, each player gets resources from the field around the second settlement. the game. After placing the second settlement the players will each receive the resources from around the second settlement.
4. Every Player is being sorted into a faction. There cannot be two players in the 4. Every Player receives a faction. There cannot be two players in the
same faction. same faction.
5. A player cannot build two settlements or cities right next one another. 5. A player cannot build two settlements or cities right next one another.
There have to be at least two roads between them. There have to be at least two roads between them.
6. The cost for each structure is set and is nonnegotiable. 6. The cost for each structure is set and is nonnegotiable.
7. The player with the longest road (most roads connecting to one another), which is longer then 4 7. The player with the longest road (most roads connecting to one another), which is longer than 4
will be awarded two additional points. will be awarded two additional winpoints.
8. If a player rolls a 7 on a dice throw, then the resources of every player that has 8. If a player rolls a 7 on a dice throw, all player that are holding more than 7 resources,
more than 7 resources will be halved. The resources that are being taken are chosen will lose half of all their resources. The resources that are being taken are chosen
by random. by random.
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 #Usermanual
First the program will ask how many players will be playing the game. The minimum Setup Phase:
amount of players is 2 and the maximum amount of players is 4. Each player will 1. Enter the number of players that will be playing. (min 2, max 4)
be appointed to a faction. In the next step, the program ask for the number of win points. The first player who reaches this number of win points, will win the game. Now every player can build a settlement and a road 2. Enter the number of winpoints needed to win the game. (min 3)
after every player has built a settlement and road, they can build a second 3. Each player is given a faction it is your as soon as the console says it is your faction's turn.
settlement and road in reversed order. When the players build their second 4. Every Faction will receive the possibility to place a settlement with a corresponding road. (no resource cost)
settlement they then receive the resources surrounding that specific settlement. 5. Play order is reversed and every faction receives a second settlement and a road to place. (no resource cost)
Now that the setup is complete the next player can start with the first dice throw. After the players have rolled the dice the fields connected to the Each faction will afterwards receive the resources surrounding the second settlement.
number that the player rolled with the dice will pay the associated resources to the players who have placed a settlement on a corner around of the field.
If the settlement is upgraded to a city, the player gets two of the appropriate resource.
To execute a action type in the associated number of the command, which is showed in the terminal. After the setup phase the game phase will begin and continue until a winner emerges or the game gets quit via the quit command.
#1. Next Player Navigate in the Game Phase:
``next player`` Ends a players 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.
Same applies when asked about resources.
#Avaible Commands:
>``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 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 want to end their turn they can end it by entering the command next player. By choosing
this command the player relinquishes their turn and the next player may start their the command the player finishes their turn and the next player is at turn
turn.
#2. Build Settlement
``build settlement`` Builds a settlement >``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 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 build settlement. With that they will be asked where they want to build said settlement
@ -56,8 +61,8 @@ program will subtract the resources needed to build a settlement. If the player
insufficient resources the settlement will not be built and an error message will 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. appear. The turn of the current player will continue until the player ends it.
#3. Build City
``build city`` Builds a city >``build city`` Builds a city at the chosen location.
During the players turn they can build a city on the same coordinates that they During the players turn they can build a city on the same coordinates that they
have already built a settlement on. To do that they have to enter the command have already built a settlement on. To do that they have to enter the command
@ -68,11 +73,11 @@ 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 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. be build and the player continues their turn until they end it.
#4. Build Road
``build road`` Builds a road
During the current players turn, the player can build a new road by giving the >``build road`` Builds a road at chosen location.
command build road. Then the player will be asked to give the coordinates of the start corner and the end corner for where
During the current players turn, the player can build a new road by choosing the
command build road. The player will be asked to give the coordinates of the start corner and the end corner for where
they want to build the new road after entering the coordinates the program will 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. 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 If the coordinates are checked and there was no error message, then the program
@ -81,8 +86,7 @@ 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 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. an error message. The player continues their turn until they end it.
#5. Trade with Bank >``trade with bank`` Starts the trade with the bank
``trade with bank`` Let's the player trade resources with the bank
The current player can trade resources with the bank by entering the command 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 trade with bank. The player then can enter what and how many resources they want
@ -92,10 +96,9 @@ trade for one of their choosing from the bank. If they do not have enough resour
to give the trade will not be completed and the player may continue their turn. to give the trade will not be completed and the player may continue their turn.
#6. Quit >``quit`` Quits the game completely.
``quit`` Let's a player quit the game
If a player wants to quit the game they can enter the command quit while it's their If a player wants to quit the game they can choose the command quit while it's their
turn to quit the game. turn to quit the game.
#Coordinates #Coordinates