Rust Wiki

Hosting Custom Maps

image.png
This article is not finished and doesn't explain basics of server hosting, only details you need to know while hosting a custom map.

+server.levelurl and about URLs

Most important server parameter you need for hosting a custom map is +server.levelurl [url]. Server reads the [url] argument and starts downloading the map. Keep in mind that other startup parameters that are responsible for procedural maps like +server.worldsize or +server.seed should be removed.

Your map file should be hosted on a public web-site that works 24/7, since new players of your server will download the map from that URL, not from your Rust server. If your URL link doesn't work then players that haven't downloaded the map yet won't be able to join the server.

The URL can be literally anything as long as it's a direct download link. You can check if your link is correct or not by accessing it in your browser - if download starts automatically, then it's a direct download link. If it loads a page that requires user to click something to start the download, then this URL won't work and server will throw an error.

You can also host your map locally. In this case your URL should start with file:/// and after this you enter a full path to your map. For example, file:///path/to/your/cool.map. Keep in mind that other players won't be able to connect because of locally hosted map.

Common issues

World Cache Version Mismatch / World File Outdated

This error means that the downloaded .map file is conflicting with the map installed on a server. This usually happens when you're loading your custom map on a server for the first time, then you edit and save it under the same name and try to load it again. You can easily avoid this issue by saving a new version of your custom map under a different name.

To fix this error, open your Rust client folder (Steam Library -> Right click on Rust -> Properties -> Local Files -> Click on "Browse Local files") and find the "maps" folder. Find the conflicting map and delete it. If you don't know it's name, then see the full error log using in-game console via f1. It offers information about the name of the conflicting file.

Server freezes while loading a map

Usually this happens when your custom map doesn't have an access to the ocean, which means there is no area that can be used for generating paths of the Cargo Ship. You can fix that by adding some area for ocean on edges of your custom map. Alternatively you can just disable Cargo Ship event using these two server startup parameters: baseboat.generate_paths false and cargoship.event_enabled false.

Errors while trying to download the map

This means that the server couldn't download your custom map using the provided URL. Make sure that it's a direct download link, there is no typos in the link and the web-site that hosts your map is up and can be accessed by everyone.

LoadPrefab - should start with assets/

One of the provided prefab IDs on your custom map cannot be found in Rust's assets, which means it was probably removed from the game. Since June 2018, some relatively popular prefabs were removed from Rust, so this error appears pretty often on old custom maps. Some map editors will automatically remove all missing prefabs on load, so you only have to save the map.

Prefab Name Prefab ID Asset Path Status
Bridge 2633142014 assets/bundled/prefabs/autospawn/decor/bridge/bridge.prefab Removed
Storm Drain 1869153096 assets/content/structures/storm drain/storm_drain.prefab Removed
Supermarket 1 244764422 assets/bundled/prefabs/autospawn/monument/small/supermarket_1.prefab Modified
Gas Station 1 3087947638 assets/bundled/prefabs/autospawn/monument/small/gas_station_1.prefab Modified
Warehouse 4115634190 assets/bundled/prefabs/autospawn/monument/small/warehouse.prefab Modified

NullReferenceException: Object reference not set to an instance of an object

image.png

This means that your custom map has a broken prefab which won't allow you join the server. If you are sure it's not a file corruption, then open your map in the editor and remove the broken prefab.

Page Links


Special Pages


Wikis

?

Render Time: 32ms

DB GetPage 6
Generate Html 0
SaveChanges (1) 23
Render Body 0
Render Sidebar 0