Skip to the content

Install · version 0.2.0

Install RustMapGen

Make your own Rust maps. The installer sets everything up by itself and downloads the free Rust dedicated server from Steam, about 6 GB. On a fast connection it is done in under ten minutes; then you open the panel and make your first custom map.

1
Download RustMapGen
Get the code as a ZIP file. It is small: the game itself comes later, in step 4.
Download the ZIP Open on GitHub
On GitHub it is the green Code button, then Download ZIP:
12
Watch this step in the video (0:37)
2
Extract the ZIP
In your Downloads folder, right-click rustmapgen-main.zip, choose Extract All…, then Extract.
1
2
Always extract first. A file opened from inside the ZIP runs from a temporary folder, and the game would be downloaded there.
Windows makes a folder inside a folder of the same name, rustmapgen-main\rustmapgen-main: that is fine. The game and your maps are kept inside it, so put it on a drive with about 7 GB free. You can move the extracted folder anywhere before step 3.
3
Double-click install.cmd
In the extracted folder, double-click install.cmd. Windows asks first, because the file came from the internet and is not signed. Untick Always ask before opening this file so it stops asking for this file, then click Run.
12
install.cmd only starts install.ps1, a short script you can read on GitHub before you run it. The game and your maps are kept in this folder.
4
Let it install
A black window shows each step as it starts. Leave it open until it says Installed.
- Python. With no Python 3.9 or newer on the computer, it installs Python 3.12 with winget.
- The game. steamcmd downloads the free Rust dedicated server, about 6 GB, in its own lines.
- The 3D models. The monuments and rocks of the 3D view are made from the game's files: a few minutes.
No Python yet: winget installs it.
steamcmd downloading the game.
It ends with what it set up (your folder and the game's build will differ):
C:\Windows\system32\cmd.exe
```
   113s  3D models made: 69 monuments, 109 kinds of scenery

In place:
  game: build 25902425, public branch, in C:\Users\you\Downloads\rustmapgen-main\rustmapgen-main\game
  mod: the one that came with the code, for game build 25902425
  maps and settings: C:\Users\you\Downloads\rustmapgen-main\rustmapgen-main\data

Installed. Start the panel with rustmapgen.cmd (double-click it).

Press any key to continue . . .
```
Press a key to close the window. Run install.cmd again at any time to bring the game up to date.
5
Open the panel
Double-click rustmapgen.cmd in the same folder (Windows asks once more, as in step 3). The panel opens in your browser at http://127.0.0.1:5350.
Keep its black window open while you use the panel: closing it stops the panel. Next time, start here: double-click rustmapgen.cmd.
Watch this step in the video (2:08)

1
Install what it needs
Python with its venv module, the 32-bit C library that steamcmd needs, and git. On Debian or Ubuntu:
```
$ sudo apt install git python3 python3-venv lib32gcc-s1
```
On another distribution, install the same with its own package manager: Python 3.9 or newer with venv, the 32-bit GCC runtime library, and git.
2
Get the code
Clone it into a folder with about 7 GB free: the game and your maps are kept inside it.
```
$ git clone https://github.com/S1gil0/rustmapgen.git
$ cd rustmapgen
```

3

Run the installer

$ ./install.sh

It makes a Python environment of its own, downloads steamcmd and the Rust dedicated server (about 6 GB), and makes the 3D view's models. Each step shows as it starts, the download as it goes. This is a real install of 0.2.0:

~/rustmapgen

$ ./install.sh
Making a Python environment of its own in .venv...
Installing the Python packages it needs (numpy, Pillow, lz4)...
downloading steamcmd into /home/you/rustmapgen/steamcmd
steamcmd: installing the Rust dedicated server in /home/you/rustmapgen/game (about 6 GB on the first install; it can take a while)
  steamcmd is updating itself        [####################] 100 %
  downloading the game               [####################] 100 %  6.1 of 6.1 GB
  checking what was downloaded       [####################] 100 %  6.1 of 6.1 GB
game build 25902425 (public)
installing UnityPy to read the game files (once)…
     0s  reading the game files
    12s  models 1 of 182
   113s  models 181 of 182
   113s  3D models made: 69 monuments, 109 kinds of scenery
In place:
  game: build 25902425, public branch, in /home/you/rustmapgen/game
  mod: the one that came with the code, for game build 25902425
  maps and settings: /home/you/rustmapgen/data
Installed. Start the panel with:  ./rustmapgen.sh

A fresh install of 0.2.0: five and a half minutes on a fast connection. Your folder and the game's build will differ.

Run ./install.sh again at any time to bring the game up to date.

Watch this step in the video (2:46)

4
Open the panel
```
$ ./rustmapgen.sh
```
The panel opens in your browser at http://127.0.0.1:5350. Keep the terminal open while you use it; Ctrl+C stops it.
Open the panel from another computer (a server with no desktop)
From anywhere, the safe way: an SSH tunnel. On your own computer run the line below, then open http://127.0.0.1:5350 there.
```
$ ssh -L 5350:127.0.0.1:5350 you@that-computer
```
On a network you trust: start the panel open to it, and use the http:// address it prints (not https://).
```
$ ./rustmapgen.sh panel --host 0.0.0.0
```
The panel has no password. Anyone who can reach it can make and delete maps and update RustMapGen and the game. Never open it to the internet.
Watch this step in the video (3:34)

Then

Make your first map

New Map: presets under Settings, Size, Seed and Maps at the top, Make maps on the right

New Map: presets under Settings, Size, Seed and Maps at the top, Make maps on the right

New Map opens on the Game default preset: the map the game makes by itself.
Pick a preset under Settings, or change anything in the sections on the left.
Choose the Size, a Seed (empty for a random one) and how many Maps, then click Make maps.
Open Maps to watch it being made: a small map takes from 30 seconds to two minutes, a large one from two to six.

A finished map in the panel: its picture, At a glance and its checks, Load test, 3D and Download .map

A finished map in the panel: its picture, At a glance and its checks, Load test, 3D and Download .map

The finished map shows At a glance (green, amber, red) and every check. Load test has the dedicated server load the file the way your server will.
3D ↗ beside it opens the map in 3D, in a tab of its own.
Download .map gives you the file to put on your server.

Put a map on your server Read the full guide See example maps

If something goes wrong

“Python 3.9 or newer is needed”

Install Python (on Windows from python.org with Add python.exe to PATH ticked; on Debian or Ubuntu sudo apt install python3 python3-venv), then run the installer again.

“steamcmd needs the 32-bit C library”

sudo apt install lib32gcc-s1, then run the installer again.

On Windows the window stops moving and its title starts with “Select”

A click in it started a text selection, which pauses it: press Esc.

The panel does not open from another computer

Start it with --host 0.0.0.0 and use http://, not https://. See “Open the panel from another computer” above.

“GB of memory free, … needed”

Close other programs: a map needs about 5 GB of memory while it is made.

“the game did not load the mod”

After a Rust update: Updates → Check for updates in the panel brings a RustMapGen whose mod works, when there is one.

“the last update of the game did not finish”

Updates → Update the game again, or run the installer again.

Not listed here? Open an issue on GitHub with what the window or terminal says.