{"id":27624260,"url":"https://github.com/toro-nicolas/jetpack","last_synced_at":"2025-04-23T11:26:25.962Z","repository":{"id":289123973,"uuid":"970194746","full_name":"toro-nicolas/Jetpack","owner":"toro-nicolas","description":"A Jetpack Joyride game with a multiplayer mode.","archived":false,"fork":false,"pushed_at":"2025-04-21T16:34:38.000Z","size":8634,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-21T17:38:46.448Z","etag":null,"topics":["client","cpp","epitech","game","jetpack","jetpack-joyride","multiplayer","server"],"latest_commit_sha":null,"homepage":"https://toro-nicolas.github.io/Jetpack/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toro-nicolas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-21T16:21:39.000Z","updated_at":"2025-04-21T16:34:42.000Z","dependencies_parsed_at":"2025-04-21T17:49:46.317Z","dependency_job_id":null,"html_url":"https://github.com/toro-nicolas/Jetpack","commit_stats":null,"previous_names":["toro-nicolas/jetpack"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toro-nicolas%2FJetpack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toro-nicolas%2FJetpack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toro-nicolas%2FJetpack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toro-nicolas%2FJetpack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toro-nicolas","download_url":"https://codeload.github.com/toro-nicolas/Jetpack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250423590,"owners_count":21428193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","cpp","epitech","game","jetpack","jetpack-joyride","multiplayer","server"],"created_at":"2025-04-23T11:26:24.624Z","updated_at":"2025-04-23T11:26:25.956Z","avatar_url":"https://github.com/toro-nicolas.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jetpack\n\n![Jetpack](https://toro-nicolas.github.io/Jetpack/preview2.png)\n\n## Table of contents 📑\n- [Description](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#description-)\n- [Usage](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#usage-%EF%B8%8F)\n- [Result](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#result-)\n- [Compilation](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#compilation-%EF%B8%8F)\n- [Documentation](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#documentation-)\n- [Code mandatory](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#code-mandatory-)\n- [Contributors](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#contributors-)\n\n\n## Description 📝\nThe **Jetpack** is a project carried out by **groups of 3** (see [Contributors](https://github.com/toro-nicolas/Jetpack/blob/main/README.md#contributors-), during our **2nd year** in [**EPITECH**](https://www.epitech.eu/) Grand Ecole program.  \nIts purpose is to recreate in [**C++**](https://en.wikipedia.org/wiki/C%2B%2B) a [**Jetpack Joyride game**](https://en.wikipedia.org/wiki/Jetpack_Joyride) with a **multiplayer** mode.  \nWe had to create a **server** and a **client** that communicate with each other using the **TCP protocol**.  \nThe game is a **side-scrolling** runner where the player controls a character that automatically moves forward.  \nThe player can control the character's vertical position by pressing space key to make it fly and releasing it to let it fall.  \nThe goal is to collect coins while avoiding obstacles.  \n\n\n## Usage ⚔️\nYou can run Jetpack server like this :\n```sh\n./jetpack_server -p [port] -m [map]\n```\nFor more information, please see the help section.\n```sh\n\u003e ./jetpack_server --help\nUSAGE: ./jetpack_server -p \u003cport\u003e -m \u003cmap\u003e [-d]\n\nDESCRIPTION:\n        -p \u003cport\u003e       The port number on which the server socket listens\n        -m \u003cmap\u003e        The path of the map file\n        -d              Enable debug mode\n        --help          Display this help message\n\nCREDITS:\n        Made by Christophe VANDEVOIR, Guillaume LECOCQ and Nicolas TORO\n        EPITECH Nice 2025\n```\n\nYou can run Jetpack client like this :\n```sh\n./jetpack_client -h [host] -p [port]\n```\nFor more information, please see the help section.\n```sh\n\u003e ./jetpack_client --help\nUSAGE: ./jetpack_client -h \u003cip\u003e -p \u003cport\u003e [-d]\n\nDESCRIPTION:\n        -h \u003cip\u003e The server IP address\n        -p \u003cport\u003e       The port number on which the server socket listens\n        -d              Enable debug mode\n        --help          Display this help message\n\nCREDITS:\n        Made by Christophe VANDEVOIR, Guillaume LECOCQ and Nicolas TORO\n        EPITECH Nice 2025\n```\n\n\n## Result 🚩\nThe result of this project is a **almost perfect Jetpack Joyride game in multiplayer**.  \nIf you discover a **problem** or an **error**, don't hesitate to **create an issue** and **report it** to us as soon as possible.\n\n\n### my.epitech.eu result\n| Test name                                 |  Result  | Crash  |\n|-------------------------------------------|:--------:|:------:|\n| Server                                    |    OK    |   No   |\n| Client                                    |    OK    |   No   |\n| Minimal functions client (write and poll) |    OK    |   No   |\n| Minimal functions server (write and poll) |    OK    |   No   |\n| Documentation                             |    OK    |   No   |\n| **Results**                               | **100%** | **No** |\n\n### Defense\nTODO\n\n\n## Compilation 🛠️\nThis project is compiled with **CMake** and **Makefile**.  \nThis project use **C++20** standard, **CMake 3.20** or higher and **SFML 2.5.1**.  \n\nYou can compile the project with this command :\n- via CMake and Makefile :\n```sh\ncmake -B build -S . \u0026\u0026 make -s -C build -j\n```\n- via only Makefile :\n```sh\nmake\n```\n\nIf you want to debug the program, you can compile the project with this :\n- via CMake and Makefile :\n```sh\ncmake -B build -S . \u0026\u0026 make debug -s -C build -j\n```\n- via only Makefile :\n```sh\nmake debug \n```\n\nIf you want clean the project, you can run this command :\n- via CMake and Makefile :\n```sh\ncmake -B build -S . \u0026\u0026 make fclean -s -C build -j\n```\n- via only Makefile :\n```sh\nmake fclean\n```\n\nYou can clean and compile the project with the rules ```re``` and for debugging ```re_debug```\n\n\n## Documentation 📚\nThe requested documentation for EPITECH is accessible [here](https://toro-nicolas.github.io/Jetpack/doc.txt).  \nThe protocol documentation is accessible [here](https://toro-nicolas.github.io/Jetpack/protocol_documentation_en.md).  \nThe map documentation is accessible [here](https://toro-nicolas.github.io/Jetpack/map_documentation.md).  \nThe code documentation is accessible [here](https://toro-nicolas.github.io/Jetpack/html/).  \n\nYou can generate the documentation with this command :\n- via CMake and Makefile:\n```sh\ncmake -B build -S . \u0026\u0026 make doc -s -C build -j\n```\n- via only Makefile:\n```sh\nmake doc\n```\nYou need multiple package for generate them :\n- doxygen\n- doxygen-latex\n- doxygen-doxywizard\n- graphviz\n\n\n## Code mandatory 📦\n- You'll need to create a branch where you'll push your code. Once you've completed your tasks on this branch, we'll work together to merge it and check that everything works.\n- Every function you add must be code-style and documented.\n- If the github actions don't succeed, then ask yourself some questions\n- Each commit will contain ```[+]``` or ```[-]``` or ```[~]``` followed by a message\n    - ```[+]``` : Add feature\n    - ```[-]``` : Delete feature\n    - ```[~]``` : Edit feature\n\n**Of course, in exceptional cases, we may depart from these rules.**\n\n\n## Contributors 👥\nFor this project, we were a group of **3 people**. Here are the people in the group:\n- [Christophe VANDEVOIR](https://github.com/ItsKarmaOff) : also published the [Jetpack](https://github.com/ItsKarmaOff/Jetpack)\n- [Guillaume LECOCQ](https://github.com/guilec06)\n- [Nicolas TORO](https://github.com/toro-nicolas) : also published the [Jetpack](https://github.com/toro-nicolas/Jetpack)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoro-nicolas%2Fjetpack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoro-nicolas%2Fjetpack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoro-nicolas%2Fjetpack/lists"}