Administering Factorio in AMP
Please note: Not every entry below will apply to your account. This guide serves to support both the end-user server manager and the AMP server administrator to ensure that everything necessary to rebuild/set up the servers is documented in one place. Anything that can only be done by the AMP server administrator will have the (administrator) suffix applied to the header.
Basic Factorio Server Management
To start or stop just the server, click on the green Manage Instance button in the Factorio Server Instance's card. On the instance Status page, click on Start, Restart, or Stop to perform the appropriate action on the Factorio server.
Changing Factorio Server Settings
Click on the Manage Instance button for the Factorio Server Instance that you would like configure the settings for and navigate to Configuration -> Factorio. The various settings are explained below. Changing any settings will require a restart of the server to take effect.
- Server Start Mode: Sets the server start mode: Start the server with the specified Save File; or Start the server with the latest save file; or Start the server with a new save with the specified Save File name.
- Save File: Sets the name of the save file in the 'saves' directory to load on server start, if applicable to the Server Start Mode. If the file does not exist, it will be created. It will be overwritten if 'Create and start server' is the Server Start Mode.
- Server Name: Sets the name of the server as it will appear in the in game browser (for publicly visible games) and in the "Continue" menu dialog on the main menu.
- Server Description: Sets the description of the server as it will appear in the game listing. Rich text formatting and newlines are permitted.
- Server Tags: Sets a list of tags for the server that will appear in the game listing.
- Server Admins: Must be in valid JSON format: ["Admin1","Admin2"]. Editable only in the file manager.
- Player Limit: Sets the maximum number of players that may connect to the server at one time. Admins can still join a full server, as can returning players if Ignore Player Limit For Returning Players is enabled. 0 = unlimited.
- Ignore Player Limit For Returning Players: If enabled, players that have played on this map already can join even when the Player Limit is reached.
- Make Server Visible Publicly: If set, the server will be published on the official Factorio matching server. Requires the Factorio.com Username and either Factorio.com Password or Factorio.com Auth Token to be set.
- Factorio.com Username/Password/Auth Token: The login information for the server owner from the factorio.com website.
- Game Password: Sets the password required to join the server. Default is no password.
- Require User Verification: If enabled, allow clients that have a valid Factorio.com account will be allowed to connect to the server.
- Use Server Whitelist: If enabled, only whitelisted players can connect. The whitelist can be configured in 'data/server-whitelist.json'. Must be in valid JSON format: ["Player1","Player2"]. Editable only in the file manager.
- Use Auth Server Bans: If enabled, the server will verify that connecting players are not banned from multiplayer and inform Factorio.com about ban/unban commands.
- Autosave Interval: Time in minutes between autosaves.
- Autosave Slots: Sets the number of server autosave slots, cycled through when the server autosaves.
- AFK Autokick Interval: Sets the period until someone is kicked when doing nothing. 0 = never kick.
- Enable Auto Pause: If enabled, the server will be paused when no players are present.
- Auto Pause When Players Connect: If enabled, the server will be paused when a player is connecting to the server.
Changing Factorio Save Files
The save file in use can be changed by setting the "Save File" setting (as described above) to the name of the save file to use. Multiple save files can exist but only one can be loaded at a time. Changing this field to a name that does not exist will create a new save file with default settings the next time the server starts. If the save file exists, the server will load that save file when it starts.
You can configure the level generation settings prior to starting a new save by editing the configuration as detailed below in 'Configuring the Map Generation Settings'.
Alternatively you can generate the world yourself on your local Factorio game and upload the zip to the server to use. The zip should be uploaded to the saves folder in the File Manager and the Save File setting should be updated to reflect the name of the zip file to use.
Enabling or Disabling Factorio Space Age
Space Age can only be enabled or disabled via the mods\mod-list.json file in the File Manager while the server is stopped.
Note: Ensure you have not progressed in the save file yet. If you have and wish to restart, either delete the save file or set the save file setting to a new name
- Stop the Factorio server by managing the Factorio Server Instance and, on the Status page, clicking on Stop.
- Navigate to the File Manager on the left and open the
modsdirectory. - Click on the three dots to the right of the
mod-list.jsonfile and click on Edit. - Change the following mod entries from
"enabled": trueto"enabled": falseand click Save on the top right:- elevated-rails
- quality
- space-age
- Start the server from the Status page when you're ready.
Configuring the Map Generation Settings
These settings are only read when a save file is first created.
//todo https://wiki.factorio.com/Map_generator
Managing In-Game Admins on the Factorio Server
The admin list can be edited while the server is running but will not take effect until the server is restarted.
Creating a Factorio Server Instance (administrator)
From the Instances tab of the AMP control panel, click on Create Instance. Select Factorio from the list, provide a friendly name, and click on Create instance. Once the instance starts, you can see the IP address the instance is listening on, and the port in the instance card. 0.0.0.0 means it is listening on any IP address on the server. If you want to be able to connect via domain name without specifying a port, save this port for later when creating the SRV DNS records.
Configuring DNS SRV Records for a Factorio Server
While typically done by the server administrator, the records don't require any actual configuration on the server so they can be set up by anyone that owns a domain.
Prerequisites:
- You must know the IP address and port of the Factorio server.
Log in to your DNS manager (may be different than your registrar) and create the following two records:
- Type: SRV
- Name: _factorio._udp.yourfactorio.domain.com
- Priority & Weight: 0
- Port: the port from your instance above
- Target: yourfactorio.domain.com
- Type: A
- Name: yourfactorio.domain.com
- IPv4 address: The public IP address of the server running the Factorio instance. If using cloudflare, make sure that Proxy is disabled!
Now you can connect to your server by specifying yourfactorio.domain.com in the 'connect to address' dialog!
- https://wiki.factorio.com/Multiplayer#DNS_SRV_Records
Listing the Factorio Server in the Public Server Browser
Prerequisites:
- You must have your username & password/token from https://www.factorio.com/profile
Listing the server publicly means that all of the players connecting must own the game via legitimate means. If you want to permit users that do not own the game to join, the server cannot be listed in the public server browser. In these cases you should configure DNS SRV records above to make joining more convenient.
- Log in to factorio.com, navigate to your profile, and copy your username and token.
- In the AMP portal, manage your Factorio instance and navigate to Configuration -> Factorio.
- If available to you, set the Factorio.com Username and Factorio.com Auth Token fields. If these options are not available, contact your server administrator to enable your access to these options or confirm that they have provided their own credentials.
- Ensure that Require User Verification is enabled.
- Ensure Make Server Visible Publicly is enabled.
- Restart the server if any changes were made.
The server should now show up in the public server browser! If not, review the output of the Console or the logs to determine why the server is not being listed (e.g. invalid credentials, missing field, etc.)
Managing Permissions on the Factorio Server (administrator)
Prerequisites:
- A role exists for the user(s) that will manage the Factorio instance.
- The user is assigned to the role.
- The Factorio instance must already be created.
- The role is given permission to the instance in Configuration -> Role Management -> <role name> -> All Instances -> Local Instances -> <Factorio instance>.
The default permissions for a user with "access" to an instance is limited to Start/Stop and Update. All other settings are hidden.
Note that this is not changing the settings of the server, only changing whether this role can view these settings to change themselves.
- Settings\
- Meta Config\
- GenericModule\
- Server Start Mode: Enabled
- Save File: Enabled
- Server Name: Enabled
- Server Description: Enabled
- Server Tags: Enabled
- Server Admins: Enabled
- Player Limit: Enabled
- Ignore Player Limit for Returning Players: Enabled
- Make Server Visible Publicly: Enabled
- Factorio.com Username/Password/Auth Token: Enabled if you are not providing your own
- Game Password: Enabled
- Require User Verification: Enabled
- Use Server Whitelist: Enabled
- Use Auth Server Bans: Enabled
- Autosave Interval: Enabled
- Autosave Slots: Enabled
- AFK Autokick Interval: Enabled
- Enable Auto Pause: Enabled
- Auto Pause When Players Connect: Enabled
- GenericModule\
- Meta Config\
- File Manager\
- File Manager\
- Browse Files: Enabled
- Download Files: Enabled
- Upload Files: Enabled
- Rename Files: Enabled
- Change File Extension: Enabled
- Copy Files: Enabled
- Trash Files: Enabled
- Trash Directories: Enabled
- Create Directory: Enabled
- Rename Directories: Enabled
- Modify AMP Config Files: Enabled
- File Manager\
- Local File Backup\
- Backup\
- View Backups List: Enabled
- Create Backup: Enabled
- Delete Backup: Enabled
- Restore Backup: Enabled
- Backup\
- AMPCore\
- Scheduler\
- View Schedule: Enabled
- Create Trigger: Enabled
- Edit Trigger: Enabled
- Create Task: Enabled
- Delete Task: Enabled
- Delete Trigger: Enabled
- Edit Task: Enabled
- App Management: Enabled (whole category)
- Start Application: Enabled
- Stop Application: Enabled
- Restart Application: Enabled
- Update Application: Enabled
- Send Console Input: Enabled
- Read Console: Enabled
- Scheduler\