Rust Essentials Logo
Search Normal

Using Custom Maps in Rust

Prerequisites

  • A working Rust Dedicated Server
  • Administrative access to your server files
  • Basic familiarity with server configuration

Types of Custom Maps

There are two main types of custom maps in Rust:

  1. Custom Procedural Maps: Modified versions of the default procedural map generation
  2. Pregenerated Maps: Fully custom, pre-made maps

Creating Custom Procedural Maps

  1. Use the RustEdit.io tool: https://www.rustedit.io/
  2. Adjust parameters like map size, monuments, and terrain features
  3. Save your custom map configuration

Finding and Hosting Pregenerated Maps

You can find and host pregenerated maps using the following resource:

Installing a Custom Map

  1. Download your chosen custom map file or obtain the URL from mapstr.gg
  2. If using a downloaded file:
    • Locate your Rust server installation directory
    • Place the custom map file (.map) directly in the server folder

Configuring Your Server to Use the Custom Map

  1. Open your server's startup script (usually a .bat or .sh file)
  2. Find the line that sets the "server.level" parameter
  3. Replace the existing value with "Custom"
  4. Add a new parameter: +server.levelurl "YourMapFileOrURL"
  5. Optionally adjust or remove other parameters (e.g., server.worldsize, server.seed)

Important Note:

When using a custom map, the parameters server.worldsize and server.seed can either be left in the configuration or removed. The custom map will override these settings if they are defined within the map file itself.

Example Configuration

@echo off
:start
RustDedicated.exe -batchmode ^
+server.port 28015 ^
+server.level "Custom" ^
+server.levelurl "YourMapFileOrURL" ^
+server.maxplayers 150 ^
+server.hostname "My Custom Map Server" ^
+server.description "A server running a custom map" ^
+server.identity "custom_map_server"
goto start

Note: Replace "YourMapFileOrURL" with either the filename of your local map (e.g., "file://MyCustomMap.map") or the URL provided by mapstr.gg.

If you want to include the world size and seed parameters, you can add them like this:

+server.worldsize 4500 ^
+server.seed 12345 ^

Include these lines in your configuration if you want to specify or override the world size and seed.

Testing Your Custom Map

  1. Start your Rust server using the modified startup script
  2. Monitor the server console for any error messages related to the map loading
  3. Connect to your server and verify that the custom map has loaded correctly

Troubleshooting

  • If the map fails to load, double-check the file path or URL in your configuration
  • Ensure the map file is not corrupted by re-downloading if necessary
  • Verify that your server has enough RAM and storage to handle the custom map
  • Check the Rust server logs for specific error messages related to map loading

Important Note:

Using custom maps can significantly impact server performance and player experience. Always test thoroughly before deploying on a live server, and be prepared to make adjustments as needed.