BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2025-08-17 08:55:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixes issue #17

Browse Source
This commit is contained in:
alex.ita 2024-02-13 13:53:17 +01:00 committed by Starystars67
parent 5989672d96
commit f0cbd610b2
7 changed files with 48 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/assets/content/keymaster_copy_key.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
docs/assets/content/keymaster_homepage.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docs/assets/content/keymaster_key_done.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 40 KiB

BIN
docs/assets/content/keymaster_new_key.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

BIN
docs/assets/content/keymaster_server_name.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

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

@ -48,37 +48,48 @@ The “Authentication Key”, often called “AuthKey”, is necessary for makin
You will need a [Discord](https://discord.com) account for this step. This is necessary to prevent spam. You will need a [Discord](https://discord.com) account for this step. This is necessary to prevent spam.
#### 2.1.  #### 2.1. Accessing the keys page
To get your key, head to the [Keymaster](https://beammp.com/keymaster), click on "Keys” on the left (key symbol) and then click on the blue '_here_' text.  Login with Discord to the [Keymaster](https://beammp.com/keymaster).
From the Keymaster homepage click on "Keys" on the left of the screen:
<figure markdown> <figure markdown>
![](/assets/content/keymaster1.png) ![](/assets/content/keymaster_homepage.png)
</figure> </figure>
#### 2.2. #### 2.2. Creating a key
 Next, fill out the Server Name field (this is just the key name not the actual name of the server on the list). Example: To create your key click on the green "+" button in the top right. 
<figure markdown>
![](/assets/content/keymaster_new_key.png)
</figure>
#### 2.3. Filling out the key information
Next, fill out the Server Name field (this is just the key name not the actual name of the server on the list), then click "Create". Example:
<figure class="image image_resized" style="width:44.84%;" markdown> <figure class="image image_resized" style="width:44.84%;" markdown>
![](/assets/content//keymaster_key.png) ![](/assets/content/keymaster_server_name.png)
</figure> </figure>
It should, in the end, look something like this: It should, in the end, look something like this:
<figure markdown> <figure markdown>
![](/assets/content//keymaster3.png) ![](/assets/content/keymaster_key_done.png)
</figure> </figure>
Ignore the IP field as it doesn't do anything.
**DO NOT EVER SHARE THIS KEY OR SHOW IT TO ANYONE. TREAT THIS LIKE A PASSWORD.** **DO NOT EVER SHARE THIS KEY OR SHOW IT TO ANYONE. TREAT THIS LIKE A PASSWORD.**
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. 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.
#### 2.3. #### 2.4. Copying the key
Now copy the text in the “Key” field, in this example that is `3173a2e-6az0-4542-a3p0-ddqq5ff95558` and hold onto it for the next step. Now copy the text in the “Key” field, in this example that is `3173a2e-6az0-4542-a3p0-ddqq5ff95558` and hold onto it for the next step. You can do this by clicking the clipboard on the right of the key:
<figure markdown>
![](/assets/content/keymaster_copy_key.PNG)
</figure>
### 3. Installation ### 3. Installation
@ -93,7 +104,7 @@ Please ensure you have port-forwarded before attempting to host a server! Withou
1. Ensure you have installed the [Visual C++ Redistributables](https://aka.ms/vs/17/release/vc_redist.x64.exe) in order to run the server. 1. Ensure you have installed the [Visual C++ Redistributables](https://aka.ms/vs/17/release/vc_redist.x64.exe) in order to run the server.
2. Download the server executable from [beammp.com](https://www.beammp.com/). You should end up with an executable file, called something like `BeamMP-Server.exe`. 2. Download the server executable from [beammp.com](https://www.beammp.com/). You should end up with an executable file, called something like `BeamMP-Server.exe`.
3. Once downloaded, make a folder somewhere and put the `BeamMP-Server.exe` there. This is where your server will live. 3. Once downloaded, make a folder somewhere and put the `BeamMP-Server.exe` there. This is where your server will live.
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 `Server.log` file and a `ServerConfig.toml` file next to your `BeamMP-Server.exe`. 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).** 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 the next step.
@ -111,7 +122,7 @@ This step will work on all distributions we provide binaries for [here](https://
3. Download the correct version for your distro. For sake of semplicity it will be called `BeamMP-Server-xxx` from now on, where `xxx` denotes the version for the distro you're using. 3. Download the correct version for your distro. For sake of semplicity it will be called `BeamMP-Server-xxx` from now on, where `xxx` denotes the version for the distro you're using.
4. Once downloaded, you should see one file called `BeamMP-Server-xxx`, among others which you can ignore for now. Make a folder somewhere and put the `BeamMP-Server-xxx` there. This is where your server will live. 4. Once downloaded, you should see one file called `BeamMP-Server-xxx`, among others which you can ignore for now. Make a folder somewhere and put the `BeamMP-Server-xxx` there. This is where your server will live.
5. Open a terminal, go to that folder you put the `BeamMP-Server-xxx` in, and run `chmod +x BeamMP-Server-xxx`. This ensures that you have permissions to run it. 5. Open a terminal, go to that folder you put the `BeamMP-Server-xxx` in, and run `chmod +x BeamMP-Server-xxx`. This ensures that you have permissions to run it.
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 `Server.log` file and a `ServerConfig.toml` file next to your `BeamMP-Server-xxx`. 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. 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 the next step.

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

@ -48,37 +48,48 @@ La chiave di autenticazione, spesso chiamata "AuthKey", è necessaria per creare
Ti servirà un account [Discord](https://discord.com) per questo passo. Discord è necessario per evitare problemi di spam. Ti servirà un account [Discord](https://discord.com) per questo passo. Discord è necessario per evitare problemi di spam.
#### 2.1 #### 2.1. Accedere alla pagina delle chiavi
Richiedi la tua chiave al [Keymaster](https://beammp.com/keymaster), clicca su "Keys" sulla sinistra (con il simbolo di una chiave) e poi clicca sul testo blu '_here_'. Fai il login con Discord al [Keymaster](https://beammp.com/keymaster).
Dalla homepage del Keymaster, clicca su "Keys" a sinistra dello schermo:
<figure markdown> <figure markdown>
![](/assets/content/keymaster1.png) ![](/assets/content/keymaster_homepage.png)
</figure> </figure>
#### 2.2 #### 2.2. Creare una chiave
Inserisci il nome del server (questo è solo il nome per la chiave, non è il nome vero e proprio del server), ad esempio: Per creare una chiave clicca il "+" verde presente in alto a destra.
<figure markdown>
![](/assets/content/keymaster_new_key.png)
</figure>
#### 2.3. Compilare i dati per la chiave
Inserisci il nome del server (questo è solo il nome per la chiave, non è il nome vero e proprio del server), poi clicca "Create", ad esempio:
<figure class="image image_resized" style="width:44.84%;" markdown> <figure class="image image_resized" style="width:44.84%;" markdown>
![](/assets/content//keymaster_key.png) ![](/assets/content/keymaster_server_name.png)
</figure> </figure>
Il risultato dovrebbe essere simile a questo: Il risultato dovrebbe essere simile a questo:
<figure markdown> <figure markdown>
![](/assets/content//keymaster3.png) ![](/assets/content/keymaster_key_done.png)
</figure> </figure>
Ignora il campo '_IP_'.
**NON CONDIVIDERE MAI QUESTA CHIAVE. TRATTALA COME UNA PASSWORD** **NON CONDIVIDERE MAI QUESTA CHIAVE. TRATTALA COME UNA PASSWORD**
Hai un numero limitato di chiavi. Puoi utilizzare una chiave su un server per volta, quindi non puoi far partire due server con la stessa chiave nello stesso momento. Hai un numero limitato di chiavi. Puoi utilizzare una chiave su un server per volta, quindi non puoi far partire due server con la stessa chiave nello stesso momento.
#### 2.3 #### 2.4. Copiare la chiave
Copia il testo del campo "key", in questo esempio è `3173a2e-6az0-4542-a3p0-ddqq5ff95558` e tienilo pronto per il passo successivo. Copia il testo del campo "key", in questo esempio è `3173a2e-6az0-4542-a3p0-ddqq5ff95558` e tienilo pronto per il passo successivo. Puoi fare questo cliccando l'icona a destra della chiave:
<figure markdown>
![](/assets/content/keymaster_copy_key.PNG)
</figure>
### 3. Installazione ### 3. Installazione
@ -93,7 +104,7 @@ Ricordati di fare il port forwarding, altrimenti il tuo server non sarà raggiun
1. Assicurati di aver installato i [Visual C++ Redistributables](https://aka.ms/vs/17/release/vc_redist.x64.exe), necessari per eseguire il server. 1. Assicurati di aver installato i [Visual C++ Redistributables](https://aka.ms/vs/17/release/vc_redist.x64.exe), necessari per eseguire il server.
2. Scarica l'eseguibile del server da [beammp.com](https://www.beammp.com/). Dovresti trovarti con un file chiamato `BeamMP-Server.exe`. 2. Scarica l'eseguibile del server da [beammp.com](https://www.beammp.com/). Dovresti trovarti con un file chiamato `BeamMP-Server.exe`.
3. Una volta scaricato, crea una cartella dove desideri e sposta al suo interno `BeamMP-Server.exe`. Qui è dove il server risiederà. 3. Una volta scaricato, crea una cartella dove desideri e sposta al suo interno `BeamMP-Server.exe`. Qui è dove il server risiederà.
4. Avvia il server cliccandoci due volte. Questo genererà tutti i files necessari e quando vedi del testo sul terminale, puoi chiuderlo. Dovresti vedere questi files chiamati `Server.log` e `ServerConfig.toml` nella stessa cartella di `BeamMP-Server.exe`. 4. Avvia il server cliccandoci due volte. Questo genererà tutti i files necessari e quando vedi del testo sul terminale, puoi chiuderlo. Dovresti vedere questo file chiamato `ServerConfig.toml` nella stessa cartella di `BeamMP-Server.exe`.
5. (opzionale) Per accedere velocemente al server, crea un collegamento al desktop **cliccando col tasto destro** su `BeamMP-Server.exe` > **Invia a** > **Desktop (crea collegamento)**. 5. (opzionale) Per accedere velocemente al server, crea un collegamento al desktop **cliccando col tasto destro** su `BeamMP-Server.exe` > **Invia a** > **Desktop (crea collegamento)**.
Procedi ora al passo "4\. Configurazione". Procedi ora al passo "4\. Configurazione".
@ -109,7 +120,7 @@ Questo passo è valido per tutte le distribuzioni Linux per cui offriamo i files
3. Scarica la versione corretta per la tua distribuzione. Per semplicità sarà chiamata `BeamMP-Server-xxx` durante la guida, dove `xxx` è la versione per la distribuzione che stai usando. 3. Scarica la versione corretta per la tua distribuzione. Per semplicità sarà chiamata `BeamMP-Server-xxx` durante la guida, dove `xxx` è la versione per la distribuzione che stai usando.
4. Una volta scaricato, crea una cartella dove desideri e sposta al suo interno `BeamMP-Server-xxx`. Qui è dove il server risiederà. 4. Una volta scaricato, crea una cartella dove desideri e sposta al suo interno `BeamMP-Server-xxx`. Qui è dove il server risiederà.
5. Apri un terminale, naviga alla cartella dove si trova `BeamMP-Server-xxx` e incolla il comando `chmod +x BeamMP-Server-xxx`. Questo farà in modo che si abbiano i permessi per eseguire il server. 5. Apri un terminale, naviga alla cartella dove si trova `BeamMP-Server-xxx` e incolla il comando `chmod +x BeamMP-Server-xxx`. Questo farà in modo che si abbiano i permessi per eseguire il server.
6. Avvia il server con il comando `./BeamMP-Server-xxx`. Questo genererà tutti i files necessari e quando vedi del testo sul terminale, puoi chiuderlo. Dovresti vedere questi files chiamati `Server.log` e `ServerConfig.toml` nella stessa cartella di `BeamMP-Server-xxx`. 6. Avvia il server con il comando `./BeamMP-Server-xxx`. Questo genererà tutti i files necessari e quando vedi del testo sul terminale, puoi chiuderlo. Dovresti vedere questo file chiamato `ServerConfig.toml` nella stessa cartella di `BeamMP-Server-xxx`.
7. (opzionale) È consigliato creare un utente chiamato `beammpserver` (o simile), siccome **non** raccomandiamo di eseguire il server come root, sudo o con il proprio utente personale. Dovresti poi rendere possibile l'esecuzione del server solo da questo utente. 7. (opzionale) È consigliato creare un utente chiamato `beammpserver` (o simile), siccome **non** raccomandiamo di eseguire il server come root, sudo o con il proprio utente personale. Dovresti poi rendere possibile l'esecuzione del server solo da questo utente.
Procedi ora al passo "4\. Configurazione". Procedi ora al passo "4\. Configurazione".