Modding:Modder Guide/APIs/Logging - Revision history

imported>Margotbean: ru link

2026-01-07T18:53:21Z

ru link

← Older revision		Revision as of 18:53, 7 January 2026
Line 84:		Line 84:
	It's output to the game's <samp>ErrorLogs</samp> data folder. See [https://smapi.io/log/ smapi.io/log] for help finding the log file, and you can also upload your log there to see what it looks like. The log file is always created (even if there are no errors) and it's written continuously (so you don't need to exit the game to see the log so far).		It's output to the game's <samp>ErrorLogs</samp> data folder. See [https://smapi.io/log/ smapi.io/log] for help finding the log file, and you can also upload your log there to see what it looks like. The log file is always created (even if there are no errors) and it's written continuously (so you don't need to exit the game to see the log so far).

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

imported>Sunbeam135: /* Where is the log file created? */

2026-01-02T12:57:40Z

Where is the log file created?

← Older revision		Revision as of 12:57, 2 January 2026
Line 84:		Line 84:
	It's output to the game's <samp>ErrorLogs</samp> data folder. See [https://smapi.io/log/ smapi.io/log] for help finding the log file, and you can also upload your log there to see what it looks like. The log file is always created (even if there are no errors) and it's written continuously (so you don't need to exit the game to see the log so far).		It's output to the game's <samp>ErrorLogs</samp> data folder. See [https://smapi.io/log/ smapi.io/log] for help finding the log file, and you can also upload your log there to see what it looks like. The log file is always created (even if there are no errors) and it's written continuously (so you don't need to exit the game to see the log so far).

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

imported>Mahalo: /* Verbose logging */ config.user.json

2025-10-25T20:39:35Z

Verbose logging: config.user.json

← Older revision		Revision as of 20:39, 25 October 2025
Line 75:		Line 75:
	</syntaxhighlight>		</syntaxhighlight>

	Players can enable verbose logging by adding your mod ID to the <samp>VerboseLogging</samp> field in the <samp>smapi-internal/StardewModdingAPI.config.json</samp> file. For example, this enables it for SMAPI and Content Patcher:		Players can enable verbose logging by adding your mod ID to the <samp>VerboseLogging</samp> field in the <samp>smapi-internal/StardewModdingAPI.config.json</samp> (or <samp>smapi-internal/config.user.json</samp> file. For example, this enables it for SMAPI and Content Patcher:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="js">
	"VerboseLogging": [ "SMAPI", "Pathoschild.ContentPatcher" ],		"VerboseLogging": [ "SMAPI", "Pathoschild.ContentPatcher" ],

imported>VulpesLucida: zh link

2025-01-05T14:30:00Z

zh link

← Older revision		Revision as of 14:30, 5 January 2025
Line 83:		Line 83:
	===Where is the log file created?===		===Where is the log file created?===
	It's output to the game's <samp>ErrorLogs</samp> data folder. See [https://smapi.io/log/ smapi.io/log] for help finding the log file, and you can also upload your log there to see what it looks like. The log file is always created (even if there are no errors) and it's written continuously (so you don't need to exit the game to see the log so far).		It's output to the game's <samp>ErrorLogs</samp> data folder. See [https://smapi.io/log/ smapi.io/log] for help finding the log file, and you can also upload your log there to see what it looks like. The log file is always created (even if there are no errors) and it's written continuously (so you don't need to exit the game to see the log so far).

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

imported>Pathoschild: /* Verbose logging */ add example config

2023-05-09T19:04:54Z

Verbose logging: add example config

← Older revision		Revision as of 19:04, 9 May 2023
Line 63:		Line 63:

	===Verbose logging===		===Verbose logging===
	You can have messages appear in the log (and console in the ''for developers'' version) only if SMAPI's verbose logging option is enabled. This is meant for diagnostic information that's sometimes needed to troubleshoot, but doesn't need to be logged in most cases~~. Players can enable verbose logging by editing the <samp>smapi-internal/StardewModdingAPI.config.json</samp> file~~.		You can have messages appear in the log (and console in the ''for developers'' version) only if SMAPI's verbose logging option is enabled. This is meant for diagnostic information that's sometimes needed to troubleshoot, but doesn't need to be logged in most cases.

	There are two ways to use it:		There are two ways to use it:
Line 73:		Line 73:
	if (this.Monitor.IsVerbose)		if (this.Monitor.IsVerbose)
	this.Monitor("This will only appear if verbose logging is enabled.", LogLevel.Trace);		this.Monitor("This will only appear if verbose logging is enabled.", LogLevel.Trace);
			</syntaxhighlight>

			Players can enable verbose logging by adding your mod ID to the <samp>VerboseLogging</samp> field in the <samp>smapi-internal/StardewModdingAPI.config.json</samp> file. For example, this enables it for SMAPI and Content Patcher:
			<syntaxhighlight lang="js">
			"VerboseLogging": [ "SMAPI", "Pathoschild.ContentPatcher" ],
	</syntaxhighlight>		</syntaxhighlight>

imported>AlSweigart: /* Overview */ Adding a small note about the colorful text in the SMAPI console window

2022-02-25T18:12:06Z

Overview: Adding a small note about the colorful text in the SMAPI console window

← Older revision		Revision as of 18:12, 25 February 2022
Line 26:		Line 26:
	<span style="color:red;">[18:00:00 ERROR NameOfMod] an error message</span>		<span style="color:red;">[18:00:00 ERROR NameOfMod] an error message</span>
	</div>		</div>

			The text won't appear in color in the log file, but will appear in color in SMAPI console window as the game runs.

	===Log levels===		===Log levels===

imported>Pathoschild: /* Log levels */ further clarify ALERT level

2022-02-25T17:02:59Z

Log levels: further clarify ALERT level

← Older revision		Revision as of 17:02, 25 February 2022
Line 51:		Line 51:
	\|-		\|-
	\| <samp>Alert</samp>		\| <samp>Alert</samp>
	\| Important information to highlight for the player when player action is needed (''e.g.,'' new version available). This should be used ~~rarely to avoid alert fatigue~~.		\| Important information to highlight for the player when player action is needed (''e.g.,'' new version available). This is mainly meant for SMAPI itself, and should almost never be used by mods.
	\|}		\|}

imported>Pathoschild: /* Logging */ restore colors (they're shown in the SMAPI console), copyedit (no need to repeat the log level name in each description), undo incorrect information (DEBUG level is shown to players, INFO isn't meant for "general events", and ALERT is definitely not for errors)

2022-02-25T16:55:52Z

Logging: restore colors (they're shown in the SMAPI console), copyedit (no need to repeat the log level name in each description), undo incorrect information (DEBUG level is shown to players, INFO isn't meant for "general events", and ALERT is definitely not for errors)

← Older revision		Revision as of 16:55, 25 February 2022
Line 17:		Line 17:
	</syntaxhighlight>		</syntaxhighlight>

	...will produce entries ~~in the log~~ with a timestamp, log level, name ~~of the mod writing the log entry~~, and ~~the log~~ message ~~itself~~:		...will produce log entries with a timestamp, log level, mod name, and message:

	<~~pre~~>		<div style="font-family: monospace;">
	[18:00:00 TRACE NameOfMod] a trace message		<span style="color:#666;">[18:00:00 TRACE NameOfMod] a trace message</span><br />
	[18:00:00 DEBUG NameOfMod] a debug message		<span style="color:#666;">[18:00:00 DEBUG NameOfMod] a debug message</span><br />
	[18:00:00 INFO NameOfMod] an info message		<span style="color:black;">[18:00:00 INFO NameOfMod] an info message</span><br />
	[18:00:00 WARN NameOfMod] a warning message		<span style="color:darkorange;">[18:00:00 WARN NameOfMod] a warning message</span><br />
	[18:00:00 ERROR NameOfMod] an error message		<span style="color:red;">[18:00:00 ERROR NameOfMod] an error message</span>
	</~~pre~~>		</div>

	===Log levels===		===Log levels===
Line 36:		Line 36:
	\|-		\|-
	\| <samp>Trace</samp>		\| <samp>Trace</samp>
	\| Tracing info is intended for developers, ~~and are~~ usually low-level troubleshooting details that are useful when someone sends you their error log. Trace messages won't appear in the console window by default (unless you have the "SMAPI for developers" version), though they're always written to the log file.		\| Tracing info intended for developers, usually low-level troubleshooting details that are useful when someone sends you their error log. Trace messages won't appear in the console window by default (unless you have the "SMAPI for developers" version), though they're always written to the log file.
	\|-		\|-
	\| <samp>Debug</samp>		\| <samp>Debug</samp>
	\| ~~Debug info contains troubleshooting~~ details that may be relevant to the ~~developer~~.		\| Troubleshooting details that may be relevant to the player.
	\|-		\|-
	\| <samp>Info</samp>		\| <samp>Info</samp>
	\| Info ~~messages are~~ relevant to the player~~, logging when general or higher-level events happen~~. This should be used judiciously.		\| Info relevant to the player. This should be used judiciously.
	\|-		\|-
	\| <samp>Warn</samp>		\| <samp>Warn</samp>
	\| ~~Warnings are for announcing potential~~ problems ~~that could happen~~ that the player should be aware of. This should be used rarely.		\| Potential problems that the player should be aware of. This should be used rarely.
	\|-		\|-
	\| <samp>Error</samp>		\| <samp>Error</samp>
	\| ~~Error messages describe a problem that happened or~~ something ~~that~~ went wrong.		\| A message indicating something went wrong.
	\|-		\|-
	\| <samp>Alert</samp>		\| <samp>Alert</samp>
	\| ~~Alerts are severe errors that the mod cannot recover from. They contain important~~ information to highlight ~~what~~ player action is needed (''e.g.,'' new version available). This should be used rarely to avoid alert fatigue.		\| Important information to highlight for the player when player action is needed (''e.g.,'' new version available). This should be used rarely to avoid alert fatigue.
	\|}		\|}

imported>AlSweigart: /* Log levels */ Adding more descriptive text to logging levels, some light copyediting.

2022-02-25T16:44:30Z

Log levels: Adding more descriptive text to logging levels, some light copyediting.

← Older revision		Revision as of 16:44, 25 February 2022
Line 36:		Line 36:
	\|-		\|-
	\| <samp>Trace</samp>		\| <samp>Trace</samp>
	\| Tracing info intended for developers, usually troubleshooting details that are useful when someone sends you their error log. Trace messages won't appear in the console window by default (unless you have the "SMAPI for developers" version), though they're always written to the log file.		\| Tracing info is intended for developers, and are usually low-level troubleshooting details that are useful when someone sends you their error log. Trace messages won't appear in the console window by default (unless you have the "SMAPI for developers" version), though they're always written to the log file.
	\|-		\|-
	\| <samp>Debug</samp>		\| <samp>Debug</samp>
	\| ~~Troubleshooting~~ info that may be relevant to the ~~player~~.		\| Debug info contains troubleshooting details that may be relevant to the developer.
	\|-		\|-
	\| <samp>Info</samp>		\| <samp>Info</samp>
	\| Info relevant to the player. This should be used judiciously.		\| Info messages are relevant to the player, logging when general or higher-level events happen. This should be used judiciously.
	\|-		\|-
	\| <samp>Warn</samp>		\| <samp>Warn</samp>
	\| ~~An issue~~ the player should be aware of. This should be used rarely.		\| Warnings are for announcing potential problems that could happen that the player should be aware of. This should be used rarely.
	\|-		\|-
	\| <samp>Error</samp>		\| <samp>Error</samp>
	\| ~~A message indicating~~ something went wrong.		\| Error messages describe a problem that happened or something that went wrong.
	\|-		\|-
	\| <samp>Alert</samp>		\| <samp>Alert</samp>
	\| ~~Important~~ information to highlight ~~for the player when~~ player action is needed (''e.g.,'' new version available). This should be used rarely to avoid alert fatigue.		\| Alerts are severe errors that the mod cannot recover from. They contain important information to highlight what player action is needed (''e.g.,'' new version available). This should be used rarely to avoid alert fatigue.
	\|}		\|}

imported>AlSweigart: /* Logging */ Adding more detail and taking out the colors because log files don't have colors.

2022-02-25T15:52:47Z

Logging: Adding more detail and taking out the colors because log files don't have colors.

← Older revision		Revision as of 15:52, 25 February 2022
Line 17:		Line 17:
	</syntaxhighlight>		</syntaxhighlight>

	will log ~~something like this~~:		...will produce entries in the log with a timestamp, log level, name of the mod writing the log entry, and the log message itself:

	<~~div style="font-family: monospace;"~~>		<pre>
	~~<span style="color:#666;">~~[18:00:00 TRACE ~~Mod Name~~] a trace message~~</span><br />~~		[18:00:00 TRACE NameOfMod] a trace message
	~~<span style="color:#666;">~~[18:00:00 DEBUG ~~Mod Name~~] a debug message~~</span><br />~~		[18:00:00 DEBUG NameOfMod] a debug message
	~~<span style="color:black;">~~[18:00:00 INFO ~~Mod Name~~] an info message~~</span><br />~~		[18:00:00 INFO NameOfMod] an info message
	~~<span style="color:darkorange;">~~[18:00:00 WARN ~~Mod Name~~] a warning message~~</span><br />~~		[18:00:00 WARN NameOfMod] a warning message
	~~<span style="color:red;">~~[18:00:00 ERROR ~~Mod Name~~] an error message~~</span>~~		[18:00:00 ERROR NameOfMod] an error message
	</~~div~~>		</pre>

	===Log levels===		===Log levels===