mirror of
https://github.com/BeamMP/Docs.git
synced 2026-07-23 07:10:59 +00:00
New VitePress and design look + little work on update to work with.
This commit is contained in:
Starystars67
@@ -5,30 +5,29 @@
|
||||
BeamMP is fully compatible with Windows and Linux, compatibility with MacOS is being worked on.
|
||||
However, both Linux and MacOS are secondary platforms, this means bugs are to be expected.
|
||||
|
||||
!!!warning
|
||||
|
||||
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.
|
||||
|
||||
::: warning
|
||||
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.
|
||||
:::
|
||||
---
|
||||
|
||||
## **2. Installation**
|
||||
|
||||
### **2a. Windows Installation**
|
||||
|
||||
!!!note
|
||||
::: note
|
||||
As of April 1st, 2026, the MSI installer is an "unrecognized app" according to Windows Defender SmartScreen.
|
||||
|
||||
As of April 1st, 2026, the MSI installer is an "unrecognized app" according to Windows Defender SmartScreen.
|
||||
|
||||
To bypass this warning, click 'More info', then click 'Run anyway'.
|
||||
To bypass this warning, click 'More info', then click 'Run anyway'.
|
||||
:::
|
||||
|
||||
1. Go to [beammp.com](https://beammp.com/) and click the 'Download Now' button.
|
||||
2. Run the `BeamMP_Installer.msi` installer and follow the instructions.
|
||||
3. The BeamMP Launcher icon should appear on your desktop. If not, just search for “BeamMP” in the Windows search bar.
|
||||
|
||||
!!!note
|
||||
|
||||
As you are loading into a map with multiple vehicles spawned it might take longer than expected to join.
|
||||
::: note
|
||||
As you are loading into a map with multiple vehicles spawned it might take longer than expected to join.
|
||||
:::
|
||||
|
||||
### **2b. Linux Installation**
|
||||
|
||||
@@ -83,24 +82,25 @@ cmake . -B bin -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cma
|
||||
cmake --build bin --parallel
|
||||
```
|
||||
|
||||
!!!note ""
|
||||
::: note
|
||||
Should you run out of RAM while building, you can ommit the --parallel instruction, it will then use less RAM due to building only on one CPU thread.
|
||||
:::
|
||||
|
||||
Should you run out of RAM while building, you can ommit the --parallel instruction, it will then use less RAM due to building only on one CPU thread.
|
||||
:::note ""
|
||||
By not specifying `-DCMAKE_BUILD_TYPE=Release` you are building a debug version, which is larger in filesize but does not contain the launcher-can-only-connect-to-a-server-once bug
|
||||
:::
|
||||
|
||||
!!!note ""
|
||||
|
||||
By not specifying `-DCMAKE_BUILD_TYPE=Release` you are building a debug version, which is larger in filesize but does not contain the launcher-can-only-connect-to-a-server-once bug
|
||||
|
||||
!!!note "Fedora Users"
|
||||
If vcpkg fails during OpenSSL compilation with kernel headers errors, ensure all dependencies are installed:
|
||||
```bash
|
||||
sudo dnf install kernel-headers kernel-devel gcc gcc-c++ make perl
|
||||
```
|
||||
Then clean the vcpkg cache:
|
||||
```bash
|
||||
rm -rf $VCPKG_ROOT/buildtrees/openssl
|
||||
```
|
||||
And retry the cmake configuration command.
|
||||
:::note Fedora Users
|
||||
If vcpkg fails during OpenSSL compilation with kernel headers errors, ensure all dependencies are installed:
|
||||
```bash
|
||||
sudo dnf install kernel-headers kernel-devel gcc gcc-c++ make perl
|
||||
```
|
||||
Then clean the vcpkg cache:
|
||||
```bash
|
||||
rm -rf $VCPKG_ROOT/buildtrees/openssl
|
||||
```
|
||||
And retry the cmake configuration command.
|
||||
:::
|
||||
|
||||
Move the finished application out of the `/bin` folder into its own folder and run it from there:
|
||||
```bash
|
||||
@@ -132,11 +132,11 @@ With the symlink in place between the userfolders and the launcher compiled, you
|
||||
|
||||
Note that this assumes you put the launcher's binary you compiled earlier into `/home/user/BeamMP/`, so change it to match where you put the finished binary, and you will need to re-compile the launcher with the correct git branch each time a launcher update is released.
|
||||
|
||||
!!! tip "Adding an emoji-font to get in-text emojis"
|
||||
::: tip "Adding an emoji-font to get in-text emojis"
|
||||
In order to get emojis to show up in either the serverlist (As part of a servers customised name) or in the ingame chat, you need to have a font that contains emojis.
|
||||
|
||||
In order to get emojis to show up in either the serverlist (As part of a servers customised name) or in the ingame chat, you need to have a font that contains emojis.
|
||||
|
||||
This can be done for example by adding the [Linux-port of the Windows Segoe-UI emoji font](https://github.com/mrbvrz/segoe-ui-linux)
|
||||
This can be done for example by adding the [Linux-port of the Windows Segoe-UI emoji font](https://github.com/mrbvrz/segoe-ui-linux)
|
||||
:::
|
||||
|
||||
### **2d. Updating the Launcher**
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
If disabled, physics instabilities will cause your game to pause
|
||||
|
||||
!!! note ""
|
||||
::: note ""
|
||||
|
||||
Its advised to leave disabled, since repeated instabilities can cause the game to crash
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
|
||||
If disabled, the ingame chat will be displayed in the UI app
|
||||
|
||||
!!! note ""
|
||||
::: note ""
|
||||
|
||||
Dragging IMGUI windows out of the main game window can cause performance issues, as well as trick screen recording software into recording the chat window instead of the main game window
|
||||
|
||||
@@ -76,7 +76,7 @@
|
||||
|
||||
If disbaled, other vehicles will stay fully visible regardless of distance
|
||||
|
||||
!!! note ""
|
||||
::: note ""
|
||||
|
||||
This only affects the visible 3d mesh of a vehicle, not its physics node-beam-mesh. In order to also disable physics, you need to enable `Simplified collision physics` in the Gameplay settings
|
||||
|
||||
@@ -190,13 +190,13 @@
|
||||
|
||||
??? setting "Fade distance/Invert nametag fade direction"
|
||||
|
||||
!!! setting "Fade out"
|
||||
::: setting "Fade out"
|
||||
|
||||
Nametags are getting less visible the further away a player is
|
||||
|
||||
`Fade distance` defines the distance at which a nametag will be drawn at minimal opacity
|
||||
|
||||
!!! setting "Fade in"
|
||||
::: setting "Fade in"
|
||||
|
||||
Nametags are getting more visible the further away a player is
|
||||
|
||||
@@ -234,7 +234,7 @@
|
||||
|
||||
If disabled, no further network activity will be shown in the console
|
||||
|
||||
!!! danger ""
|
||||
::: danger ""
|
||||
|
||||
Be careful with this setting, since all the console output gets also written into the log files
|
||||
|
||||
@@ -248,7 +248,7 @@
|
||||
|
||||
Dont forget to also change it on the launcher side, by modifying `launcher.cfg`
|
||||
|
||||
!!! tip ""
|
||||
::: tip ""
|
||||
|
||||
The port specified is only the first of two, the second port being used is directly following, set port + 1
|
||||
|
||||
|
||||
Reference in New Issue
Block a user