diff --git a/README.md b/README.md index fd8c5264f7f51538b4cf9d8ec79f4c45da457c69..8229f2b413764b5984a1d3c67ba1043c5a05a520 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,39 @@ -# sae-2023-groupei-lasoa-gomis +<img src="./client/public/images/dragonio.png" > +## Sommaire <!-- omit in toc --> +- [A. Notre Jeu](#a-notre-Jeu) +- [B. Les difficultés techniques](#b-les-difficultés-techniques) +- [C. Les points d'amélioration](#c-les-points-d'amélioration) +- [D. Ce dont nous sommes le plus fiers](#d-ce-dont-nous-sommes-le-plus-fiers) +- [E. Diagramme de séquence](#e-diagramme-de-séquence) -## Getting started -To make it easy for you to get started with GitLab, here's a list of recommended next steps. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## A. Notre Jeu +**Pour le compte d'un devoir noté, nous avons développé une adaptation d'Agar.io basée sur l'univers Dragon Ball Z. Notre jeu met en scène les personnages emblématiques de la série, tels que Goku, Vegeta ou Freezer, et vous permet d'absorber des boules de ki pour devenir plus fort et combattre d'autres joueurs en ligne. notre adaptation d'Agar.io offre une expérience de jeu unique pour les fans de la série et les amateurs de jeux en ligne. Nous espérons que vous apprécierez jouer à notre jeu autant que nous avons aimé le développer !** -## Add your files +## B. Les difficultés techniques +nous avons rencontré des difficultés techniques liées à l'utilisation de Socket.io pour la gestion de la communication en temps réel entre les joueurs. Nous avons constaté que le nombre de connexions simultanées pouvait avoir un impact sur les performances, ce qui nous a obligé à optimiser notre code et à gérer efficacement les ressources du serveur. -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +En outre, nous avons eu des difficultés avec l'utilisation du canvas et du context pour dessiner les graphismes en 2D et en 3D de notre jeu. Cela a nécessité une gestion minutieuse des ressources, une résolution de collisions efficace, et une synchronisation de l'affichage en fonction des mouvements des joueurs. -``` -cd existing_repo -git remote add origin https://gitlab.univ-lille.fr/sofiane.lasoa.etu/sae-2023-groupei-lasoa-gomis.git -git branch -M main -git push -uf origin main -``` +Pour surmonter ces difficultés, nous avons mené des recherches approfondies, effectué des tests et adopté les meilleures pratiques de programmation pour améliorer les performances de notre jeu. Nous avons également optimisé notre code et notre architecture pour garantir une expérience de jeu fluide et agréable pour les joueurs. Finalement, nous avons réussi à créer une adaptation réussie d'Agar.io basée sur l'univers Dragon Ball Z. -## Integrate with your tools +## C. Les points d'amélioration +1. Ajout de musique : Nous pourrions améliorer l'immersion des joueurs dans l'univers de Dragon Ball Z en ajoutant de la musique de fond qui correspond à l'ambiance de chaque niveau. Par exemple, nous pourrions jouer de la musique de combat lorsque nous attaquons un adversaire. -- [ ] [Set up project integrations](https://gitlab.univ-lille.fr/sofiane.lasoa.etu/sae-2023-groupei-lasoa-gomis/-/settings/integrations) +2. Effets sonores : Les effets sonores sont un élément important pour renforcer l'expérience de jeu. Nous pourrions ajouter des sons pour les actions des joueurs, comme le bruit de l'absorption d'un adversaire ou le bruit d'un combat. -## Collaborate with your team +3. Ajout de la fonctionnalité boule de cristal : La boule de cristal est un élément clé de l'univers Dragon Ball Z. Nous pourrions ajouter une fonctionnalité qui permet aux joueurs de collecter des boules de cristal en cours de jeu. Une fois qu'un joueur a collecté toutes les boules de cristal(7), il pourrait avoir accès à des pouvoirs spéciaux, tels que devenir beaucoup plus grand, devenir invincible, ou augmenter sa vitesse pendant un certain temps... Tout dépendrait de son choix. -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +## D. Ce dont nous sommes le plus fiers +Nous sommes particulièrement fiers de notre interface utilisateur que nous avons développée pour le jeu. Nous avons voulu recréer l'univers de Dragon Ball Z dans le jeu et nous avons réussi à le faire de manière très amusante et engageante. Les graphismes sont colorés et vibrants, et la disposition des éléments de l'interface utilisateur est intuitive et facile à comprendre. -## Test and Deploy +De plus, nous sommes très fiers d'avoir pu développer le jeu en TypeScript. C'était un défi pour nous car nous n'avions jamais utilisé ce langage de programmation auparavant, mais nous avons persévéré et cela a fini par payer. TypeScript nous a permis de coder de manière plus propre et structurée, ce qui a rendu le développement plus facile et plus efficace. En outre, cela nous a également permis de détecter les erreurs plus rapidement, ce qui a accéléré le processus de développement. + +Dans l'ensemble, nous sommes très satisfaits de ce que nous avons accompli avec ce projet -Use the built-in continuous integration in GitLab. +## E. Diagramme de séquence -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +<img src="./client/public/images/clientserv.png">