parent
0e9c47ec9b
commit
9007e5b63e
@ -1,24 +1,25 @@
|
||||
|
||||
# Table of Contents
|
||||
|
||||
1. [Guide de contribution et de développement du serveur NALC](#orgeb470ba)
|
||||
1. [Créer son compte gitea](#orga2bfd98)
|
||||
2. [Créer des tickets de bugs](#org312d59a)
|
||||
1. [Où poster les tickets](#orgbbde114)
|
||||
3. [Créer et installer **sa** version de NALC](#orgef281b4)
|
||||
1. [Bifurquer les dépôts essentiels de NALC](#org01b3988)
|
||||
2. [Cloner votre bifurcation du dépot nalc-server](#org8365c7d)
|
||||
3. [Faire l'installation du serveur avec vos dépôts](#org0aaabe4)
|
||||
4. [Configuration de fichiers](#orgaaaa093)
|
||||
5. [Désactiver le mod irc et irc<sub>commands</sub>](#orgd7fa3e9)
|
||||
6. [Changer le backend de la map (optionnel)](#orgfa3596f)
|
||||
4. [Lancer le serveur](#org921b6d8)
|
||||
1. [Manière classique](#org253d4e7)
|
||||
2. [Avec shutdown.sh](#orga671518)
|
||||
5. [Proposer vos modifications](#org9a94502)
|
||||
1. [Modifier un mod](#org63cf764)
|
||||
1. [Guide de contribution et de développement du serveur NALC](#orgc90d68b)
|
||||
1. [Créer son compte gitea](#org39d978b)
|
||||
2. [Créer des tickets de bugs](#org52b589d)
|
||||
1. [Où poster les tickets](#orgcc72412)
|
||||
3. [Créer et installer **sa** version de NALC](#org0c36156)
|
||||
1. [Bifurquer les dépôts essentiels de NALC](#org59b99a9)
|
||||
2. [Cloner votre bifurcation du dépot nalc-server](#orgf950ff3)
|
||||
3. [Faire l'installation du serveur avec vos dépôts](#org7f381d0)
|
||||
4. [Configuration de fichiers](#org1e74a22)
|
||||
5. [Désactiver le mod irc et irc<sub>commands</sub>](#org1a03d7f)
|
||||
6. [Changer le backend de la map (optionnel)](#orgdb7507c)
|
||||
4. [Lancer le serveur](#org5dff227)
|
||||
1. [Manière classique](#org01469d2)
|
||||
2. [Avec shutdown.sh](#org333ef7a)
|
||||
5. [Proposer vos modifications](#org96b13a9)
|
||||
1. [Modifier un mod](#orgdff111f)
|
||||
|
||||
|
||||
<a id="orgeb470ba"></a>
|
||||
<a id="orgc90d68b"></a>
|
||||
|
||||
# Guide de contribution et de développement du serveur NALC
|
||||
|
||||
@ -29,7 +30,7 @@
|
||||
Pour les exemples donnés dans le guide nous serons l'utilisateur Sam.
|
||||
|
||||
|
||||
<a id="orga2bfd98"></a>
|
||||
<a id="org39d978b"></a>
|
||||
|
||||
## Créer son compte gitea
|
||||
|
||||
@ -39,7 +40,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="org312d59a"></a>
|
||||
<a id="org52b589d"></a>
|
||||
|
||||
## Créer des tickets de bugs
|
||||
|
||||
@ -47,7 +48,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="orgbbde114"></a>
|
||||
<a id="orgcc72412"></a>
|
||||
|
||||
### Où poster les tickets
|
||||
|
||||
@ -55,7 +56,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="orgef281b4"></a>
|
||||
<a id="org0c36156"></a>
|
||||
|
||||
## Créer et installer **sa** version de NALC
|
||||
|
||||
@ -63,7 +64,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="org01b3988"></a>
|
||||
<a id="org59b99a9"></a>
|
||||
|
||||
### Bifurquer les dépôts essentiels de NALC
|
||||
|
||||
@ -83,7 +84,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="org8365c7d"></a>
|
||||
<a id="orgf950ff3"></a>
|
||||
|
||||
### Cloner votre bifurcation du dépot nalc-server
|
||||
|
||||
@ -93,7 +94,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="org0aaabe4"></a>
|
||||
<a id="org7f381d0"></a>
|
||||
|
||||
### Faire l'installation du serveur avec vos dépôts
|
||||
|
||||
@ -103,7 +104,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="orgaaaa093"></a>
|
||||
<a id="org1e74a22"></a>
|
||||
|
||||
### Configuration de fichiers
|
||||
|
||||
@ -136,7 +137,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="orgd7fa3e9"></a>
|
||||
<a id="org1a03d7f"></a>
|
||||
|
||||
### Désactiver le mod irc et irc<sub>commands</sub>
|
||||
|
||||
@ -156,7 +157,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="orgfa3596f"></a>
|
||||
<a id="orgdb7507c"></a>
|
||||
|
||||
### Changer le backend de la map (optionnel)
|
||||
|
||||
@ -169,7 +170,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="org921b6d8"></a>
|
||||
<a id="org5dff227"></a>
|
||||
|
||||
## Lancer le serveur
|
||||
|
||||
@ -177,7 +178,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="org253d4e7"></a>
|
||||
<a id="org01469d2"></a>
|
||||
|
||||
### Manière classique
|
||||
|
||||
@ -187,7 +188,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="orga671518"></a>
|
||||
<a id="org333ef7a"></a>
|
||||
|
||||
### Avec shutdown.sh
|
||||
|
||||
@ -208,7 +209,7 @@ Pour arrêter le serveur :
|
||||
$ ./shutdown.sh
|
||||
|
||||
|
||||
<a id="org9a94502"></a>
|
||||
<a id="org96b13a9"></a>
|
||||
|
||||
## Proposer vos modifications
|
||||
|
||||
@ -217,7 +218,7 @@ Au travers de l'exemple suivant, voici une méthode pour modifier un mod que vou
|
||||
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="org63cf764"></a>
|
||||
<a id="orgdff111f"></a>
|
||||
|
||||
### Modifier un mod
|
||||
|
||||
@ -268,7 +269,7 @@ Puis vous demanderez à ce que cette modification soit fusionnée dans le dépô
|
||||
url = https://sys4.fr/gitea/mtcontrib/signs_lib.git
|
||||
lines 1-13/13 (END)
|
||||
|
||||
On voie bien le changement d'url pour le submodule riesenpilz.
|
||||
On voit bien le changement d'url pour le submodule riesenpilz.
|
||||
|
||||
Le fichier .gitmodules étant modifié il est tant de faire un premier commit pour refléter ce changement dans le dépôt git nalc-server-mods :
|
||||
|
||||
@ -303,5 +304,134 @@ Puis vous demanderez à ce que cette modification soit fusionnée dans le dépô
|
||||
gauges, item_drop, maptools, nether
|
||||
lines 1-13/13 (END)
|
||||
|
||||
4. TODO La suite…
|
||||
4. Modifier le mod
|
||||
|
||||
Ça y est, votre environnement est presque prêt pour que vous puissiez commencer à modifier le code de votre mod bifurqué.
|
||||
Avant d'éditer son code, mettez vous sur sa branche principale ou créez-en une nouvelle car actuellement vous êtes certainement sur une branche détachée (HEAD détachée) du dépôt qui n'a aucun lien avec la branche distante.
|
||||
Dans cet exemple nous nous mettons sur la branche master :
|
||||
|
||||
$ cd ~/nalc-server/nalc-server-mods/riesenpilz
|
||||
$ git status
|
||||
HEAD détachée sur 2a8d3aa
|
||||
rien à valider, la copie de travail est propre
|
||||
|
||||
$ git checkout master
|
||||
Basculement sur la branche 'master'
|
||||
Votre branche est à jour avec 'origin/master'.
|
||||
|
||||
Maintenant vous pouvez éditer le code avec votre éditeur favoris puis enregistrez vos modifications.
|
||||
Puis vous relancez le serveur pour tester vos modifications.
|
||||
|
||||
$ cd ~/nalc-server
|
||||
$ ./shutdown.sh -r
|
||||
#+begin_src
|
||||
Si tout va bien et que vous êtes satisfait de votre test, vous voudrez sûrement commiter vos changements :
|
||||
#+begin_src sh
|
||||
$ cd ~/nalc-server/nalc-server-mods/riesenpilz
|
||||
$ git status
|
||||
Sur la branche master
|
||||
Votre branche est à jour avec 'origin/master'.
|
||||
|
||||
Modifications qui ne seront pas validées :
|
||||
(utilisez "git add <fichier>..." pour mettre à jour ce qui sera validé)
|
||||
(utilisez "git restore <fichier>..." pour annuler les modifications dans le répertoire de travail)
|
||||
modifié : init.lua
|
||||
|
||||
aucune modification n'a été ajoutée à la validation (utilisez "git add" ou "git commit -a")
|
||||
|
||||
$ git commit -a -m "Ma modif blablabla..."
|
||||
[master 7a5df83] Ma modif blablabla...
|
||||
1 file changed, 1 insertion(+), 2 deletions(-)
|
||||
|
||||
$ git log
|
||||
commit 7a5df839c98ff7e0d95961aae97bec040a04d144 (HEAD -> master)
|
||||
Author: Sam <samedi@monemail.fr>
|
||||
Date: Sat Oct 10 15:44:25 2020 +0200
|
||||
|
||||
Ma modif blablabla...
|
||||
|
||||
commit 2a8d3aafcff0d372fd1fee541261a0d707d6a914 (origin/master, origin/HEAD)
|
||||
Author: sys4 <admin@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>
|
||||
Date: Fri May 8 20:25:49 2020 +0200
|
||||
|
||||
Désactive les pommes en 3D
|
||||
|
||||
5. Poussez vos commits (Push)
|
||||
|
||||
Vous avez fait vos modifs, les avez testées et avez commité votre code. Mais cela n'a été fait qu'au niveau de vos dépôts locaux. Vous avez besoin de pousser (push) vos commits pour qu'ils soient publiés sur le serveur git :
|
||||
|
||||
$ git push
|
||||
Username for 'https://sys4.fr': Sam
|
||||
Password for 'https://samedi@monemail.fr':
|
||||
Énumération des objets: 5, fait.
|
||||
Décompte des objets: 100% (5/5), fait.
|
||||
Compression par delta en utilisant jusqu'à 12 fils d'exécution
|
||||
Compression des objets: 100% (3/3), fait.
|
||||
Écriture des objets: 100% (3/3), 302 octets | 302.00 Kio/s, fait.
|
||||
Total 3 (delta 2), réutilisés 0 (delta 0), réutilisés du pack 0
|
||||
remote:
|
||||
remote: Create a new pull request for 'Sam:master':
|
||||
remote: https://sys4.fr/gitea/nalc/riesenpilz/compare/master...Sam:master
|
||||
remote:
|
||||
remote: . Processing 1 references
|
||||
remote: Processed 1 references in total
|
||||
To https://sys4.fr/gitea/Sam/riesenpilz.git
|
||||
2a8d3aa..7a5df83 master -> master
|
||||
|
||||
Comme nous avons fait la modification du sous-module riesenpilz et que celui-ci pointe vers une nouvelle référence, il faut également mettre à jour le dépôt git parent, soit le dépôt nalc-server-mods :
|
||||
|
||||
$ cd ~/nalc-server/nalc-server-mods
|
||||
$ git status
|
||||
Sur la branche dev
|
||||
Votre branche est en avance sur 'origin/dev' de 1 commit.
|
||||
(utilisez "git push" pour publier vos commits locaux)
|
||||
|
||||
Modifications qui ne seront pas validées :
|
||||
(utilisez "git add <fichier>..." pour mettre à jour ce qui sera validé)
|
||||
(utilisez "git restore <fichier>..." pour annuler les modifications dans le répertoire de travail)
|
||||
modifié : riesenpilz (nouveaux commits)
|
||||
|
||||
aucune modification n'a été ajoutée à la validation (utilisez "git add" ou "git commit -a")
|
||||
|
||||
$ git diff
|
||||
diff --git a/riesenpilz b/riesenpilz
|
||||
index 2a8d3aa..7a5df83 160000
|
||||
--- a/riesenpilz
|
||||
+++ b/riesenpilz
|
||||
@@ -1 +1 @@
|
||||
-Subproject commit 2a8d3aafcff0d372fd1fee541261a0d707d6a914
|
||||
+Subproject commit 7a5df839c98ff7e0d95961aae97bec040a04d144
|
||||
lines 1-7/7 (END)
|
||||
|
||||
$ git commit -a -m "[riesenpilz] Ma modif blablabla..."
|
||||
[dev 6c82718] [riesenpilz] Ma modif blablabla..."
|
||||
1 file changed, 1 insertion(+), 1 deletion(-)
|
||||
|
||||
$ git push
|
||||
Username for 'https://sys4.fr': Sam
|
||||
Password for 'https://samedi@monemail.fr':
|
||||
Énumération des objets: 7, fait.
|
||||
Décompte des objets: 100% (7/7), fait.
|
||||
Compression par delta en utilisant jusqu'à 12 fils d'exécution
|
||||
Compression des objets: 100% (5/5), fait.
|
||||
Écriture des objets: 100% (5/5), 597 octets | 597.00 Kio/s, fait.
|
||||
Total 5 (delta 3), réutilisés 0 (delta 0), réutilisés du pack 0
|
||||
remote:
|
||||
remote: Create a new pull request for 'Sam:dev':
|
||||
remote: https://sys4.fr/gitea/nalc/nalc-server-mods/compare/master...Sam:dev
|
||||
remote:
|
||||
remote: . Processing 1 references
|
||||
remote: Processed 1 references in total
|
||||
To https://sys4.fr/gitea/Sam/nalc-server-mods.git
|
||||
2e46254..6c82718 dev -> dev
|
||||
|
||||
Voilà vos modifications sont bel et bien publiées et de façon correcte sur le serveur git.
|
||||
|
||||
6. Proposer une demande d'ajout (Pull Request)
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user