Modding:Modder Guide/APIs/Console - Revision history

imported>Sunbeam135 at 19:32, 9 January 2026

2026-01-09T19:32:02Z

← Older revision		Revision as of 19:32, 9 January 2026
Line 61:		Line 61:
	* [[Modding:Modder Guide/APIs/Logging\|Logging API]]		* [[Modding:Modder Guide/APIs/Logging\|Logging API]]

			[[ru:Модификации:Руководство мододела/API/Консоль]]
	[[zh:模组:制作指南/APIs/Console]]		[[zh:模组:制作指南/APIs/Console]]

imported>Margotbean at 17:18, 3 April 2024

2024-04-03T17:18:17Z

← Older revision		Revision as of 17:18, 3 April 2024
Line 60:		Line 60:
	* [[Modding:Modder Guide/APIs/Integrations\|Integration APIs]]		* [[Modding:Modder Guide/APIs/Integrations\|Integration APIs]]
	* [[Modding:Modder Guide/APIs/Logging\|Logging API]]		* [[Modding:Modder Guide/APIs/Logging\|Logging API]]

			[[zh:模组:制作指南/APIs/Console]]

imported>Pathoschild: /* See also */ + logging API

2023-05-09T19:02:07Z

imported>AlSweigart: /* Add a custom command */ Fixed a typo in the code: money should be Money.

2022-02-25T21:12:32Z

Add a custom command: Fixed a typo in the code: money should be Money.

← Older revision		Revision as of 21:12, 25 February 2022
Line 39:		Line 39:
	private void SetMoney(string command, string[] args)		private void SetMoney(string command, string[] args)
	{		{
	Game1.player.~~money~~ = int.Parse(args[0]);		Game1.player.Money = int.Parse(args[0]);
	this.Monitor.Log($"OK, set your money to {args[0]}.", LogLevel.Info);		this.Monitor.Log($"OK, set your money to {args[0]}.", LogLevel.Info);
	}		}

imported>Pathoschild: /* Intro */ clarify screenshot shows non-developer mode

2022-02-25T18:34:17Z

Intro: clarify screenshot shows non-developer mode

← Older revision		Revision as of 18:34, 25 February 2022
Line 7:		Line 7:
	The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <samp>help</samp> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.		The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <samp>help</samp> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.

	[[File:smapi-console-window.png\|thumb\|none\|The SMAPI console window with ~~some~~ example mods.]]		[[File:smapi-console-window.png\|thumb\|none\|The SMAPI console window with example mods (for the non-developer version of SMAPI).]]

	==Add a custom command==		==Add a custom command==

imported>Pathoschild: /* Intro */ use image thumbnail format

2022-02-25T18:31:20Z

Intro: use image thumbnail format

← Older revision		Revision as of 18:31, 25 February 2022
Line 7:		Line 7:
	The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <samp>help</samp> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.		The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <samp>help</samp> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.

	~~The SMAPI console window looks like this:~~		[[File:smapi-console-window.png\|thumb\|none\|The SMAPI console window with some example mods.]]

	[[File:smapi-console-window.png\|~~400px~~]]

	==Add a custom command==		==Add a custom command==

imported>AlSweigart: /* Intro */ Changing the size of the smapi console window screenshot to be smaller and fit the page better.

2022-02-25T18:24:48Z

Intro: Changing the size of the smapi console window screenshot to be smaller and fit the page better.

← Older revision		Revision as of 18:24, 25 February 2022
Line 9:		Line 9:
	The SMAPI console window looks like this:		The SMAPI console window looks like this:

	[[File:smapi-console-window.png]]		[[File:smapi-console-window.png\|400px]]

	==Add a custom command==		==Add a custom command==

imported>AlSweigart: /* Intro */ Adding a screenshot of the smapi console window for more immediate recognition.

2022-02-25T18:21:48Z

Intro: Adding a screenshot of the smapi console window for more immediate recognition.

← Older revision		Revision as of 18:21, 25 February 2022
Line 6:		Line 6:
	==Intro==		==Intro==
	The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <samp>help</samp> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.		The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <samp>help</samp> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.

			The SMAPI console window looks like this:

			[[File:smapi-console-window.png]]

	==Add a custom command==		==Add a custom command==

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:48:11Z

Text replacement - "tt>" to "samp>"

← Older revision		Revision as of 18:48, 4 November 2021
Line 5:		Line 5:
	__TOC__		__TOC__
	==Intro==		==Intro==
	The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <tt>help</tt> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.		The SMAPI console is the window that opens alongside the game, which displays messages from SMAPI and mods in a text-only format. Players can enter commands directly into that window to interact with mods. For example, you can type <samp>help</samp> to see a list of available commands. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features in most cases.

	==Add a custom command==		==Add a custom command==
	Each console command must have:		Each console command must have:
	* A name which the player types to invoke the command.		* A name which the player types to invoke the command.
	* A description shown when the player uses the <tt>help</tt> command. This should explain what the command does, how to use it, and what arguments it accepts. The example below shows the recommended convention.		* A description shown when the player uses the <samp>help</samp> command. This should explain what the command does, how to use it, and what arguments it accepts. The example below shows the recommended convention.
	* The method to call when the command is entered.		* The method to call when the command is entered.

	This code creates a minimal <tt>player_setmoney</tt> command:		This code creates a minimal <samp>player_setmoney</samp> command:
	<syntaxhighlight lang="C#">		<syntaxhighlight lang="C#">
	/// <summary>The main entry point for the mod.</summary>		/// <summary>The main entry point for the mod.</summary>

imported>Shekurika at 23:24, 21 May 2021

2021-05-21T23:24:15Z

← Older revision		Revision as of 23:24, 21 May 2021
Line 38:		Line 38:
	{		{
	Game1.player.money = int.Parse(args[0]);		Game1.player.money = int.Parse(args[0]);
	this.Monitor.Log($"OK, set your money to {args[0]}.");		this.Monitor.Log($"OK, set your money to {args[0]}.", LogLevel.Info);
	}		}
	}		}

← Older revision		Revision as of 19:02, 9 May 2023
Line 59:		Line 59:
	==See also==		==See also==
	* [[Modding:Modder Guide/APIs/Integrations\|Integration APIs]]		* [[Modding:Modder Guide/APIs/Integrations\|Integration APIs]]
			* [[Modding:Modder Guide/APIs/Logging\|Logging API]]