BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2025-07-01 15:35:56 +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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -0,0 +1,22 @@
# Error Codes
This page contains all the error codes that the launcher may display.
---
| Code | Description | Possible solution |
|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 10054 | Connection reset by peer | The server you're connecting to has gone offline. |
| Failed to find the game please launch it. Report this if the issue persists code 3. | The launcher was unable to find the game's info (game directory, profile directory, version ect...) in the registry entry | Run the game at least once so the registry values get created. |
| Failed to find the game please launch it. Report this if the issue persists code 4. | The launcher was unable to read the game's info (game directory, profile directory, version ect...) in the registry entry | This error is most likely to appear in users with **pirated copies** of the game. If you have bought the game, run it at least once so the registry values get created. |
| Failed to Launch the game! launcher closing soon | The launcher was unable to find the game's executable | Run the game at least once before running the launcher again. |
| Game Closed! launcher closing soon | The game was closed | This message will appear on game closure or when the game failed to start. |
| Launcher Update failed! | The launcher failed to download a new version | Check your internet connection and firewall / antivirus rules so that the launcher is not blocked. |
| Logger file init failed | The launcher does not have the ability to create files | Run the launcher as administrator. |
| Please close the game and try again | The game is already open and the launcher can't clear the `multiplayer/mods` folder | Close the game and retry. |
| Please launch the game at least once | The launcher tried and failed to modify the game's directory | Run the game at least once before running the launcher again. |
| Primary Servers Offline! sorry for the inconvenience! | The launcher failed to check for an update | Check your internet connection and firewall rules. If there is no problem on your end, please check the [BeamMP updates channel](<https://discord.com/channels/601558901657305098/697596153943949352>) on our Discord. |
| Sorry Backend System Outage! Don't worry it will back on soon! | The BeamMP backend did not respond | Check your internet connection and firewall rules. If there is no problem on your end, please check the [BeamMP updates channel](<https://discord.com/channels/601558901657305098/697596153943949352>) on our Discord. |
| Stuck on updating | The launcher is stuck on updating and will not continue to the next step | Run the launcher as administrator and check your antivirus rules so that the launcher is not blocked. |
If the launcher closes immediately, check the `Launcher.log` file in the folder where you installed BeamMP.

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.

22
docs/it/game/error-codes.md Normal file
View File

@ -0,0 +1,22 @@
# Codici di errore
Questa pagina contiene tutti i possibili errori del launcher.
---
| Codice | Descrizione | Soluzione possibile |
|--------|-------------|---------------------|
| 10054 | Connessione reimpostata dal peer | Il server al quale ti stai connettendo è andato offline. |
| Bloccato sugli aggiornamenti | Il launcher è bloccato agli aggiornamenti e non procede al passo successivo | Esegui il launcher come amministratore e controlla le regole del tuo antivirus affinché il launcher non sia bloccato. |
| Failed to find the game please launch it. Report this if the issue persists code 3. | Il launcher non è stato in grado di trovare le informazioni del gioco (cartella del gioco, cartella del profilo, versione, ecc...) nel registro di sistema | Avvia il gioco almeno una volta per creare i valori nel registro. |
| Failed to find the game please launch it. Report this if the issue persists code 4. | Il launcher non è stato in grado di leggere le informazioni del gioco (cartella del gioco, cartella del profilo, versione, ecc...) nel registro di sistema | Questo errore è mostrato per la maggior parte a utenti che hanno una **copia pirata** del gioco. Se hai acquistato il gioco, avvialo almeno una volta per creare i valori nel registro. |
| Failed to Launch the game! launcher closing soon | Il launcher non è stato in grado di trovare l'eseguibile del gioco | Avvia il gioco almeno una volta ed esegui di nuovo il launcher. |
| Game Closed! launcher closing soon | Il gioco è stato chiuso | Questo messaggio appare alla chiusura del gioco o quando il gioco non si è avviato correttamente. |
| Launcher Update failed! | Il launcher non è stato in grado di scaricare una nuova versione | Controlla la tua connessione ad internet e le regole del tuo firewall / antivirus affinché il launcher non sia bloccato. |
| Logger file init failed | Il launcher non ha i permessi per creare file | Esegui il launcher come amministratore. |
| Please close the game and try again | Il gioco è già aperto e il launcher non riesce a liberare la cartella `multiplayer/mods` | Chiudi il gioco e riprova. |
| Please launch the game at least once | Il launcher ha provato e ha fallito a modificare la cartella del gioco | Avvia il gioco almeno una volta ed esegui di nuovo il launcher. |
| Primary Servers Offline! sorry for the inconvenience! | Il launcher non è stato in grado di controllare gli aggiornamenti | Controlla la tua connessione ad internet e le regole del firewall. Se non ci sono errori dalla tua parte, guarda il [canale BeamMP updates](<https://discord.com/channels/601558901657305098/697596153943949352>) sul nostro Discord. |
| Sorry Backend System Outage! Don't worry it will back on soon! | Il backend BeamMP è irraggiungibile | Controlla la tua connessione ad internet e le regole del firewall. Se non ci sono errori dalla tua parte, guarda il [canale BeamMP updates](<https://discord.com/channels/601558901657305098/697596153943949352>) sul nostro Discord. |
Se il launcher si chiude immediatamente, controlla il file `Launcher.log` nella cartella dove hai installato BeamMP.

8
docs/it/server/create-a-server.md
View File

@ -95,7 +95,7 @@ Copia il testo del campo "key", in questo esempio è `3173a2e-6az0-4542-a3p0-ddq
Il BeamMP-Server è disponibile per Windows e Linux. Le prossime due sezioni sono dedicate all'installazione su Windows e Linux rispettivamente.
### 3.a Installazione su Windows
#### 3.a Installazione su Windows
Per l'installazione su Linux, salta alla sezione succesiva.
@ -109,9 +109,9 @@ Ricordati di fare il port forwarding, altrimenti il tuo server non sarà raggiun
Procedi ora al passo "4\. Configurazione".
### 3.b Installazione su Linux
#### 3.b Installazione su Linux
#### Utilizzando la build precompilata (consigliato)
##### Utilizzando la build precompilata (consigliato)
Questo passo è valido per tutte le distribuzioni Linux per cui offriamo i files binari [qui](https://github.com/BeamMP/BeamMP-Server/releases/latest). Se usi una distribuzione o architettura differente, salta al passo "Compilazione file sorgente".
@ -125,7 +125,7 @@ Questo passo è valido per tutte le distribuzioni Linux per cui offriamo i files
Procedi ora al passo "4\. Configurazione".
#### Compilazione file sorgente
##### Compilazione file sorgente
È molto probabile, ma non è stato ufficialmente provato, che BeamMP-Server per Linux funzioni su distribuzioni differenti da quelle per cui offriamo i files binari [qui](https://github.com/BeamMP/BeamMP-Server/releases/latest). Se vuoi compilare i codice sorgente puoi farlo, scaricando il codice dal nostro [GitHub](https://github.com/BeamMP/BeamMP-Server), una guida si può trovare [qui](https://github.com/BeamMP/BeamMP-Server#build-instructions).

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

@ -0,0 +1,22 @@
# Codici di errore
Questa pagina contiene tutti i possibili errori del server.
---
| Codice | Descrizione | Soluzione possibile |
|--------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| 10022 | Problema di associazione porta | Controlla se la porta in uso dal server è già occupata da altri servizi, se lo è scegline un'altra. |
| 10048 | Indirizzo già in uso | Un altro server BeamMP o altro programma sta già usando quella porta, scegline un'altra. |
| 10051 | Rete non raggiungibile | Port forward non corretto o errori simili, controlla che sia tutto impostato correttamente. |
| 10052 | Reset della rete | Capita quando la rete cade nel momento in cui si effettua una nuova connessione. Riprova a connetterti. |
| 10053 | Connessione interrotta | Causata da un timeout o errore di rete, riprova a connetterti. |
| 10054 | Connessione reimpostata dal peer | Un utente si è disconnesso dal tuo server. |
| 10060 | Timeout della connessione | Port forward non corretto, guarda la [guida di installazione](create-a-server.md#1-port-forwarding). |
| 10061 | Connessione rifiutata | Port forward non corretto, guarda la [guida di installazione](create-a-server.md#1-port-forwarding). |
| 10064 | Host inattivo | Errore non comune, significa che l'host è inattivo perché è spento o perché ha le porte chiuse. |
| 10065 | Host non raggiungibile | Nessuna connessione ad internet oppure port forward non corretto, guarda la [guida di installazione](create-a-server.md#1-port-forwarding). |
!!! note
Altri codici non riportati in tabella sono disponibili qui <https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2> se sai un po' come funzionano le reti e i socket.

12
mkdocs.yml
View File

@ -109,11 +109,13 @@ plugins:
Getting started: Empezando
Playing BeamMP: Jugando a BeamMP
Installing BeamMP: Instalación de BeamMP
Error Codes: Códigos de error
Customizing your setup: Personaliza tu configuración
Using BeamMP: Usando BeamMP
Running a Server: Ejecutando un Servidor
Server Installation: Instalación del Servidor
Server Maintenance: Manutención del Servidor
Error Codes: Códigos de error
Server Manual: Manual del Servidor
Mod & Resource Creation: Creación de Mods y Recursos
Client Side: Lado del Cliente
@ -146,11 +148,13 @@ plugins:
Getting started: Erste Schritte
Playing BeamMP: BeamMP spielen
Installing BeamMP: BeamMP Installation
Error Codes: Fehlercodes
Customizing your setup: Konfiguration anpassen
Using BeamMP: BeamMP verwenden
Running a Server: Server ausführen
Server Installation: Server Installation
Server Maintenance: Server Wartung
Error Codes: Fehlercodes
Server Manual: Server Handbuch
Mod & Resource Creation: Mod- & Ressourcenerstellung
Client Side: Clientseite
@ -183,11 +187,13 @@ plugins:
Getting started: Démarrage
Playing BeamMP: Jouer à BeamMP
Installing BeamMP: Installation de BeamMP
Error Codes: Codes d'erreur
Customizing your setup: Personnalisation de votre configuration
Using BeamMP: Utilisation de BeamMP
Running a Server: Exécution d'un serveur
Server Installation: Installation du serveur
Server Maintenance: Maintenance du serveur
Error Codes: Codes d'erreur
Server Manual: Manuel du serveur
Mod & Resource Creation: Création de mods et de ressources
Client Side: Côté client
@ -220,11 +226,13 @@ plugins:
Getting started: Guida introduttiva
Playing BeamMP: Giocare a BeamMP
Installing BeamMP: Installazione di BeamMP
Error Codes: Codici di errore
Customizing your setup: Personalizza la tua configurazione
Using BeamMP: Utilizzare BeamMP
Running a Server: Eseguire un server
Server Installation: Installazione del server
Server Maintenance: Manutenzione del server
Error Codes: Codici di errore
Server Manual: Manuale del server
Mod & Resource Creation: Creazione di Mod e Risorse
Client Side: Lato client
@ -257,11 +265,13 @@ plugins:
Getting started: Начало работы
Playing BeamMP: Игра в BeamMP
Installing BeamMP: Установка BeamMP
Error Codes: коды ошибок
Customizing your setup: Настройка конфигурации
Using BeamMP: Использование BeamMP
Running a Server: Запуск сервера
Server Installation: Установка сервера
Server Maintenance: Обслуживание сервера
Error Codes: коды ошибок
Server Manual: Руководство по серверу
Mod & Resource Creation: Создание модов и ресурсов
Client Side: Сторона клиента
@ -318,11 +328,13 @@ nav:
- Getting started:
- Playing BeamMP:
- Installing BeamMP: game/getting-started.md
- Error Codes: game/error-codes.md
- Customizing your setup: game/tailoring.md
- Using BeamMP: game/playing.md
- Running a Server:
- Server Installation: server/create-a-server.md
- Server Maintenance: server/server-maintenance.md
- Error Codes: server/error-codes.md
- Server Manual: server/manual.md
- Mod & Resource Creation:
- Client Side: guides/mod-creation/client/getting-started.md