From cca01f34cb988a40eec6330b6286abc390191a21 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Mon, 11 Dec 2023 11:55:05 +0100 Subject: [PATCH 01/10] Update server installation to follow the new website download options - New instructions for installation as per the new website's download options; - Updated dead link to the Linux dependencies; --- docs/en/server/create-a-server.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md index f2b03c24..e8317364 100644 --- a/docs/en/server/create-a-server.md +++ b/docs/en/server/create-a-server.md @@ -88,10 +88,11 @@ For the Linux installation, see the next step. Please ensure you have port-forwarded before attempting to host a server! Without you ports being forwarded, you cannot host a server to the public! -1. Download the server zip from [beammp.com](https://www.beammp.com/). You should end up with a compressed `.zip` archive, called something like `BeamMP-Server.zip`. -2. Extract the `BeamMP-Server.zip`. You will end up with a `BeamMP-Server.exe` file, among others which you can ignore for now. Make a folder somewhere and put the `BeamMP-Server.exe` there. This is where your server will live. -3. Start the server once by double-clicking on it. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a `Server.log` file and a `ServerConfig.toml` file next to your `BeamMP-Server.exe`. -4. (optional) For quick access in the future you can easily create a desktop shortcut to `BeamMP-Server.exe` using **[Right click]** > **Send to** > **Desktop (create shortcut).** +1. Ensure you have installed the [Visual C++ Redistributables](https://aka.ms/vs/17/release/vc_redist.x64.exe) in order to run the server. +2. Download the server executable from [beammp.com](https://www.beammp.com/). You should end up with an executable file, called something like `BeamMP-Server.exe`. +3. Once downloaded, make a folder somewhere and put the `BeamMP-Server.exe` there. This is where your server will live. +4. Start the server once by double-clicking on it. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a `Server.log` file and a `ServerConfig.toml` file next to your `BeamMP-Server.exe`. +5. (optional) For quick access in the future you can easily create a desktop shortcut to `BeamMP-Server.exe` using **[Right click]** > **Send to** > **Desktop (create shortcut).** Now proceed to the next step. @@ -103,12 +104,13 @@ Skip this if you did “Installation on Windows”. This step will work on Debian, Ubuntu, and similar Debian-derivatives on x86_64\. If you're on a different distribution or architecture, refer to the "Building from source” step below. -1. Ensure you have the dependencies installed which are listed [here](https://github.com/BeamMP/BeamMP-Server#prerequisites). -2. Download the server zip from [beammp.com](https://www.beammp.com/). You should end up with a compressed `.zip` archive, called something like `BeamMP-Server.zip`. -3. Extract the `BeamMP-Server.zip`. You will end up with a `BeamMP-Server-linux` file, among others which you can ignore for now. Make a folder somewhere and put the `BeamMP-Server-linux` there. This is where your server will live. -4. Open a terminal, go to that folder you put the `BeamMP-Server-linux` in, and run `chmod +x BeamMP-Server-linux`. This ensures that you have permissions to run it. -5. Start the server once by running it with `./BeamMP-Server-linux`. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a `Server.log` file and a `ServerConfig.toml` file next to your `BeamMP-Server-linux`. -6. (optional) It is heavily recommended to set up a user called `beammpserver` (or similar), as we do NOT recommend running the server as root, sudo or with your personal user account. You should then take steps to make sure that you start the server as this user only. +1. Ensure you have the dependencies installed which are listed [here](https://github.com/BeamMP/BeamMP-Server#runtime-dependencies). +2. Go to [beammp.com](https://beammp.com/) and click the “Download Server” button, you will be redirected to the server's Github release page. +3. Download the correct version for your distro. For sake of semplicity it will be called `BeamMP-Server-xxx` from now on, where `xxx` denotes the version for the distro you're using. +4. Once downloaded, you should see one file called `BeamMP-Server-xxx`, among others which you can ignore for now. Make a folder somewhere and put the `BeamMP-Server-xxx` there. This is where your server will live. +5. Open a terminal, go to that folder you put the `BeamMP-Server-xxx` in, and run `chmod +x BeamMP-Server-xxx`. This ensures that you have permissions to run it. +6. Start the server once by running it with `./BeamMP-Server-xxx`. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a `Server.log` file and a `ServerConfig.toml` file next to your `BeamMP-Server-xxx`. +7. (optional) It is heavily recommended to set up a user called `beammpserver` (or similar), as we do NOT recommend running the server as root, sudo or with your personal user account. You should then take steps to make sure that you start the server as this user only. Now proceed to the next step. From 551b3f6582077cfb437b9e31194cc0275ed9289c Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Sun, 17 Dec 2023 09:36:21 +0100 Subject: [PATCH 02/10] Update create a server instructions. Updated to keep in line with the wiki. --- docs/en/server/create-a-server.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md index e8317364..af776e62 100644 --- a/docs/en/server/create-a-server.md +++ b/docs/en/server/create-a-server.md @@ -102,7 +102,7 @@ Skip this if you did “Installation on Windows”. #### Using our build (recommended) -This step will work on Debian, Ubuntu, and similar Debian-derivatives on x86_64\. If you're on a different distribution or architecture, refer to the "Building from source” step below. +This step will work on all distributions we provide binaries for [here](https://github.com/BeamMP/BeamMP-Server/releases/latest). If you're on a different distribution or architecture, refer to the "Building from source” step below. 1. Ensure you have the dependencies installed which are listed [here](https://github.com/BeamMP/BeamMP-Server#runtime-dependencies). 2. Go to [beammp.com](https://beammp.com/) and click the “Download Server” button, you will be redirected to the server's Github release page. @@ -116,7 +116,7 @@ Now proceed to the next step. #### Building from source -BeamMP-Server for Linux can be officially built on both Debian, Ubuntu, other Debian-derivatives, and ArchLinux. Other distributions are likely to work, too, but aren't officially supported. If you want to 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). +BeamMP-Server for Linux can be officially built on Debian, Ubuntu, other Debian-derivatives, and ArchLinux. Other distributions are likely to work, too, but aren't officially supported. If you want to 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). At the end, make sure to run your server once with `./BeamMP-Server` and then proceed to the next step. From 5ca22dde3ad0188d6e98707178e3b2a0916b3ee9 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Sun, 17 Dec 2023 16:37:00 +0100 Subject: [PATCH 03/10] Added the most important things to the Italian localization Added: - Italian localization for: "create-a-server.md", "manual.md", "getting-started.md". Fixed: - "getting-started.md": updated some links, reorganized it to be more similar to "create-a-server.md". - "create-a-server.md": updated some links; --- docs/en/game/getting-started.md | 41 +++--- docs/en/server/create-a-server.md | 4 +- docs/it/game/getting-started.md | 33 +++++ docs/it/server/create-a-server.md | 214 ++++++++++++++++++++++++++++++ docs/it/server/manual.md | 6 + 5 files changed, 278 insertions(+), 20 deletions(-) create mode 100644 docs/it/game/getting-started.md create mode 100644 docs/it/server/create-a-server.md create mode 100644 docs/it/server/manual.md diff --git a/docs/en/game/getting-started.md b/docs/en/game/getting-started.md index 08c2a4ed..ee9ccd42 100644 --- a/docs/en/game/getting-started.md +++ b/docs/en/game/getting-started.md @@ -5,26 +5,31 @@ BeamMP is only compatible with legitimate, Steam versions of the game. "Cracked" copies are not supported. --- -## **Windows Installation** -1. Go to our [Official Website](https://beammp.com/) and download the latest `BeamMP_Installer.zip` by clicking the green, "Download Client" button. -2. Open the `BeamMP_Installer.zip` archive. + +## **Installation** + +BeamMP is natively compatible only with Windows at the moment. + +### **Windows Installation** +1. Go to [beammp.com](https://beammp.com/) and click the "Download client" button. +2. Extract the `BeamMP_Installer.zip` archive. 3. Launch `BeamMP_Installer.exe` and follow the instructions. -4. The BeamMP Launcher icon should appear on your desktop. If not, just search for “BeamMP” in the windows search bar. Afterwards you should see a little black window appear, shortly after BeamNG.drive should start. Remember to keep this console open while you are playing. -5. Once BeamNG launches, press “Play”. In the main menu you should see “Multiplayer” and from there you can play BeamMP. -6. You will be prompted with a login pop-up, you can either play as a guest (not all servers will allow guests), or create an account on our [Forum](https://forum.beammp.com) and then login to BeamMP with your credentials. -7. Select any server you like, and press “Connect”. Enjoy! +4. The BeamMP Launcher icon should appear on your desktop. If not, just search for “BeamMP” in the windows search bar. +5. Once the launcher has started, you should see a terminal window, shortly after BeamNG.drive should automatically start. **Do not** close the terminal window. +6. Once BeamNG launches, in the main menu, click the `Multiplayer` button to start multiplayer. +7. You will be prompted to login or play as a guest (not all servers will allow guests). You can create an account on our [forum](https://forum.beammp.com) and then login to BeamMP with the same credentials. +8. Select any server you like, and press `Connect`. Enjoy! -Just to note, as you are loading into a map with multiple vehicles spawned it might take longer than expected to join. +Note: _As you are loading into a map with multiple vehicles spawned it might take longer than expected to join._ ---- -## **Known Issues** -If you don’t see the “Multiplayer” button. Make sure that the BeamMP mod is activated in the “Mod Manager” then try pressing CTRL + L. - -It's also important that BeamMP is the **only** mod activated in the “Mod Manager” as otherwise this can cause issues. - -If you need further help with installation, you are welcome to create a post on our [Forum](https://forum.beammp.com) or ask in the [Official Discord](https://discord.gg/beammp) - ---- ## **Linux Installation** -BeamMP should work with `wine`, but is not officially supported (yet). \ No newline at end of file +BeamMP should work with `wine`, but is not officially supported (yet). + +--- + +## **Known Issues** +- If you don’t see the “Multiplayer” button. Make sure that the BeamMP mod is activated in the “Mod Manager” then try pressing CTRL + L. +- It's also important that BeamMP is the **only** mod activated in the “Mod Manager” as otherwise this can cause issues. + +If you need further help with installation, you are welcome to create a post on our [forum](https://forum.beammp.com) or ask on our [Discord server](https://discord.gg/beammp). diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md index af776e62..3945d962 100644 --- a/docs/en/server/create-a-server.md +++ b/docs/en/server/create-a-server.md @@ -12,7 +12,7 @@ Servers are an integral part of BeamMP; players are connected to each other thro You can make private servers, which only people you invite can join, or public servers, which will show in our official server list. -Getting a server up and running is a process with a few steps! It's quite easy, but if you run into any issues, feel free to ask on our [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#server-support` channel. Also refer to the [Server Maintenance](https://wiki.beammp.com/en/home/server-maintenance) section for more info.  +Getting a server up and running is a process with a few steps! It's quite easy, but if you run into any issues, feel free to ask on our [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#support` channel. Also refer to the [Server Maintenance](https://wiki.beammp.com/en/home/server-maintenance) section for more info.  Please make sure to read the [LICENSE](https://raw.githubusercontent.com/BeamMP/BeamMP-Server/master/LICENSE) of the server before use. @@ -32,7 +32,7 @@ This step is the same for almost every game's server, such as Minecraft Servers, While the default **Port** you want to “forward” is **30814**, you can choose any other number >1024, but you need to note down what you picked if it's not 30814\. You need to forward both **TCP** and **UDP**.  -If you have issues, also feel free to ask on our [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#server-support` channel. +If you have issues, also feel free to ask on our [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#support` channel. #### 1.1 Firewall diff --git a/docs/it/game/getting-started.md b/docs/it/game/getting-started.md new file mode 100644 index 00000000..a93524c4 --- /dev/null +++ b/docs/it/game/getting-started.md @@ -0,0 +1,33 @@ +# Per iniziare + +--- +## **Prima di iniziare** +BeamMP è compatibile solo con versioni originali del gioco. Le versioni piratate non sono supportate. + +--- +## **Installazione** + +BeamMP è nativamente compatibile solo con Windows al momento. + +### **Installazione su Windows** +1. Vai su [beammp.com](https://beammp.com/) e clicca il pulsante "Download client". +2. Estrai la cartella `BeamMP_Installer.zip`. +3. Avvia `BeamMP_Installer.exe` e segui le istruzioni a schermo. +4. L'icona di `BeamMP-Launcher` dovrebbe apparire sul tuo desktop. Se questo non fosse il caso cerca `BeamMP` nella barra di ricerca di Windows, dopodiché clicca il l'icona per avviarlo. +5. Una volta avviato l'eseguibile vedrai un terminale e in seguito BeamNG si avvierà automaticamente. **Non** chiudere la finestra del terminale. +6. Raggiunto il menù principale del gioco, clicca sul pulsante `Multiplayer` per giocare in multigiocatore. +7. Prima di giocare, ti sarà richiesto di effettuare il login o di giocare come ospite (non tutti i server accettano giocatori ospiti). Puoi creare un account sul nostro [forum](https://forum.beammp.com) e poi usare le credenziali del forum per fare il login in gioco. +8. Seleziona un server che ti piace e premi `Connect`. + +Nota: _Se ti connetti ad un server con molti giocatori potresti impiegare più tempo ad entrare in gioco._ + +### **Installazione su Linux** +BeamMP non è (ancora) ufficialmente supportato su Linux ma dovrebbe comunque funzionare tramite `wine`. + +--- + +## **Problemi noti** +- Se il pulsante `Multiplayer` non è visibile, assicurarsi che la mod `multiplayerbeammp` sia l'unica attiva nel "Mod Manager" dopodiché premi `ctrl + L`. +- Assicurarsi che la mod `multiplayerbeammp` sia l'unica attiva nel "Mod Manager", altrimenti potrebbero sorgere diversi problemi. + +Se hai dei problemi, chiedi pure sul nostro [Forum](https://forum.beammp.com) o sul nostro [server Discord](https://discord.gg/beammp) nel canale `#support`. \ No newline at end of file diff --git a/docs/it/server/create-a-server.md b/docs/it/server/create-a-server.md new file mode 100644 index 00000000..381cd8e8 --- /dev/null +++ b/docs/it/server/create-a-server.md @@ -0,0 +1,214 @@ +# Installazione del server + +## **Creazione del server** +Basi per la creazione di un server + +--- +### **Introduzione** + +**Creare un server per BeamMP è facile e veloce!** + +I server sono una parte integrante di BeamMP, tutti i giocatori sono connessi tra loro attraverso il server. I server possono funzionare nativamente su Windows e Linux. + +Puoi creare server privati, ai quali si possono connettere solo persone che inviti, o server pubblici, che saranno visibili sulla nostra ufficiale lista di server. + +Per far funzionare correttamente un server è necessario seguire alcuni passi! È abbastanza semplice, ma se hai dei problemi, chiedi pure sul nostro [Forum](https://forum.beammp.com) o sul nostro [server Discord](https://discord.gg/beammp) nel canale `#support`. Fai anche riferimento alla sezione di [Manutenzione Server](https://wiki.beammp.com/en/home/server-maintenance) per ulteriori informazioni. + +Assicurati di aver letto e compreso la [LICENZA](https://raw.githubusercontent.com/BeamMP/BeamMP-Server/master/LICENSE) del server prima dell'uso. + +Nota: _Il server supporta esclusivamente indirizzi IPv4\. Se non sai che tipo di indirizzo usi, visita il sito_ [_whatsmyip.org_](https://www.whatsmyip.org/) _- se l'indirizzo contiene_ `_:_` _due punti, è di tipo **IPv6**. In tal caso devi investigare più a fondo e capire se hai a disposizione anche un indirizzo IPv4\. Per far ciò puoi telefonare al tuo ISP chiedendo informazioni a riguardo, o chiedi a qualcuno che se ne intende che conosci. Il supporto per gli indirizzi IPv6 è in programma._ + +## Configurare il server + +La configurazione consiste di pochi passi che sono obbligatori da seguire. + +### 1. Port forwarding + +_Se stai utilizzando un VPS (Virtual Private Server) o un Rootserver, puoi generalmente saltare questo passo. Se non sei sicuro di cosa sia un VPS o Rootserver, non lo stai usando._ + +Questo passo è necessario se vuoi che qualcuno all'esterno della tua casa ("all'esterno del tuo network locale o LAN") possa accedere al server. + +Questo passo è praticamente il medesimo per tutti i server di gioco, come i server di Minecraft, quindi puoi trovare molte guide su internet riguardo all'argomento, anche per il tuo router in specifico. Una buona guida è [la seguente](https://www.aranzulla.it/come-aprire-le-porte-del-router-31808.html). Assicurati di aggiungere nelle regole di forwarding la porta **30814** sia in protocollo **TCP** sia in **UDP**. + +La **porta** di default può essere cambiata con quella che desideri, basta che non sia già utilizzata da altri servizi e che il numero sia >1024. Ricordati o segnati quale porta hai scelto se non usi quella predefinita\. Il forwarding deve essere sempre fatto sia in protocollo **TCP** sia in **UDP**. + +Se hai dei problemi, chiedi pure sul nostro [Forum](https://forum.beammp.com) o sul nostro [server Discord](https://discord.gg/beammp) nel canale `#support`. + +#### 1.1 Firewall + +A seconda della tua configurazione, potresti dover aggiungere BeamMP-Server alle regole del tuo firewall. Questo è il caso di Windows (spegnere il firewall di solito **non** funziona) e su molti server Linux pre-configurati. + +Qui, come nel caso del port forwarding, devi permettere il traffico **sia in entrata sia in uscita** e sia **TCP** sia **UDP** di BeamMP-Server attraverso il firewall. Se invece il tuo firewall richiede una porta, usa la stessa utilizzata nel passo precedente ("1\. Port forwarding"). + +Se hai dei problemi, chiedi pure sul nostro [Forum](https://forum.beammp.com) o sul nostro [server Discord](https://discord.gg/beammp) nel canale `#support`. + +### 2. Ottenere una chiave di autenticazione + +La chiave di autenticazione, spesso chiamata "AuthKey", è necessaria per creare un server **pubblico**, ma è **consigliato** usarla anche per i server privati. + +Ti servirà un account [Discord](https://discord.com) per questo passo. Discord è necessario per evitare problemi di spam. + +#### 2.1 + +Richiedi la tua chiave al [Keymaster](https://beammp.com/keymaster), clicca su "Keys" sulla sinistra (con il simbolo di una chiave) e poi clicca sul testo blu '_here_'. + +
+ ![](/assets/content/keymaster1.png) +
+ +#### 2.2 + +Inserisci il nome del server (questo è solo il nome per la chiave, non è il nome vero e proprio del server), ad esempio: + +
+ ![](/assets/content//keymaster_key.png) +
+ +Il risultato dovrebbe essere simile a questo: + +
+ ![](/assets/content//keymaster3.png) +
+ +Ignora il campo '_IP_'. + +**NON CONDIVIDERE MAI QUESTA CHIAVE. TRATTALA COME UNA PASSWORD** + +Hai un numero limitato di chiavi. Puoi utilizzare una chiave su un server per volta, quindi non puoi far partire due server con la stessa chiave nello stesso momento. + +#### 2.3 + +Copia il testo del campo "key", in questo esempio è `3173a2e-6az0-4542-a3p0-ddqq5ff95558` e tienilo pronto per il passo successivo. + +### 3. Installazione + +Il BeamMP-Server è disponibile per Windows e Linux. Le prossime due sezioni sono dedicate all'installazione su Windows e Linux rispettivamente. + +### 3.a Installazione su Windows + +Per l'installazione su Linux, salta alla sezione succesiva. + +Ricordati di fare il port forwarding, altrimenti il tuo server non sarà raggiungibile al pubblico! + +1. Assicurati di aver installato i [Visual C++ Redistributables](https://aka.ms/vs/17/release/vc_redist.x64.exe), necessari per eseguire il server. +2. Scarica l'eseguibile del server da [beammp.com](https://www.beammp.com/). Dovresti trovarti con un file chiamato `BeamMP-Server.exe`. +3. Una volta scaricato, crea una cartella dove desideri e sposta al suo interno `BeamMP-Server.exe`. Qui è dove il server risiederà. +4. Avvia il server cliccandoci due volte. Questo genererà tutti i files necessari e quando vedi del testo sul terminale, puoi chiuderlo. Dovresti vedere questi files chiamati `Server.log` e `ServerConfig.toml` nella stessa cartella di `BeamMP-Server.exe`. +5. (opzionale) Per accedere velocemente al server, crea un collegamento al desktop **cliccando col tasto destro** su `BeamMP-Server.exe` > **Invia a** > **Desktop (crea collegamento)**. + +Procedi ora al passo "4\. Configurazione". + +### 3.b Installazione su Linux + +#### Utilizzando la build precompilata (consigliato) + +Questo passo è valido per tutte le distribuzioni Linux per cui offriamo i files binari [qui](https://github.com/BeamMP/BeamMP-Server/releases/latest). Se usi una distribuzione o architettura differente, salta al passo "Compilazione file sorgente". + +1. Assicurati di avere installato tutte le dipendenze che sono elencate [qui](https://github.com/BeamMP/BeamMP-Server#runtime-dependencies). +2. Vai su [beammp.com](https://www.beammp.com/) e clicca il pulsante "Download server", sarai reindirizzato alla pagina Github delle release del server. +3. Scarica la versione corretta per la tua distribuzione. Per semplicità sarà chiamata `BeamMP-Server-xxx` durante la guida, dove `xxx` è la versione per la distribuzione che stai usando. +4. Una volta scaricato, crea una cartella dove desideri e sposta al suo interno `BeamMP-Server-xxx`. Qui è dove il server risiederà. +5. Apri un terminale, naviga alla cartella dove si trova `BeamMP-Server-xxx` e incolla il comando `chmod +x BeamMP-Server-xxx`. Questo farà in modo che si abbiano i permessi per eseguire il server. +6. Avvia il server con il comando `./BeamMP-Server-xxx`. Questo genererà tutti i files necessari e quando vedi del testo sul terminale, puoi chiuderlo. Dovresti vedere questi files chiamati `Server.log` e `ServerConfig.toml` nella stessa cartella di `BeamMP-Server-xxx`. +7. (opzionale) È consigliato creare un utente chiamato `beammpserver` (o simile), siccome **non** raccomandiamo di eseguire il server come root, sudo o con il proprio utente personale. Dovresti poi rendere possibile l'esecuzione del server solo da questo utente. + +Procedi ora al passo "4\. Configurazione". + +#### Compilazione file sorgente + +BeamMP-Server per Linux può essere compilato in modo ufficiale su Debian, Ubuntu, altre distribuzioni derivate da Debian e ArchLinux. Altre distribuzioni non sono state provate, ma è molto probabile che funzionino lo stesso. Se vuoi compilare i codice sorgente puoi farlo, 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). + +Infine ricordati di eseguire il server con il comando `./BeamMP-Server-xxx`, dopodiché vai al passo successivo. + +### 4. Configurazione + +Dopo che il server è stato avviato almeno una volta, dovrebbe aver creato diversi files e mostrato un paio di errori; questo perché manca ancora qualcosa. La tua cartella dovrebbe contenere questi files: + +
+ ![](/assets/content/after-running-once.png) +
+ +Potrebbero chiamarsi `ServerConfig`, `Server` e `BeamMP-Server` senza estensioni, ma è corretto anche questo! + +Apri `ServerConfig.toml` con un editor di testo come `Blocco note`. Per fare ciò **click col tasto destro** > **Apri con** > **Blocco note** o un qualsiasi altro editor di testo. + +Dovresti vedere qualcosa di simile a questo: +```TOML +[General] +AuthKey = '' +Debug = false +Description = 'BeamMP Default Description' +Map = '/levels/gridmap_v2/info.json' +MaxCars = 1 +MaxPlayers = 10 +Name = 'BeamMP Server' +Port = 30814 +Private = false +ResourceFolder = 'Resources' +``` + +Questo è il tuo file di configurazione. Utilizza un formato chiamato TOML. Fai anche riferimento alla sezione di [Manutenzione Server](https://wiki.beammp.com/en/home/server-maintenance) per maggiori informazioni. + +Per ora ci interessa soltanto il campo `AuthKey`. Incolla tra le virgolette `''` la chiave ottenuta nel passo "2\. Ottenere una chiave di autenticazione". + +Per questo esempio, dovrà essere così: +```TOML +AuthKey = '3173a2e-6az0-4542-a3p0-ddqq5ff95558' +``` + +Dai anche un nome al tuo server tramite il campo `Name`. Puoi utilizzare colori e altri tipi di formattazione seguendo le indicazioni di [questa sezione](https://wiki.beammp.com/en/home/server-maintenance#customize-the-look-of-your-server-name) della pagina di manutenzione del server. + +Se hai scelto una **porta** differente da **30814** inseriscila al posto di quella predefinita in `Port`. + +**IMPORTANTE:** Il tuo server **non** sarà visibile sulla lista di server fintanto che `Private = true`. _Se_ vuoi rendere visibile su tale lista il tuo server, metti `Private = false`. + +### 5. Verifica di corretto funzionamento + +Avvia nuovamente il server e guarda se mostra altri messaggi con l'etichetta `[ERROR]`. La finestra deve rimanere aperta. A questo punto puoi avviare BeamMP utilizzando il BeamMP-Launcher e dovresti trovare il tuo server con il nome specificato nel file `ServerConfig.toml` nella lista dei server. + +--- + +## Come aggiungere mod al tuo server + +Sia le mod dei veicoli che una mappa mod, vanno inserite nella cartella `Resources/Client` all'interno della cartella del server. + +### Mod generiche + +Se ti interessa aggiungere mod di veicoli, basta aggiungerle alla cartella `Resources/Client`. Verranno scaricate automaticamente da chiunque si connetta al server. + +### Mappe + +Tutte le mappe ufficiali del gioco (quindi che non sono mod) non necessitano di essere installate, devi soltanto cambiare il valore del campo `Map` del file `ServerConfig.toml` con una di [queste stringhe](https://wiki.beammp.com/en/home/server-maintenance#all-vanilla-maps-names). Per mappe non ufficiali (mod), bisogna fare così: + +1. Inserire il file `.zip` della mappa nella cartella `Resources/Client` all'interno della cartella del server. +2. Apri il file `.zip` della mappa senza estrarlo e naviga alla cartella `/levels/`. In questa cartella ce ne dovrebbe essere un'altra con il nome della mappa, ad esempio `myawesomedriftmap2021`. Copia o ricordati questo nome _esattamente come è scritto su tale cartella_. +3. Apri il file `ServerConfig.toml`. Nel campo `Map` dovresti vedere il valore `/levels/MAPNAME/info.json`, dove `MAPNAME` è molto probabilmente `gridmap_v2`. Cambia `MAPNAME` col nome della cartella del passo precedente, per questo esempio `myawesomedriftmap2021`. Salvo rare eccezioni, tutte le mappe necessitano di avere `/info.json` alla fine. Dovresti ottenere qualcosa di simile: +```TOML +Map = '/levels/myawesomedriftmap2021/info.json' +``` + +La mappa, come tutte le altre mod, verrà scaricata automaticamente da chiunque si connetta al server. + +**Se la connessione non va a buon fine**, installa la mappa in BeamNG.drive (non multigiocatore) e caricala. Quando sei in gioco, apri la console con il tasto `ò` (se non utilizzi il layout Italiano è un tasto differente, guarda l'assegnazione di **Toggle System Console** in **Options > Controls > Bindings** nella sezione **General Debug**), ed esegui questo comando: `print(getMissionFilename())`. Otterrai così il corretto nome da utilizzare. + +Il tuo server con la mappa moddata è pronto! + +## Come connettersi a un server + +Come tu e altre persone possono connettersi al tuo server. + +### Connettersi al proprio server + +Se sei il proprietario del server devi connetterti tramite connessione diretta, per fare questo, clicca il pulsante **Direct Connect** a sinistra della lista dei server. Lascia i parametri predefiniti (IP `127.0.0.1` e porta `30814`) e clicca `Connect`. Se il tuo server è in esecuzione all'esterno della tua LAN devi prima [trovare il suo IP](https://whatismyipaddress.com/) e poi connetterti direttamente. + +### Connessione di altre persone al proprio server (Pubblico) + +Chiunque può connettersi al tuo server fintanto che si sia fatto port forwarding (una buona guida è [la seguente](https://www.aranzulla.it/come-aprire-le-porte-del-router-31808.html)). Per connettersi a un server pubblico basta andare sulla lista dei server, cercare il nome del server e cliccare `Connect`. Se non sei sicuro del nome del server, è lo stesso che hai messo nel file `ServerConfig.toml`. + +### Connessione di altre persone al proprio server (Privato) + +Chiunque può connettersi al tuo server fintanto che si sia fatto port forwarding (una buona guida è [la seguente](https://www.aranzulla.it/come-aprire-le-porte-del-router-31808.html)). Per connettersi a un server privato clicca il pulsante **Direct Connect** a sinistra della lista dei server, dopodiché inserisci l'indirizzo IP e la porta del server. Se non sei sicuro di quale sia il tuo IP, puoi verificarlo da [questo sito](https://whatismyipaddress.com/). Se non sei sicuro della porta, è la stessa che hai messo nel file `ServerConfig.toml`. + +### Connessione di altre persone al proprio server (Hamachi) + +Solo le persone nel tuo network di Hamachi possono connettersi al tuo server, non è necessario fare port forwarding in questo caso. Chi vuole connettersi, dopo essere entrato nel tuo network Hamachi, userà l'IP di Hamachi e la porta predefinita per eseguire una connessione diretta al tuo server. Per maggiori informazioni guarda la nostra guida per gli utenti [Hamachi](https://forum.beammp.com/t/tutorial-how-to-host-a-server-with-logmein-hamachi/52). \ No newline at end of file diff --git a/docs/it/server/manual.md b/docs/it/server/manual.md new file mode 100644 index 00000000..9b5f54cf --- /dev/null +++ b/docs/it/server/manual.md @@ -0,0 +1,6 @@ +# 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 From 8e2b4a2b4d532cb6f5a1bcf35f40c494265a3ad8 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Mon, 18 Dec 2023 14:21:43 +0100 Subject: [PATCH 04/10] Updated as per review request --- docs/en/server/create-a-server.md | 2 +- docs/it/server/create-a-server.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md index 3945d962..7e24394e 100644 --- a/docs/en/server/create-a-server.md +++ b/docs/en/server/create-a-server.md @@ -116,7 +116,7 @@ Now proceed to the next step. #### Building from source -BeamMP-Server for Linux can be officially built on Debian, Ubuntu, other Debian-derivatives, and ArchLinux. Other distributions are likely to work, too, but aren't officially supported. If you want to 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). +Other distributions in addition to the ones that already have a binary [here](https://github.com/BeamMP/BeamMP-Server/releases/latest) are likely to work too, but aren't officially supported. If you want to 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). At the end, make sure to run your server once with `./BeamMP-Server` and then proceed to the next step. diff --git a/docs/it/server/create-a-server.md b/docs/it/server/create-a-server.md index 381cd8e8..06d13618 100644 --- a/docs/it/server/create-a-server.md +++ b/docs/it/server/create-a-server.md @@ -116,7 +116,7 @@ Procedi ora al passo "4\. Configurazione". #### Compilazione file sorgente -BeamMP-Server per Linux può essere compilato in modo ufficiale su Debian, Ubuntu, altre distribuzioni derivate da Debian e ArchLinux. Altre distribuzioni non sono state provate, ma è molto probabile che funzionino lo stesso. Se vuoi compilare i codice sorgente puoi farlo, 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). +È molto probabile, ma non è stato ufficialmente provato, che BeamMP-Server per Linux funzioni su distribuzioni differenti da quelle per cui offriamo i files binari [qui](https://github.com/BeamMP/BeamMP-Server/releases/latest). Se vuoi compilare i codice sorgente puoi farlo, 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). Infine ricordati di eseguire il server con il comando `./BeamMP-Server-xxx`, dopodiché vai al passo successivo. From 55866c50bdbb6eb993fae80764404b3f6172c0ff Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Tue, 26 Dec 2023 12:01:26 +0100 Subject: [PATCH 05/10] Updated FAQs - Updated dead links; - Updated server on Linux FAQs; - Both FAQs have the same structure now; - Added table for code licenses; --- docs/en/support/game-faq.md | 29 +++++++++++++---------------- docs/en/support/server-faq.md | 27 ++++++++++++++++++++++++--- 2 files changed, 37 insertions(+), 19 deletions(-) diff --git a/docs/en/support/game-faq.md b/docs/en/support/game-faq.md index 26db5546..44a32537 100644 --- a/docs/en/support/game-faq.md +++ b/docs/en/support/game-faq.md @@ -7,7 +7,7 @@ List of commonly asked questions and known bugs. --- #### **How do I install BeamMP?** -There is a full guide on how to install BeamMP on Windows, you can find it [here](/en/installation). +There is a full guide on how to install BeamMP on Windows, you can find it [here](https://docs.beammp.com/game/getting-started/). --- #### **Does BeamMP work on a cracked version of BeamNG?** @@ -19,14 +19,12 @@ BeamMP does not work with cracked versions or outdated versions of BeamNG.drive. The Client is not officially supported on Linux. However, you might be able to get it working by running the launcher in the same proton prefix as the game. -The Server builds can be found in the `BeamMP_Server.zip` download on the [Official Website](https://beammp.com/), or in the [releases tab on the Github](https://github.com/BeamMP/BeamMP-Server/releases). For building instructions see [here](https://github.com/BeamMP/BeamMP-Server/releases). - --- #### **Why is the launcher flagged by my antivirus or by Windows Defender** In order to prevent Windows Defender from flagging a specific .exe, we need to buy a license which is very expensivr, therefor, BeamMP might get flagged by Windows Defender -Some antivirus may flag BeamMP as a virus beacause it does some interactions with network and other stuff. There are **no viruses** in any of the code. The code for the launcher, server, and lua client can be seen on our [GitHub](https://github.com/BeamMP/BeamMP-Server/releases). +Some antivirus may flag BeamMP as a virus beacause it does some interactions with network and other stuff. There are **no viruses** in any of the code. The code for the launcher, server, and lua client can be seen on our [GitHub](https://github.com/BeamMP). --- #### **I have poor performance, what should I do?** @@ -40,21 +38,20 @@ 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 under [Terms of Use](https://forum.beammp.com/t/terms-of-use-v1-0/43) +| Code | License | +|------------|:--------------------------------------------------------------------------:| +| Server | [LICENSE](https://github.com/BeamMP/BeamMP-Server/blob/master/LICENSE) | +| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/README.md) | +| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE.md) | --- #### **I have found a bug or an exploit what should I do?** -If the issue is code related and you know how to use Github, you can post the issue on our [GitHub](https://github.com/BeamMP). - -If it is not something sensitive, you can create a post on our [BeamMP Forum](https://forum.beammp.com) or you can report this on our [Official Discord](https://discord.gg/beammp). - -If the information is sensitive you can directly report the issue to a Staff member on our [Discord](https://discord.gg/beammp). - - - - - - +If the issue is code related and you know how to use Github, create a new "Issue" in the appropriate repository on our [GitHub](https://github.com/BeamMP). We use an issue-based workflow so even if you already have a fix for the bug, consider opening a new "Issue", then asking a "Pull Request" that solves your "Issue". More info on contributing can be found [here](https://github.com/BeamMP/BeamMP/blob/development/CONTRIBUTING.md). +If you don't have a GitHub account or you don't know how to use GitHub you can get in touch with us in the following ways: +- If it is not something sensitive, you can create a post on our [BeamMP Forum](https://forum.beammp.com) or you can report this on our [Official Discord](https://discord.gg/beammp). +- If the information is sensitive you can directly report the issue to a Staff member on our [Discord](https://discord.gg/beammp). \ No newline at end of file diff --git a/docs/en/support/server-faq.md b/docs/en/support/server-faq.md index 93fdc3f7..7515600f 100644 --- a/docs/en/support/server-faq.md +++ b/docs/en/support/server-faq.md @@ -1,4 +1,4 @@ -# Server FAQ +# F.A.Q. and Known Issues List of commonly asked questions and known bugs. --- @@ -7,13 +7,34 @@ List of commonly asked questions and known bugs. --- #### **How can I setup my own servers** -All the information to setup your own server can be found [here](../create-a-server). +All the information to setup your own server can be found [here](https://docs.beammp.com/server/create-a-server/). --- #### **Can you make a server using linux?** -BeamMP server can be built on Linux, however builds are not provided, you should build it yourself. It is officially supported on Debian 9 and Debian 10 a tutorial can be found [Here](https://github.com/BeamMP/BeamMP-Server/releases). +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). --- +## **Miscellaneous** +--- +#### **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: + +| Code | License | +|------------|:--------------------------------------------------------------------------:| +| Server | [LICENSE](https://github.com/BeamMP/BeamMP-Server/blob/master/LICENSE) | +| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/README.md) | +| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE.md) | + +--- +#### **I have found a bug or an exploit what should I do?** + +If the issue is code related and you know how to use Github, create a new "Issue" in the appropriate repository on our [GitHub](https://github.com/BeamMP). We use an issue-based workflow so even if you already have a fix for the bug, consider opening a new "Issue", then asking a "Pull Request" that solves your "Issue". More info on contributing can be found [here](https://github.com/BeamMP/BeamMP/blob/development/CONTRIBUTING.md). + +If you don't have a GitHub account or you don't know how to use GitHub you can get in touch with us in the following ways: +- If it is not something sensitive, you can create a post on our [BeamMP Forum](https://forum.beammp.com) or you can report this on our [Official Discord](https://discord.gg/beammp). +- If the information is sensitive you can directly report the issue to a Staff member on our [Discord](https://discord.gg/beammp). \ No newline at end of file From 8a71b687ce0ceeee32360a20cc8f0ef687250dea Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Tue, 26 Dec 2023 12:04:49 +0100 Subject: [PATCH 06/10] Italian localization for FAQs --- docs/it/support/game-faq.md | 55 +++++++++++++++++++++++++++++++++++ docs/it/support/server-faq.md | 39 +++++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 docs/it/support/game-faq.md create mode 100644 docs/it/support/server-faq.md diff --git a/docs/it/support/game-faq.md b/docs/it/support/game-faq.md new file mode 100644 index 00000000..9f1df8cd --- /dev/null +++ b/docs/it/support/game-faq.md @@ -0,0 +1,55 @@ +# F.A.Q. e problemi noti +Una lista di domande frequenti e bug noti. + +--- +## **Client** + +--- +#### **Come si installa BeamMP?** + +C'è una guida per installare BeamMP, la puoi trovare [qui](https://docs.beammp.com/it/game/getting-started/). + +--- +#### **BeamMP funziona su versioni piratate del gioco?** + +Le versioni piratate o non aggiornate di BeamNG.drive non sono supportate. Se vuoi usare BeamMP, acquista il gioco. + +--- +#### **BeamMP funziona su Linux?** + +Il client non è ufficialmente supportato su Linux, ma dovrebbe comunque funzionare tramite `wine` o utilizzando lo stesso prefisso del gioco tramite `proton`. + +--- +#### **Perché il launcher è segnalato come un virus da Windows defender?** + +Il launcher è segnalato come **falso positivo** perché non è stato firmato con delle licenze specifiche che, essendo molto costose, non sono state acquistate. +Non c'è alcun codice malevolo in BeamMP; tutto il codice per il server, launcher e il client Lua è disponibile sul nostro [GitHub](https://github.com/BeamMP). + +--- +#### **Le prestazioni del gioco sono basse, cosa posso fare?** + +Stiamo lavorando il più possibile per garantire prestazioni stabili a tutti. Se hai già abbassato le impostazioni grafiche, purtroppo non c'è molto che puoi fare se non giocare con un numero minore di persone. Il gioco è strettamente legato alla potenza e al numero di core della CPU, quindi con processori più vecchi (anche con quattro core) avrai difficoltà ad avere buone prestazioni con più di una manciata di giocatori. + +--- +## **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: + +| Codice | Licenza | +|------------|:--------------------------------------------------------------------------:| +| Server | [LICENSE](https://github.com/BeamMP/BeamMP-Server/blob/master/LICENSE) | +| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/README.md) | +| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE.md) | + +--- +#### **Ho trovato un bug o un exploit cosa faccio?** + +Se il problema è legato al codice e sai come usare GitHub, crea una nuova "Issue" nel repo corretto sul nostro [GitHub](https://github.com/BeamMP). Il nostro flusso di lavoro è basato sulle "Issue" di GitHub; anche se hai già una soluzione al bug, sei pregato di creare una nuova "Issue" e poi chiedere una "Pull Request" che risolva la "Issue". Maggiori informazioni [qui](https://github.com/BeamMP/BeamMP/blob/development/CONTRIBUTING.md). + +Nel caso non abbia o non sappia usare GitHub, puoi procedere nei seguenti modi: +- Se il problema non concerne nulla di sensibile, puoi creare un nuovo post sul nostro [forum](https://forum.beammp.com) o sul nostro [Discord](https://discord.gg/beammp). +- Se il problema concerne informazioni sensibili, contatta un nostro membro dello staff su [Discord](https://discord.gg/beammp). \ No newline at end of file diff --git a/docs/it/support/server-faq.md b/docs/it/support/server-faq.md new file mode 100644 index 00000000..f4062584 --- /dev/null +++ b/docs/it/support/server-faq.md @@ -0,0 +1,39 @@ +# F.A.Q. e problemi noti +Una lista di domande frequenti e bug noti. + +--- +## **Server** + +--- +#### **Come posso creare un server?** + +Tutte le informazioni per creare un server sono contenute in [questa guida](https://docs.beammp.com/it/server/create-a-server/). + +--- +#### **Posso creare un server su Linux?** + +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). + +--- +## **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: + +| Codice | Licenza | +|------------|:--------------------------------------------------------------------------:| +| Server | [LICENSE](https://github.com/BeamMP/BeamMP-Server/blob/master/LICENSE) | +| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/README.md) | +| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE.md) | + +--- +#### **Ho trovato un bug o un exploit cosa faccio?** + +Se il problema è legato al codice e sai come usare GitHub, crea una nuova "Issue" nel repo corretto sul nostro [GitHub](https://github.com/BeamMP). Il nostro flusso di lavoro è basato sulle "Issue" di GitHub; anche se hai già una soluzione al bug, sei pregato di creare una nuova "Issue" e poi chiedere una "Pull Request" che risolva la "Issue". Maggiori informazioni [qui](https://github.com/BeamMP/BeamMP/blob/development/CONTRIBUTING.md). + +Nel caso non abbia o non sappia usare GitHub, puoi procedere nei seguenti modi: +- Se il problema non concerne nulla di sensibile, puoi creare un nuovo post sul nostro [forum](https://forum.beammp.com) o sul nostro [Discord](https://discord.gg/beammp). +- Se il problema concerne informazioni sensibili, contatta un nostro membro dello staff su [Discord](https://discord.gg/beammp). \ No newline at end of file From dd46f8b11754d3944bafeaa57aa90076390d8737 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Thu, 28 Dec 2023 19:35:28 +0100 Subject: [PATCH 07/10] 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 | |------------|:--------------------------------------------------------------------------:| From 18d97f03c3fe9527be57e4ba1f75a1cdc31da1d6 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Fri, 29 Dec 2023 10:12:57 +0100 Subject: [PATCH 08/10] Update server-faq.md --- docs/en/support/server-faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/support/server-faq.md b/docs/en/support/server-faq.md index fdef6e9c..0af461c5 100644 --- a/docs/en/support/server-faq.md +++ b/docs/en/support/server-faq.md @@ -7,7 +7,7 @@ List of commonly asked questions and known bugs. --- #### **How can I setup my own servers** -All the information to setup your own server can be found [here](https://docs.beammp.com/server/create-a-server/). +All the information to set up your own server can be found [here](https://docs.beammp.com/server/create-a-server/). --- #### **Can you make a server using linux?** From 40f401c2eeda4d138302d89b16a42b26998c991f Mon Sep 17 00:00:00 2001 From: Starystars67 Date: Sun, 31 Dec 2023 14:18:31 +0000 Subject: [PATCH 09/10] Remove random newline --- docs/en/support/server-faq.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/en/support/server-faq.md b/docs/en/support/server-faq.md index 51b6b5e0..f8f3bc55 100644 --- a/docs/en/support/server-faq.md +++ b/docs/en/support/server-faq.md @@ -7,7 +7,6 @@ List of commonly asked questions and known bugs. --- #### **How can I setup my own servers** - All the information to set up your own server can be found [here](https://docs.beammp.com/server/create-a-server/). --- From d1fc9d74827c4a321e532b29f067e7c028cf15c6 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Tue, 2 Jan 2024 22:55:21 +0100 Subject: [PATCH 10/10] Update manual.md Fixed italian translation --- docs/it/server/manual.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/it/server/manual.md b/docs/it/server/manual.md index 52941f2f..86d595b9 100644 --- a/docs/it/server/manual.md +++ b/docs/it/server/manual.md @@ -25,8 +25,8 @@ Con la versione v3.2.0, il server BeamMP accetta varaibili di contesto, che **so - `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). +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`. +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). ## Argomenti da linea di comando