Skip to content

Commit

Permalink
Gameserver - BeamMP - Install Addon Map (#1379)
Browse files Browse the repository at this point in the history
* Create beammp-custom-map.md

added BeamMP: Add Custom Map guide (en)

* added BeamMP addon map guide for DE and EN

added BeamMP Install Addon Map guide for DE and EN, also added it to the  sidebar

* tweak: general improvements

* Minor mistakes corrected and improved

* fixed minor formatting errors

* Update GitHubContributors.js

---------

Co-authored-by: Jacob <[email protected]>
Co-authored-by: fgalz <[email protected]>
  • Loading branch information
3 people authored Dec 11, 2024
1 parent c5a8b34 commit d58e9b1
Show file tree
Hide file tree
Showing 4 changed files with 198 additions and 1 deletion.
97 changes: 97 additions & 0 deletions docs/beammp-addon-map.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
id: beammp-addon-map
title: "BeamMP: Install Addon Map"
description: Information on how to install an addon map for your BeamMP server from ZAP-Hosting - ZAP-Hosting.com documentation
sidebar_label: Install Addon Map
services:
- gameserver
---

import InlineVoucher from '@site/src/components/InlineVoucher';

## Introduction

BeamNG.Drive has native modding support and a massive community which allows you to expand and enhance the gameplay with your friends. Since BeamMP simply acts as a multiplayer modification, most map addons should be compatible with your BeamMP server. In this guide, we will cover the process of installing and activating a custom map addon on your BeamMP server.

<InlineVoucher />

## Preperation

To install an addon map to your BeamMP server, you need to connect to it via FTP. If you are not familiar with this, we recommend you to have a look at the [Access via FTP](gameserver-ftpaccess.md) guide.

Before proceeding with installation, you will also have to find maps addons that you wish to install to your server. We recommend browsing the [official BeamNG.Drive Forum](https://www.beamng.com/resources/categories/terrains-levels-maps.9/) which contains a huge library of mods and map addons created by the community.

:::tip
Since BeamMP is a multiplayer modification for BeamNG.Drive, most map addons should be compatible with your BeamMP server. However, it is possible that certain specific maps may not function as expected, so you will have to test each map out.
:::

## Installation

To begin, ensure that you have downloaded an addon map which you aim to add to your server. This should be in a `.zip` file format.

### Selecting Map Name

Before proceeding with further steps, it is important to ensure that the correct map name is being used. The `.zip` file that you have downloaded should typically have the correct name, however this is not always the case which is why you should double check.

To do so, you need to open the downloaded `.zip` file. Inside of the file, locate and open the `levels` directory, which will contain the actual map.

![](https://screensaver01.zap-hosting.com/index.php/s/8cGobQaKBJmexwK/preview)

You need to copy the specific name of the map addon folder found in this directory. You can do so by pressing right-click, selecting the `Properties` option and copying the highlighted text using `CTRL + C`.

![](https://screensaver01.zap-hosting.com/index.php/s/D4AnY5zbfHMgMwR/preview)

### Configuring Map

Now that you have determined the map name, you will have to adjust the configuration file and adjust a parameter which contains the active map.

This can be done easily by navigating to the **Configs** section in your game server's web interface panel.

![](https://screensaver01.zap-hosting.com/index.php/s/sBj4CFQ3yKmMy8d/preview)

Find and open the `ServerConfig.toml` configuration file and search for the line:
`Map = "/levels/gridmap_v2/info.json"`

![](https://screensaver01.zap-hosting.com/index.php/s/JQg3EzkszXDrGFQ/preview)

After that, you replace the value with `Map = "/levels/[your_mapname]/info.json"` using the map name we determined earlier and then save the config.

![](https://screensaver01.zap-hosting.com/index.php/s/oNKN34KTAxrSxYX/preview)

:::info
In rare cases, a map can be formatted differently. If the map doesn't work after following all the steps, it is possible that instead of `Map = "/levels/[your_mapname]/info.json"`, you need to specify this path: `Map = "/levels/[your_mapname]/[your_mapname].mis"`
:::

:::tip
At any time, you can utilise the game's default maps simply by editing the configuration file again. Below is the list of the current default maps.
```
"/levels/gridmap/info.json"
"/levels/automation_test_track/info.json"
"/levels/east_coast_usa/info.json"
"/levels/hirochi_raceway/info.json"
"/levels/italy/info.json"
"/levels/jungle_rock_island/info.json"
"/levels/industrial/info.json"
"/levels/small_island/info.json"
"/levels/smallgrid/info.json"
"/levels/utah/info.json"
"/levels/west_coast_usa/info.json"
"/levels/driver_training/info.json"
"/levels/derby/info.json"
```
:::

### Uploading Map

As a final step, you will need to upload the `.zip` file you downloaded previously containing the map to your BeamMP game server via FTP. Once again, please use our [Access via FTP](gameserver-ftpaccess.md) guide if you need assistance with this.

Locate the following path in your FTP client.
```
../beammp/Resources/Client
```

Simply drag and drop the map addon `.zip` file into this location to upload the map to your server. With the configuration file edited and the map files uploaded, your map addon should be ready for use.

## Conclusion

After you followed all the steps, proceed to restart your BeamMP server. You have successfully installed an addon map on your BeamMP game server. For further questions or assistance, please don't hesitate to contact our support team, which is available daily to assist you! 🙂
98 changes: 98 additions & 0 deletions i18n/de/docusaurus-plugin-content-docs/current/beammp-addon-map.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
id: beammp-addon-map
title: "BeamMP: Addon Map installieren"
description: Informationen, wie du eine Addon Map für deinen BeamMP Server von ZAP-Hosting installieren kannst - ZAP-Hosting.com Dokumentation
sidebar_label: Addon Map installieren
services:
- gameserver
---

import InlineVoucher from '@site/src/components/InlineVoucher';

## Einführung

BeamNG.Drive bietet native Modding-Unterstützung und eine riesige Community, die es dir ermöglicht, das Gameplay mit deinen Freunden zu erweitern und zu verbessern. Da BeamMP einfach als Multiplayer-Modifikation fungiert, sollten die meisten Addon Maps mit deinem BeamMP-Server kompatibel sein. In dieser Anleitung behandeln wir den Prozess der Installation und Aktivierung einer benutzerdefinierten Addon Map auf deinem BeamMP-Server.

<InlineVoucher />

## Vorbereitung

Um eine Addon Map auf deinem BeamMP-Server zu installieren, musst du dich per FTP verbinden. Falls du nicht mit der Verwendung von FTP vertraut bist, empfehlen wir dir, einen Blick in die [Zugriff per FTP](gameserver-ftpaccess.md) Anleitung zu werfen.

Bevor du mit der Installation fortfährst, musst du die Addon Map heraussuchen, die du auf deinem Server installieren möchtest. Wir empfehlen dir, das [offizielle BeamNG.Drive-Forum](https://www.beamng.com/resources/categories/terrains-levels-maps.9/) zu durchsuchen, die eine riesige Bibliothek an Mods und Addon Maps enthält, die von der Community erstellt wurden.

:::tip
Da BeamMP eine Multiplayer-Modifikation für BeamNG.Drive ist, sollten die meisten Addon Maps mit deinem BeamMP-Server kompatibel sein. Es ist jedoch möglich, dass bestimmte Maps nicht wie erwartet funktionieren, sodass du jede Map einzeln testen musst.
:::

## Installation

Stelle zunächst sicher, dass du eine Addon Map heruntergeladen hast, die du deinem Server hinzufügen möchtest. Diese sollte im `.zip`-Dateiformat vorliegen.

### Auswählen der Map

Bevor du mit dem nächsten Schritt fortfährst, musst du sicherstellen, dass du den richtigen Mapnamen verwendest. Die heruntergeladene `.zip`-Datei sollte normalerweise den richtigen Namen haben, dies ist jedoch nicht immer der Fall, weshalb du dies überprüfen solltest.

Dazu musst du die heruntergeladene `.zip`-Datei öffnen. Suche und öffne in der Datei das Verzeichnis `levels`, das die eigentliche Map enthält.

![](https://screensaver01.zap-hosting.com/index.php/s/8cGobQaKBJmexwK/preview)

Du musst den spezifischen Namen des Addon Maps Ordners in diesem Verzeichnis kopieren. Klicke dazu mit der rechten Maustaste, wähle die Option `Eigenschaften` aus und kopiere den markierten Text mit `STRG + C`.

![](https://screensaver01.zap-hosting.com/index.php/s/D4AnY5zbfHMgMwR/preview)

### Konfigurieren der Map

Nachdem du den Mapnamen bestimmt hast, musst du die Konfigurationsdatei und einen Parameter anpassen, der die aktive Map enthält.

Dies kann ganz einfach durch Navigieren zum Abschnitt **Configs** im Webinterface deines Gameservers erfolgen.

![](https://screensaver01.zap-hosting.com/index.php/s/QnQHKiaG6oia3qJ/preview)

Suche und öffne die Konfigurationsdatei `ServerConfig.toml` und suche nach der Zeile `Map = "/levels/gridmap_v2/info.json"`.

![](https://screensaver01.zap-hosting.com/index.php/s/PiatDsnqPpoiZr4/preview)

Danach ersetzt du den Wert durch `Map = "/levels/[your_mapname]/info.json"` unter Verwendung des zuvor festgelegten Mapnamen und speicherst dann die Konfiguration.

![](https://screensaver01.zap-hosting.com/index.php/s/kFgGEKgrXTQsqYZ/preview)

:::info
In seltenen Fällen kann eine Map unterschiedlich formatiert sein. Wenn die Map nach dem Ausführen aller Schritte nicht funktioniert, musst du möglicherweise anstelle von
`Map = "/levels/[your_mapname]/info.json"` diesen Pfad angeben:
`Map = "/levels/[your_mapname]/[your_mapname].mis"`
:::

:::tip
Du kannst jederzeit die Standardmaps des Spiels verwenden, indem du die Konfigurationsdatei erneut bearbeitest. Unten findest du eine Liste der aktuellen Standardmaps.
```
"/levels/gridmap/info.json"
"/levels/automation_test_track/info.json"
"/levels/east_coast_usa/info.json"
"/levels/hirochi_raceway/info.json"
"/levels/italy/info.json"
"/levels/jungle_rock_island/info.json"
"/levels/industrial/info.json"
"/levels/small_island/info.json"
"/levels/smallgrid/info.json"
"/levels/utah/info.json"
"/levels/west_coast_usa/info.json"
"/levels/driver_training/info.json"
"/levels/derby/info.json"
```
:::

### Map hochladen

Als letzten Schritt musst du die zuvor heruntergeladene `.zip`-Datei mit der Map per FTP auf deinen BeamMP Gameserver hochladen. Wenn du dabei Hilfe benötigst, verwende bitte erneut unsere [Zugriff per FTP](gameserver-ftpaccess.md) Anleitung.

Suche in deinem FTP-Client den folgenden Pfad.
```
../beammp/Resources/Client
```

Ziehe die `.zip`-Datei der Addon Map einfach per Drag-and-drop an diesen Speicherort, um die Map auf deinen Server hochzuladen. Nachdem du die Konfigurationsdatei bearbeitet und die Addon Map hochgeladen hast, sollte deine Addon Map einsatzbereit sein.

## Abschluss

Nachdem du alle Schritte ausgeführt hast, starte deinen BeamMP-Server neu. Du hast erfolgreich eine Addon Map auf deinem BeamMP Gameserver installiert. Für weitere Fragen oder Hilfe zögere bitte nicht, unser Support-Team zu kontaktieren, das dir täglich zur Verfügung steht! 🙂
3 changes: 2 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,8 @@ const sidebars = {
]
},
"beammp-authkey",
"beammp-mods"
"beammp-mods",
"beammp-addon-map"
],
},
{
Expand Down
1 change: 1 addition & 0 deletions src/theme/DocItem/Footer/GitHubContributors.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const zapTeam = new Map([
['danymo1221', 'ZAP-Hosting'],
['frank-zap', 'ZAP-Hosting'],
['RugileZAP', 'ZAP-Hosting'],
['ItsPaulAT', 'ZAP-Hosting'],
]);


Expand Down

0 comments on commit d58e9b1

Please sign in to comment.