Debug
Documentation
Download
Mod version
1.3.0
Last updated
July 15, 2019
Game Version
1.52.100.1020
Overview Files Requirements Issues Changes Development

Debug is a mod that allows creators to get a better picture of how things go wrong in their mods. It works to accomplish this by enabling built in logging system latent in The Sims 4. With this mod in the hands of a regular user, it would allow them to send mod creators potentially far more detailed reports in the event they encounter an unexpected problem.

Features

  • Enables the logging of reports with the severity of "error", "warning" and more, instead of just "exception".
  • Reports are written to XML files and are easy to read by human or machines.
  • Settings changeable in-game that allow you to change how rigorous logging is, or to even disable it all together.

Mod Links

Documentation - https://doc.mods.neonoceancreations.com/s4/debug
Sources Repository - https://github.com/NeonOcean/Debug

This mod is reliant on one or more other mods to function, check the requirements tab to download these.

Installer (Windows Only)
Download
An executable to automatically place this mod in The Sims 4 mod folder. You would want to use the installer if you want to expend minimal effort to setup this mod. It can do some nifty stuff like uninstalling any old versions, and automatically enabling mods if you wish. This can currently only run on Windows computers.
Files (Manual Installation)
Download
The mod files contained in a zip folder. Download this if you would like to install the mod manually or you can't use the installer. If you need assistance installing this mod, a guide can be found in the mod's documentation.
Sources
Download
The source code and other raw files used to make this mod. You should only download this if you know what you are doing.
If you would like to download outdated versions of this mod you can do so here:
Previous versions

Required Mods

  • Main by NeonOcean - This mod contains many tools required for this mod to function.

Recommended Mods

  • Order by NeonOcean - A mod that controls the order in which mods are loaded, This mod is not necessary, but without it, the start up of some mods will be missed by Debug's watch.

Incompatible Mods

  • Sims Log Enabler by Scumbumbo - This mod is completely incompatible as it entirely replaces functions in The Sims 4's logging system instead of patching them. This is not a horrible problem though as the mod is inferior to Debug, there will be no loss in functionality if you use Debug as a replacement.

Bugs

This mod has no known bugs.


Reporting Issues

If you are experiencing unexpected problems with this mod you can report your troubles via this mod's Github page. Be sure to check the mod's documentation to learn the proper procedure for reporting bugs.

https://github.com/NeonOcean/Debug/issues
Bug reporting guide

Change Log


v1.3.0 (July 15, 2019)

Changes

  • All of Debug's interactions will now only show up when clicking on Sims instead of everything.

v1.2.0 (June 12, 2019)

New Features

  • Exceptions will now be logged for reports that are below the level 'exception', even though they aren't directly passed to the log functions.

Changes

  • Dumped logging mod settings, this also required the unification the continuous and burst log level and log interval settings.
  • Updated setting dialogs to work with the new system in Main.

Fixed Bugs

  • Fixed a few problems with debug session files.
  • Fixed problems with write failure notifications.
  • Changing logging interval values no longer causes problems in writing log files.
  • Log group folders are now created as they should have been, this previously prevented the usage of the write groups setting.

v1.1.0 (March 26, 2019)

  • Log files now have a root element, as XML files are suppose to.
  • Extra new line and indentation characters that are added to log files for readability are now commented out.
  • Users will now be notified of errors that prevented logging new reports.
  • In-game notifications will now appear telling you when an update is available.
  • Interactions now exist that can direct you to web pages relevant to this mod, such as the documentation.
  • Addition and removal of this mod are can now be facilitated through an installer or uninstaller. These currently are only usable on windows computers.

v1.0.0 (July 26, 2018)

  • Initial release

Plans

Debugger Support (Status: Idea)

  • Would allow The Sims 4's python to connect to popular python debuggers.

Create Stubs From Built-In Python Modules (Status: Idea)

  • Could automatically read the structure of The Sims 4's built-in Python modules and output it as a stub module file.