diff --git a/docs/en/faq.md b/docs/en/faq.md new file mode 100644 index 00000000..80868621 --- /dev/null +++ b/docs/en/faq.md @@ -0,0 +1,22 @@ +# F.A.Q. and known issues +List of commonly asked questions and known bugs + +## **Client** +#### **How do I install BeamMP?** + +There is a full guide on how to install BeamMP on Windows, you can find it [here](/en/installation). + +#### **Does BeamMP work on a cracked version of BeamNG?** + +BeamMP does not work with cracked versions or outdated versions of BeamNG.drive. If you want to use BeamMP please consider buying the game. + +#### **Does BeamMP work on linux?** + +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). + + + + + diff --git a/docs/en/installation.md b/docs/en/installation.md index eed0ee11..e8d04638 100644 --- a/docs/en/installation.md +++ b/docs/en/installation.md @@ -1,19 +1,23 @@ # Installing the mod ## **Before getting started** -BeamMP is only compatible with legitimate, Steam versions of the game."Cracked" copies are not supported. +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. +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. 3. Launch `BeamMP_Installer.exe` and follow the instructions. -4. A BeamMP icon should appear on your desktop, double click it to run it. You should see a little black window appear and shortly after BeamNG.drive should start. -5. Once it started, press “Play” and then “Multiplayer”. -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 with those credentials. -7. Select any server you like and join it. Enjoy! +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. +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! + +Just to 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 the BeamMP mod is activated. then try pressing CTRL +L. +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) diff --git a/docs/en/welcome.md b/docs/en/welcome.md index 54e4b4d9..7e9b7bb6 100644 --- a/docs/en/welcome.md +++ b/docs/en/welcome.md @@ -1,6 +1,6 @@ # Welcome to the BeamMP Docs -This document goes through everything you need to know about the mod, the launcher, servers and contains many useful bits to help you get the most out of BeamMP. +This document goes through everything you need to know about the Mod, Client and Servers and contains many useful bits to help you get the most out of BeamMP. Don't have it installed yet? Begin by [installing the mod](/en/installation)