From 51d327a32e3ea080efd8d8d40ca9495b0fa35777 Mon Sep 17 00:00:00 2001 From: Van-CO-US Date: Sat, 30 Sep 2023 17:54:12 -0600 Subject: [PATCH] Added manual tab --- docs/en/create-a-server.md | 2 -- docs/en/game/getting-started.md | 31 ++++++++++++++++++++++++++++++- docs/en/getting-started.md | 30 ------------------------------ docs/en/server/create-a-server.md | 14 ++++++++++++++ docs/en/server/server-manual.md | 1 + mkdocs.yml | 2 +- 6 files changed, 46 insertions(+), 34 deletions(-) delete mode 100644 docs/en/create-a-server.md delete mode 100644 docs/en/getting-started.md create mode 100644 docs/en/server/create-a-server.md create mode 100644 docs/en/server/server-manual.md diff --git a/docs/en/create-a-server.md b/docs/en/create-a-server.md deleted file mode 100644 index b503f7e8..00000000 --- a/docs/en/create-a-server.md +++ /dev/null @@ -1,2 +0,0 @@ -# Create a Server - diff --git a/docs/en/game/getting-started.md b/docs/en/game/getting-started.md index 8b3a7945..480d743c 100644 --- a/docs/en/game/getting-started.md +++ b/docs/en/game/getting-started.md @@ -1 +1,30 @@ -# Getting Started \ No newline at end of file +# Getting Started + +--- +## **Before getting started** +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. +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. +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 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 diff --git a/docs/en/getting-started.md b/docs/en/getting-started.md deleted file mode 100644 index 480d743c..00000000 --- a/docs/en/getting-started.md +++ /dev/null @@ -1,30 +0,0 @@ -# Getting Started - ---- -## **Before getting started** -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. -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. -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 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 diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md new file mode 100644 index 00000000..34063f83 --- /dev/null +++ b/docs/en/server/create-a-server.md @@ -0,0 +1,14 @@ +# **Create a Server** +Basics of setting up the server application + +--- +## **Overview** +#### **Making a server for BeamMP is simple and free!** + +Servers are an integral part of BeamMP; players are connected to each other through the server. They run natively on Windows and Linux. + +You can make private servers, which only people you invite can join, or public servers, which will show in our official server list. To invite someone simply give them the IP and Port of the server and they can join through Direct Connect. + +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 Manual](/en/server/server-manual) section for more info. + + diff --git a/docs/en/server/server-manual.md b/docs/en/server/server-manual.md new file mode 100644 index 00000000..3f94dc2b --- /dev/null +++ b/docs/en/server/server-manual.md @@ -0,0 +1 @@ +# Server Manual \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 7b9aacc6..a4f197a2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -99,7 +99,7 @@ nav: - Using BeamMP: en/game/playing.md - Running a Server: - Installation: en/server/create-a-server.md - - Server Manual: en/server/manual.md + - Server Manual: en/server/server-manual.md - FAQ: - Installation: en/faq.md - Guides: