Changes

</syntaxhighlight>

</syntaxhighlight>

will log something like this:

...will produce log entries with a timestamp, log level, mod name, and message:

<div style="font-family: monospace;">

<div style="font-family: monospace;">

<span style="color:#666;">[18:00:00 TRACE Mod Name] a trace message</span><br />

<span style="color:#666;">[18:00:00 TRACE NameOfMod] a trace message</span><br />

<span style="color:#666;">[18:00:00 DEBUG Mod Name] a debug message</span><br />

<span style="color:#666;">[18:00:00 DEBUG NameOfMod] a debug message</span><br />

<span style="color:black;">[18:00:00 INFO  Mod Name] an info message</span><br />

<span style="color:black;">[18:00:00 INFO  NameOfMod] an info message</span><br />

<span style="color:darkorange;">[18:00:00 WARN  Mod Name] a warning message</span><br />

<span style="color:darkorange;">[18:00:00 WARN  NameOfMod] a warning message</span><br />

<span style="color:red;">[18:00:00 ERROR Mod Name] an error message</span>

<span style="color:red;">[18:00:00 ERROR NameOfMod] an error message</span>

</div>

</div>

===Log levels===

===Log levels===

|-

|-

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

| Troubleshooting info that may be relevant to the player.

| Troubleshooting details that may be relevant to the player.

|-

|-

| <samp>Info</samp>

| <samp>Info</samp>

|-

|-

| <samp>Warn</samp>

| <samp>Warn</samp>

| An issue 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>

|-

|-

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

|}

|}

===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:

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>

</syntaxhighlight>