From d466ced6e873a1a66d1cb4c433c7c733841d0d54 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Mon, 7 Apr 2025 09:02:14 +0200 Subject: [PATCH 01/12] Create Defender-exclusions.md --- docs/en/FAQ/Defender-exclusions.md | 37 ++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/en/FAQ/Defender-exclusions.md diff --git a/docs/en/FAQ/Defender-exclusions.md b/docs/en/FAQ/Defender-exclusions.md new file mode 100644 index 00000000..80de0c24 --- /dev/null +++ b/docs/en/FAQ/Defender-exclusions.md @@ -0,0 +1,37 @@ +# How to create exclusions in the Windows Defender Firewall and Antivirus? + +!!! info + + Before tampering with the firewall, make sure that your network within the windows networking settings is set to private (assuming you are in a private network). + + !!! danger ":material-scale-balance: DISCLAIMER:" + + **Firewall exclsuions are a risk**. + + By creating exclsuions, you understand the risks of opening up ports on your home network to the public and therefore void the right to hold BeamMP accountable for **any and all** damages that may happen to you or your household. + + We take no responsibility for any content on any externally linked services or websites. + +## 1. Firewall exclusion for the BeamMP-Launcher. + +1 Open the 'Windows Defender Firewall with advanced settings' +2 In the Window, click 'inbound' to open the inbound exclusions tab. +3 Click 'Create new rule' in the top right to create a new exclusion. +4 Select 'Program' to create a program specific exclusion. +5 Enter the full qualified path towards the 'BeamMP-Launcher.exe'. By default, this would be '%appdata%\BeamMP-Launcher\BeamMP-Launcher.exe' without quotes. +6 Make sure to allow the connection +7 Give the exclusion a name (e.g. 'BeamMP-Launcher') and save it. +8 Restart your PC. + +## 2. Antivirus exclsuion for the BeamMP-Launcher. + +Open the 'Windows Security' app. +Click the first item 'virus and threat protection'. +Scroll down to navigate to the 'Exclusions' tab. +There, click 'create' and select 'process'. +Enter 'BeamMP-Launcher.exe' into the field and save it. +Restart your PC. + +## Still facing issues? + +Open a Thread on the [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#support` channel. From b54425b92093849b5635a5c96267714a20f69de0 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Mon, 7 Apr 2025 09:51:44 +0200 Subject: [PATCH 02/12] Update mkdocs.yml --- mkdocs.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 221c5549..73877e12 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -126,6 +126,7 @@ plugins: How to deactivate my mods?: ¿Cómo desactivar mis mods? Manually updating the Launcher: Actualizar manualmente el Launcher Changing the Launcher port: Cambiar el puerto del Launcher + Creating Exclusions (Defender): Creación de exclusiones (Defender) Player FAQ: Preguntas frecuentes del jugador Game FAQ: Preguntas Frecuentes del Juego Server FAQ: Preguntas Frecuentes del Servidor @@ -170,6 +171,7 @@ plugins: How to deactivate my mods?: Wie deaktiviere ich meine Mods? Manually updating the Launcher: Den Launcher Manuell updaten Changing the Launcher port: Ändern des Launcher Ports + Creating Exclusions (Defender): Ausnahmen erstellen (Defender) Player FAQ: Spieler-FAQ Game FAQ: Spiel FAQ Server FAQ: Server FAQ @@ -214,6 +216,7 @@ plugins: How to deactivate my mods?: Comment désactiver mes mods? Manually updating the Launcher: Mise à jour manuelle du lanceur Changing the Launcher port: Changer le port du lanceur + Creating Exclusions (Defender): Création d'exclusions (Defender) Player FAQ: FAQ del giocatore Game FAQ: FAQ du jeu Server FAQ: FAQ du serveur @@ -258,6 +261,7 @@ plugins: How to deactivate my mods?: Come disattivare le mie mod? Manually updating the Launcher: Aggiornamento manuale del Launcher Changing the Launcher port: Cambiare la porta del Launcher + Creating Exclusions (Defender): Creazione di esclusioni (Defender) Player FAQ: FAQ del giocatore Game FAQ: FAQ del gioco Server FAQ: FAQ del server @@ -302,6 +306,7 @@ plugins: How to deactivate my mods?: Как деактивировать мод? Manually updating the Launcher: Обновление лаунчера вручную Changing the Launcher port: Изменение порта лаунчера + Creating Exclusions (Defender): Создание исключений (Defender) Player FAQ: Игроки ЧаВо Game FAQ: Часто задаваемые вопросы об игре Server FAQ: Часто задаваемые вопросы о сервере @@ -370,6 +375,7 @@ nav: - How to deactivate my mods?: FAQ/How-to-deactivate-mods.md - Manually updating the Launcher: FAQ/Update-launcher.md - Changing the Launcher port: FAQ/Change-launcher-port.md + - Creating Exclusions (Defender): FAQ/Defender-exclusions.md - Player FAQ: support/player-faq.md - Game FAQ: support/game-faq.md - Server FAQ: support/server-faq.md From d0b54e502a70863af876c8041cc2c4395b1626bf Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Mon, 7 Apr 2025 22:31:52 +0200 Subject: [PATCH 03/12] Update Defender-exclusions.md --- docs/en/FAQ/Defender-exclusions.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/en/FAQ/Defender-exclusions.md b/docs/en/FAQ/Defender-exclusions.md index 80de0c24..f29938ee 100644 --- a/docs/en/FAQ/Defender-exclusions.md +++ b/docs/en/FAQ/Defender-exclusions.md @@ -25,12 +25,13 @@ ## 2. Antivirus exclsuion for the BeamMP-Launcher. -Open the 'Windows Security' app. -Click the first item 'virus and threat protection'. -Scroll down to navigate to the 'Exclusions' tab. -There, click 'create' and select 'process'. -Enter 'BeamMP-Launcher.exe' into the field and save it. -Restart your PC. +1 Open the 'Windows Security' app. +2 Click the first item 'virus and threat protection'. +3 Click 'Manage settings' beneath "Virus & threat protection settings". +4 Scroll down to navigate to the 'Exclusions' tab. +5 There, click 'Add an exclusion' and select 'process'. +6 Enter 'BeamMP-Launcher.exe' into the field and save it. +7 Restart your PC. ## Still facing issues? From 16f49554a1510e79c43cd1c85382d012d4cdadc3 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:23:55 +0200 Subject: [PATCH 04/12] Delete docs/en/support/error-codes.md Delete and move to /game/ --- docs/en/support/error-codes.md | 24 ------------------------ 1 file changed, 24 deletions(-) delete mode 100644 docs/en/support/error-codes.md diff --git a/docs/en/support/error-codes.md b/docs/en/support/error-codes.md deleted file mode 100644 index eaa967e5..00000000 --- a/docs/en/support/error-codes.md +++ /dev/null @@ -1,24 +0,0 @@ -# Error Codes - -This page contains all the error codes that the launcher may display. - ---- - -| Code | Description | Possible solution | -|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 10048 | Something else is already using the launcher port | Make sure to only have ONE instance of the BeamMP-Launcher running at a time. Try restarting your PC. -| 10038 / 10060 / 10061 | No Server answered on this specified IP and / or port | If you are the server owner, please check the port forwarding and/or firewall rules found at [BeamMP-Server](https://docs.beammp.com/server/create-a-server). If you are not the server owner, choose a different server or contact the owner if known. -| 10054 | Connection reset by peer | The server you're connecting to has gone offline. | -| Failed to find the game please launch it. Report this if the issue persists code 3. | The launcher was unable to find the game's info (game directory, profile directory, version ect...) in the registry entry | Run the game at least once so the registry values get created. | -| Failed to find the game please launch it. Report this if the issue persists code 4. | The launcher was unable to read the game's info (game directory, profile directory, version ect...) in the registry entry | This error is most likely to appear in users with **pirated copies** of the game. If you have bought the game, run it at least once so the registry values get created. | -| Failed to Launch the game! launcher closing soon | The launcher was unable to find the game's executable | Run the game at least once before running the launcher again. | -| Game Closed! launcher closing soon | The game was closed | This message will appear on game closure or when the game failed to start. | -| Launcher Update failed! | The launcher failed to download a new version | Check your internet connection and firewall / antivirus rules so that the launcher is not blocked. | -| Logger file init failed | The launcher does not have the ability to create files | Run the launcher as administrator. | -| Please close the game and try again | The game is already open and the launcher can't clear the `multiplayer/mods` folder | Close the game and retry. | -| Please launch the game at least once | The launcher tried and failed to modify the game's directory | Run the game at least once before running the launcher again. | -| Primary Servers Offline! Sorry for the inconvenience! | The launcher failed to check for an update | Check your internet connection and firewall rules. If there is no problem on your end, please check the [BeamMP updates channel]() on our Discord. | -| Sorry Backend System Outage! Don't worry it will back on soon! | The BeamMP backend did not respond | Check your internet connection and firewall rules. If there is no problem on your end, please check the [BeamMP updates channel]() on our Discord. | -| Stuck on updating | The launcher is stuck on updating and will not continue to the next step | Run the launcher as administrator and check your antivirus rules so that the launcher is not blocked. | - -If the launcher closes immediately, check the `Launcher.log` file in the folder where you installed BeamMP. From 56cece80a3cf0cc82e18ae985c8b24d70de6d58d Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:24:25 +0200 Subject: [PATCH 05/12] Create error-codes.md Moved file to /game/ --- docs/en/game/error-codes.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/en/game/error-codes.md diff --git a/docs/en/game/error-codes.md b/docs/en/game/error-codes.md new file mode 100644 index 00000000..eaa967e5 --- /dev/null +++ b/docs/en/game/error-codes.md @@ -0,0 +1,24 @@ +# Error Codes + +This page contains all the error codes that the launcher may display. + +--- + +| Code | Description | Possible solution | +|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 10048 | Something else is already using the launcher port | Make sure to only have ONE instance of the BeamMP-Launcher running at a time. Try restarting your PC. +| 10038 / 10060 / 10061 | No Server answered on this specified IP and / or port | If you are the server owner, please check the port forwarding and/or firewall rules found at [BeamMP-Server](https://docs.beammp.com/server/create-a-server). If you are not the server owner, choose a different server or contact the owner if known. +| 10054 | Connection reset by peer | The server you're connecting to has gone offline. | +| Failed to find the game please launch it. Report this if the issue persists code 3. | The launcher was unable to find the game's info (game directory, profile directory, version ect...) in the registry entry | Run the game at least once so the registry values get created. | +| Failed to find the game please launch it. Report this if the issue persists code 4. | The launcher was unable to read the game's info (game directory, profile directory, version ect...) in the registry entry | This error is most likely to appear in users with **pirated copies** of the game. If you have bought the game, run it at least once so the registry values get created. | +| Failed to Launch the game! launcher closing soon | The launcher was unable to find the game's executable | Run the game at least once before running the launcher again. | +| Game Closed! launcher closing soon | The game was closed | This message will appear on game closure or when the game failed to start. | +| Launcher Update failed! | The launcher failed to download a new version | Check your internet connection and firewall / antivirus rules so that the launcher is not blocked. | +| Logger file init failed | The launcher does not have the ability to create files | Run the launcher as administrator. | +| Please close the game and try again | The game is already open and the launcher can't clear the `multiplayer/mods` folder | Close the game and retry. | +| Please launch the game at least once | The launcher tried and failed to modify the game's directory | Run the game at least once before running the launcher again. | +| Primary Servers Offline! Sorry for the inconvenience! | The launcher failed to check for an update | Check your internet connection and firewall rules. If there is no problem on your end, please check the [BeamMP updates channel]() on our Discord. | +| Sorry Backend System Outage! Don't worry it will back on soon! | The BeamMP backend did not respond | Check your internet connection and firewall rules. If there is no problem on your end, please check the [BeamMP updates channel]() on our Discord. | +| Stuck on updating | The launcher is stuck on updating and will not continue to the next step | Run the launcher as administrator and check your antivirus rules so that the launcher is not blocked. | + +If the launcher closes immediately, check the `Launcher.log` file in the folder where you installed BeamMP. From 24e58dddc5f043ff551e715a40fcf66129f4138d Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:26:53 +0200 Subject: [PATCH 06/12] Update mkdocs.yml changing paths to moved files --- mkdocs.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 73877e12..5f59f702 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -359,9 +359,9 @@ nav: - Support: - Playing BeamMP: - Installing BeamMP: game/getting-started.md - - Error Codes: support/error-codes.md + - Error Codes: game/error-codes.md - Multiplayer Settings: game/multiplayer-settings.md - - Running a Server: + - Running a BeamMP-Server: - Server Installation: server/create-a-server.md - Port Forwarding: server/port-forwarding.md - Server Maintenance: server/server-maintenance.md @@ -376,9 +376,9 @@ nav: - Manually updating the Launcher: FAQ/Update-launcher.md - Changing the Launcher port: FAQ/Change-launcher-port.md - Creating Exclusions (Defender): FAQ/Defender-exclusions.md - - Player FAQ: support/player-faq.md - - Game FAQ: support/game-faq.md - - Server FAQ: support/server-faq.md + - Player FAQ: FAQ/player-faq.md + - Game FAQ: FAQ/game-faq.md + - Server FAQ: FAQ/server-faq.md - Development Guides: - guides/index.md - Development Environment Setup: guides/beammp-dev/beammp-dev.md From be67d0769bc691d207105f2c9c1d1e4a9bf62347 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:27:39 +0200 Subject: [PATCH 07/12] Delete docs/en/support/game-faq.md delete and move file to /FAQ/ --- docs/en/support/game-faq.md | 56 ------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 docs/en/support/game-faq.md diff --git a/docs/en/support/game-faq.md b/docs/en/support/game-faq.md deleted file mode 100644 index c46cfcea..00000000 --- a/docs/en/support/game-faq.md +++ /dev/null @@ -1,56 +0,0 @@ -# F.A.Q. -List of commonly asked questions. - ---- -## **Client** - ---- -### **How do I install BeamMP?** - -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?** - -BeamMP will not work with pirated or outdated versions of BeamNG.drive. -The BeamMP support team does not offer support for issues with pirated / outdated copies. - ---- -### **Does BeamMP work on linux?** - -The Client is not officially supported on Linux. However, you can follow our [guide on how to use BeamMP on Linux](../game/getting-started/#2b-linux-installation) - ---- -### **Why is the launcher flagged by my antivirus or by Windows Defender** - -Some antivirus programs may flag BeamMP as a threat, due to it interacting with the network and other stuff. There are **no viruses** in any of the code. The code for the launcher, server, and lua client can be found on our [GitHub](https://github.com/BeamMP). - ---- -### **I have poor gameplay performance, what should I do?** - -We are working hard to make the Multiplayer experience as stable as possible. If you have already lowered your graphic settings and your performance is still poor, consider playing on a server with less players. The game is mainly CPU bound when you play with lots of people, so older CPUs (even quadcores) will suffer with more than a handful of people. (General Rule of Thumb: 1 car per CPU Thread) - ---- -## **Miscellaneous** - ---- -### **Where can I find the code?** - -All the source code can be found on our [GitHub](https://github.com/BeamMP). -Before making any changes, 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/LICENSE) | -| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE) | - ---- -### **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, open 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 open a "Pull Request" with the solutions for the 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 or have any other questions, 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). From 5b3188d33d8c13ca920bfdca740234c9f578985e Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:28:08 +0200 Subject: [PATCH 08/12] Create game-faq.md moved file to /FAQ/ --- docs/en/FAQ/game-faq.md | 56 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/en/FAQ/game-faq.md diff --git a/docs/en/FAQ/game-faq.md b/docs/en/FAQ/game-faq.md new file mode 100644 index 00000000..c46cfcea --- /dev/null +++ b/docs/en/FAQ/game-faq.md @@ -0,0 +1,56 @@ +# F.A.Q. +List of commonly asked questions. + +--- +## **Client** + +--- +### **How do I install BeamMP?** + +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?** + +BeamMP will not work with pirated or outdated versions of BeamNG.drive. +The BeamMP support team does not offer support for issues with pirated / outdated copies. + +--- +### **Does BeamMP work on linux?** + +The Client is not officially supported on Linux. However, you can follow our [guide on how to use BeamMP on Linux](../game/getting-started/#2b-linux-installation) + +--- +### **Why is the launcher flagged by my antivirus or by Windows Defender** + +Some antivirus programs may flag BeamMP as a threat, due to it interacting with the network and other stuff. There are **no viruses** in any of the code. The code for the launcher, server, and lua client can be found on our [GitHub](https://github.com/BeamMP). + +--- +### **I have poor gameplay performance, what should I do?** + +We are working hard to make the Multiplayer experience as stable as possible. If you have already lowered your graphic settings and your performance is still poor, consider playing on a server with less players. The game is mainly CPU bound when you play with lots of people, so older CPUs (even quadcores) will suffer with more than a handful of people. (General Rule of Thumb: 1 car per CPU Thread) + +--- +## **Miscellaneous** + +--- +### **Where can I find the code?** + +All the source code can be found on our [GitHub](https://github.com/BeamMP). +Before making any changes, 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/LICENSE) | +| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE) | + +--- +### **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, open 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 open a "Pull Request" with the solutions for the 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 or have any other questions, 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). From c2683ba111162f8898a3aefd06e2718495bd839e Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:28:39 +0200 Subject: [PATCH 09/12] Create player-faq.md moved file to /FAQ/ --- docs/en/FAQ/player-faq.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/en/FAQ/player-faq.md diff --git a/docs/en/FAQ/player-faq.md b/docs/en/FAQ/player-faq.md new file mode 100644 index 00000000..d87bb19e --- /dev/null +++ b/docs/en/FAQ/player-faq.md @@ -0,0 +1,26 @@ +# Players FAQ + +## How do I link my Discord account? +Linking your Discord and BeamMP account is a new feature to BeamMP. To do this you will need send `!link` as a message to the [BeamMP Accounts](https://discordapp.com/channels/@me/1201234743568634026/) bot. +The bot will respond with a link for you to sign into your BeamMP account. Simply sign in with your BeamMP account, once done you will receive a second message saying that it has successfully linked your accounts. 🎉 + +## How do I get early access? + +Early access (including the purple nametag and other benefits) can be obtained by supporting us financially on [Patreon](https://patreon.com/BeamMP) by buying a tier, donating, or by boosting the Discord Server. +Donating **x** amount US$ = **x** additional server key(s) including EA benefits. +Boosting gives you +4 Server keys in addition to EA benefits. + +## I subscribed on Patreon. How do I get my perks? + +Please ensure you do the following to automatically receive your perks: + +1. Link your Discord account on Patreon to receive the Roles and Access in the Discord server. +2. Please ensure you use the same email address on Patreon as you do for your BeamMP account on the [Forum](https://forum.beammp.com/). + +Please be patient, it can take a few hours, sometimes up to 12, for the system to sync. If you have not received your perks after 12 hours and have completed the above steps please contact BeamMP support. + +## I have more questions! + +If your question or issue relates to the Game or playing please refer to the [Game FAQs](game-faq.md). +If your question or issue relates to running a Server please refer to the [Server FAQs](server-faq.md). +Otherwise please check out the [forums](https://forum.beammp.com/c/faq/35) where the community can ask questions and get answers. From d06c8a261087700da95ebdf86872582cb6714dcf Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:28:51 +0200 Subject: [PATCH 10/12] Delete docs/en/support/player-faq.md delete and move file to /FAQ/ --- docs/en/support/player-faq.md | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 docs/en/support/player-faq.md diff --git a/docs/en/support/player-faq.md b/docs/en/support/player-faq.md deleted file mode 100644 index d87bb19e..00000000 --- a/docs/en/support/player-faq.md +++ /dev/null @@ -1,26 +0,0 @@ -# Players FAQ - -## How do I link my Discord account? -Linking your Discord and BeamMP account is a new feature to BeamMP. To do this you will need send `!link` as a message to the [BeamMP Accounts](https://discordapp.com/channels/@me/1201234743568634026/) bot. -The bot will respond with a link for you to sign into your BeamMP account. Simply sign in with your BeamMP account, once done you will receive a second message saying that it has successfully linked your accounts. 🎉 - -## How do I get early access? - -Early access (including the purple nametag and other benefits) can be obtained by supporting us financially on [Patreon](https://patreon.com/BeamMP) by buying a tier, donating, or by boosting the Discord Server. -Donating **x** amount US$ = **x** additional server key(s) including EA benefits. -Boosting gives you +4 Server keys in addition to EA benefits. - -## I subscribed on Patreon. How do I get my perks? - -Please ensure you do the following to automatically receive your perks: - -1. Link your Discord account on Patreon to receive the Roles and Access in the Discord server. -2. Please ensure you use the same email address on Patreon as you do for your BeamMP account on the [Forum](https://forum.beammp.com/). - -Please be patient, it can take a few hours, sometimes up to 12, for the system to sync. If you have not received your perks after 12 hours and have completed the above steps please contact BeamMP support. - -## I have more questions! - -If your question or issue relates to the Game or playing please refer to the [Game FAQs](game-faq.md). -If your question or issue relates to running a Server please refer to the [Server FAQs](server-faq.md). -Otherwise please check out the [forums](https://forum.beammp.com/c/faq/35) where the community can ask questions and get answers. From 4e2240833896413d39835f42d2906ade6acff458 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:29:13 +0200 Subject: [PATCH 11/12] Create server-faq.md moved file to /FAQ/ --- docs/en/FAQ/server-faq.md | 75 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 docs/en/FAQ/server-faq.md diff --git a/docs/en/FAQ/server-faq.md b/docs/en/FAQ/server-faq.md new file mode 100644 index 00000000..53d3994e --- /dev/null +++ b/docs/en/FAQ/server-faq.md @@ -0,0 +1,75 @@ +# F.A.Q. and Known Issues +List of commonly asked questions and known bugs. + +--- +## **Server** + +--- +### **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/). + +--- +### **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 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). + +--- +### **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 + +--- +## **Players outside my network can not join my self-hosted server** + +Read the port forwarding guide that's available [here](https://docs.beammp.com/server/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 '[probablyup.net](https://probablyup.net/api)' whilst the server is running. + +Notes: + +- Some internet providers do not offer dedicated IPv4 addresses to your connection (CGNAT), 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 cannot 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. + +--- +## **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 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). From 827947a9c4be31acc1a97de547ce4b1abc7d3005 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 8 Apr 2025 08:29:24 +0200 Subject: [PATCH 12/12] Delete docs/en/support/server-faq.md Delete and move file to /FAQ/ --- docs/en/support/server-faq.md | 75 ----------------------------------- 1 file changed, 75 deletions(-) delete mode 100644 docs/en/support/server-faq.md diff --git a/docs/en/support/server-faq.md b/docs/en/support/server-faq.md deleted file mode 100644 index 53d3994e..00000000 --- a/docs/en/support/server-faq.md +++ /dev/null @@ -1,75 +0,0 @@ -# F.A.Q. and Known Issues -List of commonly asked questions and known bugs. - ---- -## **Server** - ---- -### **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/). - ---- -### **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 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). - ---- -### **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 - ---- -## **Players outside my network can not join my self-hosted server** - -Read the port forwarding guide that's available [here](https://docs.beammp.com/server/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 '[probablyup.net](https://probablyup.net/api)' whilst the server is running. - -Notes: - -- Some internet providers do not offer dedicated IPv4 addresses to your connection (CGNAT), 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 cannot 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. - ---- -## **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 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).