You have to create Zappy, which is an entirely automatic game where some AI's play amongst themselves. It is about creating families, surviving by eating food and collecting stones in order to level up. Each level has different requirements for a ritual, which makes the adventure more and more difficult for the AI players, which play on their own, without any help form their creator. The game is over once six members of one family reach the highest possible level (8).
You have to create Zappy, which is an entirely automatic game where some AIs play amongst themselves. It is about creating families/teams, surviving by eating food and collecting stones in order to level up. Each level has different requirements for a ritual, which makes the adventure more and more difficult for the AI players, which play on their own, without any help form their creator. The game is over once six members of one family/team reach the highest possible level (8).
### Game presentation
@ -18,86 +18,86 @@ Here are the different parts of the game:
#### Geography
- The game consists in managing an entire world and its population. That world, "Trantor" is geographically made of plains that have no height, no crater, no valley or mountains.
- The game consists in managing an entire world and its population. That world, "Minerth" is geographically made of plains, there won't be any obstacles on it.
- The game board represents the entire surface of that world, like a map. If a player exits on the right of the board, he will re-enter on the left.
- The game is played by teams. The winning team is the first one that will have its 6 players reach the maximum level.
### Resources
The location where we are is quite rich in resources, mining and food. All you need to do is to walk around and discover this wonderful food and many stones of various nature on the ground.
The place where we are contains many resources that can be used for your survival, what you have to do is just look for them and get them before other players do. Here you will find some stones and food that you will need if you want to survive and evolve.
- These stones are of 6 different types:
- Jade
- Peridot
- Amber
- Amethyst
- Garnet
- Ammolite
- These stones be of 6 distinct kinds:
- These resources must be randomly generated by the server, despite being random, the generation must have some logical rules, for example:
- linemate
- deraumere
- sibur
- mendiane
- phiras
- thystame
- You can't put all the stones in one square.
- You can't put more than one food per square.
- Only one stone of each type in a square. You can have up to 3 stones of different types in the same square.
- These resources must be randomly generated by the server, despite being random, the generation must have some logical rules.
These are just some examples of some rules. It's up to you to decide them, but be prepared to explain them to the auditors.
### Rules
### General Rules
- Each player starts with 10 food (1260 time units) and 0 stones.
- Each player starts with 10 food and 0 stones.
- Each player starts on level 1.
- As you level up, your player sight improves.
- You must eat to survive and not starve and die.
- You must collect stones to level up.
- Create a family of (at least) 6 and win the game.
- Hatch an egg if you need a spot in your family.
### The Trantorians Activities
The population of Trantor has two type of occupation:
- Get food to eat and not die of hunger.
- Look for stones, pick them up to create totems, have an elevation ritual and get to the next level.
Elevation is an important activity for Trantorians!
- To win the game you must have at least 6 players of your family/team at level 8.
### Player
- The local is pacific, he is neither violent nor aggressive, he is happy just looking for stones and feeding on the way.
- The local, is happy just looking for stones and feeding on the way, but don't be fooled by him, he can get greedy and kick you out of his way!
- He meets, without issues, other people on the same location and sees as far as the eye can see.
- It is impossible to guess the Trantorian orientation when crossing him.
- It is impossible to guess the Minerthian orientation when crossing him.
- The food that the Trantorian picks up is the only resource he needs to live.
- The food that the Minerthian picks up is the only resource he needs to live.
- One food unit allows him to survive 126 time units, so 126/t seconds. The more he picks up the more he lives.
- The Trantorian must also collect the stones in order to elevate, each level will require different combination of stones.
### Evolution ritual
### Elevation ritual
- The goal for everyone is to reach the top of the Minerthian hierarchy.
- The goal for everyone is to reach the top of the Trantorian hierarchy.
- The ritual that allows you to increase the Minerthian physical and mental capacities must be performed as follows:
- The ritual that allows to increase the Trantorian physical and mental capacities must be accomplished according to a particular rite. He needs to bring together on the same field unit (square):
It needs to gather in the same field unit (square):
- A combination of stones
- A certain number of players of the same level
- A specific set of stones.
- A specific number of players of the same level.
- The player will start the incantation and the elevation will start. It is not necessary that all the players are on the same team. Only their collective levels matter. All players within the incantation group will reach the higher level.
- The player will start the enchantment and the evolution will start.
- It is not necessary that all the players are on the same team, but they need to have the same levels.
- All players participating in the enchantment will reach a higher level.
- Passed on from generation to generation, the secret to the elevation goes as such:
Here are the combinations of resources and players you need for the enchantment and evolution:
| Level | Number of Players | linemate | deraumere | sibur | mediane | phiras | thystame |
- For multiple reasons, the vision that the player has of the field is limited. With each elevation their vision goes up one unit of measure ahead and one on each side of a new row. Thus we obtain, for example, for the first 3 levels, the first two elevations, the following vision (our player is on 0):
- The player's view of the field is limited! In order to improve your vision you will have to level up.
With each evolution, your vision goes up one unit of measurement ahead and one on either side of a new line.
Here is the example for the first 3 levels (our player is at 0):
```console
@ -130,18 +130,18 @@ Elevation is an important activity for Trantorians!
```
For the player to know his surroundings, the `client` sends the command `SEE` and the server responds the following chain of characters (for level 1):
For the player to know what's around him, the `client` sends the command `SEE` and the server responds the following chain of characters (for level 1):
Our player doesn't even see himself, and if there is more than 1 object in a box, they are all indicated and separated by a space:
Our player cannot see himself and if there is more than 1 object in a square, they are all indicated and separated by a space:
```console
-------- -------- --------
| sibur | Phiras | |
| player | Phiras | |
| Amber | Garnet | |
| player | Garnet | |
-------- -------- --------
| |
| food |
@ -151,7 +151,7 @@ Our player doesn't even see himself, and if there is more than 1 object in a box
```
```console
{food, player sibur, phiras phiras, }
{food, player Amber, Garnet Garnet, }
```
### The Time and Game Speed
@ -163,58 +163,55 @@ The time unit is defined by the function 1/t :
- t is passed as parameter at the start of the server.
- A time unit lasts 1/t seconds.
- No active wait time will be tolerated.
- There cannot be any blocking when the clients are stopped, or in any phase of the game.
- The Trantorians have adopted an international time unit.
- Time unit is a second. If `t=1` “forward” takes 7 seconds. We choose by default, t=100. t is a integer.
- The time reference is absolute time.
- The Minerthians have second as an absolute time unit.
- `t` is an integer. If `t=1` "advance" takes 7 seconds. We choose by default, `t=100` then "advance" will take 1/100 seconds.
### Objects denomination
Only the classification of an object can be identifiable. It is therefore impossible to distinguish two objects of the same class. For example, two `siburs` will have the same denomination since they belong to the same class.
It is impossible to distinguish two objects of the same class, only the classification of an object can be identifiable,
that is, two 'ambers' will have the same denomination, as they belong to the same class.
### Teams
At the beginning a team is made of n player and only n. Each player is controlled by a client. The clients cannot communicate or exchange amongst each other data outside of the game, in any way.
At the beginning a team is made of `n` player and only `n`. Each player is controlled by a client. The clients cannot communicate or exchange amongst each other data outside of the game, in any way.
At the beginning the client has 10 life units, he can therefore survive 1260 time units, 1260/t seconds.
At the beginning the client has 10 food units, he can therefore survive 1260 time units, 1260/t seconds.
### Reproduction
A player can reproduce with the `fork` command. The execution of this command results in the production of an egg.
Executing the `fork` command results in the production of an `egg`, which allows for reproduction.
Once the egg is laid, the player that laid the egg can go around until it hatches. Once the egg has hatched, a new player comes out, and is given a random direction.
Once the egg is laid, the player who laid the egg can go to it and hatch it, when it hatches, a new player will be born and given a random direction.
This operation authorizes the connection of a new client.
The `connect_nbr` command returns the number of authorized and unauthorized connections for this team.
- Time to lay an egg: 42/t
- Time to lay the egg: 48/t
- Time for the egg to hatch 600/t
### Inventory
The command `inventory` allows you to see what objects the player has and how long it has to live. The server will send back for example the following line:
The `inventory` command allows you to see what objects the player has and how much time he has left. The server will send back, for example, the following line:
```
{food 345, sibur 3, phiras 5, ..., deraumere 0}
{food 300, Amber 4, Garnet 7, ..., Peridot 2}
```
### Kick
A player can expulse all the players sharing the same square. It pushes them in the direction he is looking at. When a client sends the `kick` command to the server, all the clients in this square receive the following line:
A player can kick all the players sharing the same square. It pushes them in the direction he is looking at. When a client sends the `kick` command to the server, all the clients in that square receive the following line:
```
moving <K>\n
```
With K indicating the direction of the square where the player comes from. Basically saying that you are getting out of that square.
With K indicating the direction the player is looking to, which is where the other players will be kicked. The kick only works for players, you can't kick food or other recourses.
### The commands
Each player responds to the following actions and only with the following syntax:
Here are the actions that a player will respond to and their syntax. Remember that the syntax must be the same as the following:
@ -222,91 +219,83 @@ Each player responds to the following actions and only with the following syntax
| turn right 90 degrees | right | 7/t | ok |
| turn left 90 degrees | left | 7/t | ok |
| see | see | 7/t | {square1, square2, ...} |
| inventory | inventory | 1/t | {phiras n, sibur n, ...} |
| take an object | take \<object> | 7/t | ok/ko |
| put down an object | put \<object> | 7/t | ok/ko |
| inventory | inventory | 1/t | {Garnet n, Amber n, ...} |
| pick an object | pick \<object> | 7/t | ok/ko |
| drop an object | drop \<object> | 7/t | ok/ko |
| kick a player from the square | kick | 7/t | ok/ko |
| broadcast | broadcast \<text> | 7/t | ok |
| begin the incantation | incantation | 300/t | elevation in progress |
| begin the enchantment | enchantment | 300/t | evolution in progress |
| | | | current level : K |
| fork a player | fork | 42/t | ok |
| fork a player | fork | 48/t | ok |
| know the number of unused connections by the team | connect_nbr | 0/t | value |
| death of a player | - | - | death |
All the commands are transmitted through a character string that ends with a newline.
In case of any unknown or bad command the server must respond "ko".
### Sound Transmission
Sound is a wave that moves in a linear manner.
All the players hear the broadcasts without knowing who emits them. They perceive only the direction the sound comes from and the message. The number of squares crossed by the sound before it arrives to the player indicates the direction. This numbering is done through the attribution of `1` to the square in front of the player, then a count down of the squares surrounding the player in the trigonometric direction (counter-clock wise). The world is round, therefore we will choose the shortest trajectory for the sound between the transmitter to the player for which we calculate.
The following example indicates the sound trajectory that we must choose, as well as the numbers of the squares around the player. The player receives the broadcast through square 3.
In case the broadcast is emitted from the same box as the receiving player, he will get the message from square 0
All commands are passed as a character string that ends with a newline.
In case of any unknown or incorrect command, the server must respond with "ko".
### Broadcast
To send a message, the client must send to the server the following command:
To send a message, the following command must be sent to the server by the client:
```
broadcast <text>
```
The server will send to all its client this line:
The server will send this line to all its clients:
```
message <K>,<text>
```
With K indicating the square where the sound comes from.
With K indicating the direction from where the sound comes.
### The Server
### Sound Transmission
All the players listen to the broadcasts without knowing who broadcasts them, what they understand from it, is only the direction from which the sound comes and the message.
The number of squares traversed by the sound before reaching the player indicates its direction.
This numbering is done by assigning '1' to the square in front of the player, then counting down the squares around the player in a trigonometric (counterclockwise) direction.
Remember, sound is a wave that moves in a linear manner and the world is round, so we'll choose the shortest path for sound between the transmitter and the player we calculated for.
The following example indicates the sound trajectory that we must choose, as well as the numbers of the squares around the player. The player receives the broadcast through square 3.
<!-- TROCAR?? -->
If the broadcast is sent from the same box as the receiving player, he will receive the message from square 0.
The server is the main engine that will interfere between the AI and the GUI. It will exchange all data with the AI and execute these instructions. At the same time, it send the information to the GUI. It can be written in one of these languages [C - C++ - Rust - Go].
### The Server
For this part, you must create a TCP server to make a connection between clients and manage the entire world:
The server is the main engine that will interfere between the AI and the GUI. It will exchange all data with the AI and execute these instructions. At the same time, it send the information to the GUI. It can be written in one of these languages [C, C++, Rust].
- The server port.
- The number of teams and their names.
- The dimension of the world map.
- The number of clients authorized at the beginning of the game.
For this part, you must create a TCP server to make a connection between clients and manage the entire world.
#### Server Instructions
- Your server must generate all the resources. The generation must be in a random way.
- Your server must generate all the resources in a random way following the rules mentioned above in the resources section.
- Any request to your server must never hang forever. It must never block, and the `client` can be appropriately bounced if necessary.
- The server executes the requests of the `client` in the order they are received.
- The server executes the `client` requests in the order they are received.
- The requests are buffered and the execution time of the command will only block the player concerned.
- It's forbidden to use any `exec` functions to run another server.
- It must stay available at all costs.
You are allowed to use threads but think outside of the box.
Although you can use threads, we don't advise it. The use of multiplexing connections on your server is a better option.
-h is the name of the host, the default is localhost
```
The client is autonomous, after its launch the user won’t influence its operation. He pilots a drone (player).
The client must send the command order to the server without any intervention from humans.
The client is autonomous, he must send the command order to the server without any intervention from humans.
### Client/server communication
The communication between client and server will happen via sockets and tcp. The port used must be indicated in the programs parameters.
The communication between client and server will happen via sockets and TCP. The port used must be indicated in the programs parameters.
The client will send its requests without waiting for their execution, the server sends back a "welcome" message confirming the successful execution of the requests.
The connection client to server will happen as such:
| Client's message | Command |
| :--------------: | :-----------: |
| | WELCOME\n |
| <team-name>\n | |
| | <nb-client>\n |
| | <x><y>\n |
The `nb-client` indicates the number of clients that can still be accepted by the server for the team `team-name`. If that number is greater than 1 a new client connects. X and Y indicate the world’s dimensions.
The `nb-client` indicates the number of clients that can still be accepted by the server for the team `team-name`. If that number is greater than 1 a new client connects. `X` and `Y` indicate the world’s dimensions.
If the team name passed by the client doesn't exist the server must print `"Error: the team <name of team> doesn't exist"`
> The client can send successively up to 10 requests without response from the server. Beyond 10 the server will no longer take them into account.
If a player/client join the game, it does not join as one character in the game, but as a family of six members in the form of one team.
> The client can send up to 10 successful requests without a response from the server. More than 10, the server will no longer take them into account.
There is no chat room or sharing of data between players. Still, the Player can broadcast a message through a command-line sent to the server, which will be broadcasted to all players; All details are in the sound transmission part.
The server executes the client requests in the order that they are received. The requests are buffered and the execution time of the command will only block the player concerned. `x` and `y` indicates the dimensions of the world.
### Graphic interface
To have a better vision of the game, which is simple, clear and ergonomic, the project will need to have a graphic visualization client. That client will propose a real-time representation of the world as it is on the server.
The Graphic part must be done with one of these languages:
- Javascript
- Python
- C
- C++
- Using any game Engine is forbidden!
- The interface must be at least in 2D with the use of icons allowing a representation of the world.
- You need to make sure you can see the in-game items.
- You need to implement the ability to click on a square to see its details, such as how many items of each are inside the square. It should look like a floating window, tooltip or something else.
- You need to make sure that the visualization of sounds is included.
- The interface will integrate at least a 2D visualization through icons allowing a representation of the world.
- You need to make sure that it is possible to visualize the items in the game.
- You need to implement the the possibility of clicking on a square to see the details of it, like how many of each items it has inside. It should look like a floating window, tooltip, or something else.
- You need to include the visualization of the sounds.
This can be developed in C, PHP, Perl, Python, etc. And will communicate within the network with the `server` to retrieve the content of the `map, teams, inventories, etc`. For example, everything needed to see what is going on in the game.
The graphic part can be developed in [Javascript, Python, C, C++, PHP, Perl, etc]. This will communicate within the network with the `server` to retrieve the contents of the `map, teams, inventories, etc`, everything that is needed to see what is happening in the game.
### BONUS
- Create a 3D interface or any other type of representation.
- Create the server using only one process (No THREADS)
- Create the server using only one process (No THREADS).
- Add a flag to for a log mode when running the server.
- Add a flag for the number of resources and food density (could be different levels for example).
- Implement a seed in the server and client so that specific scenarios could be reproduced.
> Attention: `siege` is a stressing tool, use it ONLY to test your own server. Do **NEVER** use it on any server/website without the owner's permission. If you do so you would have illegally DDoSed a server and could face serious troubles.
###### Can you confirm that food and stones exist as resources in the game?
###### Can you confirm that six types of stones are present in the game? (linemate, deraumere, sibur, mendiane, phiras, thystame)
###### Can you confirm that six types of stones are present in the game? (Jade, Peridot, Amber, Amethyst, Garnet, Ammolite)
###### Are resources randomly generated?
###### Are resources randomly generated with some clear logical rules? (ask the students to explain those rules)
**_Food_**
###### Is one food unit equal to 126 time units?
**_Elevation ritual_**
**_Evolution ritual_**
##### Try to confirm that the rules of the elevation ritual are the same given in the subject. (ask the project owners for an explanation if necessary).
##### Try to confirm that the rules of the evolution ritual are the same given in the subject. (ask the project owners for an explanation if necessary).
###### Are the elevation ritual rules exactly the same?
###### Are the evolution ritual rules exactly the same?
MSilva95
