mirror of
https://github.com/BeamMP/Docs.git
synced 2026-07-19 13:23:57 +00:00
New VitePress and design look + little work on update to work with.
This commit is contained in:
Starystars67
@@ -20,7 +20,7 @@ The result should be a clean new userfolder.
|
||||
If you have renamed the userfolder, you forced the game to create a new, clean userfolder. You may copy the 'settings' and 'vehicles' folder from the folder you renamed (e.g. `current_old`) to the new folder it created.
|
||||
Make sure BeamNG.Drive is closed and replace all elements in the location you want to copy the folders to. You should now have all configs and settings as they were before.
|
||||
|
||||
!!! warning "Be careful when moving back files/folders to the new userfolder.
|
||||
::: warning "Be careful when moving back files/folders to the new userfolder.
|
||||
|
||||
If you resolved any issues by renaming the userfolder, moving back the old files may cause any issues you had to possibly re-occur.
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# How to create exclusions in the Windows Defender Firewall and Antivirus?
|
||||
|
||||
!!! info
|
||||
::: info
|
||||
|
||||
Before tampering with the firewall, make sure that your network within the windows networking settings is set to private (assuming you are in a private network).
|
||||
|
||||
!!! danger ":material-scale-balance: DISCLAIMER:"
|
||||
::: danger ":material-scale-balance: DISCLAIMER:"
|
||||
|
||||
**Firewall / Defender exclsuions are a risk**.
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ For a detailed explanation, on what CGNAT is and why it's an issue when trying t
|
||||
Open a command prompt, run ``tracert -4 beammp.com``. This will output a series of network hops. Wait for the operation to finish (may take up to 30 hops). Check the first few IP addresses after the IP of your Router/Modem/Gateway.
|
||||
If multiple IP addresses within the range of ``100.64.x.x``-``100.127.x.x`` or ``10.xx.xx.xx`` appear after the first hop, you are most likely behind a CGNAT.
|
||||
|
||||
!!! note
|
||||
::: note
|
||||
|
||||
The first hop will be your Router/Modem/Gateway and differs between Devices.
|
||||
The official ranges for local networks are as follows: ``10.0.0.xxx`` - ``192.168.xxx.xxx`` - ```172.16.xxx.xxx``
|
||||
@@ -28,7 +28,7 @@ Find out the WAN IP on your router by looking it up on its interface. Compare it
|
||||
Call your Internet Service Provider for assistance.
|
||||
Depending on your ISP, they might not offer dedicated *dynamic* IP adresses. Keep in mind, that a static IP is not necessary.
|
||||
|
||||
!!! warning
|
||||
::: warning
|
||||
|
||||
Internet Service Providers may only offer dedicated IP addresses as a **paid option**.
|
||||
Please check the prices of our partnered hosting services as they could be cheaper than this fee!
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
The Launcher can't update or shows a blank screen?
|
||||
This quick guide explains how to manually update the Launcher.
|
||||
|
||||
!!! note
|
||||
::: note
|
||||
|
||||
You should have already used or installed BeamMP using the installer provided by [our website](https://beammp.com) before continuing.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning This site is under construction!
|
||||
This site is being actively worked on.
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
Feel you could help? Please do by clicking on the page with a pencil on the right!
|
||||
|
||||
This can be done any page too.
|
||||
Feel you could help? Please do by clicking "Edit this page" at the bottom!
|
||||
:::
|
||||
|
||||
# BeamNG.drive Development Introduction
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
Feel you could help? Please do by clicking on the page with a pencil on the right!
|
||||
This site is being actively worked on.
|
||||
|
||||
Feel you could help? Please do by clicking on the page with a pencil on the right!
|
||||
|
||||
This can be done any page too.
|
||||
:::
|
||||
|
||||
This can be done any page too.
|
||||
|
||||
# BeamNG.drive ImGui Code Snippets
|
||||
|
||||
## Setup
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
@@ -205,11 +205,11 @@ HTML is supported and can be used to add images/icons, for example.
|
||||
|
||||
Multiple can be displayed at once, displayed sequentially.
|
||||
|
||||
!!! bug
|
||||
::: bug
|
||||
|
||||
Providing no buttons prevents the player from escaping the dialog without using the console.
|
||||
|
||||
!!! bug
|
||||
::: bug
|
||||
|
||||
The SDF parts of the Minimap UI app remain visible while a ConfirmationDialog is active.
|
||||
|
||||
@@ -249,7 +249,7 @@ guihooks.trigger("introPopupClose")
|
||||
* `noButtons`
|
||||
* Provides no buttons
|
||||
|
||||
!!! warning
|
||||
::: warning
|
||||
|
||||
When using the noButtons flavour on the page, providing no extra JavaScript in the page content to close the popup causes a softlock. Pages are not combined into one popup in this flavour. It is not recommended to use this flavour.
|
||||
|
||||
@@ -293,7 +293,7 @@ guihooks.trigger("introPopupClose")
|
||||
|
||||
If multiple pages are provided, or the hook is triggered multiple times, then the pages are combined into the same popup. If the hook is triggered while a introPopup is active, or when a different introPopup type has already been triggered, then it is displayed in a separate popup after the existing popup is closed.
|
||||
|
||||
!!! bug
|
||||
::: bug
|
||||
|
||||
The background blur has a minimum height, causing popups with short content to have excess blur below its window. Two main workarounds exist:
|
||||
|
||||
@@ -338,7 +338,7 @@ guihooks.trigger("introPopupClose")
|
||||
|
||||
If multiple pages are provided, or the hook is triggered multiple times, then the pages are combined into the same popup. If the hook is triggered while a introPopup is active, or when a different introPopup type has already been triggered, then it is displayed in a separate popup after the existing popup is closed.
|
||||
|
||||
!!! bug
|
||||
::: bug
|
||||
|
||||
The background blur has a minimum height, causing popups with short content to have excess blur below its window. Two main workarounds exist:
|
||||
|
||||
@@ -374,7 +374,7 @@ ui_missionInfo.closeDialogue()
|
||||
|
||||
Only one Dialogue can be displayed at once. Any existing Dialogue is overridden.
|
||||
|
||||
!!! info
|
||||
::: info
|
||||
|
||||
`#!lua ui_missionInfo.closeDialogue()` must be used to close a dialogue.
|
||||
|
||||
|
||||
+18
-18
@@ -9,29 +9,29 @@ hide:
|
||||
|
||||
## Our social media links
|
||||
|
||||
!!!failure ""
|
||||
:::warning {{''}}
|
||||
BeamMP Forum - [https://forum.beammp.com](https://forum.beammp.com)
|
||||
:::
|
||||
|
||||
BeamMP Forum - [https://forum.beammp.com](https://forum.beammp.com)
|
||||
:::quote {{''}}
|
||||
X (Twitter) - [https://x.com/BeamMPOfficial](https://x.com/BeamMPOfficial)
|
||||
:::
|
||||
|
||||
!!!quote ""
|
||||
:::danger {{''}}
|
||||
YouTube - [https://www.youtube.com/@BeamMPOfficial](https://www.youtube.com/@BeamMPOfficial)
|
||||
:::
|
||||
|
||||
X (Twitter) - [https://x.com/BeamMPOfficial](https://x.com/BeamMPOfficial)
|
||||
:::warning {{''}}
|
||||
Patreon - [https://www.patreon.com/c/BeamMP](https://www.patreon.com/c/BeamMP)
|
||||
:::
|
||||
|
||||
!!!danger ""
|
||||
:::note {{''}}
|
||||
Discord - [https://discord.com/invite/beammp](https://discord.com/invite/beammp)
|
||||
:::
|
||||
|
||||
YouTube - [https://www.youtube.com/@BeamMPOfficial](https://www.youtube.com/@BeamMPOfficial)
|
||||
|
||||
!!!warning ""
|
||||
|
||||
Patreon - [https://www.patreon.com/c/BeamMP](https://www.patreon.com/c/BeamMP)
|
||||
|
||||
!!!note ""
|
||||
|
||||
Discord - [https://discord.com/invite/beammp](https://discord.com/invite/beammp)
|
||||
|
||||
!!!info ""
|
||||
|
||||
BlueSky - [https://bsky.app/profile/beammpofficial.bsky.social](https://bsky.app/profile/beammpofficial.bsky.social)
|
||||
:::info {{''}}
|
||||
BlueSky - [https://bsky.app/profile/beammpofficial.bsky.social](https://bsky.app/profile/beammpofficial.bsky.social)
|
||||
:::
|
||||
|
||||
## Our Rules
|
||||
You can find our rules [here](rules.md)
|
||||
@@ -4,7 +4,7 @@ hide:
|
||||
---
|
||||
# BeamMP Community Rules
|
||||
|
||||
!!! info
|
||||
::: info
|
||||
BeamMP Staff are not bound to moderate strictly by these rules and may operate at their own discretion. In addition to these rules, Discord's [Community Guidelines](https://discord.com/guidelines/) and [Terms of Service](https://discord.com/terms/) apply, and are enforced.
|
||||
|
||||
## BeamMP General Rules (Applies to Discord, Forum and In-Game)
|
||||
@@ -50,5 +50,5 @@ hide:
|
||||
|
||||
All ban appeals are investigated thoroughly, involving at least two (2) members of the staff/moderation team that were not involved in the case-at-hand. The issuing staff member will be allowed to comment, but will not be otherwise involved in the appeal decision. These appeal outcomes are final. BeamMP reserves the right to allow or not allow members as they deem appropriate according to the BeamMP Community Rules (as above), [Discord ToS](https://discord.com/terms), and other factors.
|
||||
|
||||
!!! warning
|
||||
::: warning
|
||||
In the event of action taken against you, you are prohibited from creating a new Discord or BeamMP account to circumvent the ban.
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Guides
|
||||
description: This set of pages provides some basic guides for BeamMP
|
||||
status: new
|
||||
---
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Multiplayer mod creation
|
||||
|
||||
## Folderstructure and file basics
|
||||
## Folder structure and file basics
|
||||
|
||||
The basic folder and file structure needs to look like this:
|
||||
|
||||
@@ -31,8 +31,9 @@ The Client folder contains the zip files that are sent to a client, which then w
|
||||
Any other files in the Client folder will cause an error on server startup, but apart from that will be ignored by the server.
|
||||
The modScript.lua will be read by BeamNG and instructs the game which plugin to load.
|
||||
|
||||
!!!example ""
|
||||
[Download the examplePlugin.zip](../../../../assets/content/ResourcesForExamplePlugin.zip)
|
||||
:::example ""
|
||||
[Download the examplePlugin.zip](../../../../assets/content/ResourcesForExamplePlugin.zip)
|
||||
:::
|
||||
|
||||
## Serverside lua
|
||||
|
||||
|
||||
+42
-32
@@ -1,34 +1,44 @@
|
||||
---
|
||||
hide:
|
||||
- navigation
|
||||
layout: home
|
||||
|
||||
hero:
|
||||
name: BeamMP Documentation
|
||||
text: Everything you need to know
|
||||
tagline: Complete guides for players, server owners, and developers
|
||||
image:
|
||||
src: /assets/core/beammp_dark.png
|
||||
alt: BeamMP
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Get Started
|
||||
link: /en/game/getting-started
|
||||
- theme: alt
|
||||
text: View on GitHub
|
||||
link: https://github.com/beammp/docs
|
||||
|
||||
features:
|
||||
- icon: 🎮
|
||||
title: For Players
|
||||
details: Learn how to install BeamMP, connect to servers, and get the most out of your multiplayer experience
|
||||
link: /en/game/getting-started
|
||||
- icon: 🖥️
|
||||
title: For Server Owners
|
||||
details: Set up and manage your own BeamMP server with our comprehensive guides and troubleshooting resources
|
||||
link: /en/server/create-a-server
|
||||
- icon: 💻
|
||||
title: For Developers
|
||||
details: Create mods, resources, and UI apps with detailed API documentation and code examples
|
||||
link: /en/guides/index
|
||||
- icon: ❓
|
||||
title: FAQ
|
||||
details: Find quick answers to common questions about setup, troubleshooting, and best practices
|
||||
link: /en/FAQ/player-faq
|
||||
- icon: 📋
|
||||
title: Community Rules
|
||||
details: Learn about our community guidelines and how to report issues or appeal decisions
|
||||
link: /en/community/rules
|
||||
- icon: 🔗
|
||||
title: Community
|
||||
details: Join our Discord, follow on social media, and connect with other BeamMP players and developers
|
||||
link: /en/community/index
|
||||
---
|
||||
!!! warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
Feel you could help? Please do by clicking on the page with a pencil on the right!
|
||||
|
||||
This can be done on any page, too.
|
||||
|
||||
# Welcome to BeamMP Docs! :tada:
|
||||
|
||||
Welcome to the new and improved documentation hub for BeamMP! Whether you're a player, server owner, or developer, we have the resources you need to enhance your BeamNG.drive multiplayer experience.
|
||||
|
||||
## For Players
|
||||
|
||||
New to BeamMP? Check out our [Getting Started](../game/getting-started.md) page to help you hit the road running and make the most out of your multiplayer adventures.
|
||||
For general questions and issues please check out the [Players FAQ](../FAQ/player-faq.md).
|
||||
|
||||
## For Server Owners
|
||||
|
||||
Thinking about creating your own BeamMP server? Our comprehensive guide [here](../server/create-a-server.md) will walk you through the process, ensuring you have all the tools and knowledge to set up your server efficiently.
|
||||
|
||||
## For Developers
|
||||
|
||||
Discover the ins and outs of creating resources for the BeamMP Server in our [Resource Development Guide](../guides/mod-creation/server/getting-started.md).
|
||||
|
||||
Exciting updates are on the horizon, including a brand-new homepage designed to enhance your browsing experience. Stay tuned for more! :slight_smile:
|
||||
|
||||
## Community Rules
|
||||
|
||||
Read through the BeamMP [Community rules](https://docs.beammp.com/community/rules/) and how to appeal bans.
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
{}
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
!!! warning "This site is under construction!"
|
||||
::: warning "This site is under construction!"
|
||||
|
||||
This site is being actively worked on.
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
# Server Scripting Reference
|
||||
## Server Version 2.X
|
||||
!!! warning
|
||||
::: warning
|
||||
|
||||
BeamMP server version 2.X is now unsupported. This documentation is provided as a reference only.
|
||||
Please update to the latest version for maintenance and support.
|
||||
|
||||
@@ -24,12 +24,12 @@ The setup consists of the following steps, you should follow all of them.
|
||||
|
||||
### **1. Port forwarding**
|
||||
|
||||
!!! info
|
||||
::: info
|
||||
|
||||
If you are on a VPS (Virtual Private Server), Rootserver, or plan on hosting this server locally (with players in the same house as you), you can skip this step.
|
||||
This step is necessary if you want someone **outside** of your household to join your home-hosted server (outside of your local network).
|
||||
|
||||
!!! danger ":material-scale-balance: DISCLAIMER:"
|
||||
::: danger ":material-scale-balance: DISCLAIMER:"
|
||||
|
||||
**Port forwarding is a risk**.
|
||||
|
||||
@@ -74,7 +74,7 @@ The “Authentication Key”, often called “AuthKey”, is necessary for makin
|
||||
You have a limited number of keys. One key can be used on one server at a time, so you cannot start two servers at the same time with the same key.
|
||||
More keys can be obtained by supporting the project. Read [this article](https://docs.beammp.com/support/player-faq/) for more information.
|
||||
|
||||
!!! warning
|
||||
::: warning
|
||||
|
||||
DO NOT EVER SHARE THIS KEY OR SHOW IT TO ANYONE. TREAT THIS LIKE A PASSWORD.
|
||||
|
||||
@@ -192,7 +192,7 @@ Description = "Total Random Beam MP Server"
|
||||
ResourceFolder = "Resources"
|
||||
```
|
||||
|
||||
!!! info
|
||||
::: info
|
||||
|
||||
This is your configuration file. It uses a format called TOML. Refer to the [Server Maintenance](server-maintenance.md) section for more info on this file and the variables.
|
||||
Your server will **NOT** show in the server list as long as `Private = true`. _If_ you want it to show in the list, set that to **`Private = false`**.
|
||||
@@ -217,7 +217,7 @@ Now run your server again, and see if it spits out any more `[ERROR]` or `[WARN]
|
||||
|
||||
Vehicle mods and map mods are different to install, but both require you to put them in your server's (`Resources/Client`) folder. Simply slide any mod you want to add in that folder.
|
||||
|
||||
!!! warning
|
||||
::: warning
|
||||
|
||||
Should you receive a "done" or "start" message when trying to join your server after adding mods, you likely added an incompatible or broken mod to your server.
|
||||
Mod incompatibilities can also occur between 2 or more mods. If you have client mods installed, check [this guide](../../FAQ/How-to-deactivate-mods.md) about removing mods from your game.
|
||||
@@ -282,11 +282,11 @@ Enter the servers public IPv4 and Port below, then click "CheckBeamMP".
|
||||
<input type="submit" value="CheckBeamMP">
|
||||
</form>
|
||||
|
||||
!!! warning "I want to use a VPN such as RadminVPN, Hamachi, or similar."
|
||||
::: warning "I want to use a VPN such as RadminVPN, Hamachi, or similar."
|
||||
|
||||
BeamMP does not support these VPNs, as they often cause issues. One of these issues is UDP traffic not being forwarded. To resolve this, refer to section 1.
|
||||
|
||||
!!! question "But why has it worked in the past?"
|
||||
::: question "But why has it worked in the past?"
|
||||
|
||||
This is due to the developers of these applications updating their software and implementing changes which BeamMP has no control over.
|
||||
It is up to the developers of these applications to provide support for specific use cases like a BeamMP-Server.
|
||||
|
||||
@@ -17,6 +17,6 @@ This page contains all the error codes that the server may display.
|
||||
| 10064 | Host down | Unlikely error, but it means that the host is down because either it's shutdown or ports were closed. |
|
||||
| 10065 | Host not reachable | No internet or bad port forwarding, please refer to the [guide steps](create-a-server.md#1-port-forwarding). |
|
||||
|
||||
!!! note
|
||||
::: note
|
||||
For any other code not in this list, you can refer to <https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2> if you know a bit how networks / sockets work.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Port Forwarding
|
||||
|
||||
!!! danger ":material-scale-balance: DISCLAIMER:"
|
||||
::: danger ":material-scale-balance: DISCLAIMER:"
|
||||
|
||||
**Port forwarding is a risk**.
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
<u>**If you do not understand this guide, please consider using one of our partners.**</u>
|
||||
|
||||
!!! warning
|
||||
::: warning
|
||||
|
||||
Please make sure your Router is not a 4G/5G exclusive device. If it is a hybrid device, make sure to select the cable connected adapter later in section 3 of this guide!
|
||||
|
||||
@@ -116,7 +116,7 @@ Subnet Mask (most likely 255.255.255.0)
|
||||
</br>
|
||||
Default Gateway (most likely 192.168.0.1 or 192.168.1.1)
|
||||
|
||||
!!! info "Please Note"
|
||||
::: info "Please Note"
|
||||
BeamMP currently does not support IPv6 for hosting a server.
|
||||
|
||||
#### 1.2. Modify Adapter Settings
|
||||
@@ -208,7 +208,7 @@ Your router will have a place to enter the ports to be forwarded and the destina
|
||||
|
||||
BeamMP requires both UDP and TCP port 30814 (Unless you have changed this in your [ServerConfig.toml](create-a-server.md#4-configuration)).
|
||||
|
||||
!!! info "Note"
|
||||
::: info "Note"
|
||||
While the default **Port** is **30814**, you can choose any other number greater than 1024 but less than 65535, but you need to note down what you picked if it's not 30814\. You need to forward both **TCP** and **UDP**.
|
||||
</br>
|
||||
It is recommended to stick to the default port as that one is very unlikely to be used by another service on your PC.
|
||||
@@ -238,13 +238,13 @@ This can be done by getting your public IPv4 Address, this once again can be don
|
||||
Visit the following Link and replace "IP" with your actual IPv4 address, and the "Port" with your servers port. Be sure to leave no spaces.
|
||||
https://check.beammp.com/api/v2/beammp/ip/port
|
||||
|
||||
!!! success "status: ok"
|
||||
::: success "status: ok"
|
||||
|
||||
If you get the output above you can now join your server!
|
||||
There are 2 ways to join, either directly with the details you entered into Probably UP, or, if your server is set to 'public', through the server-list.
|
||||
Since you are hosting a server on-premise, use 127.0.0.1 (localhost) if the Server is running on the same PC as you play, or the LAN IPv4 of the local machine that is running the server.
|
||||
|
||||
!!! failure "status: error"
|
||||
::: failure "status: error"
|
||||
|
||||
If the connection fails entirely, your ISP could be using CGNAT (Carrier Grade Network Address Translation). For more details, please check [How to check for CGNAT?](../FAQ/How-to-check-for-CGNAT.md),
|
||||
or open a Server Support ticket on our [Discord server](https://discord.gg/beammp) in the `#support` channel and one of our staff will get to your ticket!
|
||||
|
||||
Reference in New Issue
Block a user