BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2026-07-18 21:03:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

New VitePress and design look + little work on update to work with.

Browse Source
This commit is contained in:
Starystars67
2026-06-16 12:31:19 +01:00
parent 0ed2597186
commit 97a7aaf643
141 changed files with 4356 additions and 539 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/server/create-a-server.md
+7 -7
View File
@@ -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.
docs/en/server/error-codes.md
+1 -1
View File
@@ -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.
docs/en/server/port-forwarding.md
+6 -6
View File
@@ -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!