BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2026-04-22 16:27:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into checkbeammp

Browse Source
This commit is contained in:
O1LER
2025-06-11 21:44:50 +02:00
committed by GitHub
parent 225165695d 8e92593cad
commit 05c3fab27c
19 changed files with 165 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/FAQ/How-to-check-for-CGNAT.md
View File

@@ -4,7 +4,7 @@ How to check for CGNAT?
All Firewall exclusions and Port forwarding rules are set up correctly, yet nobody can join your home-hosted Server?
If you have connection problems and you are using a Hosting-Service, contact them for assistance. If you want to use a VPS or cannot host a server at home, take a look at our
[list of Partnered hosting services](https://docs.beammp.com/server/create-a-server/#_1:~:text=our%20partnered%20Services!-,Paid%20Services%3A,-Horizon%20Hosting) (Server setup documentation).
[list of Partnered hosting services](../../server/create-a-server/#partnered-hosting-services-paid) (Server setup documentation).
# What even is CGNAT?
@@ -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``

8
docs/en/guides/beammp-dev/beammp-dev.md
View File

@@ -1,11 +1,3 @@
!!! 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 any page too.
# Getting started
In order to get started with development for BeamMP you will need at least:

6
docs/en/scripting/server/latest-server-reference.md
View File

@@ -1171,14 +1171,14 @@ Triggered when a player sends a chat message. When cancelled, it will not show t
Arguments: `player_id: number`, `vehicle_id: number`, `data: string`
Cancellable: YES
Triggered when a player spawns a new vehicle. The `data` argument contains the car's config as json. When cancelled, the car is not spawned.
Triggered when a player spawns a new vehicle. The `data` argument contains the car's configuration and positional/rotational data for the vehicle as a json string.
##### `onVehicleEdited`
Arguments: `player_id: number`, `vehicle_id: number`, `data: string`
Cancellable: YES
Triggered when a player edits their vehicle and applies the edit. The `data` argument contains the car's change config as json. When cancelled, the edit is not applied.
Triggered when a player edits their vehicle and applies the edit. The `data` argument contains the car's updated configuration as a json string but does **not** include positional or rotational data. You can use [MP.GetPositionRaw](#mpgetpositionrawpid-number-vid-number-tablestring) to get positional and rotational data.
##### `onVehicleDeleted`
@@ -1192,7 +1192,7 @@ Triggered when a player deletes their vehicle.
Arguments: `player_id: number`, `vehicle_id: number`, `data: string`
Cancellable: NO
Triggered when a player resets their vehicle. `data` is the car's data as json.
Triggered when a player resets their vehicle. `data` is the car's updated position and rotation however does **not** include the vehicles configuration. You can use [MP.GetPlayerVehicles](#mpgetplayervehiclesplayer_id-number-table) to get the vehicles configuration.
##### `onFileChanged`

10
docs/en/server/create-a-server.md
View File

@@ -54,6 +54,7 @@ The setup consists of the following steps, you should follow all of them.
* [BisectHosting](https://www.bisecthosting.com/beammp-server-hosting)
* [Four Seasons Hosting](https://fourseasonshosting.com)
* [Vertuo Hosting](https://vertuohosting.com)
* [Winheberg](https://winheberg.fr/offres/gaming/beammp?lang=en)
#### 1.1 Firewall
@@ -131,7 +132,7 @@ Please ensure you have port-forwarded before attempting to host a server at home
4. Start the server once by double-clicking on it. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a `ServerConfig.toml` file next to your `BeamMP-Server.exe`.
5. (optional) For quick access in the future you can easily create a desktop shortcut to `BeamMP-Server.exe` using **[Right click]** > **Send to** > **Desktop (create shortcut).**
Now proceed to step "4\. Configuration".
Now proceed to step [4. Configuration](#4-configuration).
#### 3.b. Installation on Linux
@@ -207,7 +208,12 @@ Now run your server again, and see if it spits out any more `[ERROR]` or `[WARN]
#### 5.1 How to add mods to your server
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. 
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
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.
#### 5.2 General Mods

31
docs/en/server/port-forwarding.md
View File

@@ -14,7 +14,6 @@
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!
## How to set up port forwarding.
Creating a port forwarding rule involves a few detailed network terms. Be prepared to write down a few notes as you go through the process.
@@ -23,10 +22,6 @@ There are 4 major steps in this guide.
## A quick guide. (A more detailed guide is below)
<div class="grid cards" markdown>
- :material-dns:{ .lg .middle } __Assign a static IP address to your computer or devices__
@@ -79,7 +74,6 @@ If you have managed to do this, please skip directly to [step 2](port-forwarding
#### 1.1. Find your current IP Address, Gateway and DNS servers:
Before we can set up a static IP address, we need to know your current network settings.
You are going to want to write these down, so get a notepad window ready.
For this step, we are going to use command prompt.
@@ -90,7 +84,7 @@ Open up a command prompt. The 3 main ways are:
<figure class="image image_resized" style="width:62%;" markdown>
![](../../assets/content/win11-open-cmd.png)
![](../../assets/content/win11-open-cmd.png)
</figure>
Once you are in the command prompt, run the following command:
@@ -103,9 +97,8 @@ You will see a lot of data.
If you have virtual or multiple network adapters, then you will see even more data.
It is common to see many virtual adapters if you have either Hyper-V or Docker installed.
<figure class="image image_resized" style="width:62%;" markdown>
![](../../assets/content/win11-command-prompt-ipconfig-highlighted.png)
![](../../assets/content/win11-command-prompt-ipconfig-highlighted.png)
</figure>
It is recommended to use a wired network connection which will be running this server, however, it will work over a wireless connection.
@@ -136,7 +129,7 @@ Now we need to change the settings on your network adapter in order for your PC
<figure class="image image_resized" style="width:62%;" markdown>
![](../../assets/content/win11-start-menu-view-network-connections.png)
![](../../assets/content/win11-start-menu-view-network-connections.png)
</figure>
You should see a list of network connections on your computer.
@@ -144,14 +137,14 @@ If you have Hyper-V or Docker installed, there can be many.
Look for any adapters that are not named "Hyper-V".
<figure class="image image_resized" style="width:62%;" markdown>
![](../../assets/content/win11-network-connections.png)
![](../../assets/content/win11-network-connections.png)
</figure>
Right-click on your adapter and choose properties. If `Internet Protocol Version 4` is not checked, then this is the wrong adapter. Choose a different one.
<figure class="image image_resized" style="width:62%;" markdown>
![](../../assets/content/win11-ethernet-properties-highlighted.png)
![](../../assets/content/win11-ethernet-properties-highlighted.png)
</figure>
Double click on `Internet Protocol Version 4`. Change `Obtain an IP address automatically` to `Use the following IP address`.
@@ -165,7 +158,7 @@ Alternatively, instead of using your DNS servers, you can use either the CloudFl
<figure class="image image_resized" style="width:62%;" markdown>
![](../../assets/content/win11-network-settings-static-ip.png)
![](../../assets/content/win11-network-settings-static-ip.png)
</figure>
Click Ok, then click Ok again, and your adapter is now changed from DHCP to static. Surf the web to make sure that you still have internet connectivity. If you do not, then change your settings back to Obtain an IP address automatically and try the next method.
@@ -197,6 +190,7 @@ Try various combinations of admin, password, and leaving the entries blank. *Whe
### 3. Create the forwarding rules!
#### 3.1. Find the forwarding section
Find the port forwarding section in your router web interface. Navigate around in your router by clicking the tabs or links at the top or left of each page. Most routers list the port forwarding section under Network, Advanced, or LAN. Look for the following keywords to help you find it:
- Port Forwarding
@@ -206,7 +200,7 @@ Find the port forwarding section in your router web interface. Navigate around i
- Apps & Gaming
- Advanced Setup/Settings
- NAT
#### 3.2. Enter in the details
Once you find your router's port forwarding section, you are ready to enter the necessary information.
@@ -214,7 +208,6 @@ 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"
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>
@@ -245,14 +238,14 @@ 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!
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!
Should you only see TCP working and UDP failing, check Firewall and Port forwarding rules again.