sabry134 / zappy

Zappy Project Documentation

Table of Contents

Introduction

Project Overview

Communication between server and AI

Usage

1. Introduction

The Zappy project is a multiplayer game developed as part of the curriculum at Epitech. It involves creating a server and multiple clients that interact with each other in a virtual world. The goal of the game is to gather resources and level up in order to win.

This documentation provides an overview of the Zappy project. Three binaries are created, the server, the ai and the GUI:

• A server, created in C, that generates the inhabitants’ world.
• A graphical client, created in C++, that can be used to watch what happens in the world.
• A client, created in python language, that drives an inhabitant through orders sent to the server

2. Project Overview

The Zappy project consists of two main components: the server and the client. The server manages the game world, handles client connections, and enforces the game rules. The clients connect to the server, send commands, and receive updates about the game state.

The game world is a grid-based map where players control avatars and perform actions such as moving, gathering resources, and interacting with other players. The server simulates the game world and broadcasts updates to all connected clients.

In the beginning of the game, a team has n slot available (represented on the board by an egg waiting for a client to connect). Each player is driven by a client. The clients cannot communicate or exchange data outside of the game (no matter what it is it should be passed via the server). In the beginning, the player has 10 life units, which means they can survive for 1260 time units, or 1260/f seconds.

A player can reproduce thanks to the fork command. The execution of this command leads to the production of an egg. Once it’s layed, the player who has layed it can take care of their business. Once the egg is layed, a new slot is added to the team.

3. Communication between server and AI

The dialogue between the ai client and the server is carried out via tcp sockets. The port that is used must be indicated in parameters. The client sends its requests, without waiting for them to be done. The server sends back a message confirming the correct execution of the requests.

Zappy AI

1. Usage

To connect a client to the server, use the following command:

./zappy_ai -p <port> -n <team_name> [-h <hostname>]

Replace the placeholders with the desired values:

<team_name>: The name of the team the client wants to join. : The port number on which the server is listening. (optional): The hostname or IP address of the server. If not specified, the client will attempt to connect to localhost.

Client Commands Once connected, the client can send various commands to the server. Here are the commands:

• Forward: Move the client's avatar one space forward.
• Right: Rotate the client's avatar 90 degrees to the right.
• Left: Rotate the client's avatar 90 degrees to the left.
• Look:
• Inventory:
• Broadcast : Send a message to all other clients.
• Connect_nbr:
• Fork:
• Eject:
• Take : Gather a resource from the current cell.
• Set : Drop a resource onto the current cell.
• Incantation:

Zappy Server

The Zappy Server follows the following game rules:

• The game is played on a 2D grid map.
• Multiple teams can participate, each controlling one or more avatars.
• Teams compete to gather resources and achieve the highest level.
• The game is played in turns, with each team taking actions in a specific order.
• Avatars can perform actions such as moving, collecting resources, and interacting with other avatars.
• Players need to cooperate and communicate to optimize their actions and succeed in the game.

Server's communication

The Zappy Server communicates with clients using a TCP/IP network protocol. Clients can send commands to the server, and the server responds accordingly.

The server listens on a specific port for incoming client connections. Clients connect to the server using a TCP socket and communicate by sending text-based commands.

Zappy GUI

The Zappy GUI allows you to configure certain settings to customize your experience. These settings include:

• Server address: Specify the IP address or hostname of the Zappy Server you want to connect to.
• Server port: Enter the port number on which the Zappy Server is listening.
• Screen size: Adjust the size of the graphical window to fit your display.
• You can usually find the configuration options in the GUI's settings or preferences menu.

User interface

The Zappy GUI provides a user-friendly interface to interact with the Zappy Server. The interface typically includes the following components:

• Game map: A visual representation of the virtual world where the game is played. It displays the terrain, avatars, resources, and other relevant elements.
• Sidebar: Contains various panels with information such as player details, resource inventories, chat window, and game statistics.
• Command input: A text field where users can enter commands to send to the Zappy Server.
• Output log: Displays the server's responses and other messages for user feedback.
• The interface may vary depending on the specific implementation of the Zappy GUI.

Credits

• Aurélien Duval
• Ulysse Villanueva
• Victor Doucet
• Van Do Pham
• Zacharie Lacombe
• Benjamin Besnainou