Revise french text manual file md

This commit is contained in:
Baptiste G.
2026-08-12 22:09:55 +02:00
committed by Starystars67
parent a16b0e7fa3
commit ccc0f99955
+101 -53
View File
@@ -1,87 +1,135 @@
# Serveur Manuel
# Serveur manuel
# Environnement
## Environnement
Le serveur est affecté par l'état de divers paramètres externes :
Le fonctionnement du serveur dépend de plusieurs paramètres externes :
- Le dossier « Ressources »
- L'ENV (environnement de processus)
- Les arguments de la ligne de commande
- Le fichier ServerConfig.toml
- Le répertoire de travail
* le dossier `Resources` ;
* les variables denvironnement ;
* les arguments de la ligne de commande ;
* le fichier `ServerConfig.toml` ;
* le répertoire de travail.
## Dossier de ressources
Le dossier « ressources » est créé au démarrage du serveur, avec les sous-répertoires « Client » et « Serveur ». Le sous-répertoire « Serveur » accepte des dossiers contenant chacun au moins un fichier `.lua` . Chacun de ces dossiers est appelé « Plugin ». Les fichiers `.lua` contenus dans le répertoire principal d'un plugin sont rechargés à chaud en cas de modification. Le sous-répertoire « Client » accepte *uniquement* les fichiers `.zip` , chargés au démarrage du serveur et supposés inchangés pendant l'exécution.
Le dossier `Resources` est créé au démarrage du serveur et contient deux sous-dossiers : `Client` et `Server`.
## ENV
Le sous-dossier `Server` peut contenir des dossiers de plugins, chacun devant contenir au moins un fichier `.lua`. Chacun de ces dossiers est considéré comme un **plugin**. Les fichiers `.lua` situés à la racine dun plugin sont rechargés automatiquement lorsquils sont modifiés.
### Paramètres Général
Le sous-dossier `Client` accepte **uniquement** les fichiers `.zip`. Ceux-ci sont chargés au démarrage du serveur et sont supposés rester inchangés pendant son fonctionnement.
Depuis la version 3.2.0 du serveur, le serveur BeamMP accepte les variables d'environnement, qui **remplacent** les paramètres du fichier ServerConfig.toml. Toutes les variables ServerConfig de la catégorie/section « Général » sont en PascalCase ; elles sont en majuscules et préfixées par `BEAMMP_` . Par exemple, le paramètre `MaxPlayers` converti en majuscules est `MAX_PLAYERS` (notez le `_` au début d'un nouveau mot) et préfixé par `BEAMMP_MAX_PLAYERS` . Ce format est utilisé pour tous les paramètres « Général ». Les variables d'environnement suivantes existent :
## Variables denvironnement
- `BEAMMP_DEBUG`
- `BEAMMP_PRIVATE`
- `BEAMMP_PORT`
- `BEAMMP_MAX_CARS`
- `BEAMMP_MAX_PLAYERS`
- `BEAMMP_MAP`
- `BEAMMP_NAME`
- `BEAMMP_DESCRIPTION`
- `BEAMMP_TAGS`
- `BEAMMP_RESOURCE_FOLDER`
- `BEAMMP_AUTH_KEY`
- `BEAMMP_LOG_CHAT`
### Paramètres généraux
Toutes les variables d'environnement correspondant à des paramètres de configuration (chaînes ou nombres) doivent être des chaînes, par exemple `BEAMMP_NAME="Cool Server"` , `BEAMMP_NAME=Server1` , `BEAMMP_PORT=12345` . Les variables d'environnement correspondant à des paramètres de configuration booléens (true/false, on/off) doivent être soit `true` , soit `1` (les deux signifiant ON), ou toute autre valeur (signifiant OFF).
Depuis la version 3.2.0 du serveur, BeamMP prend en charge les variables denvironnement. Celles-ci **prennent priorité sur les paramètres définis dans `ServerConfig.toml`**.
Les paramètres de la section `[General]` du fichier de configuration sont convertis en majuscules, puis préfixés par `BEAMMP_`. Les mots successifs sont séparés par un `_`.
Par exemple, `MaxPlayers` devient `BEAMMP_MAX_PLAYERS`.
Les variables denvironnement disponibles sont :
* `BEAMMP_DEBUG`
* `BEAMMP_PRIVATE`
* `BEAMMP_PORT`
* `BEAMMP_MAX_CARS`
* `BEAMMP_MAX_PLAYERS`
* `BEAMMP_MAP`
* `BEAMMP_NAME`
* `BEAMMP_DESCRIPTION`
* `BEAMMP_TAGS`
* `BEAMMP_RESOURCE_FOLDER`
* `BEAMMP_AUTH_KEY`
* `BEAMMP_LOG_CHAT`
Les variables correspondant à des paramètres de configuration de type chaîne ou nombre doivent être définies sous forme de chaîne. Par exemple :
```sh
BEAMMP_NAME="Cool Server"
BEAMMP_NAME="Server1"
BEAMMP_PORT="12345"
```
Pour les paramètres booléens (`true/false`, `on/off`), utilisez `true` ou `1` pour activer loption. Toute autre valeur sera considérée comme désactivée.
### Paramètres du fournisseur
Ces variables d'environnement permettent aux fournisseurs d'hébergement (et aux autres utilisateurs disposant d'un plus grand nombre de serveurs), ici appelés « fournisseurs », d'écraser certains paramètres spécifiques au fournisseur.
Ces variables denvironnement permettent aux hébergeurs et aux utilisateurs gérant plusieurs serveurs, ci-après appelés **fournisseurs**, de remplacer certains paramètres spécifiques.
#### `BEAMMP_PROVIDER_PORT_ENV` (depuis la version 3.3.0)
#### `BEAMMP_PROVIDER_PORT_ENV` depuis la version 3.3.0
Lorsqu'elle est définie sur une chaîne non vide, la variable `BEAMMP_PORT` est remplacée par une autre, afin de pouvoir la lire depuis un environnement existant. Par exemple, Pterodactyl peut exposer `SERVER_PORT` comme environnement. Pour l'utiliser avec BeamMP-Server, il faudrait utiliser `BEAMMP_PORT=${SERVER_PORT}` , ce qui est un peu absurde.
Lorsque cette variable contient une chaîne non vide, elle indique au serveur de récupérer le port depuis une autre variable denvironnement au lieu dutiliser directement `BEAMMP_PORT`.
Au lieu de cela, vous pouvez désormais utiliser `BEAMMP_PROVIDER_PORT_ENV="SERVER_PORT"` , ce qui conduit BeamMP-Server à lire le port à partir de la variable `SERVER_PORT` ENV.
#### `BEAMMP_PROVIDER_DISABLE_CONFIG` (depuis la version 3.3.0)
Si la valeur est `1` ou `true` , le `ServerConfig.toml` **n'est pas généré** et **n'est pas lu** s'il existe. La `BEAMMP_AUTH_KEY` doit être définie pour que le serveur fonctionne.
#### `BEAMMP_PROVIDER_UPDATE_MESSAGE` (depuis la version 3.2.2)
Si la chaîne est non vide, elle remplace l'intégralité du message de mise à jour, qui est par défaut « NOUVELLE VERSION ! Veuillez mettre à jour vers la nouvelle… », etc. Le message de mise à jour que vous fournissez doit **obligatoirement** contenir `{}` , que le serveur remplacera par le nouveau numéro de version. Par exemple, votre message de mise à jour pourrait ressembler à ceci :
Par exemple, Pterodactyl peut fournir le port du serveur via la variable `SERVER_PORT`. Plutôt que dutiliser :
```sh
BEAMMP_PROVIDER_UPDATE_MESSAGE="Une nouvelle version du serveur BeamMP est disponible : {} ! Veuillez suivre le guide de mise à jour ici : https://example.com/update-"
BEAMMP_PORT=${SERVER_PORT}
```
Ce qui entraînerait un message de mise à jour comme
vous pouvez définir :
```
Une nouvelle version du serveur BeamMP est disponible : v5.0.2 ! Veuillez suivre le guide de mise à jour ici : https://example.com/update-guide
```sh
BEAMMP_PROVIDER_PORT_ENV="SERVER_PORT"
```
Veuillez veiller à bien faire comprendre aux utilisateurs qu'ils doivent effectuer la mise à jour et à leur expliquer comment procéder.
BeamMP-Server récupérera alors automatiquement le port depuis `SERVER_PORT`.
## Arguments de ligne de commande
#### `BEAMMP_PROVIDER_DISABLE_CONFIG` — depuis la version 3.3.0
Exécutez le serveur BeamMP avec l'argument `--help` pour en savoir plus. Par exemple : `./BeamMP-Server --help` .
Si cette variable vaut `1` ou `true`, le fichier `ServerConfig.toml` **ne sera ni généré ni lu**, même sil existe déjà.
## ServerConfig.toml
La variable `BEAMMP_AUTH_KEY` doit alors être définie pour que le serveur puisse fonctionner.
Ce fichier est généré au premier démarrage. Les commentaires contenus dans le fichier constituent le moyen le plus récent de comprendre la fonction de chaque paramètre.
#### `BEAMMP_PROVIDER_UPDATE_MESSAGE` — depuis la version 3.2.2
Lorsque cette variable contient une valeur, elle remplace entièrement le message de mise à jour par défaut.
Le message doit **obligatoirement contenir `{}`**. Le serveur remplacera cette séquence par le numéro de la nouvelle version.
Par exemple :
```sh
BEAMMP_PROVIDER_UPDATE_MESSAGE="Une nouvelle version du serveur BeamMP est disponible : {} ! Consultez le guide de mise à jour ici : https://example.com/update-guide"
```
Le serveur affichera alors un message similaire à :
```text
Une nouvelle version du serveur BeamMP est disponible : v5.0.2 ! Consultez le guide de mise à jour ici : https://example.com/update-guide
```
Veillez à indiquer clairement aux utilisateurs quils doivent effectuer la mise à jour et à leur expliquer comment procéder.
## Arguments de la ligne de commande
Exécutez BeamMP-Server avec largument `--help` pour afficher les informations disponibles.
Par exemple :
```sh
./BeamMP-Server --help
```
## `ServerConfig.toml`
Le fichier `ServerConfig.toml` est généré lors du premier démarrage du serveur.
Les commentaires présents dans ce fichier constituent la référence la plus à jour pour comprendre le rôle de chaque paramètre.
## Répertoire de travail
Le répertoire de travail du serveur, et non l'emplacement de l'exécutable du serveur, est le facteur déterminant sur l'endroit où le ServerConfig.toml, les fichiers journaux du serveur et le dossier Ressources sont générés.
Le **répertoire de travail du serveur**, et non le dossier contenant son exécutable, détermine lemplacement où seront générés :
# Limites
* `ServerConfig.toml` ;
* les fichiers journaux du serveur ;
* le dossier `Resources`.
Les limitations suivantes sont appliquées dans le backend BeamMP, ce qui affecte les serveurs :
## Limites
- Le nom est limité à 250 caractères
- La description est limitée à 1000 caractères
- La carte est limitée à 100 caractères
- Les tags sont limités à 100 caractères
Certaines limites sont appliquées par le backend BeamMP et affectent les serveurs :
* **Nom** : 250 caractères maximum ;
* **Description** : 1 000 caractères maximum ;
* **Carte** : 100 caractères maximum ;
* **Tags** : 100 caractères maximum.