Skip to content

Commit

Permalink
Update BeamMP guides for new format
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrotski committed Jan 31, 2025
1 parent 269003b commit e15ee12
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 29 deletions.
36 changes: 7 additions & 29 deletions src/content/docs/games/BeamMP/change map.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,50 +9,28 @@ import { Steps } from '@astrojs/starlight/components';

Whether you're looking to explore new terrains or just want a different environment for your players, this guide will walk you through the steps to change the server map on your [BeamMP server](https://www.gamehostbros.com/beammp-server-hosting/) using the Game Host Bros Panel. By following these instructions, you'll be able to quickly switch to any of the stock maps that come with BeamMP or even set a custom map of your choice.


## Using Default Maps
Here is how you can use some of the default maps that come with BeamMP.
<Steps>
1. Log in to the [Game Host Bros Panel](https://panel.gamehostbros.com/) and select your BeamMP server.
2. Go to `Configuration > Startup Parameters`.
3. Find the `Map` setting and enter your desired map filepath.
3. Find the `Map` setting and select the map you would like from the dropdown.
4. Restart your server.
</Steps>
Here is a list of the stock maps that come with BeamMP and their filepath.

| Map Name | Filepath |
|----------------------|-------------------------------------------|
| Gridmap V2 | /levels/gridmap_v2/info.json |
| Automation Test Track| /levels/automation_test_track/info.json |
| East Coast USA | /levels/east_coast_usa/info.json |
| Hirochi Raceway | /levels/hirochi_raceway/info.json |
| Italy | /levels/italy/info.json |
| Jungle Rock Island | /levels/jungle_rock_island/info.json |
| Industrial | /levels/industrial/info.json |
| Small Island | /levels/small_island/info.json |
| Smallgrid | /levels/smallgrid/info.json |
| Utah | /levels/utah/info.json |
| West Coast USA | /levels/west_coast_usa/info.json |
| Driver Training | /levels/driver_training/info.json |
| Derby | /levels/derby/info.json |
| Cliff | /levels/cliff/info.json |
| Johnson Valley | /levels/johnson_valley/info.json |


:::note
This setting will override anything you have manually set inside your ServerConfig.toml file.
:::

## Uploading Custom Maps
Custom maps are normally provided to you in a .zip format. To use custom maps on your BeamMP server, you'll need to upload them via SFTP.
Custom maps are normally provided to you in a .zip format. To use custom maps on your BeamMP server, you'll need to upload them via SFTP. For this example we will be uploading a file called `custom_map.zip` to our server.

<Steps>
1. Log in to the [Game Host Bros Panel](https://panel.gamehostbros.com/) and select your BeamMP server.
2. Access your server files using [SFTP](https://guides.gamehostbros.com/getting-started/uploading-files/).
3. Upload your custom_map.zip to `/Resources/Client/` so the client is able to download the map.zip (the same as a mod .zip).
3. Upload your `custom_map.zip` to `/Resources/Client/` so players are able to download the map.
4. After uploading, go to `Configuration > Startup Parameters` in the Game Host Bros Panel.
5. Open the custom_map.zip locally on your PC and look for the info.json file. Enter the filepath for your custom map info into the `Map` section. e.g. `/levels/custom_map/info.json`.
5. Look for `Custom Map Zip File Name` and enter the name of the custom_map.zip you just uploaded.
6. Restart your server to apply the changes.

It should now say in the server console `Successfully loaded custom map from ZIP file`.

</Steps>
This is how your files should look if everything is uploaded correctly.

Expand Down
8 changes: 8 additions & 0 deletions src/content/docs/games/BeamMP/installing mods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ import { Steps } from '@astrojs/starlight/components';

Adding mods to your [BeamMP server](https://www.gamehostbros.com/beammp-server-hosting/) is a great way to enhance gameplay, introduce new features, and keep your community engaged. This guide will walk you through the steps to easily upload and enable mods on your BeamMP server using the Game Host Bros Panel.

## Before You Start
Here are some things you should know before uploading mods to your server.

- Not all mods will work so we suggest uploading one at a time and testing to make sure everything is ok before adding more.
- Please be aware of the file size of your mods, as this directly relates to how long it will take players to join your server.
- Some mods are very poorly optimized. Most well optimized car mods should be 100 - 200mb in size. If a car mod is larger than this it can cause lag for your players.
- If you upload too many mods at once, BeamMP might crash when it starts. You will need to upload your mods in batches, start the server once, then add more mods. This is a BeamMP bug.

## Uploading Mods to Your Server
To start using mods on your BeamMP server, you need to upload them to the correct directory. Here's how:

Expand Down

0 comments on commit e15ee12

Please sign in to comment.