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

Migrated error codes from the wiki

Browse Source 
Added:
- `error-codes.md` for the launcher and server separately.
Fixed:
- Tidied up `create-a-server.md`
This commit is contained in:
alex.ita
2024-02-20 12:18:54 +01:00
committed by Lion
parent 0c057b8b57
commit f8c8ff2275
7 changed files with 110 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -95,7 +95,7 @@ Now copy the text in the “Key” field, in this example that is `3173a2e-6az0-
The BeamMP-Server is available for Windows and Linux. The next two sections are dedicated to Windows and Linux each. 
### 3.a. Installation on Windows
#### 3.a. Installation on Windows
For the Linux installation, see the next step.
@@ -107,13 +107,11 @@ Please ensure you have port-forwarded before attempting to host a server! Withou
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 the next step.
Now proceed to step "4\. Configuration".
### 3.b. Installation on Linux
#### 3.b. Installation on Linux
Skip this if you did “Installation on Windows”.
#### Using our build (recommended)
##### Using our build (recommended)
This step will work on all distributions we provide binaries for [here](https://github.com/BeamMP/BeamMP-Server/releases/latest). If you're on a different distribution or architecture, refer to the "Building from source” step below.
@@ -125,9 +123,9 @@ This step will work on all distributions we provide binaries for [here](https://
6. Start the server once by running it with `./BeamMP-Server-xxx`. 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-xxx`.
7. (optional) It is heavily recommended to set up a user called `beammpserver` (or similar), as we do NOT recommend running the server as root, sudo or with your personal user account. You should then take steps to make sure that you start the server as this user only.
Now proceed to the next step.
Now proceed to step "4\. Configuration".
#### Building from source
##### Building from source
Other distributions in addition to the ones that already have a binary [here](https://github.com/BeamMP/BeamMP-Server/releases/latest) are likely to work too, but aren't officially supported. If you want to build it yourself you can do it 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).

22
docs/en/server/error-codes.md Normal file
View File

@@ -0,0 +1,22 @@
# Error Codes
This page contains all the error codes that the server may display.
---
| Code | Description | Possible solution |
|-------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| 10022 | There is an issue with binding to the port | Check if the port for the server is already in use by another service, if it is use another one. |
| 10048 | Address already in use | Another BeamMP server or program is running on that port, use another one. |
| 10051 | Network unreachable | Bad port forwarding or similar issues, verify that it is all set up correctly. |
| 10052 | Network reset | Happens if the network drops connection while a connection is being established. Retry the connection. |
| 10053 | Connection aborted | Caused by timeout or network error, retry the connection. |
| 10054 | Connection reset by peer | A client has disconnected from your server. |
| 10060 | Connection timed out | There is an issue with your port forwarding, please refer to the [guide steps](create-a-server.md#1-port-forwarding). |
| 10061 | Connection refused | There is an issue with your port forwarding, please refer to the [guide steps](create-a-server.md#1-port-forwarding). |
| 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
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.