From dd46f8b11754d3944bafeaa57aa90076390d8737 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Thu, 28 Dec 2023 19:35:28 +0100 Subject: [PATCH] Updated and added more info Updated: - `server-faq.md`: updated as per review request, fixed typo; - `game-faq.md`: updated as per review request; Italian localization: Updated: - `server-faq.md`: updated translation after review request; - `game-faq.md`: updated translation after review request; Added: - `manual.md`: translated everything that would be added by #7; - `server-faq.md`: translated everything that would be added by #3; --- docs/en/support/game-faq.md | 3 +-- docs/en/support/server-faq.md | 5 ++-- docs/it/server/manual.md | 51 ++++++++++++++++++++++++++++++++--- docs/it/support/game-faq.md | 3 +-- docs/it/support/server-faq.md | 35 ++++++++++++++++++++++-- 5 files changed, 84 insertions(+), 13 deletions(-) diff --git a/docs/en/support/game-faq.md b/docs/en/support/game-faq.md index 44a32537..8caf48fa 100644 --- a/docs/en/support/game-faq.md +++ b/docs/en/support/game-faq.md @@ -38,8 +38,7 @@ We are working hard to make performance as good as possible. Sadly, there isn't #### **Where can I find the code?** All the source code can be found on our [GitHub](https://github.com/BeamMP). -Before doing anything keep in mind that the code is under [Terms of Use](https://forum.beammp.com/t/terms-of-use-v1-0/43). -The server, launcher and Lua client code also have licenses: +Before doing anything keep in mind that the code is subject to our [Terms of Use](https://forum.beammp.com/t/terms-of-use-v1-0/43) and licenses: | Code | License | |------------|:--------------------------------------------------------------------------:| diff --git a/docs/en/support/server-faq.md b/docs/en/support/server-faq.md index 7515600f..fdef6e9c 100644 --- a/docs/en/support/server-faq.md +++ b/docs/en/support/server-faq.md @@ -12,7 +12,7 @@ All the information to setup your own server can be found [here](https://docs.be --- #### **Can you make a server using linux?** -We provide binaries for many Linux distributions [here](https://github.com/BeamMP/BeamMP-Server/releases/latest). If there are no binaries for your distribution, you can build it yourself you can do it by downloading the source on our [GitHub](https://github.com/BeamMP/BeamMP-Server), a tutorial can be found [here](https://github.com/BeamMP/BeamMP-Server#build-instructions). +We provide binaries for many Linux distributions [here](https://github.com/BeamMP/BeamMP-Server/releases/latest). If there are no binaries for your distribution, you can build it yourself by downloading the source on our [GitHub](https://github.com/BeamMP/BeamMP-Server), a tutorial can be found [here](https://github.com/BeamMP/BeamMP-Server#build-instructions). --- ## **Miscellaneous** @@ -21,8 +21,7 @@ We provide binaries for many Linux distributions [here](https://github.com/BeamM #### **Where can I find the code?** All the source code can be found on our [GitHub](https://github.com/BeamMP). -Before doing anything keep in mind that the code is under [Terms of Use](https://forum.beammp.com/t/terms-of-use-v1-0/43). -The server, launcher and Lua client code also have licenses: +Before doing anything keep in mind that the code is subject to our [Terms of Use](https://forum.beammp.com/t/terms-of-use-v1-0/43) and licenses: | Code | License | |------------|:--------------------------------------------------------------------------:| diff --git a/docs/it/server/manual.md b/docs/it/server/manual.md index 9b5f54cf..52941f2f 100644 --- a/docs/it/server/manual.md +++ b/docs/it/server/manual.md @@ -1,6 +1,49 @@ # Manuale d'uso del 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. \ No newline at end of file +# Contesto + +Il server è influenzato dallo stato di diversi parametri esterni: + +- La cartella "Resources" +- L'ENV (il contesto del processo) +- Gli argomenti da linea di comando +- Il file `ServerConfig.toml` +- La cartella di lavoro + +## Cartella "Resources" + +La cartella "Resources" è creata al primo avvio del server, insieme alle sottocartelle "Client" e "Server". +La cartella "Server" accetta altre cartelle al suo interno, ognuna contenente almeno un file `.lua`. Ciascuna delle cartelle nella cartella "Server" è considerato un "Plugin". I file `.lua` contenuti nel livello di cartelle più alto all'interno del plugin a seguito di una modifica sono ricaricati durante l'esecuzione. +La cartella "Client" accetta *solo* file `.zip` che sono caricati all'avvio del server e non mutano durante l'esecuzione. + +## 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: + +- `AuthKey` -> `BEAMMP_AUTH_KEY` +- `Port` -> `BEAMMP_PORT` +- `Description` -> `BEAMMP_DESCRIPTION` +- ...ecc. + +Qualsiasi variabile di contesto che corrisponde 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`. +Variabili di contesto che corrispondono a un parametro di configurazione che è booleano (true/false, on/off) deve essere `true` o `1` (entrambi significano ON), o qualsiasi altro valore (significa OFF). + +## Argomenti da linea di comando + +Avvia il server BeamMP con l'argomento `--help` per scoprirne di più. Ad esempio: `./BeamMP-Server --help`. + +## ServerConfig.toml + +Questo file è generato al primo avvio. I commenti all'interno del file sono il modo migliore e più aggiornato per capire che cosa faccia ogni impostazione. + +## Cartella di lavoro + +La cartella di lavoro del server, e non la posizione dell'eseguibile del server, è il fattore decisivo per la generazione di `ServerConfig.toml`, dei file di log e della cartella "Resources". + +# Limitazioni + +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. \ No newline at end of file diff --git a/docs/it/support/game-faq.md b/docs/it/support/game-faq.md index 9f1df8cd..57e2ab8b 100644 --- a/docs/it/support/game-faq.md +++ b/docs/it/support/game-faq.md @@ -36,8 +36,7 @@ Stiamo lavorando il più possibile per garantire prestazioni stabili a tutti. Se --- #### **Dove posso trovare il codice?** Tutto il codice sorgente è disponibile su [GitHub](https://github.com/BeamMP). -Prima di modificare il codice, ricordati che è protetto dai nostri [termini di utilizzo](https://forum.beammp.com/t/terms-of-use-v1-0/43). -Il server, il launcher e il client Lua sono protetti da licenze disponibili qui: +Prima di modificare il codice, ricordati che è soggetto ai nostri [termini di utilizzo](https://forum.beammp.com/t/terms-of-use-v1-0/43) e con le seguenti licenze: | Codice | Licenza | |------------|:--------------------------------------------------------------------------:| diff --git a/docs/it/support/server-faq.md b/docs/it/support/server-faq.md index f4062584..ebc9cd97 100644 --- a/docs/it/support/server-faq.md +++ b/docs/it/support/server-faq.md @@ -14,14 +14,45 @@ Tutte le informazioni per creare un server sono contenute in [questa guida](http Offriamo i binari pre-compilati per diverse distribuzioni Linux [qui](https://github.com/BeamMP/BeamMP-Server/releases/latest). Nel caso la tua distribuzione non fosse presente, puoi compilare i file sorgente scaricando il codice dal nostro [GitHub](https://github.com/BeamMP/BeamMP-Server), una guida si può trovare [qui](https://github.com/BeamMP/BeamMP-Server#build-instructions). +--- +#### **Quali sono i requisiti di sistema necessari per il server?** + +RAM: 50+ MiB (senza contare l'overhead del sistema operativo) +CPU: >1GHz, preferibilmente multicore +OS: Windows, Linux (in teoria qualsiasi POSIX) +GPU: non necessaria +HDD: 10 MiB + spazio per eventuali mod/plugin +Larghezza di banda internet: almeno 5-10 Mb/s in upload + +--- +#### **I giocatori all'esterno della mia rete locale non riescono a connettersi al mio server** + +Leggi il passo `1. Port Forwarding` della nostra guida disponibile [qui](https://docs.beammp.com/it/server/create-a-server/#1-port-forwarding). Di seguito c'è un breve riassunto dei punti salienti. +Se giocatori esterni alla tua LAN non riescono a connettersi e ricevono sul launcher codici di errore come 10060, 10061 o 10038, segui questi passi: +- Fai port forwarding della porta specificata nel file `ServerConfig.toml` (quella predefinita è 30814), sia con protocollo TCP sia UDP; +- Permetti il traffico sia in entrata sia in uscita e sia TCP sia UDP di BeamMP-Server attraverso il firewall. Spegnere il firewall di solito **non** funziona. +- Assicurati di non stare usando una VPN. +- Assicurati che il server funzioni senza errori. + +Puoi vedere se la porta è aperta correttamente usando un sito come ['portchecker.co'](https://portchecker.co/) mentre il server è attivo. + +Note: +- Alcuni ISP non offrono un indirizzo IPv4 dedicato a tutti (trattasi di [CGNAT](https://en.wikipedia.org/wiki/Carrier-grade_NAT)), quindi il port forwarding potrebbe non essere possibile. +- Non è possibile effettuare port forwarding su connessioni mobili (4G/5G). + +--- +#### **Riesco a vedere il mio server sulla lista dei server, ma non riesco a connettermi** + +Leggi [questa sezione](https://docs.beammp.com/it/server/create-a-server/#come-connettersi-a-un-server) della nostra guida. +Se non vuoi usare il pulsante `Direct Connect` e vuoi connetterti tramite la lista dei server al **tuo** server, il tuo router deve supportare il NAT-loopback, che di solito non è supportato dai router domestici. + --- ## **Varie ed eventuali** --- #### **Dove posso trovare il codice?** Tutto il codice sorgente è disponibile su [GitHub](https://github.com/BeamMP). -Prima di modificare il codice, ricordati che è protetto dai nostri [termini di utilizzo](https://forum.beammp.com/t/terms-of-use-v1-0/43). -Il server, il launcher e il client Lua sono protetti da licenze disponibili qui: +Prima di modificare il codice, ricordati che è soggetto ai nostri [termini di utilizzo](https://forum.beammp.com/t/terms-of-use-v1-0/43) e con le seguenti licenze: | Codice | Licenza | |------------|:--------------------------------------------------------------------------:|