Go to file
schrom01 1575c1b353 added javaDoc in Bank.java 2021-12-10 21:59:11 +01:00
.idea renamed Method getTextView to toString in SiedlerBoard 2021-12-10 18:06:43 +01:00
doc added Coordinates to README.md 2021-12-10 11:47:18 +01:00
lib Add files via upload 2021-11-19 08:32:32 +01:00
src/ch/zhaw added javaDoc in Bank.java 2021-12-10 21:59:11 +01:00
test/ch/zhaw reformat Code in SiedlerGameTest 2021-12-10 20:15:48 +01:00
.gitignore Merge remote-tracking branch 'origin/main' into main 2021-12-04 12:59:31 +01:00
README.md changes in README.md 2021-12-10 13:09:26 +01:00
gruppe06-hufflepuff-projekt3-catan.iml add untracked files 2021-11-19 10:54:49 +01:00

README.md

Siedler of Catan

Siedler of Catan is a multi-player-roleplay game, that lets you build roads, settlements and cites in the world of region of catan. You have to try to build as many roads, settlements and cities as you can to get points. It is also a strategic game where you have to choose wisely where to build your structures, to be able to dominate your friends.

#Rules

  1. The minimum Player amount is 2 and the maximum Player amount is 4.
  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 the game. After the placement, each player gets resources from the field around the second settlement.
  4. Every Player is being sorted into a faction. There cannot be two players in the same faction.
  5. A player cannot build two settlements or cities right next one another. There have to be at least two roads between them.
  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 will be awarded two additional points.
  8. If a player rolls a 7 on a dice throw, then the resources of every player that has more than 7 resources will be halved. The resources that are being taken are chosen 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

#Usermanual First the program will ask how many players will be playing the game. The minimum amount of players is 2 and the maximum amount of players is 4. Each player will 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 after every player has built a settlement and road, they can build a second settlement and road in reversed order. When the players build their second settlement they then receive the resources surrounding that specific settlement. 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 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.

#1. Next Player next player Ends a players turn

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.

#2. Build Settlement build settlement Builds a 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 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.

#3. Build City build city Builds a city

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 build city. Then they have to add the coordinates that they want the city to be built at. If the coordinates are available and the settlement at that coordinate is 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.

#4. Build Road build road Builds a 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 of the start corner and the end corner 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.

#5. Trade with 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 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.

#6. Quit 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 turn to quit the game.

#Coordinates

Coordinates

#Class Diagram

Class Diagramm