https://wiki.factorio.com/api.php?action=feedcontributions&feedformat=atom&user=VinzenzOfficial Factorio Wiki - User contributions [en]2026-04-22T21:12:05ZUser contributionsMediaWiki 1.43.5https://wiki.factorio.com/index.php?title=Web_authentication_API&diff=199416Web authentication API2024-08-26T11:10:42Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div><br />
<br />
Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:<br />
<br />
<code>https://auth.factorio.com/api-login</code><br />
<br />
Authentication requires sending an HTTP POST request (Content-Type: <code>application/x-www-form-urlencoded</code>) with these parameters:<br />
<br />
{| class="wikitable"<br />
| username<br />
| Required.<br />
| Account username or e-mail.<br />
|-<br />
| password<br />
| Required.<br />
| Account password.<br />
|- <br />
| api_version<br />
| (Technically) not required. API responses will be different than described on this page when not set to 4.<br />
| Currently 4.<br />
|-<br />
| require_game_ownership<br />
| Not required.<br />
| If set to 'true', will fail authentication if the user account hasn't actually purchased Factorio.<br />
|-<br />
| email_authentication_code<br />
| Not required.<br />
| If a previous login failed with <code>email-authentication-required</code>, email authentication can be completed by including the code sent to the user via mail.<br />
<br />
|}<br />
<br />
This endpoint always returns JSON encoded data. If authentication was successful, it will return an HTTP status code of 200 with a JSON object:<br />
<br />
{| class="wikitable"<br />
| token<br />
| Auth token is a hexadecimal encoded byte string<br />
|-<br />
| username<br />
| The username of the logged in user. <br />
<br />
|} <br />
<br />
On non-200 status codes, the response can be JSON encoded and provide more details about the problem:<br />
<br />
{| class="wikitable"<br />
| error<br />
| Error codes like <code>login-failed</code> or <code>email-authentication-required</code><br />
|-<br />
| message<br />
| A more detailed error message that can be shown to the user <br />
<br />
|} <br />
<br />
Clients causing a lot of errors like <code>login-failed</code> will be rate limited.<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Main_Page/Latest_versions&diff=191890Main Page/Latest versions2023-07-14T11:56:10Z<p>Vinzenz: 1.1.87 stable</p>
<hr />
<div>* {{Translation|Latest stable version}}: [[Version history/1.1.0#1.1.87|1.1.87]]<br />
* {{Translation|Latest experimental version}}: [https://forums.factorio.com/107634 1.1.87]<br />
* {{Translation|The wiki is based on version}} [[Version history/1.1.0|1.1]]<br />
----<br />
<br />
* [[Roadmap{{If language suffix}}|{{Translation|Planned releases}}]]<br />
** [[Upcoming_features{{If language suffix}}|{{Translation|Planned features}}]]<br />
<noinclude><br />
{{C|Main}}<br />
</noinclude></div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=191344Mod details API2023-05-05T10:52:54Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod. Min length 1, max length 250<br />
|-<br />
| summary || string, optional || Short description of the mod. Max length 500<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| tags || enum, optional, multiple possible || Mod tags, see [[#Tags]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || string, optional || URL of mod homepage (URL must use <code>http</code> or <code>https</code> scheme), max length 256<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || string, optional || URL of mod source code repository (URL must use <code>http</code> or <code>https</code> scheme), max length 256<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code><empty string></code>|| No category <br />
|-<br />
|<code>no-category</code>|| No category <br />
|-<br />
|<code>content</code>|| Content || Mods introducing new content into the game. <br />
|-<br />
|<code>overhaul</code>|| Overhaul || Large total conversion mods. <br />
|-<br />
|<code>tweaks</code>|| Tweaks || Small changes concerning balance, gameplay, or graphics. <br />
|-<br />
|<code>utilities</code>|| Utilities || Providing the player with new tools or adjusting the game interface, without fundamentally changing gameplay. <br />
|-<br />
|<code>scenarios</code>|| Scenarios || Scenarios, maps, and puzzles. <br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together. <br />
|-<br />
|<code>localizations</code>|| Localizations || Translations for other mods. <br />
|-<br />
|<code>internal</code>|| Internal || Lua libraries for use by other mods and submods that are parts of a larger mod. <br />
|-<br />
|}<br />
<br />
=== Tags ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code>transportation</code>|| Transportation || Transportation of the player, be it vehicles or teleporters. <br />
|-<br />
|<code>logistics</code>|| Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes! <br />
|-<br />
|<code>trains</code>|| Trains || Trains are great, but what if they could do even more? <br />
|-<br />
|<code>combat</code>|| Combat || New ways to deal with enemies, be it attack or defense. <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment. <br />
|-<br />
|<code>enemies</code>|| Enemies || Changes to enemies or entirely new enemies to deal with. <br />
|-<br />
|<code>environment</code>|| Environment || Map generation and terrain modification. <br />
|-<br />
|<code>mining</code>|| Mining || New Ores and resources as well as machines. <br />
|-<br />
|<code>fluids</code>|| Fluids || Things related to oil and other fluids. <br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots. <br />
|-<br />
|<code>circuit-network</code>|| Circuit network || Entities which interact with the circuit network. <br />
|-<br />
|<code>manufacturing</code>|| Manufacturing || Furnaces, assembling machines, production chains. <br />
|-<br />
|<code>power</code>|| Power || Changes to power production and distribution. <br />
|-<br />
|<code>storage</code>|| Storage || More than just chests. <br />
|-<br />
|<code>blueprints</code>|| Blueprints || Change blueprint behavior. <br />
|-<br />
|<code>cheats</code>|| Cheats || Play it your way. <br />
|-<br />
|}<br />
<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = {"mod": modname, "faq": "# hello world", "tags": ["power", "storage"], "category": "tweaks"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=190597Mod details API2022-12-20T09:25:48Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod. Min length 1, max length 250<br />
|-<br />
| summary || string, optional || Short description of the mod. Max length 500<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| tags || enum, optional, multiple possible || Mod tags, see [[#Tags]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || string, optional || URL of mod homepage (URL must use <code>http</code> or <code>https</code> scheme), max length 256<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || string, optional || URL of mod source code repository (URL must use <code>http</code> or <code>https</code> scheme), max length 256<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code><empty string></code>|| No category <br />
|-<br />
|<code>content</code>|| Content || Mods introducing new content into the game. <br />
|-<br />
|<code>overhaul</code>|| Overhaul || Large total conversion mods. <br />
|-<br />
|<code>tweaks</code>|| Tweaks || Small changes concerning balance, gameplay, or graphics. <br />
|-<br />
|<code>utilities</code>|| Utilities || Providing the player with new tools or adjusting the game interface, without fundamentally changing gameplay. <br />
|-<br />
|<code>scenarios</code>|| Scenarios || Scenarios, maps, and puzzles. <br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together. <br />
|-<br />
|<code>localizations</code>|| Localizations || Translations for other mods. <br />
|-<br />
|<code>internal</code>|| Internal || Lua libraries for use by other mods and submods that are parts of a larger mod. <br />
|-<br />
|}<br />
<br />
=== Tags ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code>transportation</code>|| Transportation || Transportation of the player, be it vehicles or teleporters. <br />
|-<br />
|<code>logistics</code>|| Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes! <br />
|-<br />
|<code>trains</code>|| Trains || Trains are great, but what if they could do even more? <br />
|-<br />
|<code>combat</code>|| Combat || New ways to deal with enemies, be it attack or defense. <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment. <br />
|-<br />
|<code>enemies</code>|| Enemies || Changes to enemies or entirely new enemies to deal with. <br />
|-<br />
|<code>environment</code>|| Environment || Map generation and terrain modification. <br />
|-<br />
|<code>mining</code>|| Mining || New Ores and resources as well as machines. <br />
|-<br />
|<code>fluids</code>|| Fluids || Things related to oil and other fluids. <br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots. <br />
|-<br />
|<code>circuit-network</code>|| Circuit network || Entities which interact with the circuit network. <br />
|-<br />
|<code>manufacturing</code>|| Manufacturing || Furnaces, assembling machines, production chains. <br />
|-<br />
|<code>power</code>|| Power || Changes to power production and distribution. <br />
|-<br />
|<code>storage</code>|| Storage || More than just chests. <br />
|-<br />
|<code>blueprints</code>|| Blueprints || Change blueprint behavior. <br />
|-<br />
|<code>cheats</code>|| Cheats || Play it your way. <br />
|-<br />
|}<br />
<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = {"mod": modname, "faq": "# hello world", "tags": ["power", "storage"], "category": "tweaks"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=190596Mod details API2022-12-20T08:29:27Z<p>Vinzenz: fix error in python example</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod. Min length 1, max length 250<br />
|-<br />
| summary || string, optional || Short description of the mod. Max length 500<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| tags || enum, optional, multiple possible || Mod tags, see [[#Tags]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || string, optional || URL of mod homepage (URL must use <code>http</code> or <code>https</code> scheme). Max length 256<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || string, optional || URL of mod source code repository (URL must use <code>http</code> or <code>https</code> scheme)<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code><empty string></code>|| No category <br />
|-<br />
|<code>content</code>|| Content || Mods introducing new content into the game. <br />
|-<br />
|<code>overhaul</code>|| Overhaul || Large total conversion mods. <br />
|-<br />
|<code>tweaks</code>|| Tweaks || Small changes concerning balance, gameplay, or graphics. <br />
|-<br />
|<code>utilities</code>|| Utilities || Providing the player with new tools or adjusting the game interface, without fundamentally changing gameplay. <br />
|-<br />
|<code>scenarios</code>|| Scenarios || Scenarios, maps, and puzzles. <br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together. <br />
|-<br />
|<code>localizations</code>|| Localizations || Translations for other mods. <br />
|-<br />
|<code>internal</code>|| Internal || Lua libraries for use by other mods and submods that are parts of a larger mod. <br />
|-<br />
|}<br />
<br />
=== Tags ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code>transportation</code>|| Transportation || Transportation of the player, be it vehicles or teleporters. <br />
|-<br />
|<code>logistics</code>|| Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes! <br />
|-<br />
|<code>trains</code>|| Trains || Trains are great, but what if they could do even more? <br />
|-<br />
|<code>combat</code>|| Combat || New ways to deal with enemies, be it attack or defense. <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment. <br />
|-<br />
|<code>enemies</code>|| Enemies || Changes to enemies or entirely new enemies to deal with. <br />
|-<br />
|<code>environment</code>|| Environment || Map generation and terrain modification. <br />
|-<br />
|<code>mining</code>|| Mining || New Ores and resources as well as machines. <br />
|-<br />
|<code>fluids</code>|| Fluids || Things related to oil and other fluids. <br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots. <br />
|-<br />
|<code>circuit-network</code>|| Circuit network || Entities which interact with the circuit network. <br />
|-<br />
|<code>manufacturing</code>|| Manufacturing || Furnaces, assembling machines, production chains. <br />
|-<br />
|<code>power</code>|| Power || Changes to power production and distribution. <br />
|-<br />
|<code>storage</code>|| Storage || More than just chests. <br />
|-<br />
|<code>blueprints</code>|| Blueprints || Change blueprint behavior. <br />
|-<br />
|<code>cheats</code>|| Cheats || Play it your way. <br />
|-<br />
|}<br />
<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = {"mod": modname, "faq": "# hello world", "tags": ["power", "storage"], "category": "tweaks"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=190592Mod details API2022-12-19T10:11:35Z<p>Vinzenz: Document new categories and tags</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod. Min length 1, max length 250<br />
|-<br />
| summary || string, optional || Short description of the mod. Max length 500<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| tags || enum, optional, multiple possible || Mod tags, see [[#Tags]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || string, optional || URL of mod homepage (URL must use <code>http</code> or <code>https</code> scheme). Max length 256<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || string, optional || URL of mod source code repository (URL must use <code>http</code> or <code>https</code> scheme)<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code><empty string></code>|| No category <br />
|-<br />
|<code>content</code>|| Content || Mods introducing new content into the game. <br />
|-<br />
|<code>overhaul</code>|| Overhaul || Large total conversion mods. <br />
|-<br />
|<code>tweaks</code>|| Tweaks || Small changes concerning balance, gameplay, or graphics. <br />
|-<br />
|<code>utilities</code>|| Utilities || Providing the player with new tools or adjusting the game interface, without fundamentally changing gameplay. <br />
|-<br />
|<code>scenarios</code>|| Scenarios || Scenarios, maps, and puzzles. <br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together. <br />
|-<br />
|<code>localizations</code>|| Localizations || Translations for other mods. <br />
|-<br />
|<code>internal</code>|| Internal || Lua libraries for use by other mods and submods that are parts of a larger mod. <br />
|-<br />
|}<br />
<br />
=== Tags ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|-<br />
|<code>transportation</code>|| Transportation || Transportation of the player, be it vehicles or teleporters. <br />
|-<br />
|<code>logistics</code>|| Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes! <br />
|-<br />
|<code>trains</code>|| Trains || Trains are great, but what if they could do even more? <br />
|-<br />
|<code>combat</code>|| Combat || New ways to deal with enemies, be it attack or defense. <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment. <br />
|-<br />
|<code>enemies</code>|| Enemies || Changes to enemies or entirely new enemies to deal with. <br />
|-<br />
|<code>environment</code>|| Environment || Map generation and terrain modification. <br />
|-<br />
|<code>mining</code>|| Mining || New Ores and resources as well as machines. <br />
|-<br />
|<code>fluids</code>|| Fluids || Things related to oil and other fluids. <br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots. <br />
|-<br />
|<code>circuit-network</code>|| Circuit network || Entities which interact with the circuit network. <br />
|-<br />
|<code>manufacturing</code>|| Manufacturing || Furnaces, assembling machines, production chains. <br />
|-<br />
|<code>power</code>|| Power || Changes to power production and distribution. <br />
|-<br />
|<code>storage</code>|| Storage || More than just chests. <br />
|-<br />
|<code>blueprints</code>|| Blueprints || Change blueprint behavior. <br />
|-<br />
|<code>cheats</code>|| Cheats || Play it your way. <br />
|-<br />
|}<br />
<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = data = {"mod": modname, "faq": "# hello world", tags=["power", "storage"], category="tweaks"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Multiplayer&diff=190464Multiplayer2022-11-28T14:36:36Z<p>Vinzenz: Document SRV records</p>
<hr />
<div>{{Languages}}<br />
[[File:players_colored_preview.png|190px|right]]In addition to being a single-player game, Factorio also supports multiplayer, allowing many [[player]]s to cooperate and assist each other, or work against each other in pvp. This page documents how to set up a multiplayer game, how to join one, and the Multiplayer Admin features for managing other users and the server. By default, multiplayer games run the CO-OP [[Game modes and options|freeplay scenario]] where all players work together to launch a rocket with a satellite into space. Other scenarios, including PvP maps, are available for download from the [https://forums.factorio.com/viewforum.php?f=36&sid=93d1fbe9336d31d6bac60847b6c97985 Maps and Scenarios forum].<br />
<br />
== Setting Up a Multiplayer Game ==<br />
<br />
[[File:multiplayer_game_night.png|thumb|250px|A multiplayer game.]]Multiplayer games can be joined, hosted while playing, or hosted by a dedicated server. Multiplayer games can be advertised to other players on the same LAN or worldwide.<br />
<br />
Use the ''Multiplayer'' button in the ''Play'' menu to start playing a multiplayer game, choose ''New'' or ''Load'' or ''Scenarios'' to host and play, or ''Browse'' or ''Play on LAN'' to connect to an already-running game. The host can also choose not to advertise the game at all, in which case you'll need the server's (public or otherwise reachable) IP address; you can then ''Connect'' directly to that to join the game.<br />
<br />
Notes and tips:<br />
<br />
* All game instances need the installation of ''exactly the same'' game-versions and mods.<br />
* Factorio servers use port '''34197'''. The port can be changed in the [[Application directory|config]] file.<br />
* Factorio uses '''UDP only'''. The game builds its own "reliable delivery" layer built on UDP to deal with packet loss and reordering issues.<br />
** Make sure you configure your router's port forwarding correctly for port '''34197'''.<br />
** Make sure your router does not [https://doc.pfsense.org/index.php/Static_Port randomize the source port] on packets outbound from '''34197'''. Some routers do this and require [https://forum.pfsense.org/index.php?PHPSESSID=3k4h9n5o2tksgqv910fknf7qt7&topic=142188.msg798594#msg798594 additional configuration] to prevent it.<br />
** Make sure there is no firewall or anti-virus blocking the UDP-packets.<br />
* The hard limit for the number of players is [https://forums.factorio.com/viewtopic.php?f=53&t=6481&p=50661#p50586 65,535]. However, practical limit for this is much lower, popular streamers have managed to get well over a hundred players.<br />
<br />
=== Dedicated/Headless server ===<br />
<br />
As of Factorio version 0.12.0 onwards, a dedicated (or headless) server can be started using the --start-server command line option. You can run factorio --help to get a list of all command-line arguments that Factorio accepts.<br />
<br />
In the headless mode:<br />
* Graphics are not initialized (faster start up, less memory usage, works on completely headless servers)<br />
* Game starts immediately and loads a save given as a parameter to the command<br />
* The server has no character in game<br />
* Game is paused while there are no players connected (though this can be overridden using the no-auto-pause option in the server-settings.json)<br />
* Saves the game on exit (and autosaves normally)<br />
<br />
''0.13 onwards expects --start-server to be followed by a path to a save file.''<br />
<br />
You will need to create your save file before you start the server, as the dedicated server REQUIRES a save file to be provided. This can easily be done using the --create command-line argument. For example:<br />
<br />
<pre><br />
./bin/x64/factorio --create ./saves/my-save.zip # This creates a new save, as if by clicking the New Game button in the GUI<br />
</pre><br />
<br />
<pre><br />
./bin/x64/factorio --start-server ./saves/my-save.zip # This starts a server that will host the file created on the previous line<br />
</pre><br />
<br />
There are several JSON configuration files that factorio can make use of to change the server and map settings:<br />
* '''map-gen-settings''' to set parameters used by the map generator such as width and height, ore patch frequency and size, etc. (Added in 0.13)<br />
* '''map-settings''' to control pollution spread, biter expansion and evolution, and more (Added in 0.15)<br />
* '''server-settings''' which consolidated several command-line options into a single file (Added in 0.14.12)<br />
Example files for each of these parameters are included in the data subdirectory.<br />
<br />
The --map-gen-settings and --map-settings options must be used with the --create option when you create a new map. For example:<br />
<pre>./bin/x64/factorio --create saves/my-save.zip --map-gen-settings my-map-gen-settings.json --map-settings my-map-settings.json</pre><br />
<br />
Starting the factorio server requires you to specify the location of the server-settings.json file. By default this is in the factorio data folder. For example to start factorio using the most recent saved map, you would run:<br />
<br />
<pre>./bin/x64/factorio --start-server-load-latest --server-settings ./data/server-settings.json</pre><br />
<br />
On windows, it may be useful to start the server with a .bat file. The bat file should have the following content:<br />
<br />
<pre>start /wait .\bin\x64\factorio.exe --start-server-load-latest --server-settings .\data\server-settings.json</pre><br />
<br />
''See [[Command_line_parameters]] for more command line parameters.''<br />
<br />
=== Setting up a Linux Factorio server ===<br />
<br />
'''Note:''' Factorio now requires <tt>glibc</tt> version 2.18, but CentOS/RHEL 7 only ship with version 2.17 so this guide will no longer work without [https://forums.factorio.com/viewtopic.php?t=54654#p324493 manually compiling <tt>glibc</tt> 2.18].<br />
<br />
This step-by-step guide has been verified on fresh CentOS 7 and RHEL 7 installs but should be applicable with little to no changes on most distributions.<br />
<br />
The guide assumes you will install the headless server under '''/opt/factorio''', adjust paths according to your own setup. We will also suggest that you run the Factorio server as a separate user to harden security of your setup.<br />
<br />
Note that there are two distinct packages for Linux that can be used to run a headless server. First is the usual Linux download, that contains the full game. The other is the special [https://www.factorio.com/download headless package]. The headless package does not contain any files irrelevant for a pure server, such as graphics and sounds. It is also not linked against libraries that may not be present on a server machine, such as Xlib, libGL or libasound. This option should be selected if running in a 3rd party hosted server.<br />
<br />
This guide does not handle firewall/port forwarding since this can be done in various ways on Linux (make sure to read up how this is done as a Linux admin on your particular distribution)<br />
<br />
==== Basic installation ====<br />
<br />
* Download the selected package -- either full game or the headless package -- and upload the Linux tar.gz or tar.xz package to your server /tmp<br />
* Extract the package in /tmp to /opt/factorio<br />
<pre><br />
$cd /opt/<br />
<br />
$sudo tar -xzf /tmp/factorio.tar.gz # Use the correct file name. It includes the factorio version number<br />
$sudo tar -xJf /tmp/factorio.tar.xz # if you downloaded a .tar.xz file (ver 0.15.x)</pre><br />
<br />
* Add a new user to your system and assign ownership of the factorio dir to it (please, do not run as the root user, sudo may be needed)<br />
<pre><br />
$useradd factorio<br />
$chown -R factorio:factorio /opt/factorio</pre><br />
<br />
* Try the binary<br />
<pre><br />
$su factorio<br />
$/opt/factorio/bin/x64/factorio --start-server savename</pre><br />
<br />
As long as it fails saying it cannot find/open the savename.zip you are set! Just upload a save from your own computer and put it in the /opt/factorio/saves directory, or use the --create ./saves/newgame.zip argument.<br />
<br />
=== How to list a server-hosted game on the matching server ===<br />
<br />
In order to publish the game to the matching server, Factorio needs to be given some more information than just the save file location. These information are provided in a ''server settings file''.<br />
<br />
To create a server settings file, look at the example file located in '''data/server-settings.example.json''' in the Factorio [[Application directory]]. The recommended way is to make a copy of this example file and edit the copy.<br />
<br />
The following values can be changed:<br />
; Name: This will be the name under which the server will be listed in the server browser<br />
; Description: A description of your server. May contain up to 5000 characters. [https://factorio.com/blog/post/fff-304 MP server description]<br />
; Tags: A list of game tags<br />
; Max Players: Allows you to limit the number of players that can be connected to the server at the same time. If you want no limit, just set max_players to 0.<br />
* Visibility for server browser: May be either public, LAN or hidden.<br />
** Public: The server will appear in the public server list. This requires the login credentials below to be filled in.<br />
** LAN: The server will not appear in the public server list, but will be available through the Play On LAN button<br />
** Hidden: Clients will have to connect using the server's IP address<br />
* User credentials using a username and password or authentication token (found on the factorio website or in the player-data.json): These are necessary if you wish to make the server public. Otherwise, they can be left empty.<br />
** For security reasons it is recommended to use authentication token as this document is stored as plain text. Though it should be noted that an authentication token is a sensitive piece of information as well, and you are well-advised to keep it secret.<br />
* Server Password<br />
** Field name is game_password<br />
* Whether to verify user identity<br />
(There are additional values in v0.14 of factorio.)<br />
<br />
=== Technical Implementation Details ===<br />
<br />
Notes about some technical details surrounding multiplayer have been published by the development team in several Friday Facts blog posts:<br />
<br />
* [http://www.factorio.com/blog/post/fff-76 Lock step architecture]<br />
* [http://www.factorio.com/blog/post/fff-99 Client-server connections]<br />
* [http://www.factorio.com/blog/post/fff-143 NAT punching, introduced in 0.13]<br />
<br />
=== DNS SRV Records ===<br />
Factorio supports [https://www.cloudflare.com/learning/dns/dns-records/dns-srv-record/ DNS SRV records] since 1.1.67. <br />
<br />
This makes it easier to have multiple Factorio servers on a single host and allow users to connect to them with distinct subdomains instead of having to enter port numbers.<br />
<br />
The service name is <code>_factorio</code> and it only supports <code>_udp</code> protocol. <br />
<br />
'''Example:'''<br />
<br />
<pre><br />
Domain: wube.software<br />
IP: 192.0.2.2<br />
Port: 34197<br />
<br />
DNS records:<br />
srv-target IN A 192.0.2.2 <br />
_factorio._udp IN SRV 0 0 34197 srv-target.wube.software.<br />
</pre><br />
<br />
Now a Factorio client connecting to wube.software will actually connect to srv-target.wube.software:34197<br />
<br />
'''Example screenshot:''' <br />
<br />
[[File:Screenshot of SRV record settings Cloudflare dashboard.png]]<br />
<br />
'''Log Entries:'''<br />
<br />
* Factorio will log a "DNS SRV lookup returned [...]" message when it found a SRV record for the given domain<br />
* With verbose logging Factorio will also log "DNS SRV lookup for [domain] didn't return any usable records" when there's no SRV record<br />
<br />
=== Miscellaneous Tips ===<br />
* The key for [[Console|console commands]] is also used initiate chat in multiplayer. To execute a command instead of chatting, you need to type ''/c'' before the command. Commands executed are ''visible to all players''. Additionally, the multiplayer game must have been started with commands allowable for commands to work.<br />
* Set the player's color using the command<br />
/color r g b<br />
r, g and b are for red, green and blue respectively (possible values are between 0 and 1, use [https://www.w3schools.com/colors/colors_converter.asp this site] to convert colors to rgb numbers).<br />
* To give yourself admin access, you need to create a server-adminlist.json in the same directory as factorio-current.log. The file should contain a list of admins, like so: <code>[ "user1", "user2" ]</code><br />
<br />
This file will be created if you promote a player through the console.<br />
<br />
== Joining a Multiplayer game ==<br />
<br />
As of version 0.13, players no longer necessarily have to port-forward to play with others. Players may join each other through Steam, or by just the port-forwarded host.<br />
<br />
Players wishing to join a game may do so in multiple ways:<br />
<br />
* Joining by directly inputting a public IP and port into Factorio.<br />
* Selecting the server from the active public server menu.<br />
* Joining through Steam's services.<br />
* Playing a local LAN game.<br />
<br />
=== Joining by IP ===<br />
<br />
To join a multiplayer game by IP, you will need to know the public IP of a valid server. You can find this through social media, websites, or by word of mouth. After acquiring the IP and port, simply go to play -> Multiplayer -> Connect to server, and provide all the information it asks for.<br />
<br />
If the server has been set up correctly to accept public connections, you should be able to join the game.<br />
<br />
=== Joining via server list ===<br />
<br />
Factorio's devs keep a list of all public servers that declare themselves to the service, allowing players to join directly through Factorio. Most of these servers will be password-requiring, but many completely public servers can be connected to. To join via server list, go to Play -> Multiplayer -> Browse public games. Provide your Factorio.com login if asked, and a list of public servers will appear. Simply select one.<br />
<br />
=== Joining through Steam ===<br />
<br />
Steam provides a "game invite" system, simply use that to join. You can find more info about how to use steam in it's documentation. ''This is the most recommended way for the average player to use multiplayer with their friends, as it allows Steam to handle everything''.<br />
<br />
=== Joining a local LAN game ===<br />
<br />
If you have some friends on the same internet connection as you (in the same building or network), you may play a LAN game. Simply go to Play -> Multiplayer -> Play on LAN.<br />
<br />
=== Connecting to a Server Behind NAT ===<br />
<br />
Factorio requires that the server (in client-server mode) have a publicly accessible IP address or that all players are on the same LAN. If you are behind NAT, you must set up port forwarding ([[Multiplayer#Playing_over_LAN_.2F_Internet|see above]] for port number) or use virtual LAN software such as Hamachi or Evolve.<br />
<br />
Multiplayer games will be launched in client-server mode (also [http://www.factorio.com/blog/post/fff-99 multiplayer forwarding] mode). In this mode, all clients send their network traffic to the server and the server forwards the traffic to the other clients. The advantage of this is that it allows games where some players are inside a LAN and others are outside. The disadvantage may be slightly more lag as packets must travel an extra hop (through the server).<br />
<br />
* [https://forums.factorio.com/viewtopic.php?f=53&t=6393 Forwarding ports without logging into your router]<br />
* [https://forums.factorio.com/viewtopic.php?f=53&t=7714 A guide for connecting with Evolve]<br />
* [http://steamcommunity.com/sharedfiles/filedetails/?id=653628496 A guide for connecting with Hamachi]<br />
<br />
== PvP ==<br />
<br />
In PvP mode, players can be on different forces. Each force can have one (free-for-all) or more players (teams). Each force has its own independent research progression. Additionally, each force's [[Military units and structures]] will attack other players as enemies, unless a cease fire is set. Note that, depending on the scenario, cease fires may be unidirectional — setting a cease fire with an opposing force does not guarantee a cease fire from them in return.<br />
<br />
To start a PvP game, you can select the 'PvP' scenario from the 'Play' menu, or download a custom scenario which also supports PvP.<br />
<br />
After downloading a PvP scenario, you need to move it to your application directory, and create the multiplayer game using the scenario.<br />
<br />
# Download the scenario and place the scenario directory in the ''scenarios'' directory within your [[Application_directory#Directory_locations_by_OS_and_installation_method|user data directory]].<br />
# Launch Factorio<br />
# Click ''Play''<br />
# Click ''Multiplayer''<br />
# Click ''Scenario''<br />
# Choose the PvP scenario you want and click ''Create''<br />
# Choose latency and other settings, then click ''Play''<br />
# Other players can now join the game<br />
<br />
=== Forces ===<br />
<br />
Forces can be manually created via the console. This allows any map/scenario to be used for PvP. This may not be as convenient as a pre-made PvP scenario, as there will be no way for players to turn on/off cease fires other than through the console.<br />
<br />
Each created force has its own research progression and different forces may attack each other.<br />
<br />
The console commands for setting up and controlling forces are below:<br />
<br />
<pre><br />
game.create_force("Name")<br />
--Creates the force "Name"<br />
<br />
game.players["Player_name"].force = game.forces["Name"]<br />
--Sets this player to the new force<br />
<br />
game.forces["Name"].set_cease_fire("Other_force_name", true)<br />
--Sets the new force ceasefire to the "other force"<br />
<br />
game.forces["Name"].set_spawn_position({x = 10, y = 20}, game.surfaces[1])<br />
--Sets the spawn position of the force<br />
<br />
game.print(#game.forces)<br />
--Prints the number of forces<br />
<br />
for name, force in pairs (game.forces) do<br />
game.print(name)<br />
end<br />
--Prints the name of all the forces<br />
</pre><br />
<br />
The ability of players and entities belonging to one force to interact with structures belonging to another, non-friendly force is limited. However, some types of interactions are still possible:<br />
<br />
;Manual pickup from belts<br />
: Players can pick up items traveling along a transport belt that belongs to an opposing force. Note however that this can't be automated: Inserters will ''not'' take items from an opposing force's belts.<br />
;Belt network connection<br />
: Belts will connect to each other regardless of force membership, so it's possible to extend an opposing force's belt line, and items will flow to them. It is also possible to side-load into, and place items onto (with inserters) an opposing force's belt line.<br />
;Fluid network connection<br />
: Pipes (and storage tanks, and pumps, &c) will connect to each other regardless of force membership. For example, it's possible to pump fluids out of or into a storage tank belonging to an opposing force.<br />
;Power leeching<br />
: Players can draw power from an opposing force's electric network, by building structures inside the coverage area of a power pole belonging to an opposing force. Power poles that you build next to a power pole belonging to an opposing force will automatically connect to it, but will be impossible to connect or disconnect manually.<br />
<br />
== History ==<br />
<br />
=== Narrative history ===<br />
<br />
Because of the potentially immense amount of activity on a map, the game engine utilizes a [https://www.factorio.com/blog/post/fff-76 lock step architecture]. All instances of the game run full simulations of the entire world and only player actions are transferred across the network.<br />
<br />
Multiplayer games were introduced to Factorio with version 0.11.0. The only connection method available was peer-to-peer mode which meant every player had to be able to directly communicate with every other player. In version 0.12.4, a client-server mode of communication was introduced in which the server (either a dedicated one or the player who hosted the game) relays messages to all peers. This means that direct connection between all players is no longer necessary. As of version 0.13, P2P connecting is completely removed.<br />
<br />
As of version 0.12.0, the game features "latency hiding" mechanics where the game simulates some of the player's actions locally to make some common interactions (such as moving the player's character) more fluid. Not every action is a part of latency hiding – most notably, car or train driving and shooting are not a part of it.<br />
<br />
=== Version history ===<br />
<br />
Maintainer note: The following history may not be fully up to date, or comprehensive. Factorio's multiplayer has undergone a great deal of small changes since its inception, however this history will provide a rough overview.<br />
<br />
{{history|0.14.14|<br />
* Added multiplayer server option "Autosave only on server".<br />
* Deconstructing/canceling deconstruction sets the "last user" on an entity.<br />
* Decreased the size of connection accept message with lot of mod which could help some people with 50+ mod multiplayer games.<br />
}}<br />
<br />
{{history|0.14.13|<br />
* Reconnecting to multiplayer game that the player is already in (due to being dropped, most often) instantly closes the previous connection and connects the player.}}<br />
<br />
{{history|0.14.11|<br />
* Multiplayer user names can only consist of letters, and <code> -_. </code> characters.}}<br />
<br />
{{history|0.14.10|<br />
* Disabled 32bit (x86) multiplayer. All hosts and members must be running the 64bit (x86_64) version of the game.}}<br />
<br />
{{history|0.14.8|<br />
* More than 10 players in one game will reduce the rate the game is saved to the server.}}<br />
<br />
{{history|0.14.6|<br />
* Username is now set to username setting, not email.}}<br />
<br />
{{history|0.14.5|<br />
* Added AFK Auto kick interval to multiplayer host settings (with never as default).}}<br />
<br />
{{history|0.14.3|<br />
* When save of scenario is loaded in multiplayer, it's scenario is saved in user scenarios.<br />
* Added <code>/time</code> command to print the current map age.<br />
* Added option to host multiplayer game with scenario (it only had new game/load game there).<br />
}}<br />
<br />
{{history|0.14.2|<br />
* Can specify limit of upload speed when hosting.}}<br />
<br />
{{history|0.14.0|<br />
* Server doesn't stop/slow down the game when some client is too slow, stops communicating or saves the game longer than the server.<br />
* Players automatically quit game after 3 desyncs.<br />
* Removed the option to enable/disable latency hiding, it is always on on clients (and off on the server).<br />
}}<br />
<br />
{{history|0.13.10|<br />
* Server stdout messages now contain time stamps and message-type tags}}<br />
<br />
{{history|0.13.2|<br />
* Limit multiplayer player name to 60 characters.}}<br />
<br />
{{history|0.13.0|<br />
* Improved Multiplayer game UX<br />
* Server games are published to the server and clients can browse existing games.<br />
* Removed multiplayer peer-to-peer mode.<br />
* Building sound is played also for other players in multiplayer.<br />
}}<br />
<br />
{{history|0.12.31|<br />
* Human readable error notice when multiplayer connection wasn't successful. (https://forums.factorio.com/23132)<br />
* Improved map download speed when connecting to multiplayer game.}}<br />
<br />
{{history|0.12.30|<br />
* Mod checksums are calculated when the game starts and are compared with other peers when joining a multiplayer game. This is to ensure everyone has exactly the same mod in order to prevent desyncs caused by local changes made to mod files.}}<br />
<br />
{{history|0.12.28|<br />
* Added --port to specify which network port the game should use, when hosting with --start-server or --mp-load-game.}}<br />
<br />
{{history|0.12.27|<br />
* The report of different mods when trying to connect to multiplayer game is now scroll-able when needed.<br />
* Better message when the server leaves a multiplayer game}}<br />
<br />
{{history|0.12.11|<br />
* Added --no-auto-pause: When running as a server, --no-auto-pause will prevent stopping the game when no players are connected.}}<br />
<br />
{{history|0.12.9|<br />
* Added resume button to multiplayer game menu}}<br />
<br />
{{history|0.12.7|<br />
*New command line options for the headless server: --disallow-commands and --peer-to-peer}}<br />
<br />
{{history|0.12.5|<br />
* Multiplayer broadcast (heartbeats) is done via a single message when not using peer2peer.<br />
* Further optimizations in size of the Multiplayer heartbeat (message sent every tick).<br />
* LatencyState is suspended when player is killed (and waiting for respawn) in Multiplayer.<br />
}}<br />
<br />
{{history|0.12.4|<br />
* Simple mechanism for multiplayer relaying via the server.<br />
* Less annoying glitches when running and shooting in multiplayer with latency hiding.}}<br />
<br />
{{history|0.12.0|<br />
* Multiplayer latency hiding (gives impression that some common tasks are performed immediately)<br />
* Factorio can run as a dedicated server without graphics.<br />
* Basic PvP: New forces can now be created and merged back together; a cease-fire can be agreed upon between forces<br />
* IPv6 support for multiplayer.<br />
* DNS names can be used when connecting to multiplayer game.<br />
* Player's logistic filters are now remembered after respawn in multiplayer<br />
* Smaller multiplayer heartbeat packet size.<br />
}}<br />
<br />
{{history|0.11.19|<br />
* Multiplayer dropping threshold is doubled during map upload / download.}}<br />
<br />
{{history|0.11.17|<br />
* Autosaves in multiplayer are performed at the same time by all clients (interval is set by hosting player).<br />
* Progress bar is shown when non-responsive peers are about to be dropped from the game in the Multiplayer.<br />
* Progress bar is shown when other peers in multiplayer are saving map.}}<br />
<br />
{{history|0.11.16|<br />
* Revived character (after dying in multiplayer) are placed on the spawn point instead of the center of the map.}}<br />
<br />
{{history|0.11.2|<br />
* Mods that don't affect game state are not needed to be synchronized when playing multiplayer game or replaying game.}}<br />
<br />
{{history|0.11.0|<br />
* Introduced}}</div>Vinzenzhttps://wiki.factorio.com/index.php?title=File:Screenshot_of_SRV_record_settings_Cloudflare_dashboard.png&diff=190463File:Screenshot of SRV record settings Cloudflare dashboard.png2022-11-28T13:48:29Z<p>Vinzenz: </p>
<hr />
<div>Screenshot of an example SRV record setting in the Cloudflare dashboard</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_publish_API&diff=189560Mod publish API2022-07-26T15:31:06Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
<br />
The mod publish API is used to add new mods to the Factorio mod portal. It requires an API key with the <code>ModPortal: Publish Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoints ==<br />
<br />
=== init_publish ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/init_publish<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod that will be published.<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the mod zip file should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the init_publish endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| file || file ||Mod zip file<br />
|-<br />
| description || string, optional || Mod description in markdown format<br />
|- <br />
| category || enum, optional || Mod category, See [[Mod details API#Category]]<br />
|- <br />
| license || enum, optional || Mod category, See [[Mod details API#License]]<br />
|- <br />
| source_url || url, optional || Url to mod source code repository<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidModRelease || Invalid release data in info.json<br />
|-<br />
| InvalidModUpload || Invalid mod data in zipfile<br />
|-<br />
| ModAlreadyExists || Mod name already exists in mod portal<br />
|-<br />
|}<br />
<br />
== Python example ==<br />
<syntaxhighlight lang="python"><br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/init_publish"<br />
<br />
apikey = getenv("MOD_UPLOAD_API_KEY")<br />
modname = sys.argv[1]<br />
filepath = sys.argv[2]<br />
<br />
request_body = data = {"mod": modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(filepath, "rb") as f:<br />
request_body = {"file": f}<br />
response = requests.post(upload_url, files=request_body, data={"description": "# published via API"})<br />
<br />
if not response.ok:<br />
print(f"upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_images_API&diff=189559Mod images API2022-07-26T15:30:56Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
The mod images API is used to add, reorder or remove mod images on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoints ==<br />
<br />
=== add ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/images/add<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod, for which a new image will be uploaded<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the image should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the add endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| image || Image file<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| id || string || This attribute only appears on <strong>successful</strong> uploads. SHA1 of the uploaded image.<br />
|-<br />
| url || bool || This attribute only appears on <strong>successful</strong> uploads. Url of the uploaded image.<br />
|-<br />
| thumbnail || bool || This attribute only appears on <strong>successful</strong> uploads. Url of thumbnail of the uploaded image.<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
=== edit ===<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/images/edit<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod, for which a new image will be uploaded<br />
| images || string || List of comma-seperated image ids that should be displayed on the mod page<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| images || list || This attribute only appears on <strong>successful</strong> uploads. List of objects with id, url and thumbnail attribute same as finish_upload endpoint.<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidImageUpload || Invalid image file uploaded.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
<br />
|}<br />
<br />
== Python Examples ==<br />
=== Add Image ===<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/images/add"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = sys.argv[1]<br />
filepath = sys.argv[2]<br />
<br />
request_body = data = {"mod": modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(filepath, "rb") as f:<br />
request_body = {"image": f}<br />
response = requests.post(upload_url, files=request_body)<br />
<br />
if not response.ok:<br />
print(f"upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
<br />
=== Edit Images ===<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/images/edit"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
image_ids = ["fdc375d5ca3c263fedafb7ef143c82f9fb668472", "47bda5cd27ef49fe86fe03f803cb5c351a848586"]<br />
image_ids_text = ",".join(image_ids)<br />
<br />
request_body = data = {"mod": modname, "images": image_ids_text}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=189558Mod details API2022-07-26T15:30:45Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod<br />
|-<br />
| summary || string, optional || Short description of the mod<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || strong, optional || URL of mod homepage<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || strong, optional || URL of mod source code repository<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|- <br />
|<code><empty string></code>|| No category ||<br />
|- <br />
|<code>general</code>|| General || Mods that cannot be sorted into other categories<br />
|-<br />
|<code>non-game-changing</code>|| Non-Game-Changing || Changes only look&feel. New graphics, new sounds, etc.<br />
|-<br />
|<code>helper-mods</code>|| Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
|<code>transportation</code>|| Transportation || Player transport<br />
|-<br />
|<code>logistics</code>|| Logistics || Transport of materials<br />
|-<br />
|<code>utility</code>|| Utility || Helps with certain things the player is doing.<br />
|-<br />
|<code>balancing</code>|| Balancing || <br />
|-<br />
|<code>weapons</code>|| Weapons || <br />
|-<br />
|<code>enemies</code>|| Enemies || <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment related.<br />
|-<br />
|<code>oil</code>|| Oil || Things related to oil related manufacture<br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots<br />
|-<br />
|<code>circuit-network</code>|| Circuit network || <br />
|-<br />
|<code>storage</code>|| Storage || <br />
|-<br />
|<code>power-production</code>|| Power production || <br />
|-<br />
|<code>manufacture</code>|| Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
|<code>blueprints</code>|| Blueprints || <br />
|-<br />
|<code>cheats</code>|| Cheats || <br />
|-<br />
|<code>defense</code>|| Defense || <br />
|-<br />
|<code>mining</code>|| Mining || <br />
|-<br />
|<code>environment</code>|| Environment || <br />
|-<br />
|<code>info</code>|| Info || Mods that provide additional information to the player<br />
|-<br />
|<code>trains</code>|| Trains || <br />
|-<br />
|<code>big-mods</code>|| Big mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
|<code>scenarios</code>|| Scenarios || Story mode campaigns on a premade map<br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together!<br />
|-<br />
|<code>libraries</code>|| Libraries || Mods used by other mods<br />
|-<br />
|}<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = data = {"mod": modname, "faq": "# hello world"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=189557Factorio HTTP API usage guidelines2022-07-26T15:30:08Z<p>Vinzenz: </p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by or associated with Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
=== Experimental ===<br />
* Short-lived, unstable APIs<br />
* For testing new features with the community<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* [[Download API]]<br />
* [[Matchmaking API]]<br />
* [[Mod portal API]]<br />
* [[Web authentication API]]<br />
<br />
=== Public ===<br />
* [[Mod upload API]]<br />
* [[Mod details API ]]<br />
* [[Mod images API ]]<br />
* [[Mod publish API ]]<br />
<br />
=== Experimental ===<br />
<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_publish_API&diff=189556Mod publish API2022-07-26T15:29:51Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
The mod publish API is used to add new mods to the Factorio mod portal. It requires an API key with the <code>ModPortal: Publish Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoints ==<br />
<br />
=== init_publish ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/init_publish<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod that will be published.<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the mod zip file should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the init_publish endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| file || file ||Mod zip file<br />
|-<br />
| description || string, optional || Mod description in markdown format<br />
|- <br />
| category || enum, optional || Mod category, See [[Mod details API#Category]]<br />
|- <br />
| license || enum, optional || Mod category, See [[Mod details API#License]]<br />
|- <br />
| source_url || url, optional || Url to mod source code repository<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidModRelease || Invalid release data in info.json<br />
|-<br />
| InvalidModUpload || Invalid mod data in zipfile<br />
|-<br />
| ModAlreadyExists || Mod name already exists in mod portal<br />
|-<br />
|}<br />
<br />
== Python example ==<br />
<syntaxhighlight lang="python"><br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/init_publish"<br />
<br />
apikey = getenv("MOD_UPLOAD_API_KEY")<br />
modname = sys.argv[1]<br />
filepath = sys.argv[2]<br />
<br />
request_body = data = {"mod": modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(filepath, "rb") as f:<br />
request_body = {"file": f}<br />
response = requests.post(upload_url, files=request_body, data={"description": "# published via API"})<br />
<br />
if not response.ok:<br />
print(f"upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_images_API&diff=189555Mod images API2022-07-26T15:29:18Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
The mod images API is used to add, reorder or remove mod images on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoints ==<br />
<br />
=== add ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/images/add<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod, for which a new image will be uploaded<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the image should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the add endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| image || Image file<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| id || string || This attribute only appears on <strong>successful</strong> uploads. SHA1 of the uploaded image.<br />
|-<br />
| url || bool || This attribute only appears on <strong>successful</strong> uploads. Url of the uploaded image.<br />
|-<br />
| thumbnail || bool || This attribute only appears on <strong>successful</strong> uploads. Url of thumbnail of the uploaded image.<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
=== edit ===<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/images/edit<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod, for which a new image will be uploaded<br />
| images || string || List of comma-seperated image ids that should be displayed on the mod page<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| images || list || This attribute only appears on <strong>successful</strong> uploads. List of objects with id, url and thumbnail attribute same as finish_upload endpoint.<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidImageUpload || Invalid image file uploaded.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
<br />
|}<br />
<br />
== Python Examples ==<br />
=== Add Image ===<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/images/add"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = sys.argv[1]<br />
filepath = sys.argv[2]<br />
<br />
request_body = data = {"mod": modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(filepath, "rb") as f:<br />
request_body = {"image": f}<br />
response = requests.post(upload_url, files=request_body)<br />
<br />
if not response.ok:<br />
print(f"upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
<br />
=== Edit Images ===<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/images/edit"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
image_ids = ["fdc375d5ca3c263fedafb7ef143c82f9fb668472", "47bda5cd27ef49fe86fe03f803cb5c351a848586"]<br />
image_ids_text = ",".join(image_ids)<br />
<br />
request_body = data = {"mod": modname, "images": image_ids_text}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=189554Mod details API2022-07-26T15:28:40Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod<br />
|-<br />
| summary || string, optional || Short description of the mod<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || strong, optional || URL of mod homepage<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || strong, optional || URL of mod source code repository<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|- <br />
|<code><empty string></code>|| No category ||<br />
|- <br />
|<code>general</code>|| General || Mods that cannot be sorted into other categories<br />
|-<br />
|<code>non-game-changing</code>|| Non-Game-Changing || Changes only look&feel. New graphics, new sounds, etc.<br />
|-<br />
|<code>helper-mods</code>|| Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
|<code>transportation</code>|| Transportation || Player transport<br />
|-<br />
|<code>logistics</code>|| Logistics || Transport of materials<br />
|-<br />
|<code>utility</code>|| Utility || Helps with certain things the player is doing.<br />
|-<br />
|<code>balancing</code>|| Balancing || <br />
|-<br />
|<code>weapons</code>|| Weapons || <br />
|-<br />
|<code>enemies</code>|| Enemies || <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment related.<br />
|-<br />
|<code>oil</code>|| Oil || Things related to oil related manufacture<br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots<br />
|-<br />
|<code>circuit-network</code>|| Circuit network || <br />
|-<br />
|<code>storage</code>|| Storage || <br />
|-<br />
|<code>power-production</code>|| Power production || <br />
|-<br />
|<code>manufacture</code>|| Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
|<code>blueprints</code>|| Blueprints || <br />
|-<br />
|<code>cheats</code>|| Cheats || <br />
|-<br />
|<code>defense</code>|| Defense || <br />
|-<br />
|<code>mining</code>|| Mining || <br />
|-<br />
|<code>environment</code>|| Environment || <br />
|-<br />
|<code>info</code>|| Info || Mods that provide additional information to the player<br />
|-<br />
|<code>trains</code>|| Trains || <br />
|-<br />
|<code>big-mods</code>|| Big mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
|<code>scenarios</code>|| Scenarios || Story mode campaigns on a premade map<br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together!<br />
|-<br />
|<code>libraries</code>|| Libraries || Mods used by other mods<br />
|-<br />
|}<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = data = {"mod": modname, "faq": "# hello world"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=189553Mod details API2022-07-26T15:28:25Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod<br />
|-<br />
| summary || string, optional || Short description of the mod<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || strong, optional || URL of mod homepage<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || strong, optional || URL of mod source code repository<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|- <br />
|<code><empty string></code>|| No category ||<br />
|- <br />
|<code>general</code>|| General || Mods that cannot be sorted into other categories<br />
|-<br />
|<code>non-game-changing</code>|| Non-Game-Changing || Changes only look&feel. New graphics, new sounds, etc.<br />
|-<br />
|<code>helper-mods</code>|| Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
|<code>transportation</code>|| Transportation || Player transport<br />
|-<br />
|<code>logistics</code>|| Logistics || Transport of materials<br />
|-<br />
|<code>utility</code>|| Utility || Helps with certain things the player is doing.<br />
|-<br />
|<code>balancing</code>|| Balancing || <br />
|-<br />
|<code>weapons</code>|| Weapons || <br />
|-<br />
|<code>enemies</code>|| Enemies || <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment related.<br />
|-<br />
|<code>oil</code>|| Oil || Things related to oil related manufacture<br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots<br />
|-<br />
|<code>circuit-network</code>|| Circuit network || <br />
|-<br />
|<code>storage</code>|| Storage || <br />
|-<br />
|<code>power-production</code>|| Power production || <br />
|-<br />
|<code>manufacture</code>|| Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
|<code>blueprints</code>|| Blueprints || <br />
|-<br />
|<code>cheats</code>|| Cheats || <br />
|-<br />
|<code>defense</code>|| Defense || <br />
|-<br />
|<code>mining</code>|| Mining || <br />
|-<br />
|<code>environment</code>|| Environment || <br />
|-<br />
|<code>info</code>|| Info || Mods that provide additional information to the player<br />
|-<br />
|<code>trains</code>|| Trains || <br />
|-<br />
|<code>big-mods</code>|| Big mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
|<code>scenarios</code>|| Scenarios || Story mode campaigns on a premade map<br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together!<br />
|-<br />
|<code>libraries</code>|| Libraries || Mods used by other mods<br />
|-<br />
|}<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = data = {"mod": modname, "faq": "# hello world"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=189433Factorio HTTP API usage guidelines2022-06-28T13:08:16Z<p>Vinzenz: </p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by or associated with Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
=== Experimental ===<br />
* Short-lived, unstable APIs<br />
* For testing new features with the community<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* [[Download API]]<br />
* [[Matchmaking API]]<br />
* [[Mod portal API]]<br />
* [[Web authentication API]]<br />
<br />
=== Public ===<br />
* [[Mod upload API]]<br />
<br />
=== Experimental ===<br />
* [[Mod details API ]]<br />
* [[Mod images API ]]<br />
* [[Mod publish API ]]<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_publish_API&diff=189432Mod publish API2022-06-28T13:08:11Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
The mod publish API is used to add new mods to the Factorio mod portal. It requires an API key with the <code>ModPortal: Publish Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoints ==<br />
<br />
=== init_publish ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/experimental/mods/init_publish<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod that will be published.<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the mod zip file should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the init_publish endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| file || file ||Mod zip file<br />
|-<br />
| description || string, optional || Mod description in markdown format<br />
|- <br />
| category || enum, optional || Mod category, See [[Mod details API#Category]]<br />
|- <br />
| license || enum, optional || Mod category, See [[Mod details API#License]]<br />
|- <br />
| source_url || url, optional || Url to mod source code repository<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidModRelease || Invalid release data in info.json<br />
|-<br />
| InvalidModUpload || Invalid mod data in zipfile<br />
|-<br />
| ModAlreadyExists || Mod name already exists in mod portal<br />
|-<br />
<br />
|}<br />
<br />
<br />
== Python example ==<br />
<syntaxhighlight lang="python"><br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/init_publish"<br />
<br />
apikey = getenv("MOD_UPLOAD_API_KEY")<br />
modname = sys.argv[1]<br />
filepath = sys.argv[2]<br />
<br />
request_body = data = {"mod": modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(filepath, "rb") as f:<br />
request_body = {"file": f}<br />
response = requests.post(upload_url, files=request_body, data={"description": "# published via API"})<br />
<br />
if not response.ok:<br />
print(f"upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
<br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_publish_API&diff=189431Mod publish API2022-06-28T13:07:23Z<p>Vinzenz: Created page with "<div align="center" class="stub">'''Category:''' Experimental API</div> The mod publish API is used to add new mods to the..."</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
The mod publish API is used to add new mods to the Factorio mod portal. It requires an API key with the <code>ModPortal: Publish Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoints ==<br />
<br />
=== init_publish ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/experimental/mods/init_publish<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod that will be published.<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the mod zip file should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the init_upload endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| file || file ||Mod zip file<br />
|-<br />
| description || string, optional || Mod description in markdown format<br />
|- <br />
| category || enum, optional || Mod category, See [[Mod details API#Category]]<br />
|- <br />
| license || enum, optional || Mod category, See [[Mod details API#License]]<br />
|- <br />
| source_url || url, optional || Url to mod source code repository<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidModRelease || Invalid release data in info.json<br />
|-<br />
| InvalidModUpload || Invalid mod data in zipfile<br />
|-<br />
| ModAlreadyExists || Mod name already exists in mod portal<br />
|-<br />
<br />
|}<br />
<br />
<br />
== Python example ==<br />
<syntaxhighlight lang="python"><br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/init_publish"<br />
<br />
apikey = getenv("MOD_UPLOAD_API_KEY")<br />
modname = sys.argv[1]<br />
filepath = sys.argv[2]<br />
<br />
request_body = data = {"mod": modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(filepath, "rb") as f:<br />
request_body = {"file": f}<br />
response = requests.post(upload_url, files=request_body, data={"description": "# published via API"})<br />
<br />
if not response.ok:<br />
print(f"upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
<br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=189430Factorio HTTP API usage guidelines2022-06-28T12:33:28Z<p>Vinzenz: </p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by or associated with Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
=== Experimental ===<br />
* Short-lived, unstable APIs<br />
* For testing new features with the community<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* [[Download API]]<br />
* [[Matchmaking API]]<br />
* [[Mod portal API]]<br />
* [[Web authentication API]]<br />
<br />
=== Public ===<br />
* [[Mod upload API]]<br />
<br />
=== Experimental ===<br />
* [[Mod details API ]]<br />
* [[Mod images API ]]<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_images_API&diff=189429Mod images API2022-06-28T12:31:35Z<p>Vinzenz: Created page with "<div align="center" class="stub">'''Category:''' Experimental API</div> The mod images API is used to add, reorder or remov..."</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
The mod images API is used to add, reorder or remove mod images on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
== Endpoints ==<br />
<br />
=== add ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/experimental/mods/images/add<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod, for which a new image will be uploaded<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the image should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the add endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| image || Image file<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| id || string || This attribute only appears on <strong>successful</strong> uploads. SHA1 of the uploaded image.<br />
|-<br />
| url || bool || This attribute only appears on <strong>successful</strong> uploads. Url of the uploaded image.<br />
|-<br />
| thumbnail || bool || This attribute only appears on <strong>successful</strong> uploads. Url of thumbnail of the uploaded image.<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
=== edit ===<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/experimental/mods/images/edit<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod, for which a new image will be uploaded<br />
| images || string || List of comma-seperated image ids that should be displayed on the mod page<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| images || list || This attribute only appears on <strong>successful</strong> uploads. List of objects with id, url and thumbnail attribute same as finish_upload endpoint.<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidImageUpload || Invalid image file uploaded.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
<br />
|}<br />
<br />
== Python Examples ==<br />
=== Add Image ===<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/images/add"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = sys.argv[1]<br />
filepath = sys.argv[2]<br />
<br />
request_body = data = {"mod": modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(filepath, "rb") as f:<br />
request_body = {"image": f}<br />
response = requests.post(upload_url, files=request_body)<br />
<br />
if not response.ok:<br />
print(f"upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
<br />
=== Edit Images ===<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/images/edit"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
image_ids = ["fdc375d5ca3c263fedafb7ef143c82f9fb668472", "47bda5cd27ef49fe86fe03f803cb5c351a848586"]<br />
image_ids_text = ",".join(image_ids)<br />
<br />
request_body = data = {"mod": modname, "images": image_ids_text}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
<br />
</syntaxhighlight><br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=189428Mod details API2022-06-28T08:50:36Z<p>Vinzenz: </p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
<br />
The mod details API is used to change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/experimental/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod<br />
|-<br />
| summary || string, optional || Short description of the mod<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || strong, optional || URL of mod homepage<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || strong, optional || URL of mod source code repository<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|- <br />
|<code><empty string></code>|| No category ||<br />
|- <br />
|<code>general</code>|| General || Mods that cannot be sorted into other categories<br />
|-<br />
|<code>non-game-changing</code>|| Non-Game-Changing || Changes only look&feel. New graphics, new sounds, etc.<br />
|-<br />
|<code>helper-mods</code>|| Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
|<code>transportation</code>|| Transportation || Player transport<br />
|-<br />
|<code>logistics</code>|| Logistics || Transport of materials<br />
|-<br />
|<code>utility</code>|| Utility || Helps with certain things the player is doing.<br />
|-<br />
|<code>balancing</code>|| Balancing || <br />
|-<br />
|<code>weapons</code>|| Weapons || <br />
|-<br />
|<code>enemies</code>|| Enemies || <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment related.<br />
|-<br />
|<code>oil</code>|| Oil || Things related to oil related manufacture<br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots<br />
|-<br />
|<code>circuit-network</code>|| Circuit network || <br />
|-<br />
|<code>storage</code>|| Storage || <br />
|-<br />
|<code>power-production</code>|| Power production || <br />
|-<br />
|<code>manufacture</code>|| Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
|<code>blueprints</code>|| Blueprints || <br />
|-<br />
|<code>cheats</code>|| Cheats || <br />
|-<br />
|<code>defense</code>|| Defense || <br />
|-<br />
|<code>mining</code>|| Mining || <br />
|-<br />
|<code>environment</code>|| Environment || <br />
|-<br />
|<code>info</code>|| Info || Mods that provide additional information to the player<br />
|-<br />
|<code>trains</code>|| Trains || <br />
|-<br />
|<code>big-mods</code>|| Big mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
|<code>scenarios</code>|| Scenarios || Story mode campaigns on a premade map<br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together!<br />
|-<br />
|<code>libraries</code>|| Libraries || Mods used by other mods<br />
|-<br />
|}<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = data = {"mod": modname, "faq": "# hello world"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=189427Factorio HTTP API usage guidelines2022-06-28T08:48:59Z<p>Vinzenz: link mod details API</p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by or associated with Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
=== Experimental ===<br />
* Short-lived, unstable APIs<br />
* For testing new features with the community<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* [[Download API]]<br />
* [[Matchmaking API]]<br />
* [[Mod portal API]]<br />
* [[Web authentication API]]<br />
<br />
=== Public ===<br />
* [[Mod upload API]]<br />
<br />
=== Experimental ===<br />
* [[Mod details API ]]<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_details_API&diff=189426Mod details API2022-06-28T08:48:01Z<p>Vinzenz: initial mod details API documentation</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div><br />
<br />
The mod details API is used the change mod information like the description on the Factorio mod portal. It requires an API key with the <code>ModPortal: Edit Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
<br />
== Endpoint ==<br />
=== edit_details ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/experimental/mods/edit_details <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string, mandatory || Internal name of the mod whose details are to be changed<br />
|-<br />
| title || string, optional || Display name of the mod<br />
|-<br />
| summary || string, optional || Short description of the mod<br />
|-<br />
| description || string, optional || Long description of the mod in markdown format<br />
|-<br />
| category || enum, optional || Mod category, see [[#Category]]<br />
|-<br />
| license || enum, optional || Mod license, see [[#License]]<br />
|-<br />
| homepage || strong, optional || URL of mod homepage<br />
|-<br />
| deprecated || bool, optional || Deprecated flag to hide mod from public listings<br />
|-<br />
| source_url || strong, optional || URL of mod source code repository<br />
|-<br />
| faq || string, optional || FAQ for the mod in markdown format<br />
|}<br />
<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears for <strong>successful</strong> requests. It's set to true.<br />
|-<br />
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
|}<br />
== Enums ==<br />
=== Category ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description<br />
|- <br />
|<code><empty string></code>|| No category ||<br />
|- <br />
|<code>general</code>|| General || Mods that cannot be sorted into other categories<br />
|-<br />
|<code>non-game-changing</code>|| Non-Game-Changing || Changes only look&feel. New graphics, new sounds, etc.<br />
|-<br />
|<code>helper-mods</code>|| Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
|<code>transportation</code>|| Transportation || Player transport<br />
|-<br />
|<code>logistics</code>|| Logistics || Transport of materials<br />
|-<br />
|<code>utility</code>|| Utility || Helps with certain things the player is doing.<br />
|-<br />
|<code>balancing</code>|| Balancing || <br />
|-<br />
|<code>weapons</code>|| Weapons || <br />
|-<br />
|<code>enemies</code>|| Enemies || <br />
|-<br />
|<code>armor</code>|| Armor || Armors or armor equipment related.<br />
|-<br />
|<code>oil</code>|| Oil || Things related to oil related manufacture<br />
|-<br />
|<code>logistic-network</code>|| Logistic network || Related to roboports and logistic robots<br />
|-<br />
|<code>circuit-network</code>|| Circuit network || <br />
|-<br />
|<code>storage</code>|| Storage || <br />
|-<br />
|<code>power-production</code>|| Power production || <br />
|-<br />
|<code>manufacture</code>|| Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
|<code>blueprints</code>|| Blueprints || <br />
|-<br />
|<code>cheats</code>|| Cheats || <br />
|-<br />
|<code>defense</code>|| Defense || <br />
|-<br />
|<code>mining</code>|| Mining || <br />
|-<br />
|<code>environment</code>|| Environment || <br />
|-<br />
|<code>info</code>|| Info || Mods that provide additional information to the player<br />
|-<br />
|<code>trains</code>|| Trains || <br />
|-<br />
|<code>big-mods</code>|| Big mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
|<code>scenarios</code>|| Scenarios || Story mode campaigns on a premade map<br />
|-<br />
|<code>mod-packs</code>|| Mod packs || Collections of mods with tweaks to make them work together!<br />
|-<br />
|<code>libraries</code>|| Libraries || Mods used by other mods<br />
|-<br />
|}<br />
=== License ===<br />
<br />
{| class="wikitable"<br />
! Value !! Name !! Description !! URL<br />
|-<br />
|<code>default_mit</code>|| MIT || A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. || https://opensource.org/licenses/MIT<br />
|-<br />
|<code>default_gnugplv3</code>|| GNU GPLv3 || The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. || https://opensource.org/licenses/gpl-3.0<br />
|-<br />
|<code>default_gnulgplv3</code>|| GNU LGPLv3 || Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. || https://opensource.org/licenses/lgpl-3.0<br />
|-<br />
|<code>default_mozilla2</code>|| Mozilla Public License 2.0 || The Mozilla Public License (MPL 2.0) is maintained by the Mozilla foundation. This license attempts to be a compromise between the permissive BSD license and the reciprocal GPL license. || https://opensource.org/licenses/mpl-2.0<br />
|-<br />
|<code>default_apache2</code>|| Apache License 2.0 || A permissive license that also provides an express grant of patent rights from contributors to users. || https://opensource.org/licenses/apache-2.0<br />
|-<br />
|<code>default_unlicense</code>|| The Unlicense (Public Domain) || Because copyright is automatic in most countries, the Unlicense is a template to waive copyright interest in software you've written and dedicate it to the public domain. Use the Unlicense to opt out of copyright entirely. It also includes the no-warranty statement from the MIT/X11 license. || http://unlicense.org/<br />
|-<br />
|<code>custom_$ID</code>|| Custom || Custom license. The ID can be taken from the edit URL on the "My licenses" page on the mod portal. <code>mods.factorio.com/licenses/edit/$ID</code> || https://mods.factorio.com/licenses<br />
|}<br />
== Python Example ==<br />
<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/edit_details"<br />
<br />
apikey = getenv("MOD_EDIT_API_KEY")<br />
modname = getenv("MOD_NAME")<br />
<br />
request_body = data = {"mod": modname, "faq": "# hello world"}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(EDIT_MOD_URL, data=request_body, headers=request_headers)<br />
<br />
if not response.ok:<br />
print(f"edit failed: {response.text}")<br />
sys.exit(1)<br />
<br />
print(f"edit successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_portal_API&diff=188742Mod portal API2022-03-22T13:50:20Z<p>Vinzenz: /* /api/mods */ document sort and sort_order parameters</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div><br />
<br />
The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.<br />
<br />
<code>https://mods.factorio.com/api/mods</code><br />
<br />
More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.<br />
<br />
<code>https://mods.factorio.com/api/mods/{name}</code><br />
<br />
To get even more information about a mod, you can use the following URL.<br />
<br />
<code>https://mods.factorio.com/api/mods/{name}/full</code><br />
<br />
== Endpoints ==<br />
<br />
=== /api/mods ===<br />
<br />
GET Parameters:<br />
<br />
{| class="wikitable"<br />
! Key !! Values !! Description<br />
|-<br />
| hide_deprecated || {boolean} || Only return non-deprecated mods. <br />
|-<br />
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all<br />
|-<br />
| page_size ||{an integer or 'max'}||The amount of results to show in your search<br />
|-<br />
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.<br />
|-<br />
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.<br />
|-<br />
| namelist || {array of strings} || Return only mods that match the given names. <br />
|-<br />
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} || Only return non-deprecated mods compatible with this Factorio version<br />
|}<br />
<br />
<br />
Returns [[#Mod List Response]]<br />
<br />
=== /api/mods/{mod_name} ===<br />
<br />
Return short information of a specific mod.<br />
<br />
See [[#Result Entry]], "Short" column.<br />
<br />
=== /api/mods/{mod_name}/full ===<br />
<br />
Returns more information of a mod.<br />
<br />
See [[#Result Entry]], "Full" column.<br />
<br />
== JSON Object Types ==<br />
<br />
=== Mod List Response ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]<br />
|-<br />
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.<br />
|}<br />
<br />
=== Pagination ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| count || Integer || Total number of mods that match your specified filters.<br />
|-<br />
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.<br />
|-<br />
| page || Integer || The current page number.<br />
|-<br />
| page_count || Integer || The total number of pages returned.<br />
|-<br />
| page_size || Integer || The number of results per page.<br />
|}<br />
<br />
=== Pagination Links ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.<br />
|- <br />
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.<br />
|-<br />
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.<br />
|-<br />
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.<br />
|}<br />
<br />
=== Result Entry ===<br />
<br />
Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description<br />
|-<br />
| downloads_count || Integer || ✓ || ✓ || ✓<br />
| Number of downloads.<br />
|-<br />
| latest_release || [[#Releases|Release]] || ✓ || ||<br />
| The latest version of the mod available for download. See [[#Releases]]<br />
|-<br />
| name || String || ✓ || ✓ || ✓<br />
| The mod's machine-readable ID string.<br />
|-<br />
| owner || String || ✓ || ✓ || ✓<br />
| The Factorio username of the mod's author.<br />
|-<br />
| releases || [[#Releases|Release]][] || || ✓ || ✓<br />
| A list of different versions of the mod available for download. See [[#Releases]]<br />
|-<br />
| summary || String || ✓ || ✓ || ✓<br />
| A shorter mod description.<br />
|-<br />
| title || String || ✓ || ✓ || ✓<br />
| The mod's human-readable name.<br />
|-<br />
| category || [[#Tags|Tag]]? || ✓ || ✓ || ✓<br />
| A single tag describing the mod. Warning: Seems to be absent sometimes. See [[#Tags]].<br />
|-<br />
| changelog || String || || || ✓<br />
| A string describing the recent changes to a mod<br />
|- <br />
| created_at || String(ISO 8601) || || || ✓<br />
| ISO 6501 for when the mod was created.<br />
|-<br />
| description || String || || || ✓<br />
| A longer description of the mod, in text only format.<br />
|-<br />
| github_path || String || || || ✓<br />
| A link to the mod's github project page, just prepend "github.com/". Can be blank ("").<br />
|-<br />
| homepage || String || || || ✓<br />
| Usually a URL to the mod's main project page, but can be any string.<br />
|-<br />
| tag || [[#Tags|Tag]][] || || || ✓<br />
| A list of tag objects that categorize the mod. See [[#Tags]].<br />
|-<br />
|}<br />
<br />
=== Releases ===<br />
<br />
Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| download_url || String <br />
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]<br />
|-<br />
| file_name || String <br />
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"<br />
|-<br />
| info_json || Object <br />
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version<br />
|- <br />
| released_at || String(ISO 8601) <br />
| ISO 6501 for when the mod was released.<br />
|-<br />
| version || String <br />
| The version string of this mod release. Used to determine dependencies. <br />
|-<br />
| sha1 || String <br />
| The sha1 key for the file<br />
|- <br />
|}<br />
<br />
=== Tags ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| id || Integer || A numerical ID unique to this tag.<br />
|-<br />
| name || String || An all lower-case string used to identify this tag internally.<br />
|-<br />
| title || String || The tag's human-readable tag name.<br />
|-<br />
| description || String || A short description for the tag.<br />
|-<br />
| type || String || <br />
|}<br />
<br />
Currently, there are only a fixed number of tags available, these include:<br />
<br />
{| class="wikitable"<br />
! id !! type !! name !! title !! description<br />
|-<br />
| 1 || t || general || General || Mods that cannot be sorted into other categories<br />
|-<br />
| 2 || t || non-game-changing || Non-Game-Changing || Changes only look&feel. New graphics, new sounds, ... such things.<br />
|-<br />
| 3 || t || helper-mods || Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
| 6 || t || big-mods || Big Mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
| 12 || t || transportation || Transportation || Player transport<br />
|-<br />
| 13 || t || logistics || Logistics || Transport of materials<br />
|-<br />
| 14 || t || utility || Utility || Helps with certain things the player is doing.<br />
|-<br />
| 15 || t || balancing || Balancing || Makes the game much more fair<br />
|-<br />
| 17 || t || enemies || Enemies || Adds more enemies for more challange<br />
|-<br />
| 16 || t || weapons || Weapons || Adds more weapons to annihilate the enemy<br />
|-<br />
| 18 || t || armor || Armor || Armors or armor equipment related.<br />
|-<br />
| 19 || t || oil || Oil || Things related to oil related manufacture<br />
|-<br />
| 20 || t || logistics-network || Logistics Network || Related to roboports and logistic robots<br />
|- <br />
| 21 || t || storage || Storage || Allows more ways to be able to store items<br />
|-<br />
| 22 || t || power-production || Power Production || Allows more ways to create mass amounts of energy<br />
|-<br />
| 23 || t || manufacture || Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
| 24 || t || blueprints || Blueprints || <br />
|-<br />
| 25 || t || cheats || Cheats || Well, they let you cheat<br />
|- <br />
| 26 || t || defense || Defense || Mods that add the ability to protect your base more<br />
|-<br />
| 27 || t || mining || Mining || Mods that provide better or new ways of mining resources<br />
|-<br />
| 28 || t || info || Info || Mods that provide additional information to the player<br />
|-<br />
| 29 || t || trains || Trains || Related to trains<br />
|}<br />
<br />
<br />
=== Error ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| detail || String ||<br />
|}<br />
<br />
== Downloading Mods ==<br />
<br />
You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].<br />
<br />
Example usage:<br />
https://mods.factorio.com/{download_url}?username={username}&token={token}<br />
<br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_portal_API&diff=188739Mod portal API2022-03-21T11:36:04Z<p>Vinzenz: /* /api/mods */ document version and hide_deprecated parameters</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div><br />
<br />
The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.<br />
<br />
<code>https://mods.factorio.com/api/mods</code><br />
<br />
More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.<br />
<br />
<code>https://mods.factorio.com/api/mods/{name}</code><br />
<br />
To get even more information about a mod, you can use the following URL.<br />
<br />
<code>https://mods.factorio.com/api/mods/{name}/full</code><br />
<br />
== Endpoints ==<br />
<br />
=== /api/mods ===<br />
<br />
GET Parameters:<br />
<br />
{| class="wikitable"<br />
! Key !! Values !! Description<br />
|-<br />
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all<br />
|-<br />
| page_size ||{an integer or 'max'}||The amount of results to show in your search<br />
|-<br />
| namelist || {array of strings} || Return only mods that match the given names. <br />
|-<br />
| hide_deprecated || {boolean} || Only return non-deprecated mods. <br />
|-<br />
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} || Only return non-deprecated mods compatible with this Factorio version<br />
|}<br />
<br />
<br />
Returns [[#Mod List Response]]<br />
<br />
=== /api/mods/{mod_name} ===<br />
<br />
Return short information of a specific mod.<br />
<br />
See [[#Result Entry]], "Short" column.<br />
<br />
=== /api/mods/{mod_name}/full ===<br />
<br />
Returns more information of a mod.<br />
<br />
See [[#Result Entry]], "Full" column.<br />
<br />
== JSON Object Types ==<br />
<br />
=== Mod List Response ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]<br />
|-<br />
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.<br />
|}<br />
<br />
=== Pagination ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| count || Integer || Total number of mods that match your specified filters.<br />
|-<br />
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.<br />
|-<br />
| page || Integer || The current page number.<br />
|-<br />
| page_count || Integer || The total number of pages returned.<br />
|-<br />
| page_size || Integer || The number of results per page.<br />
|}<br />
<br />
=== Pagination Links ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.<br />
|- <br />
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.<br />
|-<br />
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.<br />
|-<br />
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.<br />
|}<br />
<br />
=== Result Entry ===<br />
<br />
Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description<br />
|-<br />
| downloads_count || Integer || ✓ || ✓ || ✓<br />
| Number of downloads.<br />
|-<br />
| latest_release || [[#Releases|Release]] || ✓ || ||<br />
| The latest version of the mod available for download. See [[#Releases]]<br />
|-<br />
| name || String || ✓ || ✓ || ✓<br />
| The mod's machine-readable ID string.<br />
|-<br />
| owner || String || ✓ || ✓ || ✓<br />
| The Factorio username of the mod's author.<br />
|-<br />
| releases || [[#Releases|Release]][] || || ✓ || ✓<br />
| A list of different versions of the mod available for download. See [[#Releases]]<br />
|-<br />
| summary || String || ✓ || ✓ || ✓<br />
| A shorter mod description.<br />
|-<br />
| title || String || ✓ || ✓ || ✓<br />
| The mod's human-readable name.<br />
|-<br />
| category || [[#Tags|Tag]]? || ✓ || ✓ || ✓<br />
| A single tag describing the mod. Warning: Seems to be absent sometimes. See [[#Tags]].<br />
|-<br />
| changelog || String || || || ✓<br />
| A string describing the recent changes to a mod<br />
|- <br />
| created_at || String(ISO 8601) || || || ✓<br />
| ISO 6501 for when the mod was created.<br />
|-<br />
| description || String || || || ✓<br />
| A longer description of the mod, in text only format.<br />
|-<br />
| github_path || String || || || ✓<br />
| A link to the mod's github project page, just prepend "github.com/". Can be blank ("").<br />
|-<br />
| homepage || String || || || ✓<br />
| Usually a URL to the mod's main project page, but can be any string.<br />
|-<br />
| tag || [[#Tags|Tag]][] || || || ✓<br />
| A list of tag objects that categorize the mod. See [[#Tags]].<br />
|-<br />
|}<br />
<br />
=== Releases ===<br />
<br />
Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| download_url || String <br />
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]<br />
|-<br />
| file_name || String <br />
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"<br />
|-<br />
| info_json || Object <br />
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version<br />
|- <br />
| released_at || String(ISO 8601) <br />
| ISO 6501 for when the mod was released.<br />
|-<br />
| version || String <br />
| The version string of this mod release. Used to determine dependencies. <br />
|-<br />
| sha1 || String <br />
| The sha1 key for the file<br />
|- <br />
|}<br />
<br />
=== Tags ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| id || Integer || A numerical ID unique to this tag.<br />
|-<br />
| name || String || An all lower-case string used to identify this tag internally.<br />
|-<br />
| title || String || The tag's human-readable tag name.<br />
|-<br />
| description || String || A short description for the tag.<br />
|-<br />
| type || String || <br />
|}<br />
<br />
Currently, there are only a fixed number of tags available, these include:<br />
<br />
{| class="wikitable"<br />
! id !! type !! name !! title !! description<br />
|-<br />
| 1 || t || general || General || Mods that cannot be sorted into other categories<br />
|-<br />
| 2 || t || non-game-changing || Non-Game-Changing || Changes only look&feel. New graphics, new sounds, ... such things.<br />
|-<br />
| 3 || t || helper-mods || Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
| 6 || t || big-mods || Big Mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
| 12 || t || transportation || Transportation || Player transport<br />
|-<br />
| 13 || t || logistics || Logistics || Transport of materials<br />
|-<br />
| 14 || t || utility || Utility || Helps with certain things the player is doing.<br />
|-<br />
| 15 || t || balancing || Balancing || Makes the game much more fair<br />
|-<br />
| 17 || t || enemies || Enemies || Adds more enemies for more challange<br />
|-<br />
| 16 || t || weapons || Weapons || Adds more weapons to annihilate the enemy<br />
|-<br />
| 18 || t || armor || Armor || Armors or armor equipment related.<br />
|-<br />
| 19 || t || oil || Oil || Things related to oil related manufacture<br />
|-<br />
| 20 || t || logistics-network || Logistics Network || Related to roboports and logistic robots<br />
|- <br />
| 21 || t || storage || Storage || Allows more ways to be able to store items<br />
|-<br />
| 22 || t || power-production || Power Production || Allows more ways to create mass amounts of energy<br />
|-<br />
| 23 || t || manufacture || Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
| 24 || t || blueprints || Blueprints || <br />
|-<br />
| 25 || t || cheats || Cheats || Well, they let you cheat<br />
|- <br />
| 26 || t || defense || Defense || Mods that add the ability to protect your base more<br />
|-<br />
| 27 || t || mining || Mining || Mods that provide better or new ways of mining resources<br />
|-<br />
| 28 || t || info || Info || Mods that provide additional information to the player<br />
|-<br />
| 29 || t || trains || Trains || Related to trains<br />
|}<br />
<br />
<br />
=== Error ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| detail || String ||<br />
|}<br />
<br />
== Downloading Mods ==<br />
<br />
You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].<br />
<br />
Example usage:<br />
https://mods.factorio.com/{download_url}?username={username}&token={token}<br />
<br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=188707Factorio HTTP API usage guidelines2022-03-18T12:24:10Z<p>Vinzenz: /* APIs */ add mod upload api to public category</p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by or associated with Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
=== Experimental ===<br />
* Short-lived, unstable APIs<br />
* For testing new features with the community<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* [[Download API]]<br />
* [[Matchmaking API]]<br />
* [[Mod portal API]]<br />
* [[Web authentication API]]<br />
<br />
=== Public ===<br />
* [[Mod upload API]]<br />
<br />
=== Experimental ===<br />
<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_upload_API&diff=188706Mod upload API2022-03-18T12:23:00Z<p>Vinzenz: Add upload API documentation from forums</p>
<hr />
<div><div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public|Public API]]</div><br />
The mod upload API is used to add new releases to mods on the Factorio mod portal. It requires an API key with the <code>ModPortal: Upload Mods</code> usage, which can be created on https://factorio.com/profile. <br />
<br />
It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.<br />
<br />
It was first announced on the Factorio forums. [https://forums.factorio.com/viewtopic.php?f=189&t=101769&p=562619#p562619]<br />
<br />
== Endpoints ==<br />
<br />
=== init_upload ===<br />
<br />
{| class="wikitable"<br />
|-<br />
| URL || https://mods.factorio.com/api/v2/mods/releases/init_upload <br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Header<br />
{| class="wikitable"<br />
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| mod || string || Name of the mod, for which a new release will be uploaded<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| upload_url || string || URL the mod zip file should be uploaded to<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> requests.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.<br />
|}<br />
<br />
=== finish_upload ===<br />
{| class="wikitable"<br />
|-<br />
| URL || <code>$upload_url</code> URL returned by the init_upload endpoint<br />
|-<br />
| HTTP Method || <code>POST</code> <br />
|-<br />
|}<br />
<br />
HTTP Request Body<br />
{| class="wikitable"<br />
| file || Mod zip file<br />
|}<br />
<br />
JSON object response<br />
{| class="wikitable"<br />
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.<br />
|-<br />
| error || string || This attribute only appears on <strong>failed</strong> uploads.<br />
|-<br />
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.<br />
|}<br />
<br />
== Possible API Error Responses ==<br />
Possible values for the <code>error</code> property of API responses<br />
{| class="wikitable"<br />
| InvalidApiKey || Missing or invalid API key for the current endpoint<br />
|-<br />
| InvalidRequest || Invalid request.<br />
|-<br />
| InternalError || Internal error, please try again later.<br />
|-<br />
| Forbidden || Insufficent permission for current endpoint<br />
|-<br />
| Unknown || Unknown error, please try again later.<br />
|-<br />
| InvalidModRelease || Invalid release data in info.json<br />
|-<br />
| InvalidModUpload || Invalid mod data in zipfile<br />
|-<br />
| UnknownMod || Mod does not exist in mod portal<br />
|-<br />
<br />
|}<br />
<br />
== Python Example ==<br />
<syntaxhighlight lang="python"><br />
import sys<br />
import requests<br />
from os import getenv<br />
<br />
MOD_PORTAL_URL = "https://mods.factorio.com"<br />
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/releases/init_upload"<br />
<br />
apikey = getenv("MOD_UPLOAD_API_KEY")<br />
modname = getenv("MOD_UPLOAD_NAME")<br />
zipfilepath = getenv("MOD_UPLOAD_FILE")<br />
<br />
request_body = data={"mod":modname}<br />
request_headers = {"Authorization": f"Bearer {apikey}"}<br />
<br />
response = requests.post(<br />
INIT_UPLOAD_URL,<br />
data=request_body,<br />
headers=request_headers)<br />
<br />
if not response.ok: <br />
print(f"init_upload failed: {response.text}")<br />
sys.exit(1)<br />
<br />
upload_url = response.json()["upload_url"]<br />
<br />
with open(zipfilepath, "rb") as f: <br />
request_body = {"file": f} <br />
response = requests.post(upload_url, files=request_body)<br />
<br />
if not response.ok: <br />
print(f"upload failed: {response.text}") <br />
sys.exit(1)<br />
<br />
print(f"upload successful: {response.text}")<br />
</syntaxhighlight><br />
<br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Web_authentication_API&diff=188588Web authentication API2022-03-07T16:55:23Z<p>Vinzenz: Update to api_version 4</p>
<hr />
<div>{{Languages}}<br />
<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div><br />
<br />
Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:<br />
<br />
<code>https://auth.factorio.com/api-login</code><br />
<br />
Authentication requires sending an HTTP POST request with these parameters:<br />
<br />
{| class="wikitable"<br />
| username<br />
| Required.<br />
| Account username or e-mail.<br />
|-<br />
| password<br />
| Required.<br />
| Account password.<br />
|- <br />
| api_version<br />
| (Technically) not required. API responses will be different than described on this page when not set to 4.<br />
| Currently 4.<br />
|-<br />
| require_game_ownership<br />
| Not required.<br />
| If set to 'true', will fail authentication if the user account hasn't actually purchased Factorio.<br />
|-<br />
| email_authentication_code<br />
| Not required.<br />
| If a previous login failed with <code>email-authentication-required</code>, email authentication can be completed by including the code sent to the user via mail.<br />
<br />
|}<br />
<br />
This endpoint always returns JSON encoded data. If authentication was successful, it will return an HTTP status code of 200 with a JSON object:<br />
<br />
{| class="wikitable"<br />
| token<br />
| Auth token is a hexadecimal encoded byte string<br />
|-<br />
| username<br />
| The username of the logged in user. <br />
<br />
|} <br />
<br />
On non-200 status codes, the response can be JSON encoded and provide more details about the problem:<br />
<br />
{| class="wikitable"<br />
| error<br />
| Error codes like <code>login-failed</code> or <code>email-authentication-required</code><br />
|-<br />
| message<br />
| A more detailed error message that can be shown to the user <br />
<br />
|} <br />
<br />
Clients causing a lot of errors like <code>login-failed</code> will be rate limited.<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=188548Factorio HTTP API usage guidelines2022-03-04T18:51:10Z<p>Vinzenz: Link Experimental Upload API</p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by or associated with Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
=== Experimental ===<br />
* Short-lived, unstable APIs<br />
* For testing new features with the community<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* [[Download API]]<br />
* [[Matchmaking API]]<br />
* [[Mod portal API]]<br />
* [[Web authentication API]]<br />
<br />
=== Public ===<br />
Stay tuned...<br />
<br />
=== Experimental ===<br />
* Experimental Mod Upload API [https://forums.factorio.com/viewtopic.php?f=189&t=101769&p=562619#p562619]<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=188547Factorio HTTP API usage guidelines2022-03-04T13:03:39Z<p>Vinzenz: add experimental category, minor wording updates</p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by or associated with Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
=== Experimental ===<br />
* Short-lived, unstable APIs<br />
* For testing new features with the community<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* [[Download API]]<br />
* [[Matchmaking API]]<br />
* [[Mod portal API]]<br />
* [[Web authentication API]]<br />
<br />
=== Public ===<br />
Stay tuned...<br />
<br />
=== Experimental ===<br />
Stay tuned...<br />
<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=187908Factorio HTTP API usage guidelines2022-01-21T09:47:52Z<p>Vinzenz: add wiki category</p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords or tokens.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* https://wiki.factorio.com/Download_API<br />
* https://wiki.factorio.com/Matchmaking_API<br />
* https://wiki.factorio.com/Mod_portal_API<br />
* https://wiki.factorio.com/Web_authentication_API<br />
<br />
=== Public ===<br />
Stay tuned...<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Web_authentication_API&diff=187907Web authentication API2022-01-21T09:46:31Z<p>Vinzenz: add category</p>
<hr />
<div>{{Languages}}<br />
'''Category:''' [https://wiki.factorio.com/Factorio_HTTP_API_usage_guidelines#Internal internal]<br />
<br />
Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:<br />
<br />
<code>https://auth.factorio.com/api-login</code><br />
<br />
Authentication requires sending an HTTP POST request with these parameters:<br />
<br />
{| class="wikitable"<br />
| username<br />
| Required.<br />
| Account username.<br />
|-<br />
| password<br />
| Required.<br />
| Account password.<br />
|- <br />
| api_version<br />
| Not required.<br />
| Currently 2.<br />
|-<br />
| require_game_ownership<br />
| Not required.<br />
| If set to 'true', will fail authentication if the user account hasn't actually purchased Factorio.<br />
|}<br />
<br />
This endpoint always returns JSON encoded data. If authentication was successful, it will return an HTTP status code of 200 with a JSON list containing a single item: the auth token. The auth token seems to always be a hexadecimal encoded 15-byte string of random bytes.<br />
<br />
TODO: exceptions and stuffs.<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Mod_portal_API&diff=187906Mod portal API2022-01-21T09:46:15Z<p>Vinzenz: add category</p>
<hr />
<div>'''Category:''' [https://wiki.factorio.com/Factorio_HTTP_API_usage_guidelines#Internal internal]<br />
<br />
The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.<br />
<br />
<code>https://mods.factorio.com/api/mods</code><br />
<br />
More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.<br />
<br />
<code>https://mods.factorio.com/api/mods/{name}</code><br />
<br />
To get even more information about a mod, you can use the following URL.<br />
<br />
<code>https://mods.factorio.com/api/mods/{name}/full</code><br />
<br />
== Endpoints ==<br />
<br />
=== /api/mods ===<br />
<br />
GET Parameters:<br />
<br />
{| class="wikitable"<br />
! Key !! Values !! Description<br />
|-<br />
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all<br />
|-<br />
| page_size ||{an integer or 'max'}||The amount of results to show in your search<br />
|-<br />
| namelist || {array of strings} || Return only mods that match the given names. <br />
|}<br />
<br />
<br />
Returns [[#Mod List Response]]<br />
<br />
=== /api/mods/{mod_name} ===<br />
<br />
Return short information of a specific mod.<br />
<br />
See [[#Result Entry]], "Short" column.<br />
<br />
=== /api/mods/{mod_name}/full ===<br />
<br />
Returns more information of a mod.<br />
<br />
See [[#Result Entry]], "Full" column.<br />
<br />
== JSON Object Types ==<br />
<br />
=== Mod List Response ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]<br />
|-<br />
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.<br />
|}<br />
<br />
=== Pagination ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| count || Integer || Total number of mods that match your specified filters.<br />
|-<br />
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.<br />
|-<br />
| page || Integer || The current page number.<br />
|-<br />
| page_count || Integer || The total number of pages returned.<br />
|-<br />
| page_size || Integer || The number of results per page.<br />
|}<br />
<br />
=== Pagination Links ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.<br />
|- <br />
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.<br />
|-<br />
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.<br />
|-<br />
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.<br />
|}<br />
<br />
=== Result Entry ===<br />
<br />
Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description<br />
|-<br />
| downloads_count || Integer || ✓ || ✓ || ✓<br />
| Number of downloads.<br />
|-<br />
| latest_release || [[#Releases|Release]] || ✓ || ||<br />
| The latest version of the mod available for download. See [[#Releases]]<br />
|-<br />
| name || String || ✓ || ✓ || ✓<br />
| The mod's machine-readable ID string.<br />
|-<br />
| owner || String || ✓ || ✓ || ✓<br />
| The Factorio username of the mod's author.<br />
|-<br />
| releases || [[#Releases|Release]][] || || ✓ || ✓<br />
| A list of different versions of the mod available for download. See [[#Releases]]<br />
|-<br />
| summary || String || ✓ || ✓ || ✓<br />
| A shorter mod description.<br />
|-<br />
| title || String || ✓ || ✓ || ✓<br />
| The mod's human-readable name.<br />
|-<br />
| category || [[#Tags|Tag]]? || ✓ || ✓ || ✓<br />
| A single tag describing the mod. Warning: Seems to be absent sometimes. See [[#Tags]].<br />
|-<br />
| changelog || String || || || ✓<br />
| A string describing the recent changes to a mod<br />
|- <br />
| created_at || String(ISO 8601) || || || ✓<br />
| ISO 6501 for when the mod was created.<br />
|-<br />
| description || String || || || ✓<br />
| A longer description of the mod, in text only format.<br />
|-<br />
| github_path || String || || || ✓<br />
| A link to the mod's github project page, just prepend "github.com/". Can be blank ("").<br />
|-<br />
| homepage || String || || || ✓<br />
| Usually a URL to the mod's main project page, but can be any string.<br />
|-<br />
| tag || [[#Tags|Tag]][] || || || ✓<br />
| A list of tag objects that categorize the mod. See [[#Tags]].<br />
|-<br />
|}<br />
<br />
=== Releases ===<br />
<br />
Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| download_url || String <br />
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]<br />
|-<br />
| file_name || String <br />
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"<br />
|-<br />
| info_json || Object <br />
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version<br />
|- <br />
| released_at || String(ISO 8601) <br />
| ISO 6501 for when the mod was released.<br />
|-<br />
| version || String <br />
| The version string of this mod release. Used to determine dependencies. <br />
|-<br />
| sha1 || String <br />
| The sha1 key for the file<br />
|- <br />
|}<br />
<br />
=== Tags ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| id || Integer || A numerical ID unique to this tag.<br />
|-<br />
| name || String || An all lower-case string used to identify this tag internally.<br />
|-<br />
| title || String || The tag's human-readable tag name.<br />
|-<br />
| description || String || A short description for the tag.<br />
|-<br />
| type || String || <br />
|}<br />
<br />
Currently, there are only a fixed number of tags available, these include:<br />
<br />
{| class="wikitable"<br />
! id !! type !! name !! title !! description<br />
|-<br />
| 1 || t || general || General || Mods that cannot be sorted into other categories<br />
|-<br />
| 2 || t || non-game-changing || Non-Game-Changing || Changes only look&feel. New graphics, new sounds, ... such things.<br />
|-<br />
| 3 || t || helper-mods || Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...<br />
|-<br />
| 6 || t || big-mods || Big Mods || Too big and/or changes too much of the game to be fit anywhere else<br />
|-<br />
| 12 || t || transportation || Transportation || Player transport<br />
|-<br />
| 13 || t || logistics || Logistics || Transport of materials<br />
|-<br />
| 14 || t || utility || Utility || Helps with certain things the player is doing.<br />
|-<br />
| 15 || t || balancing || Balancing || Makes the game much more fair<br />
|-<br />
| 17 || t || enemies || Enemies || Adds more enemies for more challange<br />
|-<br />
| 16 || t || weapons || Weapons || Adds more weapons to annihilate the enemy<br />
|-<br />
| 18 || t || armor || Armor || Armors or armor equipment related.<br />
|-<br />
| 19 || t || oil || Oil || Things related to oil related manufacture<br />
|-<br />
| 20 || t || logistics-network || Logistics Network || Related to roboports and logistic robots<br />
|- <br />
| 21 || t || storage || Storage || Allows more ways to be able to store items<br />
|-<br />
| 22 || t || power-production || Power Production || Allows more ways to create mass amounts of energy<br />
|-<br />
| 23 || t || manufacture || Manufacture || Furnaces, assembling machines, production chains<br />
|-<br />
| 24 || t || blueprints || Blueprints || <br />
|-<br />
| 25 || t || cheats || Cheats || Well, they let you cheat<br />
|- <br />
| 26 || t || defense || Defense || Mods that add the ability to protect your base more<br />
|-<br />
| 27 || t || mining || Mining || Mods that provide better or new ways of mining resources<br />
|-<br />
| 28 || t || info || Info || Mods that provide additional information to the player<br />
|-<br />
| 29 || t || trains || Trains || Related to trains<br />
|}<br />
<br />
<br />
=== Error ===<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Description<br />
|-<br />
| detail || String ||<br />
|}<br />
<br />
== Downloading Mods ==<br />
<br />
You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].<br />
<br />
Example usage:<br />
https://mods.factorio.com/{download_url}?username={username}&token={token}<br />
<br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Matchmaking_API&diff=187905Matchmaking API2022-01-21T09:45:56Z<p>Vinzenz: add category</p>
<hr />
<div>{{Languages}}<br />
'''Category:''' [https://wiki.factorio.com/Factorio_HTTP_API_usage_guidelines#Internal internal]<br />
<br />
The matchmaking API allows Factorio servers to advertise themselves, and for players to browse open game servers. The matchmaking server currently uses [https://www.heroku.com/ Heroku] and [http://gunicorn.org/ Green Unicorn] software.<br />
<br />
<code>API root: https://multiplayer.factorio.com/</code><br />
<br />
Some of the API endpoints require the use of an authentication token, which is obtained through the [[Web Authentication API]]. It is sent as the HTTP parameter named <code>token</code> and encoded using hexadecimal. All requests are encoded as JSON objects.<br />
<br />
Work in progress! I'm just going to jot down some random notes in the mean time :P<br />
<br />
https://multiplayer.factorio.com/get-games<br />
<br />
https://multiplayer.factorio.com/get-game-details/ Unauthenticated<br />
<br />
https://multiplayer.factorio.com/create-game<br />
<br />
https://multiplayer.factorio.com/post-game-heartbeat/<br />
<br />
https://multiplayer.factorio.com/remove-game/<br />
<br />
== Object Types ==<br />
<br />
=== Server Description Object ===<br />
<br />
{| class="wikitable"<br />
! rowspan="1" | Key<br />
! rowspan="1" | Type<br />
!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:80.9%' | get-games<br />
!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:80.9%' | get-game-details<br />
!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:80.9%' | create-game<br />
! rowspan="1" | Description<br />
|-<br />
| application_version<br />
| object<br />
| ✓<br />
| ✓<br />
| ✓<br />
| See [[#Application Version|application version]] below.<br />
|-<br />
| description<br />
| string<br />
| <br />
| ✓<br />
| ✓<br />
| The server's description.<br />
|-<br />
| game_id<br />
| integer<br />
| ✓<br />
| ✓<br />
| ✓<br />
| A unique id generated by the matchmaking server to identify a server for other API endpoints. <br />
|-<br />
| game_secret<br />
| string<br />
| <br />
| <br />
| ✓<br />
| <br />
|-<br />
| game_time_elapsed<br />
| string(integer)<br />
| ✓<br />
| ✓<br />
| ✓<br />
| Number of in-game minutes the loaded map has elapsed.<br />
|-<br />
| has_password<br />
| string(boolean)<br />
| ✓<br />
| ✓<br />
| ✓<br />
| "true" if a password is required to join the server.<br />
|-<br />
| host_address<br />
| string(ip:port)<br />
| <br />
| ✓<br />
| ✓<br />
| The IP address and port number the game server is hosted on.<br />
|-<br />
| last_heartbeat<br />
| number<br />
| <br />
| ✓<br />
| <br />
| The Unix timestamp of when the game server was last heard from.<br />
|-<br />
| max_players<br />
| string(integer)<br />
| ✓<br />
| ✓<br />
| ✓<br />
| Maximum number of players allowed to connect at once. 0 = unlimited.<br />
|-<br />
| mod_count<br />
| integer<br />
| ✓<br />
| <br />
| <br />
| Number of mods installed on the server.<br />
|-<br />
| mods<br />
| object[]<br />
| <br />
| ✓<br />
| ✓<br />
| List of [[#Mod Description|mods and their versions]] installed on the server.<br />
|-<br />
| mods_crc<br />
| integer<br />
| <br />
| ✓<br />
| <br />
| <br />
|-<br />
| name<br />
| string<br />
| ✓<br />
| ✓<br />
| ✓<br />
| Server's name.<br />
|-<br />
| players<br />
| string[]<br />
| ✓<br />
| ✓<br />
| <br />
| List of player's usernames connected to the server.<br />
|-<br />
| require_user_verification<br />
| string(boolean)<br />
| ✓<br />
| ✓<br />
| ✓<br />
| "true" if the server requires the user to be logged in to join.<br />
|-<br />
| server_id<br />
| string<br />
| ✓<br />
| ✓<br />
| <br />
| <br />
|-<br />
| tags<br />
| string[]<br />
| <br />
| ✓<br />
| ✓<br />
| List of server tags.<br />
|}<br />
<br />
=== Application Version ===<br />
<br />
{| class="wikitable"<br />
! Key<br />
! Type<br />
! Description<br />
|-<br />
| build_mode<br />
| string<br />
| "alpha", "headless", or "steam".<br />
|-<br />
| build_version<br />
| string(integer)<br />
| The build version associated with the game version.<br />
|-<br />
| game_version<br />
| string<br />
| Game version running on the server, e.g. "0.14.21".<br />
|-<br />
| platform<br />
| string<br />
| OS the server is running on: "linux64", "mac", or "win64".<br />
|}<br />
<br />
=== Mod Description ===<br />
<br />
{| class="wikitable"<br />
! Key<br />
! Type<br />
! Description<br />
|-<br />
| name<br />
| string<br />
| ID of the mod.<br />
|-<br />
| version<br />
| string<br />
| Version string of the mod.<br />
|}<br />
<br />
=== Error Message ===<br />
<br />
This object is returned whenever there's been an error with your request. <br />
<br />
{| class="wikitable"<br />
! Key<br />
! Type<br />
! Description<br />
|-<br />
| message<br />
| string<br />
| A short description of the error.<br />
|}<br />
<br />
== Endpoints ==<br />
<br />
=== get-games ===<br />
<br />
<code>GET https://multiplayer.factorio.com/get-games</code><br />
<br />
Returns the available Factorio game servers as a list of [[#Server Description Object|Server Description Objects]], but only with the object keys marked as available in the "get-games" column. Requires two GET parameters:<br />
<br />
{| class="wikitable"<br />
| username || The factorio username associated with the auth token.<br />
|-<br />
| token || A valid auth token, as obtained using the [[Web Authentication API]].<br />
|} <br />
<br />
'''Exceptions'''<br />
* "Missing username."<br />
* "User not found."<br />
* "Token doesn't match."<br />
<br />
=== get-game-details ===<br />
<br />
<code>GET https://multiplayer.factorio.com/get-game-details/<nowiki>{game_id}</nowiki></code><br />
<br />
Returns more details about the server, where {game_id} is the server's game_id as seen in the response from the get-games endpoint. This endpoint doesn't require an authentication token.<br />
<br />
<br />
[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Download_API&diff=187904Download API2022-01-21T09:45:27Z<p>Vinzenz: add category</p>
<hr />
<div>'''Category:''' [https://wiki.factorio.com/Factorio_HTTP_API_usage_guidelines#Internal internal]<br />
<br />
This API allows you to download official releases of stand-alone Factorio from the Factorio servers. It's not so much of an API as it is web scraping, but it's documented here for completeness. Please update this page if you utilize it and the information becomes outdated. Also note that's there's a separate, (semi)official API for upgrading between releases, which should be used when possible to lighten the load on the Factorio servers. (I'll document that later, promise!)<br />
<br />
== Authenticating ==<br />
<br />
Downloading Factorio requires an authenticated session with the web server, which is different than the typical API authentication mechanism. Authentication uses the HTML endpoint at<br />
<br />
<code>https://www.factorio.com/login</code><br />
<br />
Login in procedure:<br />
<br />
# Create an HTTP session and send a GET request. You'll get some HTML in return.<br>There's a [[:Wikipedia:Cross-site_request_forgery#Synchronizer_token_pattern|CSRF token]] you'll need to grab which can be found using one of the following selectors:<br />
#* CSS1: <code>input[name=csrf_token]</code> (and then take the "value" attribute).<br />
#* XPATH1: <code>//input[@name="csrf_token"]/@value</code><br />
# Then send a POST request with the following parameters:<br />
#* <code>csrf_token</code>: the CSRF token you grabbed earlier.<br />
#* <code>username_or_email</code>: your username or email address.<br />
#* <code>password</code>: your password.<br />
<br />
== Downloading ==<br />
<br />
Download Factorio releases at<br />
<br />
<code>https://www.factorio.com/get-download/{version}/{build}/{distro}</code><br />
<br />
* Where {version} is the version string of the release you wish to grab - e.g. "0.15.31". Use "latest" instead to default to the latest version for that build.<br />
* {build} is the release build, which currently comprises of:<br />
** <code>alpha</code> - the current standard full-featured build.<br />
** <code>demo</code> - the free, publicly accessible demo versions.<br />
** <code>headless</code> - for running servers on machines without graphical interface. <br />
* and {distro} is the os / type of release you wish to download, currently:<br />
** <code>win64</code> - EXE installer for 64 bit Windows.<br />
** <code>win64-manual</code> - ZIP package for 64 bit Windows.<br />
** <code>win32</code> - EXE installer for 32 bit Windows. ''No longer supported.''<br />
** <code>win32-manual</code> - ZIP package for 32 bit Windows. ''No longer supported.''<br />
** <code>osx</code> - DMG package for 64 bit Mac OS.<br />
** <code>linux64</code> - tar.gz or tar.xz package for 64 bit Linux.<br />
** <code>linux32</code> - tar.gz or tar.xz package for 32 bit Linux. ''No longer supported.''<br />
<br />
Factorio servers will correctly respond with a 404 if the requested download isn't available. Experimental builds are taken down quickly after they become obsolete, so it's best to check what versions are available before hand (documented below).<br />
<br />
Note: Windows 32 bit and 64 bit installers are [https://en.wikipedia.org/wiki/Inno_Setup Inno Setup] formatted packages (I'll document that somewhere someday).<br />
<br />
== Version Listings ==<br />
There is an API endpoint to find the latest version number at <code>https://factorio.com/api/latest-releases</code>. This can be polled to automatically detect when a new update was released.<br />
<br />
Due to changes in the Factorio website, all Factorio versions are now available on the HTML page at this location:<br />
<br />
<code>https://www.factorio.com/download/archive</code><br />
<br />
Note: This endpoint require an authenticated session as mentioned above.<br />
<br />
You could the grab all the informations you need by parsing the HTML using selectors but I would recommend only searching for the pattern <code>href="/get-download/*"</code> and then parse the relative link according to the <code>/get-download/{version}/{build}/{distro}</code> structure described in the section above. The second method has a clear advantage of reliability through potential HTML structure changes and simplicity.<br />
<br />
It is also better to rely on the <code>https://factorio.com/api/latest-releases</code> endpoint and version number comparisons to distinguish between stable and experimental versions than to extract that information from the download HTML page with selectors.<br />
<br />
The previous endpoints for experimental and headless releases <code>https://www.factorio.com/download/experimental</code> and <code>https://www.factorio.com/download-headless</code> now both redirect to this page containing only the latest releases:<br />
<br />
<code>https://www.factorio.com/download</code><br />
<br />
The selectors used to retrieve version numbers and build combinations are presented below, but they are probably obsolete. I will check them later and update this section accordingly.<br />
* CSS1: <code>h3</code><br />
* XPATH1: <code>//h3</code><br />
<br />
A list of available update packages is provided at <code>https://updater.factorio.com/get-available-versions</code>.<br />
<br />
{{Languages}}[[Category:Technical]]</div>Vinzenzhttps://wiki.factorio.com/index.php?title=Factorio_HTTP_API_usage_guidelines&diff=187903Factorio HTTP API usage guidelines2022-01-21T09:43:26Z<p>Vinzenz: inital guidelines</p>
<hr />
<div>== General ==<br />
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community.<br />
We ask developers to:<br />
* ensure user privacy, e.g. by properly securing account secrets like passwords or tokens.<br />
* respect server resources, e.g. by using exponential backoff in case of errors.<br />
* communicate that their tool/library is in no way sanctioned by Wube Software.<br />
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.<br />
<br />
== Categories ==<br />
=== Internal ===<br />
* These APIs are only supported for use with the official Factorio game clients or websites.<br />
* Up-to-date documentation is not guaranteed.<br />
* We strive to support very old Factorio releases, so these APIs won't change much most of the time.<br />
<br />
=== Public ===<br />
* These APIs are intended to support developers building integrations with the official Factorio game clients or websites.<br />
* Documentation will be kept up-to-date.<br />
* Breaking changes to these APIs are communicated in a reasonable timeframe.<br />
<br />
== APIs ==<br />
=== Internal ===<br />
* https://wiki.factorio.com/Download_API<br />
* https://wiki.factorio.com/Matchmaking_API<br />
* https://wiki.factorio.com/Mod_portal_API<br />
* https://wiki.factorio.com/Web_authentication_API<br />
<br />
=== Public ===<br />
Stay tuned...</div>Vinzenz