Skip to content

Commit

Permalink
Merge pull request #6 from AlexITA1100/main
Browse files Browse the repository at this point in the history
Updates FAQs
  • Loading branch information
lionkor authored Jan 3, 2024
2 parents f6c1c6c + d1fc9d7 commit 4836f9b
Show file tree
Hide file tree
Showing 5 changed files with 210 additions and 24 deletions.
28 changes: 12 additions & 16 deletions docs/en/support/game-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?**
Expand All @@ -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?**
Expand All @@ -40,21 +38,19 @@ 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 subject to our [Terms of Use](https://forum.beammp.com/t/terms-of-use-v1-0/43) and 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).
31 changes: 27 additions & 4 deletions docs/en/support/server-faq.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Server FAQ
# F.A.Q. and Known Issues
List of commonly asked questions and known bugs.

---
Expand All @@ -7,14 +7,16 @@ 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?**

BeamMP server can be used on Linux and other operating systems, however builds are usually only provided for a few distributions. The newest builds 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 Operating System/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).

For different OS/Distro, you need to build from source yourself. Information for this can be found [here](https://github.com/BeamMP/BeamMP-Server#build-instructions).
---
## **Miscellaneous**

---
#### **What are the minimum system requirements to run a BeamMP server?**
Expand All @@ -26,6 +28,27 @@ GPU: None
HDD: 10 MiB + Mods/Plugins
Bandwidth: 5-10 Mb/s upload

---
#### **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 subject to our [Terms of Use](https://forum.beammp.com/t/terms-of-use-v1-0/43) and 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).

---
### **Players outside my network can not join my self-hosted server**

Expand Down
51 changes: 47 additions & 4 deletions docs/it/server/manual.md
Original file line number Diff line number Diff line change
@@ -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.
# 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 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

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.
54 changes: 54 additions & 0 deletions docs/it/support/game-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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 è soggetto ai nostri [termini di utilizzo](https://forum.beammp.com/t/terms-of-use-v1-0/43) e con le seguenti licenze:

| 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).
70 changes: 70 additions & 0 deletions docs/it/support/server-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 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).

---
#### **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 è soggetto ai nostri [termini di utilizzo](https://forum.beammp.com/t/terms-of-use-v1-0/43) e con le seguenti licenze:

| 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).

0 comments on commit 4836f9b

Please sign in to comment.