03 03 Config logging

03 03 Config logging

This page explains Sprint Boost logging for everyday troubleshooting.

Logging is usually OFF (and that is normal)

For most normal play, logging is left off.

Turn logging on when you are troubleshooting, testing a new config change, or trying to understand why behavior is different than expected.

Why logging helps

Logging gives you a record of what Sprint Boost did during launch and gameplay setup, including:

• Sprint Boost launcher messages
• Emulator output (when enabled)

This is useful when you need to confirm what config loaded, what mode is active, and what happened during startup.

Basic logging config

[logging]
enabled = true
level = "DEBUG"
mode = "append"
path = "{usb_mount}/sprint_boost.log"

[logging.sources]
launcher = true
emulator = true

Where logging can be used

Logging settings are available in config processing for:

• boost_mode = "basic"
• boost_mode = "enhanced"

They are not relevant in pure passthrough behavior (boost_mode = "off").

Main settings

enabled

Turns logging on or off.

• Default: false
• If left out: logging stays off

enabled = true

path

Where the log file is written.

• Default: {usb_mount}/sprint_boost.log

path = "{usb_mount}/sprint_boost.log"

You can also write per-game logs:

path = "{game_folder}/{game_file}.log"

mode

What to do if the log file already exists.

• Default: overwrite
• overwrite: start fresh each run
• append: keep old content and add new sessions at the end

mode = "append"

level

How much detail Sprint Boost writes.

• Default: INFO
• Common troubleshooting choice: DEBUG

level = "DEBUG"

logging.sources

Choose message sources to include.

• launcher (default: true)
• emulator (default: true)

[logging.sources]
launcher = true
emulator = true

Default behavior summary

If you do not define a [logging] section:

• Logging remains off (enabled = false)
• No log file is created for that run

If you enable logging but leave other values out:

• path defaults to {usb_mount}/sprint_boost.log
• mode defaults to overwrite
• level defaults to INFO
• sources.launcher and sources.emulator default to true

Overrides (folder-level vs game-level)

Logging follows normal config precedence:

• Folder-level config can define your default logging behavior
• Game-level config can change it for one game

Example idea:

• Folder-level: logging enabled to a shared file
• Game-level: different path, or enabled = false

Result:

• That game uses the game-level logging behavior
• Other games keep folder-level behavior

Recommended workflow

1. Keep logging off for normal use
2. Turn it on when troubleshooting
3. Use level = "DEBUG" while diagnosing
4. Turn logging back off when done

Quick troubleshooting checklist

• No log file created?
  • Confirm enabled = true
  • Confirm your path points to a valid location
  • Check for config structure/syntax issues that may prevent logging settings from loading at startup
  • If so, validate base TOML structure first, especially general settings, [global_variables], and [logging]
• Logs exist but missing useful detail?
  • Set level = "DEBUG"
  • Confirm [logging.sources] includes both launcher and emulator

Next step

Continue to:

• 03 04 Config jzintv_flags