mirror of
https://github.com/BeamMP/Docs.git
synced 2025-07-03 08:25:43 +00:00
Merge branch 'main' into main
This commit is contained in:
commit
e45393d598
@ -22,13 +22,13 @@ Achtung: Der Server unterstützt nur IPv4 . Wenn du dir nicht sicher bist, welch
|
|||||||
|
|
||||||
## Den Server aufsetzen
|
## Den Server aufsetzen
|
||||||
|
|
||||||
Das Aufsetzten besteht aus ein paar Schritten. Du solltest unbedingt alle befolgen.
|
Das Aufsetzen besteht aus folgenden Schritten. Du solltest alle davon durchgehen.
|
||||||
|
|
||||||
### 1. Port Weiterleitung
|
### 1. Port Weiterleitung
|
||||||
|
|
||||||
*Wenn du auf einem VPS (Virtual Private Server) oder Rootserver bist, kannst du den folgenden Schritt überspringen. Wenn du nicht weißt was ein VPS oder Rootserver ist, bist du warscheinlich auch auf keinem.*
|
*Wenn du auf einem VPS (Virtual Private Server) oder Rootserver bist, kannst du den folgenden Schritt überspringen. Wenn du nicht weißt was ein VPS oder Rootserver ist, bist du warscheinlich auch auf keinem.*
|
||||||
|
|
||||||
Dieser Schritt ist wichtig, wenn jemand außerhalb des Heim-Netzwerks deinem Server beitreten möchte.
|
Dieser Schritt ist erforderlich, wenn jemand außerhalb des Haushalts (,,außerhalb des Local Area Networks") beitreten soll.
|
||||||
|
|
||||||
####
|
####
|
||||||
|
|
||||||
@ -81,14 +81,14 @@ Melde dich mit Discord beim [Keymaster](https://beammp.com/keymaster) an. Klicke
|
|||||||
|
|
||||||
#### 2.2. Einen Schlüssel erstellen
|
#### 2.2. Einen Schlüssel erstellen
|
||||||
|
|
||||||
Um einen Schlüssel zu erstellen, klicke oben rechts auf die grüne Schaltfläche „+“.
|
Um einen Schlüssel zu erstellen, klicke das grüne ,,+" oben rechts.
|
||||||
|
|
||||||
|
|
||||||
<figure markdown="">  </figure>
|
<figure markdown="">  </figure>
|
||||||
|
|
||||||
#### 2.3. Schlüssel-Informationen eingeben
|
#### 2.3. Schlüssel-Informationen eingeben
|
||||||
|
|
||||||
Fülle das Feld „Servername“ aus (dies dient nur zur Information für dich, damit zu einem späteren Zeitpunkt ein Schlüssel einem Server zugeordnet werden kann) und klicke dann auf „Erstellen“. Beispiel:
|
Als nächstes, fülle das Feld für den Servernamen (das ist lediglich der Name des Schlüssels, nicht der Name vom Server in der Liste), dann klick ,,Create".<br>Beispiel:
|
||||||
|
|
||||||
|
|
||||||
<figure class="image image_resized" style="width:44.84%;" markdown="">  </figure>
|
<figure class="image image_resized" style="width:44.84%;" markdown="">  </figure>
|
||||||
@ -156,7 +156,7 @@ Nachdem der Server einmal gestartet wurde, sollte er die nötigen Dateien erstel
|
|||||||
|
|
||||||
<figure markdown="">  </figure>
|
<figure markdown="">  </figure>
|
||||||
|
|
||||||
Diese werden oft “ServerConfig”, “Server” und “BeamMP-Server” (keine Erweiterungen wie “.exe”) genannt. Diese sind aber auch korrekt!
|
Genannt ,,ServerConfig.toml”, ,,Server.log” und ,,BeamMP-Server.exe”! (Je nach deinen Einstellungen, siehst du möglicherweise die [.toml] [.log] [.exe] Erweiterungen nicht)
|
||||||
|
|
||||||
Öffne die `ServerConfig.toml` mit einem Texteditor wie zum Beispiel `Notepad` . Dies kannst du mit <strong>[Rechtsklick] → „Öffnen mit…“</strong> und anschließender Auswahl eines Texteditors tun.
|
Öffne die `ServerConfig.toml` mit einem Texteditor wie zum Beispiel `Notepad` . Dies kannst du mit <strong>[Rechtsklick] → „Öffnen mit…“</strong> und anschließender Auswahl eines Texteditors tun.
|
||||||
|
|
||||||
@ -194,7 +194,7 @@ Wenn du einen anderen **Port** als **30814** ausgewählt hast, achte darauf, ihn
|
|||||||
|
|
||||||
### 5. Validierung
|
### 5. Validierung
|
||||||
|
|
||||||
Nun führe den Server nochmal aus und prüfe, ob er weitere `[ERROR]` Zeilen ausspuckt. Das Konsolenfenster muss offen bleiben. Ab diesem Punkt kannst du BeamMP mit dem BeamMP-Launcher starten und solltest den Server inder Liste mit dem vergebenen Namen in der `ServerConfig.toml` sehen.
|
Nun führe den Server erneut aus und sieh nach, ob weitere `[ERROR]` oder `[WARN]` Meldungen erscheinen. Der Server sollte nun offen bleiben. In den folgenden Schritten (6.) erfährst du, wie man dem Server beitretet.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -226,25 +226,21 @@ Das wärs! Die modifizierte Karte sollte jetzt geladen werden!
|
|||||||
|
|
||||||
### 6. Wie du deinem Server beitrittst
|
### 6. Wie du deinem Server beitrittst
|
||||||
|
|
||||||
Wie du und andere Personen deinem Server beitreten können.
|
Wie du und andere Spieler deinem Server beitreten können.
|
||||||
|
|
||||||
#### 6.a. Deinem eigenen Server beitreten
|
#### 6.a. Deinem eigenen Server beitreten
|
||||||
|
|
||||||
Du solltest dich per Direktverbindung mit dem Server verbinden, auch wenn dieser öffentlich ist. Klicke dazu links neben der Serverliste auf die **Registerkarte „Direktverbindung“** . Lasse die Standardinformationen dort (sollte 127.0.0.1 und Port 30814 sein) und klicke dann auf „Verbinden“. Wenn der Server außerhalb des Hauses gehostet wird, musst du [die IP auf diesem Computer finden](https://whatismyipaddress.com/) und auf diese Weise eine Direktverbindung herstellen.
|
Wenn der Server zuhause gehosted wird, musst du per direkter Verbindung beitreten. Um das zu tun, klicke **Direkte Verbindnug** zur Linken von der Serverliste. Lasse die Standard IP stehen (sollte 127.0.0.1 und der korrespondierende Port sein) dann klicke ,,Verbinden". Wenn dein Server außer Haus gehsoted wird (z.B. VPS), musst du dessen[öffentliche IP](https://whatismyipaddress.com/) der Maschine herausfinden und zu dieser eine Direkte Verbindung herstellen.
|
||||||
|
|
||||||
#### 6.b. Andere Spieler die deinem Server beitreten
|
#### 6.b. Andere Spieler die deinem Server beitreten
|
||||||
|
|
||||||
Starte den Server. Du musst anderen Spielern die IP Adresse von deinem Server geben. Sei achtsam beim teilen deiner öffentlichen Heim IP Adresse! Um deinem privaten Server beizutreten, müssen Spieler auf den **Direct Connect Tab** in BeamMP gehen, dann die IP und den Port eingeben.
|
Starte den Server. Nun musst du die öffentliche IP des Servers anderen Spielern geben. Sei jedoch vorsichtig beim teilen deiner hauseigenen IP Adresse! Um deinem privaten Server beizutreten, müssen Spieler die **Direkte Verbindung** in BeamMP aufrufen, dann die IP und den Port des Servers eingeben.
|
||||||
|
|
||||||
#### 6.c. Andere Spieler treten deinem öffentlichen Server bei
|
#### 6.c. Andere Spieler treten deinem öffentlichen Server bei
|
||||||
|
|
||||||
Um deinem öffentlichen Server beizutreten, gehe zur Server Liste und gib den Namen des Servers ein und klicke ,,Connect". Wenn du dir nicht sicher über den Namen des Server bist, es wird der Name sein, welchen du in der `ServerConfig.toml` festlegst. Stelle sicher dass Suchfilter deaktiviert sind und dass die Karte auf "Any" gesetzt ist, wenn du ihn nicht findest. Du kannst auch die [Keymaster](https://beammp.com/keymaster) Webseite für die IP des Servers prüfen.
|
Um deinem öffentlichen Server beizutreten, gehe zur Server Liste und gib den Namen des Servers ein und klicke ,,Connect". Wenn du dir nicht sicher über den Namen des Server bist, es wird der Name sein, welchen du in der `ServerConfig.toml` festlegst. Stelle sicher dass Suchfilter deaktiviert sind und dass die Karte auf "Any" gesetzt ist, wenn du ihn nicht findest. Du kannst auch die [Keymaster](https://beammp.com/keymaster) Webseite für die IP des Servers prüfen.
|
||||||
|
|
||||||
Sollten du und / oder deine Freunde einen "Connection Failed!" Fehler bekommen, prüfe das Launcher Fenster auf Codes wie 10060, 10061, 10030. Das bedeutet, dass du entweder ein CGNAT IPv4 hast, oder du hast etwas während Schritt **1. Port Forwarding** oder **1.1. Firewall** falsch gemacht. Um zu prüfen ob du eine CGNAT IPv4 besitzt, finde die WAN IP Adresse auf dem Router Interface. Vergleiche diese mit der IP, welche auf Tools wie [*whatsmyip.org*](https://www.whatsmyip.org/) gelistet sind. IPv6 Support ist **NOCH NICHT** implementiert.
|
Sollten du oder deine Freunde einen ,,Verbindung Fehlgeschlagen!" Fehler bekommen, prüfe das Launcher Fenster auf Codes wie 10060, 10061 oder 10030. Das bedeutet, dass du entweder eine CGNAT IPv4 hast, oder du hast etwas bei Schritt **1 Port Forwarding** oder **1.1. Firewall** falsch gemacht. Um zu prüfen ob du eine CGNAT IPv4 hast, finde die WAN IP Adresse im Router Interface. Vergleiche diese mit deiner [öffentlichen IP](https://www.whatsmyip.org/). Wenn diese gleich sind, hast du keine CGNAT IP. IPv6 Support ist noch **NICHT** implementiert.
|
||||||
|
|
||||||
#### 6.d. **[FUNKTIONIERT MÖGLICHERWEISE NICHT]** Für private Server (Hamachi):
|
|
||||||
|
|
||||||
Damit jemand deinem Server beitreten kann, muss derjenige in demselben Hamachi Netzwerk sein. Du musst hierfür keine Ports weiterleiten. Nachdem jemand deinem Hamachi Netzwerk beigetreten ist, müssen diese die Hamachi IP und den Standardport für eine direkte Verbindung verwenden. Für mehr Infos, siehe den [Hamachi](https://forum.beammp.com/t/tutorial-how-to-host-a-server-with-logmein-hamachi/52) Artikel.
|
|
||||||
|
|
||||||
## Immer noch Probleme?
|
## Immer noch Probleme?
|
||||||
|
|
||||||
|
@ -1,15 +1,14 @@
|
|||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
---
|
## **Compatibility**
|
||||||
## **Before getting started**
|
|
||||||
BeamMP is only compatible with legitimate, Steam versions of the game. "Cracked" copies are not supported.
|
|
||||||
|
|
||||||
---
|
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.
|
||||||
|
|
||||||
|
BeamMP might not work with pirated copies of the game.
|
||||||
|
|
||||||
## **Installation**
|
## **Installation**
|
||||||
|
|
||||||
BeamMP is natively compatible only with Windows at the moment.
|
|
||||||
|
|
||||||
### **Windows Installation**
|
### **Windows Installation**
|
||||||
1. Go to [beammp.com](https://beammp.com/) and click the "Download client" button.
|
1. Go to [beammp.com](https://beammp.com/) and click the "Download client" button.
|
||||||
2. Extract the `BeamMP_Installer.zip` archive.
|
2. Extract the `BeamMP_Installer.zip` archive.
|
||||||
@ -23,16 +22,55 @@ BeamMP is natively compatible only with Windows at the moment.
|
|||||||
|
|
||||||
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._
|
||||||
|
|
||||||
## **Linux Installation**
|
### **Linux Installation**
|
||||||
|
|
||||||
|
Currently you need to build the Launcher yourself.
|
||||||
|
In order to do this, you need a basic understanding of how to build an application.
|
||||||
|
|
||||||
|
Make sure you have [`vcpkg` installed](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started?pivots=shell-bash#1---set-up-vcpkg), as well as basic development tools, often found in packages, for example:
|
||||||
|
|
||||||
|
- Debian: `sudo apt install build-essential`
|
||||||
|
- Fedora: `sudo dnf groupinstall "Development Tools"`
|
||||||
|
- Arch: `sudo pacman -S base-devel`
|
||||||
|
- openSUSE: `zypper in -t pattern devel-basis`
|
||||||
|
|
||||||
|
Clone the BeamMP-Launcher Repository to your system using `git`, for example:
|
||||||
|
`git clone https://github.com/BeamMP/BeamMP-Launcher.git`
|
||||||
|
[Additional information about cloning a GitHub Repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
|
||||||
|
|
||||||
|
Checkout the tag that was used for the [latest release](https://github.com/BeamMP/BeamMP-Launcher/releases/latest). For example, if `v2.3.2` is used in the latest release, then do `git checkout v2.3.2`
|
||||||
|
|
||||||
|
In the root directory of the project,
|
||||||
|
1. `cmake -DCMAKE_BUILD_TYPE=Release . -B bin -DCMAKE_TOOLCHAIN_FILE=~/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux`
|
||||||
|
2. `cmake --build bin --parallel --config Release`
|
||||||
|
|
||||||
|
> 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.
|
||||||
|
|
||||||
|
Move the finished application out of the `/bin` folder into its own folder and run it from there
|
||||||
|
|
||||||
|
The native linux BeamMP-Launcher will start and use native linux BeamNG.drive
|
||||||
|
|
||||||
|
#### **Using beamNG.drive with Proton**
|
||||||
|
|
||||||
|
Should you want to use the native linux BeamMP-Launcher together with BeamNG.drive running through Proton, you can do so:
|
||||||
|
|
||||||
|
Run the BeamMP-Launcher using the argument ` -no-launch` (This will prevent the Launcher from starting native linux BeamNG.drive). Further information about launcher arguments can be found in the [Development Environment Setup](../guides/beammp-dev/beammp-dev.md)
|
||||||
|
|
||||||
|
Change the userfolder location of Proton-BeamNG.drive to the location of Linux-BeamNG.drive (since the native linux BeamMP-Launcher currently only writes into the Linux-BeamNG.drive userfolder)
|
||||||
|
|
||||||
|
This can be done for example by creating a symlink
|
||||||
|
|
||||||
|
- Note the Linux-BeamNG.drive userfolder location (this is usually found in `~/.local/share/BeamNG.drive`) and rename it, for example to ``BeamNG.drive_old
|
||||||
|
- Note the Proton-BeamNG.drive userfolder location (this is usually found in `~/.local/share/Steam/steamapps/compatdata/284160/pfx/drive_c/users/steamuser/AppData/Local/BeamNG.drive`)
|
||||||
|
- Create a symlink between both userfolders ```ln -s ~/.local/share/Steam/steamapps/compatdata/284160/pfx/drive_c/users/steamuser/AppData/Local/BeamNG.drive ~/.local/share```
|
||||||
|
|
||||||
BeamMP should work with `wine`, but is not officially supported (yet).
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## **Known Issues**
|
## **Known Issues**
|
||||||
|
- The native linux BeamMP-Launcher currently can only connect to a server once, after disconnecting you need to restart the launcher. You can do that without closing the game inbetween
|
||||||
- If you don’t see the “Multiplayer” button. Make sure that the BeamMP mod is present and activated in the “Mod Manager” then try pressing CTRL + L.
|
- If you don’t see the “Multiplayer” button. Make sure that the BeamMP mod is present and activated in the “Mod Manager” then try pressing CTRL + L.
|
||||||
- VPNs of any type may cause connection issues.
|
- VPNs of any type may cause connection issues.
|
||||||
- If the Launcher reports any errors, read the [FAQ](https://forum.beammp.com/c/faq/35).
|
- If the Launcher reports any errors, read the [FAQ](https://forum.beammp.com/c/faq/35).
|
||||||
- The Launcher tends to have issues with non-genuine versions of BeamNG.drive.
|
|
||||||
|
|
||||||
Should you need further help with installation, you are welcome to create a post on our [forum](https://forum.beammp.com) or ask on our [Discord server](https://discord.gg/beammp).
|
Should you need further help with installation, you are welcome to create a post on our [forum](https://forum.beammp.com) or ask on our [Discord server](https://discord.gg/beammp).
|
||||||
|
@ -20,14 +20,13 @@ Note: _The server only supports IPv4\. If you don't know which one you have, loo
|
|||||||
|
|
||||||
## Setting up the Server
|
## Setting up the Server
|
||||||
|
|
||||||
Setup consists of the following steps, you should follow all of them.
|
The setup consists of the following steps, you should follow all of them.
|
||||||
|
|
||||||
### 1. Port forwarding
|
### 1. Port forwarding
|
||||||
|
|
||||||
_If you are on a VPS (Virtual Private Server) or Rootserver, you can skip this step. If you're unsure about what a VPS or Rootserver is, you most likely aren't on one._
|
_If you are on a VPS (Virtual Private Server) or Rootserver, you can skip this step. If you're unsure about what a VPS or Rootserver is, you most likely aren't on one._
|
||||||
|
|
||||||
This step is necessary if you want someone outside of your household to join ("outside of your local network").
|
This step is necessary if you want someone outside of your household to join ("outside of your local network").
|
||||||
Please note that VPNs lkie Hamachi or Radmin are not supported.
|
|
||||||
|
|
||||||
####
|
####
|
||||||
!!! danger ":material-scale-balance: DISCLAIMER:"
|
!!! danger ":material-scale-balance: DISCLAIMER:"
|
||||||
@ -80,7 +79,7 @@ From the Keymaster homepage click on "Keys" on the left of the screen:
|
|||||||
|
|
||||||
#### 2.2. Creating a key
|
#### 2.2. Creating a key
|
||||||
|
|
||||||
To create your key click on the green "+" button in the top right.
|
To create your key, click on the green "+" button in the top right.
|
||||||
|
|
||||||
<figure markdown>
|
<figure markdown>
|
||||||

|

|
||||||
@ -88,7 +87,7 @@ To create your key click on the green "+" button in the top right.
|
|||||||
|
|
||||||
#### 2.3. Filling out the key information
|
#### 2.3. Filling out the key information
|
||||||
|
|
||||||
Next, fill out the Server Name field (this is just the key name not the actual name of the server on the list), then click "Create". Example:
|
Next, fill out the Server Name field (this is just the keys name and not the actual name of the server on the list), then click "Create". Example:
|
||||||
|
|
||||||
<figure class="image image_resized" style="width:44.84%;" markdown>
|
<figure class="image image_resized" style="width:44.84%;" markdown>
|
||||||

|

|
||||||
@ -160,7 +159,7 @@ Now that you ran the server once, it should have created some files and probably
|
|||||||

|

|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
They might be called “ServerConfig”, “Server” and “BeamMP-Server” (no extensions like “.exe”), but that's correct, too!
|
They are called “ServerConfig.toml”, “Server.log” and “BeamMP-Server.exe”! (Depending on your settings, you might not see the [.toml] [.log] [.exe] extentions)
|
||||||
|
|
||||||
Open the `ServerConfig.toml` with a text editor such as `Notepad`. You can do this with [Right Click] → “Open With…” and then selecting a text editor.
|
Open the `ServerConfig.toml` with a text editor such as `Notepad`. You can do this with [Right Click] → “Open With…” and then selecting a text editor.
|
||||||
|
|
||||||
@ -196,7 +195,7 @@ If you picked a different **Port** other than **30814**, make sure to replace it
|
|||||||
|
|
||||||
### 5. Validation
|
### 5. Validation
|
||||||
|
|
||||||
Now run your server again, and see if it spits out any more `[ERROR]` messages. It should just stay open. At this point, you can start BeamMP through the BeamMP-Launcher and you should find your server by the Name you entered in the `ServerConfig.toml` in the server list.
|
Now run your server again, and see if it spits out any more `[ERROR]` or `[WARN]` messages. The server should stay open now. In the following steps (6.) below you can find out how to join the server.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -228,15 +227,15 @@ That's it! Your modded map should now be available to join!
|
|||||||
|
|
||||||
### 6. How to join your server
|
### 6. How to join your server
|
||||||
|
|
||||||
How you and other people can join your server.
|
How you and other players can join your server.
|
||||||
|
|
||||||
#### 6.a. Joining your own server
|
#### 6.a. Joining your own server
|
||||||
|
|
||||||
You must join your server by direct connecting, to do this, click the **Direct Connect Tab** on the left from the server list. Leave the default info in there (should be 127.0.0.1 and a port of 30814) then hit connect.If you server is hosted outside of your house you must [find your IP](https://whatismyipaddress.com/) on that machine and direct connect that way.
|
If the server is hosted at home, you must join your server by direct connecting, to do this, click the **Direct Connect Tab** on the left from the server list. Leave the default info in there (should be 127.0.0.1 and corresponding port) then hit connect. If you server is hosted outside of your house (e.g. VPS) you must find its [public IP](https://whatismyipaddress.com/) on that machine and direct connect that way.
|
||||||
|
|
||||||
#### 6.b. Other people joining your private server
|
#### 6.b. Other people joining your private server
|
||||||
|
|
||||||
Start the Server. You have to give the people the IP Address of your Server. However, be careful sharing your homes public IP Address! To join your private server the players must go to the **Direct Connect Tab** in BeamMP, then type your IP and Port.
|
Start the Server. You have to give other users the public IP Address of your Server. However, be careful sharing your public home Address! To join your private server the players must go to the **Direct Connect Tab** in BeamMP, then type your IP and Port.
|
||||||
|
|
||||||
#### 6.c. Other people joining your public server
|
#### 6.c. Other people joining your public server
|
||||||
|
|
||||||
@ -246,7 +245,7 @@ You can also check the [Keymaster](https://beammp.com/keymaster) Website for the
|
|||||||
|
|
||||||
Should you or your friends experience a "Connection Failed!" Error, check the Launcher Window for codes like 10060, 10061, 10030.
|
Should you or your friends experience a "Connection Failed!" Error, check the Launcher Window for codes like 10060, 10061, 10030.
|
||||||
This means you eihter have a CGNAT IPv4, or you have done something wrong during Step **1 Port Forwarding** or **1.1. Firewall**.
|
This means you eihter have a CGNAT IPv4, or you have done something wrong during Step **1 Port Forwarding** or **1.1. Firewall**.
|
||||||
To check if you have a CGNAT IPv4, look up the WAN IP Address on your routers interface. Compare it to your public IP listed on [_whatsmyip.org_](https://www.whatsmyip.org/).
|
To check if you have a CGNAT IPv4, look up the WAN IP Address on your routers interface. Compare it to your [public IP](https://www.whatsmyip.org/). If they're the same, you are not behind a CGNAT.
|
||||||
IPv6 Support is **NOT** yet implemented.
|
IPv6 Support is **NOT** yet implemented.
|
||||||
|
|
||||||
## Still facing issues?
|
## Still facing issues?
|
||||||
|
Loading…
x
Reference in New Issue
Block a user