diff --git a/docs/assets/content/probably-up-sucessful.png b/docs/assets/content/probably-up-sucessful.png new file mode 100644 index 00000000..1ee883c3 Binary files /dev/null and b/docs/assets/content/probably-up-sucessful.png differ diff --git a/docs/assets/content/probably-up.png b/docs/assets/content/probably-up.png new file mode 100644 index 00000000..79052851 Binary files /dev/null and b/docs/assets/content/probably-up.png differ diff --git a/docs/assets/content/win11-command-prompt-ipconfig-highlighted.png b/docs/assets/content/win11-command-prompt-ipconfig-highlighted.png new file mode 100644 index 00000000..b9c48bb0 Binary files /dev/null and b/docs/assets/content/win11-command-prompt-ipconfig-highlighted.png differ diff --git a/docs/assets/content/win11-ethernet-properties-highlighted.png b/docs/assets/content/win11-ethernet-properties-highlighted.png new file mode 100644 index 00000000..519dd366 Binary files /dev/null and b/docs/assets/content/win11-ethernet-properties-highlighted.png differ diff --git a/docs/assets/content/win11-network-connections.png b/docs/assets/content/win11-network-connections.png new file mode 100644 index 00000000..fe60873a Binary files /dev/null and b/docs/assets/content/win11-network-connections.png differ diff --git a/docs/assets/content/win11-network-settings-static-ip.png b/docs/assets/content/win11-network-settings-static-ip.png new file mode 100644 index 00000000..ebb25b4c Binary files /dev/null and b/docs/assets/content/win11-network-settings-static-ip.png differ diff --git a/docs/assets/content/win11-open-cmd.png b/docs/assets/content/win11-open-cmd.png new file mode 100644 index 00000000..f5e1d578 Binary files /dev/null and b/docs/assets/content/win11-open-cmd.png differ diff --git a/docs/assets/content/win11-start-menu-view-network-connections.png b/docs/assets/content/win11-start-menu-view-network-connections.png new file mode 100644 index 00000000..248f7268 Binary files /dev/null and b/docs/assets/content/win11-start-menu-view-network-connections.png differ diff --git a/docs/de/server/create-a-server.md b/docs/de/server/create-a-server.md index 8a1ced58..c48af53f 100644 --- a/docs/de/server/create-a-server.md +++ b/docs/de/server/create-a-server.md @@ -30,13 +30,20 @@ Das Aufsetzten besteht aus ein paar Schritten. Du solltest unbedingt alle befolg Dieser Schritt ist wichtig, wenn jemand außerhalb des Heim-Netzwerks deinem Server beitreten möchte. -#### ACHTUNG: +#### -Durch die Port Weiterleitung verstehst du die Risiken des öffnen von Ports von deinem Heim-Netzwerk in das öffentliche und verzichtest auf dein Recht, BeamMP für (ernste) Schäden an dir oder einem Netzwerk verantwortlich zu machen. +!!! danger ":material-scale-balance: WARNUNG:" -Daher wird empfohlen, einen Server mit einen unserer Partner zu hosten. +``` +**Das weiterleiten von Ports ist ein Risiko**. + +Durch das weiterleiten von Ports akzeptierst du das Risiko beim öffnen von Ports auf einem lokalen Netzwerk in das öffentliche Netzwerk. Dadurch kannst du BeamMP für **jegliche und alle** Schäden die an dir oder deinem Haushalt passieren können, nicht verantwortlich machen. +Wir sind nicht verantwortlich für jegliches verlinktest Material auf externen Seiten oder Services. +``` -Kostenpflichtige Dienste: +Es ist zu empfehlen, einen Server mit einem unserer Partner-Services zu hosten! + +#### Kostenpflichtige Dienste: - [Horizon Hosting](https://hrzn.link/beammp) - [Snakecraft Hosting](https://schost.us/beammp-plans) @@ -47,8 +54,6 @@ Kostenpflichtige Dienste: - [HostHavoc](https://hosthavoc.com/) - [PedalHost](https://pedal.host/) -**Andere Anbieter, welche BeamMP-Server hosting anbieten und hier nicht gelistet sind, sind nicht von uns verifiziert und KÖNNEN mehr als unsere Partner verlangen.** - *Achtung: Wenn du einen Server mit unseren Partnern hostest, kannst du den ,,Port Weiterleitung" Schritt überspringen.* Nun zurück zu Port Forwarding. Dieser Schritt ist derselbe wie für fast alle anderen Spielserver wie Minecraft Server. Du kannst gute Tutorials online finden, sogar Anleitungen für dein spezifisches Routermodell. Eine gute Anleitung wäre [dieses tutorial](https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/). Stelle sicher, dass du den Port **30814** für **TCP** and **UDP** weiterleitest. @@ -61,7 +66,7 @@ Abhängig von deinem Setup, muss in der Firewall eine Ausnahme für den BeamMP-S Sowohl Ein- als auch Ausgehende Verbindungen auf **TCP** und **UDP** müssen als Firewall-Regel für die Anwendung BeamMP-Server.exe freigegeben werden. Wenn deine Firewall stattdessen nach einem Port fragt, muss dies derselbe Port sein, den du in Schritt „1. Portweiterleitung“ verwendet hast (Standard ist 30814). -Wenn du Probleme hast, kannst du diese auch gerne in unserem [Forum](https://forum.beammp.com) oder auf unserem [Discord-Server](https://discord.gg/beammp) im `#support` Kanal fragen. +Solltest du Probleme haben, frage auf unserem [Forum](https://forum.beammp.com) oder auf unserem [Discord server](https://discord.gg/beammp) im `#support` Kanal. ### 2. Authentifizierungsschlüssel @@ -183,7 +188,7 @@ Für unser Beispiel sollte der Eintrag so aussehen: AuthKey = '3173a2e-6az0-4542-a3p0-ddqq5ff95558' ``` -Vergib deinem Server einen Namen im `Name` Feld. Du kannst diesen mit Farbe und mehr formatieren. Siehe [diese Sektion zu Namensformatierung](server-maintenance.md#customize-the-look-of-your-server-name) auf der Serverwartungssteite. +Gib deinem Server auch einen Namen, in dem du das `Name` Feld befüllst. Man kann dies mit farben und mehr formatieren. Siehe [diesen Eintrag zu benutzerdefinierten Namen](server-maintenance.md#customize-the-look-of-your-server-name) auf der Server-Wartungs Seite.. Wenn du einen anderen **Port** als **30814** ausgewählt hast, achte darauf, ihn hier unter `Port` zu ersetzen. @@ -205,7 +210,7 @@ Wenn du nur modifizierte Fahrzeuge hinzufügen möchtest, lege die Zip-Datei der #### 5.3 Karten -Alle Standardkarten (Karten, die keine Mods sind) funktionieren sofort und müssen nicht installiert werden. Man ändert einfach die `Map` in der Datei `ServerConfig.toml` auf eine der [folgenden](server-maintenance.md#all-vanilla-maps-names) . Für alle anderen mod Karten befolge folgende Schritte: +Alle in BeamNG.Drive mitgelieferten Karten (welche keine Mods sind) funktionieren sofort und müssen nicht installiert werden. Du änderst einfach den `Map` Pfad in der `ServerConfig.toml` Datei auf einen [dieser](server-maintenance.md#all-vanilla-maps-names). Für jegliche Mod Karten, gehe wie folgt vor: 1. Legen die `.zip` Datei der Karte in den Ordner
`Resources/Client` des Servers. 2. Sieh dir als Nächstes in die Zip-Datei der Karte (entpacke sie nicht) und öffne den Ordner „ `levels` “. In diesem Ordner sollte sich lediglich ein weiterer Ordner mit dem Namen der Karte befinden, zum Beispiel „myawesomedriftmap2021“. Achte darauf, diesen Namen *genau so zu kopieren oder zu merken, wie er im Namen dieses Ordners geschrieben ist.* diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md index 86c633b8..156d9ec7 100644 --- a/docs/en/server/create-a-server.md +++ b/docs/en/server/create-a-server.md @@ -52,11 +52,7 @@ It is therefore recommended to host a Server with one of our partnered Services! *NOTE: if you host your server using one of our partners, the Port Forwarding step is not needed.* -Now back to Port Forwarding. This step is the same for almost every game's server, such as Minecraft Servers, so you can find many tutorials online for this, even for your specific router model. A good full guide is [this tutorial](https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/). Make sure you forward port  **30814**, as **TCP** and **UDP**.  - -While the default **Port** you want to “forward” is **30814**, you can choose any other number >1024, but you need to note down what you picked if it's not 30814\. You need to forward both **TCP** and **UDP**. -It is recommended to stick to the default port as that one is very unlikely to be used by another Service on your PC. -NOTE: If you are hosting multiple Servers on one machine, each Server needs a different Port. Server 1: 30814, Server 2: 30815 for example. +Please see [this guide on how to port forward](port-forwarding.md) #### 1.1 Firewall diff --git a/docs/en/server/port-forwarding.md b/docs/en/server/port-forwarding.md new file mode 100644 index 00000000..f0ded5b2 --- /dev/null +++ b/docs/en/server/port-forwarding.md @@ -0,0 +1,248 @@ +# Port Forwarding + +!!! danger ":material-scale-balance: DISCLAIMER:" + + **Port forwarding is a risk**. + + By Port forwarding you understand the risks of opening up ports on your home network to the public and therefore void the right to hold BeamMP accountable for **any and all** damages that may happen to you or your household. + + We take no responsibility for any content on any externally linked services or websites. + + **If you do not understand this guide, please consider using one of our partners.** + + + +## How To Set Up a Port Forward + +Setting up a port forward involves a few detailed network terms. Be prepared to write down a few notes as you go through the process. + +There are 4 major steps to setting up a port forward. + +## A quick guide. (A more detailed guide is below) + + + + + +
+ +- :material-dns:{ .lg .middle } __Assign a static IP address to your computer or devices__ + + --- + This is needed to prevent the IP of your device changing and breaking the port forwarding rule. + + + [:octicons-arrow-right-24: See info about your router](https://portforward.com/router.htm#1) + +- :material-router-wireless:{ .lg .middle } __Log in to your router__ + + --- + + This can normally be done by finding the Default Gateway IP, which can be found using `ipconfig` in command prompt and enter this in on a web browser. + +- :material-lan-connect:{ .lg .middle } __Forward ports to your computer__ + + --- + + Find the port forwarding section in your router menu. Most routers list the port forwarding section under Network, Advanced, or LAN. + +- :material-test-tube:{ .lg .middle } __Test that your port is forwarded properly__ + + --- + + Use a tool such as ProbablyUp to test if the rule is working. + + [:octicons-arrow-right-24: Probably Up](https://probablyup.net/api) + +
+ +## The detailed guide + +### 1. Assigning a static IP address + +### Method 1: Set Up a Static IP Address Using DHCP Reservations + +Another way to set up a static IP address is to use your router's DHCP reservations feature. Not all routers have this feature, so this may not be an option for you. Please search the internet with the model of your router to find out if you can. + +However, if your router does have this feature, it is an excellent choice for reserving a static IP address for all of the devices in your home. DHCP reservations allow you to centrally manage all of your home IP addresses from a single interface and will enable you to change settings on devices that you may otherwise not be able to edit. + +If you have managed to do this, please skip directly to [step 2](port-forwarding.md#2-log-in-to-your-router) + +### Method 2: Assign a static IP in Windows + +#### 1.1. Find your current IP Address, Gateway and DNS servers: + + +Before we can set up a static IP address, we need to know your current network settings. +You are going to want to write these down, so get a notepad window ready. +For this step, we are going to use command prompt. + +Open up a command prompt. The 3 main ways are: + +- Windows Key, then start typing the phrase "cmd", then press Enter when you see "Command Prompt" highlighted. +- Windows Key + R (opens the Run dialog box), followed by 'cmd', then Enter +- Right-click the Windows Icon, then choose 'Windows PowerShell' (white text on blue background) + + +
+ ![](../../assets/content/win11-open-cmd.png) +
+ +Once you are in the command prompt, run the following command: + +``` +ipconfig /all +``` + +You will see a lot of data. +If you have virtual or multiple network adapters, then you will see even more data. +It is common to see many virtual adapters if you have either Hyper-V or Docker installed. + + +
+ ![](../../assets/content/win11-command-prompt-ipconfig-highlighted.png) +
+ +It is recommended to use a wired network connection which will be running this server, however, it will work over a wireless connection. +You will need to look for an adapter in this list which has valid settings. Scroll through the list and find one that has a Default Gateway assigned. +Many of the virtual adapters will not have a Default Gateway. +You need to find a Default Gateway that has a similar IP address to the IPv4 address listed for the adapter. + +For instance, if you find an adapter with an IPv4 address that is 192.168.0.100, and the Default Gateway is 192.168.0.1, this is a suitable adapter. + +You will need to note down the following information: + +IPv4 Address, examples: + +- 192.168.x.x +- 10.x.x.x. +- 172.16.x.x - 172.31.x.x + +Subnet Mask (most likely 255.255.255.0) +
+Default Gateway (most likely 192.168.0.1 or 192.168.1.1) + +!!! info "Please Note" + BeamMP currently does not support IPv6 for hosting a server. + +#### 1.2. Modify Adapter Settings + +Now we need to change the settings on your network card or ethernet adapter. To get to the settings for your network, the fastest method is: + +- Single tap the Windows key +- Type the phrase "network connections" until you see "View network connections". +- Press the Enter key + + +
+ ![](../../assets/content/win11-start-menu-view-network-connections.png) +
+ +You should see a list of network connections on your computer. +If you have Hyper-V or Docker installed, there can be many. +Look for any adapters that are not named "Hyper-V". + +
+ ![](../../assets/content/win11-network-connections.png) +
+ + +Right-click on your adapter and choose properties. If `Internet Protocol Version 4` is not checked, then this is the wrong adapter. Choose a different one. + +
+ ![](../../assets/content/win11-ethernet-properties-highlighted.png) +
+ +Double click on `Internet Protocol Version 4`. Change `Obtain an IP address automatically` to `Use the following IP address`. + +Fill out the IP address, Subnet mask, Default gateway, and Preferred DNS server with the information from command prompt (ipconfig /all). + +Alternatively, instead of using your DNS servers, you can use either the CloudFlare or Google DNS servers: + +- CloudFlare DNS: 1.1.1.1, 1.0.0.1 +- Google DNS: 8.8.8.8, 8.8.4.4 + + +
+ ![](../../assets/content/win11-network-settings-static-ip.png) +
+ +Click Ok, then click Ok again, and your adapter is now changed from DHCP to static. Surf the web to make sure that you still have internet connectivity. If you do not, then change your settings back to Obtain an IP address automatically and try the next method. + +### 2. Log in to your router + +Now that you have a static IP address on your device, you are ready to forward your port for BeamMP! + +To start, we need to log in to your router. Earlier, one of the settings that you wrote down is your Default Gateway. That is the IP address of your router. + +Most routers use a locally hosted web page for management. To view your router's menu and settings: + +- Open up a web browser. Firefox, Chrome or Edge should work fine. +- In the address bar, type your Default Gateway IP address, such as 192.168.0.1 or 192.168.1.1 and press enter + +You should now see your router's login screen. Not all routers require a login, but most do. You need to know your router's username and password. If you have never logged in before, your username and password are most likely set to the factory default values or, in some cases, written on the bottom of your router. + +Some of the most common factory usernames and passwords are listed here: + +| Username | Password | +| ----------- | --------- | +| admin | admin | +| admin | password | +| {blank} | admin | +| {blank} | password | + +Try various combinations of admin, password, and leaving the entries blank. *Where it says blank, try leaving the value blank.* + +### 3. Create the forwarding rules! + +#### 3.1. Find the forwarding section +Find the port forwarding section in your router menu. Navigate around in your router by clicking the tabs or links at the top or left of each page. Most routers list the port forwarding section under Network, Advanced, or LAN. Look for the following keywords to help you find it: + +- Port Forwarding +- Forwarding +- Port Range Forwarding +- Virtual Servers +- Apps & Gaming +#### 3.2. Enter in the details + +Once you find your router's port forwarding section, you are ready to enter the necessary information. +Your router will have a place to enter the ports to be forwarded and the destination IP address to point those forwarded ports. If your router lists both Internal and External ports, make them the same. + +BeamMP requires both UDP and TCP port 30814 (Unless you have changed this in your [ServerConfig.toml](create-a-server.md#4-configuration)). + + +!!! info "Something to note:" + While the default **Port** you want to “forward” 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**. +
+ It is recommended to stick to the default port as that one is very unlikely to be used by another service on your PC. +
+ However, If you are hosting multiple servers on one machine, each server needs a different Port. Server 1: 30814, Server 2: 30815 for example. + +On some routers you may need to create 2 rules, one for UDP and one for TCP, whilst others are nice and allow you to do both with a single rule! + +Most routers have a Save button, and some routers require a restart or reboot for the changes to take effect. + +### 4. Time to test! + +There are a few different ways to test the connection. + +Our recommend way is to use a tool called [Probably Up](https://probablyup.net/api) as this tests for BeamMP specific issues and protocols. + +This can be done by getting your public IPv4 Address, this once again can be done in a few different ways. The main way is to use a website called [icanhazip.com](https://icanhazip.com/). This is a very simple website which displays your public IP Address. You should be looking for an IP address with the formatting: xxx.xxx.xxx.xxx + +
+ ![](../../assets/content/probably-up.png) +
+ +Once you have entered in the information required, click on Run test and it should put out something like this: + +
+ ![](../../assets/content/probably-up-sucessful.png) +
+ +If you get the output above you can now join your server! +You have 2 ways to join, either directly with the details you entered into Probably UP, or, if your server is public, through the server-list. + +## Still not working? + +Please 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! \ No newline at end of file diff --git a/docs/en/support/game-faq.md b/docs/en/support/game-faq.md index e4877f9e..84535f77 100644 --- a/docs/en/support/game-faq.md +++ b/docs/en/support/game-faq.md @@ -42,8 +42,8 @@ Before making any changes, keep in mind that the code is subject to our [Terms o | Code | License | |------------|:--------------------------------------------------------------------------:| | Server | [LICENSE](https://github.com/BeamMP/BeamMP-Server/blob/master/LICENSE) | -| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/README.md) | -| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE.md) | +| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/LICENSE) | +| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE) | --- #### **I have found a bug or an exploit what should I do?** diff --git a/docs/it/support/game-faq.md b/docs/it/support/game-faq.md index d37b002c..025f431d 100644 --- a/docs/it/support/game-faq.md +++ b/docs/it/support/game-faq.md @@ -43,8 +43,8 @@ Prima di modificare il codice, ricordati che è soggetto ai nostri [termini di u | Codice | Licenza | |------------|:--------------------------------------------------------------------------:| | Server | [LICENSE](https://github.com/BeamMP/BeamMP-Server/blob/master/LICENSE) | -| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/README.md) | -| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE.md) | +| Launcher | [LICENSE](https://github.com/BeamMP/BeamMP-Launcher/blob/master/LICENSE) | +| Client Lua | [LICENSE](https://github.com/BeamMP/BeamMP/blob/development/LICENSE) | --- #### **Ho trovato un bug o un exploit cosa faccio?** @@ -54,4 +54,4 @@ Se il problema è legato al codice e sai come usare GitHub, crea una nuova "Issu Nel caso non abbia o non sappia usare GitHub, puoi procedere nei seguenti modi: - Se il problema non concerne nulla di sensibile, puoi creare un nuovo post sul nostro [forum](https://forum.beammp.com) o sul nostro [Discord](https://discord.gg/beammp). -- Se il problema concerne informazioni sensibili, contatta un nostro membro dello staff su [Discord](https://discord.gg/beammp). \ No newline at end of file +- Se il problema concerne informazioni sensibili, contatta un nostro membro dello staff su [Discord](https://discord.gg/beammp).