herbert lib

Requires MWSE

Update (25/08/04)

The things from this library that I think were good ideas (namely the MCM features and logging API) have been improved and merged into MWSE proper. As such, I will not be developing this library further and will try to shift away from it in my future mod releases. But it will remain on the nexus and I will release minor updates/bug fixes if the need arises. Also, if someone else wants to fork the library and/or use bits and pieces of it in their personal projects they are more than welcome.

Features

New Logger

Want to start logging? Type

local log = Herbert_Logger.new()

You can write debug/info/etc messages by typing log:info(message, ...), where the additional arguments get sent to `string.format`. Log messages are only shown at the appropriate log level.

Want to add log settings to your MCM? Type

log:add_to_MCM{component = my_page, config = my_config}

Nothing else is required, you can now start using the logger. (The add_to_MCM method will also update your current logging level when the MCM is created, so you don't have to set it manually. The logging level is also updated whenever the MCM setting is changed.)

Log messages are printed as

[<MOD_NAME> | <FILE_PATH>:<LINE_NUMBER | <LOG_LEVEL> | <TIMESTAMP>] <MESSAGE>

The <MOD_NAME> is taken from your mods metadata file, if it has one; otherwise, it's the mods root folder: e.g., "mods/herbert100/more quickloot", would get <MOD_NAME> = "more quickloot"

The <FILE_PATH> is taken relative to your mods "root" folder. So, "mods/herbert100/more quickloot/managers/pickpocket.lua" would be written as "managers/pickpocket.lua".

Here's an example of what this looks like in practice: the line

log("found tool")

written at line 117 of the "mods/herbert100/quick select/get_options.lua" file would be printed as

Here are some functionalities of this logger:

[]Your mod name will be automatically retrieved when creating new loggers. No need to specify it.

[]Each file gets its own logger, to make tracing back log messages easier.

[]Updating the settings of one logger will automatically update the settings of all other loggers registered to your mod

[]Line numbers are included in output.