BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2025-07-01 07:25:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added Welcome and Installation guide

Browse Source
This commit is contained in:
Van-CO-US 2023-09-30 11:10:52 -06:00
parent e75d6416e4
commit 90a18ff752
3 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/index.md
View File

@ -1,17 +0,0 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

22
docs/setup.md Normal file
View File

@ -0,0 +1,22 @@
# Installing the mod
## **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. 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!
## **Known Issues**
If you don't see the multiplayer button, make sure the BeamMP mod is activated. then try pressing CTRL +L.
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).

7
docs/welcome.md Normal file
View File

@ -0,0 +1,7 @@
# 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.
Don't have it installed yet? Begin by [installing the mod](/setup)
If you have questions or feel that something that could be improved, feel free to create a support forum post on the [Official Discord](https://discord.gg/beammp) or open a thread on the [BeamMP Forums](https://forum.beammp.com).