BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2026-04-15 14:49:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed structure for GitLocalize

Browse Source 
Fixed:
- The file structure for `game-faq` and `server-faq` have been fixed so that GitLocalized doesn't panic.
- Server requirements is now a list as it should have been before;
This commit is contained in:
alex.ita
2024-01-03 13:38:02 +01:00
committed by Starystars67
parent e845e3290f
commit c11484a090
5 changed files with 48 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -40,6 +40,8 @@ Depending on your setup, you may need to let BeamMP-Server through your firewall
There, just like with the port forwarding, you want to allow the BeamMP-Server through the firewall, **both incoming and outgoing connections**, and **both TCP and UDP**. If your firewall asks for a port instead, that will have to be the same port you used in step “1\. Port Forwarding” (usually 30814).
If you have issues, also feel free to ask on our [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#support` channel.
### 2. Obtaining an Authentication Key
The “Authentication Key”, often called “AuthKey”, is necessary for making a **public** server, but **should** be done for private servers, too.

2
docs/en/support/game-faq.md
View File

@@ -22,7 +22,7 @@ The Client is not officially supported on Linux. However, you might be able to
---
#### **Why is the launcher flagged by my antivirus or by Windows Defender**
In order to prevent Windows Defender from flagging a specific .exe, we need to buy a license which is very expensivr, therefor, BeamMP might get flagged by Windows Defender
In order to prevent Windows Defender from flagging a specific .exe, we need to buy a license which is very expensive, therefore, BeamMP might get flagged by Windows Defender.
Some antivirus may flag BeamMP as a virus beacause it does some interactions with network and other stuff. There are **no viruses** in any of the code. The code for the launcher, server, and lua client can be seen on our [GitHub](https://github.com/BeamMP).

64
docs/en/support/server-faq.md
View File

@@ -15,18 +15,41 @@ All the information to set up your own server can be found [here](https://docs.b
We provide binaries for many Linux distributions [here](https://github.com/BeamMP/BeamMP-Server/releases/latest).
If there are no binaries for your Operating System/Distribution, you can build it yourself by downloading the source on our [GitHub](https://github.com/BeamMP/BeamMP-Server), a tutorial can be found [here](https://github.com/BeamMP/BeamMP-Server#build-instructions).
---
## **Miscellaneous**
---
#### **What are the minimum system requirements to run a BeamMP server?**
RAM: 50+ MiB usable (not counting OS overhead)
CPU: >1GHz, preferably multicore
OS: Windows, Linux (theoretically any POSIX)
GPU: None
HDD: 10 MiB + Mods/Plugins
Bandwidth: 5-10 Mb/s upload
- RAM: 50+ MiB usable (not counting OS overhead)
- CPU: >1GHz, preferably multicore
- OS: Windows, Linux (theoretically any POSIX)
- GPU: None
- HDD: 10 MiB + Mods/Plugins
- Bandwidth: 5-10 Mb/s upload
---
### **Players outside my network can not join my self-hosted server**
Read the step `1. Port Forwarding` of our guide that's available [here](https://docs.beammp.com/server/create-a-server/#1-port-forwarding). Below there's a brief summary of the most noteworthy steps.
If other players, trying to connect to your server, receive an error code 10060, 10061 or 10038 in their BeamMP launcher, then you should check the following steps:
- Forward port 30814 (or whichever port you set in your ServerConfig.toml), both TCP and UDP protocols.
- Allow BeamMP through the Windows Firewall, allow both incoming and outgoing connections. Turning off the firewall will usually NOT work.
- Make sure you're not using a VPN (this can cause issues).
- Make sure the server is actually running, without any errors or warnings.
You can check if you have successfully portforwarded using the site 'portchecker.co' whilst the server is running.
Notes:
- Some internet providers do not offer dedicated IPv4 addresses to your connection, so port forwarding may not be possible, despite it being available in the router.
- Port forwarding is not possible if you are using a mobile (4G/5G) internet connection.
---
### **I can see my self-hosted server in the server-list, but i can not join it myself**
If the server is running on the same machine as the game, you yourself have to use Direct Connect to join, with the IP 127.0.0.1 and your server's port.
For you to be able to join your own, self-hosted server trough the server-list, your router needs to support NAT-loopback, but this is a function not many home routers support.
---
## **Miscellaneous**
---
#### **Where can I find the code?**
@@ -47,25 +70,4 @@ If the issue is code related and you know how to use Github, create a new "Issue
If you don't have a GitHub account or you don't know how to use GitHub you can get in touch with us in the following ways:
- If it is not something sensitive, you can create a post on our [BeamMP Forum](https://forum.beammp.com) or you can report this on our [Official Discord](https://discord.gg/beammp).
- If the information is sensitive you can directly report the issue to a Staff member on our [Discord](https://discord.gg/beammp).
---
### **Players outside my network can not join my self-hosted server**
If other players, trying to connect to your server, receive an error code 10060, 10061 or 10038 in their BeamMP launcher, then you should check the following steps:
- Forward port 30814 (or whichever port you set in your ServerConfig.toml), both TCP and UDP protocols.
- Allow BeamMP through the Windows Firewall, allow both incoming and outgoing connections. Turning off the firewall will usually NOT work.
- Make sure you're not using a VPN (this can cause issues).
- Make sure the server is actually running, without any errors or warnings.
You can check if you have successfully portforwarded using the site 'portchecker.co' whilst the server is running.
Please note, some internet providers do not offer dedicated IPv4 addresses to your connection, so port forwarding may not be possible, despite it being available in the router.
Port forwarding is not possible if you are using a mobile (4G/5G) internet connection.
---
### **I can see my self-hosted server in the server-list, but i can not join it myself**
If the server is running on the same machine as the game, you yourself have to use Direct Connect to join, with the IP 127.0.0.1 and your server's port.
For you to be able to join your own, self-hosted server trough the server-list, your router needs to support NAT-loopback, but this is a function not many home routers support.
- If the information is sensitive you can directly report the issue to a Staff member on our [Discord](https://discord.gg/beammp).