Mod details API - Revision history

Ickputzdirwech: Removed {{Languages}}

2023-11-12T09:06:57Z

Removed {{Languages}}

← Older revision		Revision as of 09:06, 12 November 2023
Line 187:		Line 187:
	</syntaxhighlight>		</syntaxhighlight>

	~~{{Languages}}~~[[Category:Technical]]		[[Category:Technical]]

Vinzenz at 10:52, 5 May 2023

2023-05-05T10:52:54Z

← Older revision		Revision as of 10:52, 5 May 2023
Line 83:		Line 83:
	\|-		\|-
	\|<code><empty string></code>\|\| No category		\|<code><empty string></code>\|\| No category
			\|-
			\|<code>no-category</code>\|\| No category
	\|-		\|-
	\|<code>content</code>\|\| Content \|\| Mods introducing new content into the game.		\|<code>content</code>\|\| Content \|\| Mods introducing new content into the game.

Vinzenz at 09:25, 20 December 2022

2022-12-20T09:25:48Z

← Older revision		Revision as of 09:25, 20 December 2022
Line 39:		Line 39:
	\| license \|\| enum, optional \|\| Mod license, see [[#License]]		\| license \|\| enum, optional \|\| Mod license, see [[#License]]
	\|-		\|-
	\| homepage \|\| string, optional \|\| URL of mod homepage (URL must use <code>http</code> or <code>https</code> scheme)~~. Max~~ length 256		\| homepage \|\| string, optional \|\| URL of mod homepage (URL must use <code>http</code> or <code>https</code> scheme), max length 256
	\|-		\|-
	\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings		\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings
	\|-		\|-
	\| source_url \|\| string, optional \|\| URL of mod source code repository (URL must use <code>http</code> or <code>https</code> scheme)		\| source_url \|\| string, optional \|\| URL of mod source code repository (URL must use <code>http</code> or <code>https</code> scheme), max length 256
	\|-		\|-
	\| faq \|\| string, optional \|\| FAQ for the mod in markdown format		\| faq \|\| string, optional \|\| FAQ for the mod in markdown format

Vinzenz: fix error in python example

2022-12-20T08:29:27Z

fix error in python example

← Older revision		Revision as of 08:29, 20 December 2022
Line 173:		Line 173:
	modname = getenv("MOD_NAME")		modname = getenv("MOD_NAME")

	request_body ~~= data~~ = {"mod": modname, "faq": "# hello world", tags=["power", "storage"], category="tweaks"}		request_body = {"mod": modname, "faq": "# hello world", "tags": ["power", "storage"], "category": "tweaks"}
	request_headers = {"Authorization": f"Bearer {apikey}"}		request_headers = {"Authorization": f"Bearer {apikey}"}

Vinzenz: Document new categories and tags

2022-12-19T10:11:35Z

Document new categories and tags

← Older revision		Revision as of 10:11, 19 December 2022
Line 34:		Line 34:
	\|-		\|-
	\| category \|\| enum, optional \|\| Mod category, see [[#Category]]		\| category \|\| enum, optional \|\| Mod category, see [[#Category]]
			\|-
			\| tags \|\| enum, optional, multiple possible \|\| Mod tags, see [[#Tags]]
	\|-		\|-
	\| license \|\| enum, optional \|\| Mod license, see [[#License]]		\| license \|\| enum, optional \|\| Mod license, see [[#License]]
Line 79:		Line 81:
	{\| class="wikitable"		{\| class="wikitable"
	! Value !! Name !! Description		! Value !! Name !! Description
	\|-
	~~\|<code><empty string></code>\|\| No category \|\|~~
	\|-
	~~\|<code>general</code>\|\| General \|\| Mods that cannot be sorted into other categories~~
	\|-		\|-
	\|<code>~~non-game-changing~~</code>\|\| ~~Non-Game-Changing \|\| Changes only look&feel. New graphics, new sounds, etc.~~		\|<code><empty string></code>\|\| No category
	\|-		\|-
	\|<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..~~.		\|<code>content</code>\|\| Content \|\| Mods introducing new content into the game.
	\|-		\|-
	\|<code>~~transportation~~</code>\|\| ~~Transportation~~ \|\| ~~Player transport~~		\|<code>overhaul</code>\|\| Overhaul \|\| Large total conversion mods.
	\|-		\|-
	\|<code>~~logistics~~</code>\|\| ~~Logistics~~ \|\| ~~Transport of materials~~		\|<code>tweaks</code>\|\| Tweaks \|\| Small changes concerning balance, gameplay, or graphics.
	\|-		\|-
	\|<code>~~utility~~</code>\|\| ~~Utility~~ \|\| ~~Helps~~ with ~~certain things~~ the ~~player is doing~~.		\|<code>utilities</code>\|\| Utilities \|\| Providing the player with new tools or adjusting the game interface, without fundamentally changing gameplay.
	\|-		\|-
	\|<code>~~balancing~~</code>\|\| ~~Balancing~~ \|\|		\|<code>scenarios</code>\|\| Scenarios \|\| Scenarios, maps, and puzzles.
	\|-		\|-
	\|<code>~~weapons~~</code>\|\| ~~Weapons~~ \|\|		\|<code>mod-packs</code>\|\| Mod packs \|\| Collections of mods with tweaks to make them work together.
	\|-		\|-
	\|<code>~~enemies~~</code>\|\| ~~Enemies~~ \|\|		\|<code>localizations</code>\|\| Localizations \|\| Translations for other mods.
	\|-		\|-
	\|<code>~~armor~~</code>\|\| ~~Armor~~ \|\| ~~Armors or armor equipment related~~.		\|<code>internal</code>\|\| Internal \|\| Lua libraries for use by other mods and submods that are parts of a larger mod.
	\|-		\|-
	\|~~<code>oil</code>~~\|~~\| Oil \|\| Things related to oil related manufacture~~		\|}

			=== Tags ===

			{\| class="wikitable"
			! Value !! Name !! Description
	\|-		\|-
	\|<code>~~logistic-network~~</code>\|\| ~~Logistic network~~ \|\| ~~Related to roboports and logistic robots~~		\|<code>transportation</code>\|\| Transportation \|\| Transportation of the player, be it vehicles or teleporters.
	\|-		\|-
	\|<code>~~circuit-network~~</code>\|\| ~~Circuit network~~ \|\|		\|<code>logistics</code>\|\| Logistics \|\| Augmented or new ways of transporting materials - belts, inserters, pipes!
	\|-		\|-
	\|<code>~~storage~~</code>\|\| ~~Storage~~ \|\|		\|<code>trains</code>\|\| Trains \|\| Trains are great, but what if they could do even more?
	\|-		\|-
	\|<code>~~power-production~~</code>\|\| ~~Power production~~ \|\|		\|<code>combat</code>\|\| Combat \|\| New ways to deal with enemies, be it attack or defense.
	\|-		\|-
	\|<code>~~manufacture~~</code>\|\| ~~Manufacture~~ \|\| ~~Furnaces, assembling machines, production chains~~		\|<code>armor</code>\|\| Armor \|\| Armors or armor equipment.
	\|-		\|-
	\|<code>~~blueprints~~</code>\|\| ~~Blueprints~~ \|\|		\|<code>enemies</code>\|\| Enemies \|\| Changes to enemies or entirely new enemies to deal with.
	\|-		\|-
	\|<code>~~cheats~~</code>\|\| ~~Cheats~~ \|\|		\|<code>environment</code>\|\| Environment \|\| Map generation and terrain modification.
	\|-		\|-
	\|<code>~~defense~~</code>\|\| ~~Defense~~ \|\|		\|<code>mining</code>\|\| Mining \|\| New Ores and resources as well as machines.
	\|-		\|-
	\|<code>~~mining~~</code>\|\| ~~Mining~~ \|\|		\|<code>fluids</code>\|\| Fluids \|\| Things related to oil and other fluids.
	\|-		\|-
	\|<code>~~environment~~</code>\|\| ~~Environment~~ \|\|		\|<code>logistic-network</code>\|\| Logistic network \|\| Related to roboports and logistic robots.
	\|-		\|-
	\|<code>~~info~~</code>\|\| ~~Info~~ \|\| ~~Mods that provide additional information to~~ the ~~player~~		\|<code>circuit-network</code>\|\| Circuit network \|\| Entities which interact with the circuit network.
	\|-		\|-
	\|<code>~~trains~~</code>\|\| ~~Trains~~ \|\|		\|<code>manufacturing</code>\|\| Manufacturing \|\| Furnaces, assembling machines, production chains.
	\|-		\|-
	\|<code>~~big-mods~~</code>\|\| ~~Big mods~~ \|\| ~~Too big~~ and~~/or changes too much of the game to be fit anywhere else~~		\|<code>power</code>\|\| Power \|\| Changes to power production and distribution.
	\|-		\|-
	\|<code>~~scenarios~~</code>\|\| ~~Scenarios~~ \|\| ~~Story mode campaigns on a premade map~~		\|<code>storage</code>\|\| Storage \|\| More than just chests.
	\|-		\|-
	\|<code>~~mod-packs~~</code>\|\| ~~Mod packs~~ \|\| ~~Collections of mods with tweaks to make them work together!~~		\|<code>blueprints</code>\|\| Blueprints \|\| Change blueprint behavior.
	\|-		\|-
	\|<code>~~libraries~~</code>\|\| ~~Libraries~~ \|\| ~~Mods used by other mods~~		\|<code>cheats</code>\|\| Cheats \|\| Play it your way.
	\|-		\|-
	\|}		\|}

	=== License ===		=== License ===

Line 169:		Line 173:
	modname = getenv("MOD_NAME")		modname = getenv("MOD_NAME")

	request_body = data = {"mod": modname, "faq": "# hello world"}		request_body = data = {"mod": modname, "faq": "# hello world", tags=["power", "storage"], category="tweaks"}
	request_headers = {"Authorization": f"Bearer {apikey}"}		request_headers = {"Authorization": f"Bearer {apikey}"}

Bilka: added info on restrictions for multiple properties in the body

2022-12-07T17:46:55Z

added info on restrictions for multiple properties in the body

← Older revision		Revision as of 17:46, 7 December 2022
Line 27:		Line 27:
	\| mod \|\| string, mandatory \|\| Internal name of the mod whose details are to be changed		\| mod \|\| string, mandatory \|\| Internal name of the mod whose details are to be changed
	\|-		\|-
	\| title \|\| string, optional \|\| Display name of the mod		\| title \|\| string, optional \|\| Display name of the mod. Min length 1, max length 250
	\|-		\|-
	\| summary \|\| string, optional \|\| Short description of the mod		\| summary \|\| string, optional \|\| Short description of the mod. Max length 500
	\|-		\|-
	\| description \|\| string, optional \|\| Long description of the mod in markdown format		\| description \|\| string, optional \|\| Long description of the mod in markdown format
Line 37:		Line 37:
	\| license \|\| enum, optional \|\| Mod license, see [[#License]]		\| license \|\| enum, optional \|\| Mod license, see [[#License]]
	\|-		\|-
	\| homepage \|\| string, optional \|\| URL of mod homepage		\| homepage \|\| string, optional \|\| URL of mod homepage (URL must use <code>http</code> or <code>https</code> scheme). Max length 256
	\|-		\|-
	\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings		\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings
	\|-		\|-
	\| source_url \|\| string, optional \|\| URL of mod source code repository		\| source_url \|\| string, optional \|\| URL of mod source code repository (URL must use <code>http</code> or <code>https</code> scheme)
	\|-		\|-
	\| faq \|\| string, optional \|\| FAQ for the mod in markdown format		\| faq \|\| string, optional \|\| FAQ for the mod in markdown format

Justarandomgeek: another one

2022-09-21T14:17:41Z

another one

← Older revision		Revision as of 14:17, 21 September 2022
Line 41:		Line 41:
	\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings		\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings
	\|-		\|-
	\| source_url \|\| ~~strong~~, optional \|\| URL of mod source code repository		\| source_url \|\| string, optional \|\| URL of mod source code repository
	\|-		\|-
	\| faq \|\| string, optional \|\| FAQ for the mod in markdown format		\| faq \|\| string, optional \|\| FAQ for the mod in markdown format

Justarandomgeek: typo strong -> string

2022-09-21T14:17:15Z

typo strong -> string

← Older revision		Revision as of 14:17, 21 September 2022
Line 37:		Line 37:
	\| license \|\| enum, optional \|\| Mod license, see [[#License]]		\| license \|\| enum, optional \|\| Mod license, see [[#License]]
	\|-		\|-
	\| homepage \|\| ~~strong~~, optional \|\| URL of mod homepage		\| homepage \|\| string, optional \|\| URL of mod homepage
	\|-		\|-
	\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings		\| deprecated \|\| bool, optional \|\| Deprecated flag to hide mod from public listings
Line 57:		Line 57:
	\| message \|\| string \|\| This attribute only appears on <strong>failed</strong> requests. Has details about the problem.		\| message \|\| string \|\| This attribute only appears on <strong>failed</strong> requests. Has details about the problem.
	\|}		\|}

	== Possible API Error Responses ==		== Possible API Error Responses ==
	Possible values for the <code>error</code> property of API responses		Possible values for the <code>error</code> property of API responses

Vinzenz at 15:30, 26 July 2022

2022-07-26T15:30:45Z

← Older revision		Revision as of 15:30, 26 July 2022
Line 1:		Line 1:
	<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#~~Experimental~~\|~~Experimental~~ API]]</div>		<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public\|Public API]]</div>

	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.		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.

Vinzenz at 15:28, 26 July 2022

2022-07-26T15:28:40Z

← Older revision		Revision as of 15:28, 26 July 2022
Line 163:		Line 163:

	MOD_PORTAL_URL = "https://mods.factorio.com"		MOD_PORTAL_URL = "https://mods.factorio.com"
	EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/~~experimental~~/mods/edit_details"		EDIT_MOD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/edit_details"

	apikey = getenv("MOD_EDIT_API_KEY")		apikey = getenv("MOD_EDIT_API_KEY")