From c11484a090c23e538ca16be71dc716c91f866938 Mon Sep 17 00:00:00 2001 From: "alex.ita" Date: Wed, 3 Jan 2024 13:38:02 +0100 Subject: [PATCH] Fixed structure for GitLocalize Fixed: - The file structure for `game-faq` and `server-faq` have been fixed so that GitLocalized doesn't panic. - Server requirements is now a list as it should have been before; --- docs/en/server/create-a-server.md | 2 + docs/en/support/game-faq.md | 2 +- docs/en/support/server-faq.md | 62 ++++++++++++++++--------------- docs/it/support/game-faq.md | 2 + docs/it/support/server-faq.md | 17 +++++---- 5 files changed, 47 insertions(+), 38 deletions(-) diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md index 7e24394e..29c53ef6 100644 --- a/docs/en/server/create-a-server.md +++ b/docs/en/server/create-a-server.md @@ -40,6 +40,8 @@ Depending on your setup, you may need to let BeamMP-Server through your firewall There, just like with the port forwarding, you want to allow the BeamMP-Server through the firewall, **both incoming and outgoing connections**, and **both TCP and UDP**. If your firewall asks for a port instead, that will have to be the same port you used in step “1\. Port Forwarding” (usually 30814). +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. + ### 2. Obtaining an Authentication Key The “Authentication Key”, often called “AuthKey”, is necessary for making a **public** server, but **should** be done for private servers, too. diff --git a/docs/en/support/game-faq.md b/docs/en/support/game-faq.md index 8caf48fa..66045729 100644 --- a/docs/en/support/game-faq.md +++ b/docs/en/support/game-faq.md @@ -22,7 +22,7 @@ The Client is not officially supported on Linux. However, you might be able to --- #### **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 +In order to prevent Windows Defender from flagging a specific .exe, we need to buy a license which is very expensive, therefore, 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). diff --git a/docs/en/support/server-faq.md b/docs/en/support/server-faq.md index f8f3bc55..3c9e3171 100644 --- a/docs/en/support/server-faq.md +++ b/docs/en/support/server-faq.md @@ -16,17 +16,40 @@ We provide binaries for many Linux distributions [here](https://github.com/BeamM 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). --- -## **Miscellaneous** +#### **What are the minimum system requirements to run a BeamMP server?** + +- RAM: 50+ MiB usable (not counting OS overhead) +- CPU: >1GHz, preferably multicore +- OS: Windows, Linux (theoretically any POSIX) +- GPU: None +- HDD: 10 MiB + Mods/Plugins +- Bandwidth: 5-10 Mb/s upload --- -#### **What are the minimum system requirements to run a BeamMP server?** +### **Players outside my network can not join my self-hosted server** + +Read the step `1. Port Forwarding` of our guide that's available [here](https://docs.beammp.com/server/create-a-server/#1-port-forwarding). Below there's a brief summary of the most noteworthy steps. +If other players, trying to connect to your server, receive an error code 10060, 10061 or 10038 in their BeamMP launcher, then you should check the following steps: + +- Forward port 30814 (or whichever port you set in your ServerConfig.toml), both TCP and UDP protocols. +- Allow BeamMP through the Windows Firewall, allow both incoming and outgoing connections. Turning off the firewall will usually NOT work. +- Make sure you're not using a VPN (this can cause issues). +- Make sure the server is actually running, without any errors or warnings. + +You can check if you have successfully portforwarded using the site 'portchecker.co' whilst the server is running. + +Notes: +- Some internet providers do not offer dedicated IPv4 addresses to your connection, so port forwarding may not be possible, despite it being available in the router. +- Port forwarding is not possible if you are using a mobile (4G/5G) internet connection. + +--- +### **I can see my self-hosted server in the server-list, but i can not join it myself** + +If the server is running on the same machine as the game, you yourself have to use Direct Connect to join, with the IP 127.0.0.1 and your server's port. +For you to be able to join your own, self-hosted server trough the server-list, your router needs to support NAT-loopback, but this is a function not many home routers support. -RAM: 50+ MiB usable (not counting OS overhead) -CPU: >1GHz, preferably multicore -OS: Windows, Linux (theoretically any POSIX) -GPU: None -HDD: 10 MiB + Mods/Plugins -Bandwidth: 5-10 Mb/s upload +--- +## **Miscellaneous** --- #### **Where can I find the code?** @@ -47,25 +70,4 @@ If the issue is code related and you know how to use Github, create a new "Issue 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** - -If other players, trying to connect to your server, receive an error code 10060, 10061 or 10038 in their BeamMP launcher, then you should check the following steps: - -- Forward port 30814 (or whichever port you set in your ServerConfig.toml), both TCP and UDP protocols. -- Allow BeamMP through the Windows Firewall, allow both incoming and outgoing connections. Turning off the firewall will usually NOT work. -- Make sure you're not using a VPN (this can cause issues). -- Make sure the server is actually running, without any errors or warnings. - -You can check if you have successfully portforwarded using the site 'portchecker.co' whilst the server is running. - -Please note, some internet providers do not offer dedicated IPv4 addresses to your connection, so port forwarding may not be possible, despite it being available in the router. -Port forwarding is not possible if you are using a mobile (4G/5G) internet connection. - ---- -### **I can see my self-hosted server in the server-list, but i can not join it myself** - -If the server is running on the same machine as the game, you yourself have to use Direct Connect to join, with the IP 127.0.0.1 and your server's port. -For you to be able to join your own, self-hosted server trough the server-list, your router needs to support NAT-loopback, but this is a function not many home routers support. +- 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/it/support/game-faq.md b/docs/it/support/game-faq.md index 57e2ab8b..fb62a8df 100644 --- a/docs/it/support/game-faq.md +++ b/docs/it/support/game-faq.md @@ -23,6 +23,7 @@ Il client non è ufficialmente supportato su Linux, ma dovrebbe comunque funzion #### **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). --- @@ -35,6 +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 è soggetto ai nostri [termini di utilizzo](https://forum.beammp.com/t/terms-of-use-v1-0/43) e con le seguenti licenze: diff --git a/docs/it/support/server-faq.md b/docs/it/support/server-faq.md index ebc9cd97..5770b122 100644 --- a/docs/it/support/server-faq.md +++ b/docs/it/support/server-faq.md @@ -12,23 +12,25 @@ Tutte le informazioni per creare un server sono contenute in [questa guida](http --- #### **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). +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 +- 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. @@ -51,6 +53,7 @@ Se non vuoi usare il pulsante `Direct Connect` e vuoi connetterti tramite la lis --- #### **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: