Update manual.md

This commit is contained in:
alex.ita 2024-01-16 22:07:46 +01:00 committed by Starystars67
parent 1905db3e5d
commit 760c91757a

View File

@ -18,16 +18,44 @@ La cartella "Client" accetta *solo* file `.zip` che sono caricati all'avvio del
## ENV
Con la versione v3.2.0, il server BeamMP accetta varaibili di contesto, che **sovrascrivono** le impostazioni contenute nel file `ServerConfig.toml`. Tutte le variabili che esistono nella sezione "General" seguono la convenzione [PascalCase](https://it.wikipedia.org/wiki/Notazione_a_cammello), le variabili di contesto sono IN_MAIUSCOLO e con il prefisso `BEAMMP_`. Per esempio il campo `MaxPlayers` convertito IN_MAIUSCOLO diventa `MAX_PLAYERS` (si noti il `_` all'inizio di una nuova parola) e con il prefisso diventa `BEAMMP_MAX_PLAYERS`. Questa formattazione è seguita per tutte le impostazioni della sezione "General". Altri esempi di seguito:
### Impostazioni generali
- `AuthKey` -> `BEAMMP_AUTH_KEY`
- `Port` -> `BEAMMP_PORT`
- `Description` -> `BEAMMP_DESCRIPTION`
- ...ecc.
Con la versione v3.2.0, il server BeamMP accetta varaibili di contesto, che **prevalgono** sulle impostazioni contenute nel file `ServerConfig.toml`. Tutte le variabili che esistono nella sezione "General" seguono la convenzione [PascalCase](https://it.wikipedia.org/wiki/Notazione_a_cammello), le variabili di contesto sono IN_MAIUSCOLO e con il prefisso `BEAMMP_`. Per esempio il campo `MaxPlayers` convertito IN_MAIUSCOLO diventa `MAX_PLAYERS` (si noti il `_` all'inizio di una nuova parola) e con il prefisso diventa `BEAMMP_MAX_PLAYERS`. Questa formattazione è seguita per tutte le impostazioni della sezione "General". Esistono le seguenti variabili ENV:
Qualsiasi variabile di contesto corrispondenti a un parametro di configurazione che è una stringa o un numero, deve essere una stringa, ad esempio `BEAMMP_NAME="Cool Server"`, `BEAMMP_NAME=Server1`, `BEAMMP_PORT=12345`.
- `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`
Qualsiasi variabile di contesto corrispondente a un parametro di configurazione che è una stringa o un numero, deve essere una stringa, ad esempio `BEAMMP_NAME="Cool Server"`, `BEAMMP_NAME=Server1`, `BEAMMP_PORT=12345`.
Le variabili di contesto che corrispondono a un parametro di configurazione che è booleano (true/false, on/off) devono essere `true` o `1` (entrambi significano ON), o qualsiasi altro valore (significa OFF).
### Impostazioni per i provider
Queste variabili di contesto permettono ai fornitori di host (e altri utenti con un gran numero di server), qui denominati "providers", di sovrascrivere alcune impostazioni specifiche per i provider.
#### `BEAMMP_PROVIDER_UPDATE_MESSAGE` (da v3.2.2)
Quando non è una stringa vuota, questa variabile rimpiazza l'intero messaggio per l'aggiornamento, che di default è "NEW VERSION IS OUT! Please update to the new..." ecc.
È **OBBLIGATORIO** che il tuo messaggio contenga da qualche parte `{}`, che il server poi sostituirà con il numero della nuova versione. Per esempio, il tuo messaggio per l'aggiornamento può essere così:
```sh
BEAMMP_PROVIDER_UPDATE_MESSAGE="Una NUOVA VERSIONE di BeamMP-Server è stata rilasciata: {}! Per favore segui la guida per aggiornare qui: https://example.com/update-guide"
```
Che risulterà in un messaggio così:
```
Una NUOVA VERSIONE di BeamMP-Server è stata rilasciata: v5.0.2! Per favore segui la guida per aggiornare qui: https://example.com/update-guide
```
Per favore assicurati di rendere chiaro agli utenti che devono aggiornare il server e spiega come farlo.
## Argomenti da linea di comando
Avvia il server BeamMP con l'argomento `--help` per scoprirne di più. Ad esempio: `./BeamMP-Server --help`.
@ -47,4 +75,4 @@ Le seguenti limitazioni sono imposte dal backend e riguardano il server:
- Il nome del server è limitato a 250 caratteri.
- La descrizione del server è limitata a 1000 caratteri.
- La mappa è limitata a 100 caratteri.
- I tag sono limitati a 100 caratteri.
- I tag sono limitati a 100 caratteri.