User guide

Installing and Using the RedMew Scenario

All scenarios are installed the same, but some have special instructions before you play them.

Check the sidebar for a specific map guides.

Step 0

Please make sure you are on the Factorio latest stable branch. Loading our scenario in earlier versions will cause issues due to frequent updates to the codebase. Use of the RedMew scenario in earlier versions is not supported.

Step 1 - Download

To install the RedMew scenario download the release file (or the full repository for the most up-to-date version) and take the next step based on your Operating System.

Step 2 - Extract

• Windows: extract the folder in the zip file into %appdata%\Factorio\Scenarios\Redmew\
• MacOS: extract the folder in the zip file into ~/Library/Application Support/factorio/Scenarios/Redmew/
• Linux: extract the folder in the zip file into ~/.factorio/scenarios/Redmew/

Note1: If you already have a folder with the same name as what you're about to install, delete the old folder first.

Note2: these locations are based on the default configuration defined by factorio. If your installation is not default, you have to find your scenarios directory in another way.

Note3: Please make sure you keep the file structure intact, and not one level too deep! This means once you unzip (if zipped when downloaded), it should look like \Factorio\Scenarios\RedMew\<scenario files including the control.lua>\.

If you are using the RedMew scenario for a public-facing multi-player server, be sure to provide attribution back to github and keep links to the Discord, Patreon and website intact.

Step 3 - Select map

Rename the file from map_selection.SAMPLE.lua to map_selection.lua in order for the scenario to load your desired map.

Edit map_selection.lua to the map of your choice. You can find all our maps in the map_gen/maps folder.
You can find previews of many maps in map_gen/data/.map_previews. The comments in the map_selection.lua give samples for the most popular maps and how to load them.

It is also possible to select a preset for some scenarios

• return require 'map_gen.maps.danger_ores.presets.terraforming_danger_ore'
• return require 'map_gen.maps.crash_site.presets.arrakis'

Step 4 - Customize

You can turn features on or off via config.lua if desired.

Step 5 - Play

In Factorio click "Play" then "Scenarios", then under "User Scenarios" select "RedMew" or the specific map you downloaded and click "Create".

Note: Nightly releases can sometimes be non-functional. If this is the case, either download the previous night's version or inquire on discord about the latest stable release.

Scenario Features

The redmew scenario contains many GUI-based, command-based, and QOL changes to make for a better experience when playing or hosting Factorio. This is in addition to the map generation, and most features can be toggled on or off in the config.lua file. For details about what the various GUI buttons do, see our Imgur album at [LINK]. Details about commands can be found in our Command Wiki Page.

Localization

Many of the strings ingame support language localization, meaning text will be translated from English (the default language) into your native language, if your default language in Factorio has been changed. Translation progress varies by language. Our goal is to have full translations for most major languages, for the majority of text strings, by the end of 2020.

If you would like to help get the scenario translated into your native language or view the progress, then the crowdin dashboard is the best place to look. The raw localization are available in the locale folder, although if you wish to submit translations we recommend to do it through the crowdin portal instead of a Pull Request.

Contributing

We love new contributors! If you are interested in helping create a new feature, new map, or anything else then our contributing guide is a good place to start.