OxeyMultiplayer

CE PROJET EST MAINTENANT ARCHIVÉ -- PROJECT IS NOW ARCHIVED Les ressources liées à ce projet étant maintenant plus disponibles et compte tenu des nouvelles ressources proposées par GDevelop, ce projet est archivé. Vous êtes néanmoins libre de faire un fork de ce dépot et de le continuer vous-même.

The ressources linked to this project being unavailable and since GDevelop now proposes new resources for mulitplayer, this project has been archived. You are still free to fork this repository and continue working on it yourself.

Un serveur multijoueur pour GDevelop fonctionnant avec WebSocket. Documentation en français après celle en anglais. A mutliplayer server for GDevelop powered by WebSocket. English documentation before the french

Instructions (in english)

Here are the installation instructions and contributions guidelines in english This software was made for a youtube video "Comment créer un jeu multijoueur avec GDevelop" Watch the video on youtube (in french) : Oxey405.

Install

How to install the server You need nodeJS and git (optional) installed on your server

1. Download source code from github
2. If you'vhe downloaded from .zip, extract files in a folder
3. Open folder in a terminal (on windows : cmd > "cd /path/to/code/folder")
4. In terminal (cmd), type in npm ito install node modules (dependencies).
5. Type in npm start or node index.js to start the server

How to contribute

The code is open source which means that the code is opened to everyone. The code is under MIT license which means you can use, modify and share/distribute this code however you want ! You can credit me ! (see "how to credit") Wanna contribute ? You just need to know the basics of git and nodeJS. You'll find a lot of documentation for free on the internet !

Contributing guidelines :

1. Format code (in vscode : right click > "Format document")
2. Comment in FRENCH AND IN ENGLISH (use google translation or deepL but please) following this pattern "french -- english"
3. Check that your code Works as intended (try to break it) and that it doesn't break anything made before
4. It is strongly encouraged to write variable names in french.

How to credit

Dans votre readme ou les crédits de votre application/jeu mentionnez : "Serveur mutlijoueur : OxeyMutliplayer (github.com/Oxey405/OxeyMutliplayer)" Vous pouvez retirer le lien du texte si lorsque l'on clique sur le texte, la page github du projet s'affiche. In your readme or in the credits of your app/game, add a line to the credits : "Multiplayer server : OxeyMultiplayer (github.com/Oxey405/OxeyMultiplayer). You can remove the link from the text as long as when you click on the text, it opens the webpage.

Instructions (en français)

Voici les instructions d'installations et la documentation en français Vous pouvez suivre la vidéo "Comment créer un jeu multijoueur avec GDevelop" sur ma chaîne YouTube Oxey405.

Installer

Voici les étapes d'installation du serveur. Vous devez avoir nodeJS (git optionel) d'installé sur votre ordinateur/serveur

1. Télécharger le code source du programme sur github
2. Si vous avez téléchargé le code source sous forme de zip, décompressez le fichier)
3. Ouvrez le dossier du serveur et ouvrez un terminal dans ce dossier (sur windows : cmd puis cd chemin/vers/le/dossier/du/code)
4. Dans le terminal, entrez la commande npm i pour installer tous les modules NodeJS nécéssaires
5. Pour lancer le serveur, tapez npm startou node index.js. Votre serveur est en ligne sur le port 8080

Ajouter des fonctionnalités / Contribuer

Le code est open source, cela veut dire que le code est disponible gratuitement et visible par tous. Le code étant sous license MIT, vous avez le droit de copier, modifier et redistribuer ce logiciel comme vous le souhaitez. N'hesitez pas à me créditer si vous utilisez ce logiciel (voir "comment créditer") Si vous souhaitez contribuer au projet, n'hesitez pas ! Il vous faut juste connaitre le fonctionnement basique de git et de nodeJS. Vous trouverez énormément de ressources gratuites en ligne sur ces sujets.

Règles pour contribuer :

1. Formattez votre code (sur vscode clic droit sur le code > "Mettre le document en forme")
2. Documentez en français puis en anglais en suivant ce format "français -- anglais" sur la MEME LIGNE
3. Vérifiez que votre code fonctionne correctement et ne casse rien de déjà implémenté
4. Il est recommandé d'écrire les noms de variables en français

Comment créditer

Dans votre readme ou les crédits de votre application/jeu mentionnez : "Serveur mutlijoueur : OxeyMutliplayer (github.com/Oxey405/OxeyMutliplayer)" Vous pouvez retirer le lien du texte si lorsque l'on clique sur le texte, la page github du projet s'affiche.

Vous êtes arrivés à la fin du Readme !

Félicitations :) !

You made it to the end of the Readme !

Good job :) !