parent
2f8ba6d833
commit
872e199265
@ -1,25 +1,26 @@
|
||||
|
||||
# Table of Contents
|
||||
|
||||
1. [Guide de contribution et de développement du serveur NALC](#orge3d42f8)
|
||||
1. [Créer son compte gitea](#orgbf0f248)
|
||||
2. [Créer des tickets de bugs](#org9adb9cd)
|
||||
1. [Où poster les tickets](#org02e4e87)
|
||||
3. [Créer et installer **sa** version de NALC](#org37a3efb)
|
||||
1. [Bifurquer les dépôts essentiels de NALC](#org60598a4)
|
||||
2. [Cloner votre bifurcation du dépot nalc-server](#org0ff8750)
|
||||
3. [Faire l'installation du serveur avec vos dépôts](#orgc10498c)
|
||||
4. [Configuration de fichiers](#orga72a195)
|
||||
5. [Désactiver le mod irc et irc<sub>commands</sub>](#org66dff68)
|
||||
6. [Changer le backend de la map (optionnel)](#orgb682e4b)
|
||||
4. [Lancer le serveur](#orgdaed5b4)
|
||||
1. [Manière classique](#org02ece4f)
|
||||
2. [Avec shutdown.sh](#org2184c29)
|
||||
5. [Développer le serveur](#orga21fe3d)
|
||||
1. [Modifier un mod](#org1e03750)
|
||||
2. [Proposer une demande d'ajout (Pull Request)](#org908c02f)
|
||||
1. [Guide de contribution et de développement du serveur NALC](#org6534c74)
|
||||
1. [Créer son compte gitea](#org11ab240)
|
||||
2. [Créer des tickets de bugs](#org74a0f6e)
|
||||
1. [Où poster les tickets](#org3e7d58c)
|
||||
3. [Créer et installer **sa** version de NALC](#orgf10bea7)
|
||||
1. [Bifurquer les dépôts essentiels de NALC](#orgd68e509)
|
||||
2. [Cloner votre bifurcation du dépot nalc-server](#orge123536)
|
||||
3. [Faire l'installation du serveur avec vos dépôts](#org64d0baa)
|
||||
4. [Configuration de fichiers](#org4749466)
|
||||
5. [Désactiver le mod irc et irc<sub>commands</sub>](#org2e0c5f0)
|
||||
6. [Changer le backend de la map (optionnel)](#orgfa79e5b)
|
||||
4. [Lancer le serveur](#org6998137)
|
||||
1. [Manière classique](#orgb275130)
|
||||
2. [Avec shutdown.sh](#org16611ff)
|
||||
5. [Proposer vos modifications](#org65181a6)
|
||||
1. [Modifier un mod](#orga7f2955)
|
||||
2. [Proposer une demande d'ajout (Pull Request)](#orgdfc0551)
|
||||
|
||||
|
||||
<a id="orge3d42f8"></a>
|
||||
<a id="org6534c74"></a>
|
||||
|
||||
# Guide de contribution et de développement du serveur NALC
|
||||
|
||||
@ -30,7 +31,7 @@
|
||||
Pour les exemples donnés dans le guide nous serons l'utilisateur Sam.
|
||||
|
||||
|
||||
<a id="orgbf0f248"></a>
|
||||
<a id="org11ab240"></a>
|
||||
|
||||
## Créer son compte gitea
|
||||
|
||||
@ -40,7 +41,7 @@ Pour commencer, créez-vous un compte sur le serveur de dépôts git que je met
|
||||
Une fois inscrit vous pouvez vous connecter et ainsi commencer votre participation.
|
||||
|
||||
|
||||
<a id="org9adb9cd"></a>
|
||||
<a id="org74a0f6e"></a>
|
||||
|
||||
## Créer des tickets de bugs
|
||||
|
||||
@ -48,7 +49,7 @@ Si vous constatez un bug sur le serveur NALC vous pouvez déjà le rapporter dir
|
||||
Pour ceux voulant contribuer de façon plus pointue, ou pour les personnes déjà contributrices en développement ou voulant le devenir, poster des tickets de bugs directement depuis l'interface de Gitea sera plus approprié et confortable.
|
||||
|
||||
|
||||
<a id="org02e4e87"></a>
|
||||
<a id="org3e7d58c"></a>
|
||||
|
||||
### Où poster les tickets
|
||||
|
||||
@ -56,7 +57,7 @@ Pour des raisons pratiques les tickets concernants un bug du jeux ou qui semble
|
||||
Pour les bugs qui concernent la gestion ou l'administration de serveur en lui-même (exemple : un bug avec le script d'installation) vous devrez les poster dans le dépôt [nalc-server](https://sys4.fr/gitea/nalc/nalc-server/issues) de l'organisation [Notre Ami Le Cube](https://sys4.fr/gitea/nalc).
|
||||
|
||||
|
||||
<a id="org37a3efb"></a>
|
||||
<a id="orgf10bea7"></a>
|
||||
|
||||
## Créer et installer **sa** version de NALC
|
||||
|
||||
@ -64,7 +65,7 @@ Ici sera décrite l'installation du serveur avec l'intention de pouvoir proposer
|
||||
Si vous êtes juste curieux et souhaitez tester la version de développement officielle sans vouloir apporter de modifications, reportez-vous au guide d'administration du serveur qui contient un chapitre sur l'installation du serveur.
|
||||
|
||||
|
||||
<a id="org60598a4"></a>
|
||||
<a id="orgd68e509"></a>
|
||||
|
||||
### Bifurquer les dépôts essentiels de NALC
|
||||
|
||||
@ -84,7 +85,7 @@ Vos dépôts biffurqués (en tant qu'utilisateur Sam) seront accessibles à ces
|
||||
- <https://sys4.fr/gitea/Sam/nalc_game.git>
|
||||
|
||||
|
||||
<a id="org0ff8750"></a>
|
||||
<a id="orge123536"></a>
|
||||
|
||||
### Cloner votre bifurcation du dépot nalc-server
|
||||
|
||||
@ -94,7 +95,7 @@ Ouvrez un terminal bash depuis votre ordinateur puis faite un clone du dépôt q
|
||||
$ git clone https://sys4.fr/gitea/Sam/nalc-server.git
|
||||
|
||||
|
||||
<a id="orgc10498c"></a>
|
||||
<a id="org64d0baa"></a>
|
||||
|
||||
### Faire l'installation du serveur avec vos dépôts
|
||||
|
||||
@ -104,7 +105,7 @@ Toujours depuis votre terminal, faire l'installation de la branche dev du serveu
|
||||
$ ./install.sh --url https://sys4.fr/gitea/Sam dev
|
||||
|
||||
|
||||
<a id="orga72a195"></a>
|
||||
<a id="org4749466"></a>
|
||||
|
||||
### Configuration de fichiers
|
||||
|
||||
@ -137,7 +138,7 @@ Après l'installation il faut configurer quelques fichiers.
|
||||
Ce script en l'état ne permet de sauvegarder un serveur que si le backend utilisé est postgresql.
|
||||
|
||||
|
||||
<a id="org66dff68"></a>
|
||||
<a id="org2e0c5f0"></a>
|
||||
|
||||
### Désactiver le mod irc et irc<sub>commands</sub>
|
||||
|
||||
@ -157,7 +158,7 @@ Plus tard, si le fichier **world.mt** devait être régénéré pour une autre r
|
||||
Pour les réactiver il faudra simplement les supprimer du script puis éxécuter le script de nouveau comme précédemment.
|
||||
|
||||
|
||||
<a id="orgb682e4b"></a>
|
||||
<a id="orgfa79e5b"></a>
|
||||
|
||||
### Changer le backend de la map (optionnel)
|
||||
|
||||
@ -170,7 +171,7 @@ Pour cela il faut lancer le script **upgrade.sh** de nouveau de la même manièr
|
||||
$ ./upgrade.sh -w nalc-dev -b dev -f worldmt
|
||||
|
||||
|
||||
<a id="orgdaed5b4"></a>
|
||||
<a id="org6998137"></a>
|
||||
|
||||
## Lancer le serveur
|
||||
|
||||
@ -178,7 +179,7 @@ Vous êtes prêt pour le démarrage du serveur.
|
||||
Vous pouvez le faire de deux manières. Soit de manière classique soit à l'aide du script **shutdown.sh**
|
||||
|
||||
|
||||
<a id="org02ece4f"></a>
|
||||
<a id="orgb275130"></a>
|
||||
|
||||
### Manière classique
|
||||
|
||||
@ -188,7 +189,7 @@ Vous pouvez le faire de deux manières. Soit de manière classique soit à l'aid
|
||||
Pour arrêter le serveur il vous suffira de faire les touches **[CTRL+C]** du clavier.
|
||||
|
||||
|
||||
<a id="org2184c29"></a>
|
||||
<a id="org16611ff"></a>
|
||||
|
||||
### Avec shutdown.sh
|
||||
|
||||
@ -209,16 +210,16 @@ Pour arrêter le serveur :
|
||||
$ ./shutdown.sh
|
||||
|
||||
|
||||
<a id="orga21fe3d"></a>
|
||||
<a id="org65181a6"></a>
|
||||
|
||||
## Développer le serveur
|
||||
## Proposer vos modifications
|
||||
|
||||
Vous avez réussi à lancer votre propre fork du serveur, mais celui-ci est identique à l'original pour le moment et n'intègre pas encore vos corrections ou les changements qui vous tiennent tant à coeur.
|
||||
Au travers de l'exemple suivant, voici une méthode pour modifier un mod que vous aurez bifurqué (fork) et que vous intégrerez à votre serveur.
|
||||
Puis vous demanderez à ce que cette modification soit fusionnée dans le dépôt officiel de NALC avec la fonction **demande d'ajout** proposé par gitea. C'est l'équivalent des *Pull Requests* de GitHub.
|
||||
|
||||
|
||||
<a id="org1e03750"></a>
|
||||
<a id="orga7f2955"></a>
|
||||
|
||||
### Modifier un mod
|
||||
|
||||
@ -355,13 +356,13 @@ Puis vous demanderez à ce que cette modification soit fusionnée dans le dépô
|
||||
Ma modif blablabla...
|
||||
|
||||
commit 2a8d3aafcff0d372fd1fee541261a0d707d6a914 (origin/master, origin/HEAD)
|
||||
Author: sys4 <admin@sys4.fr>
|
||||
Author: sys4 <pouet@sys4.fr>
|
||||
Date: Wed Jul 22 13:07:00 2020 +0200
|
||||
|
||||
Tidy code
|
||||
|
||||
commit 06525f43eb34e1d68b1952be5fa2ce1d2ae0eb15 (tag: nalc-1.2.0)
|
||||
Author: sys4 <sys4@sys4.fr>
|
||||
Author: sys4 <pouet@sys4.fr>
|
||||
Date: Fri May 8 20:25:49 2020 +0200
|
||||
|
||||
Désactive les pommes en 3D
|
||||
@ -438,7 +439,7 @@ Puis vous demanderez à ce que cette modification soit fusionnée dans le dépô
|
||||
Voilà vos modifications sont bel et bien publiées et de façon correcte sur le serveur git.
|
||||
|
||||
|
||||
<a id="org908c02f"></a>
|
||||
<a id="orgdfc0551"></a>
|
||||
|
||||
### Proposer une demande d'ajout (Pull Request)
|
||||
|
||||
@ -465,4 +466,4 @@ Normalement la demande d'ajout devrait indiquer la fusion de la branche master d
|
||||
Pour confirmer cette demande d'ajout, cliquer sur le bouton "Nouvelle demande d'ajout" puis remplissez le formulaire qui s'affiche pour rajouter une description à votre PR. Une discussion avec le mainteneur du dépôt cible pourra alors s'engager si il souhaite avoir des précisions ou faire des commentaires.
|
||||
|
||||
Ensuite libre à lui de fusionner votre PR ou non.
|
||||
En tout cas de votre côté vous avez finalisé votre demande d'ajout.
|
||||
En tout cas de votre côté vous avez finalisé votre demande d'ajout.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user