ConScribe
Console Logging and Log Functions for the Masses
version 9.0

Requires http://obse.silverlock.org/


Download : http://www.tesnexus.com/downloads/file.php?id=26510


Description

Bah ! These useless mod authors are always asking for something or the other when it comes to bug reports. Load order, OBSE version, bashed patch status, sixual orientation, Oblivion version and non-existent error logs to name a few. Bah !

May your head fall off at an awkward moment if such a thought were to ever pass through it, verbatim or otherwise.

Until then, consider using ConScribe ?



Fine Print

ConScribe is an OBSE plugin that supersedes speedo's long-since-gone Console Logger. It logs all console output to text files for later reviewing, including those typed in by the player. It removes the need for modders to adopt independent logging functions.

ConScribe supports 3 logging modes:

• Per Game Load; and
  
• Per Game Session
  
• Static Logging

Per Game Load creates a new log every time a game is loaded. Per Game Session creates a single log file on game start and appends all logged output to it, for the length of the session. Subsequent game loads are delimited by their instance (nth game load) and time of loading. Static logging behaves like Per Game session but uses a static log ( Static Log.log ).

Console logs are saved to a folder named "ConScribe Logs" in your Oblivion root directory and each log is named in accordance to the time of its creation.

ConScribe also adds, as contradictory in terms as it may seem, independent log functions that allow mods to log output to text files. Output is primarily segregated into 2 types:

• Logs made per script – Output is grouped by the parent script
  
• Logs made per mod – Output is grouped by the parent mod

The primary output function Scribe is used to log all output. Mods may register logs using the RegisterLog function and then use Scribe to write to it. Registered logs can be unregistered using UnregisterLog. GetRegisteredLogNames returns the names of the calling mod's registered logs. The contents of registered logs may be read using the ReadFromLog function.

An INI file of the same name is created in the same directory as the plugin, on first run. Logging modes can be switched by changing the ScribeMode INI key's value. Usable Modes/Values:

• PerLoad - Per Game Load
  
• PerSession - Per Game Session
  
• Static – Static Logging

String INI values are case-insensitive. The plugin needs a valid logging mode to work. The other INI options include:

• TimeFormat – The format string used to generate log headers.
  
• Includes/Excludes - Message filtering strings. Includes-keywords must be present in a console message to be logged. Similarly, Excludes-keywords mustn’t be present in the console message if it has to be logged. Multiple keywords should be separated by a semi-colon. [ Example – osr;piiip;error; ]
  
• LogBackups – Number of log file ( only those in the Per-Mod and Per-Script folders ) backups kept by the plugin. A value of -1 will enable append mode for the logs, similar to the Static Log. A maximum of 5 backups are allowed.
  
• RootDirectory – The path to the directory in which ConScribe stores its logs. A value of Default is equivalent to the path of Oblivion’s Data directory.

Command List

Scribe - Primary output function. Prints output to a log file and, optionally, to the console.
(nothing) Scribe formatString:string var1 var2 ... var20 printToConsole:bool

RegisterLog - Registers a log name with the calling mod.
(nothing) RegisterLog formatString:string var1 var2 ... var20 defaultFlag:bool

UnregisterLog - Unregisters the calling mod's log, if any.
(nothing) UnregisterLog formatString:string var1 var2 ... var20 defaultFlag:bool deleteLog:bool

GetRegisteredLogName - Retrieves the calling mod's registered log. Returns "null" if there isn't any.
(logName:string) GetRegisteredLogName

ReadFromLog – Retrieves the log's contents.
(logContents:array) ReadFromLog formatString:string var1 var2 ... var20

DeleteSliceFromLog – Deletes a slice of lines for a registered log.
(result:int) DeleteLinesFromLog formatString:string var1 var2 ... var20 lowerLimit:int upperLimit:int

GetLogLineCount - Returns the number of lines of text in the registered log.
(lineCount:int) GetLogLineCount formatString:string var1 var2 ... var20


Detailed command list - http://cs.elderscrolls.com/constwiki/index.php/Category:ConScribe



Compatibility

This plugin is compatible with every other OBSE plugin with the exception of ConLog (Console Logger). Using both at once will create duplicate logs.



Credits

Special thanks to :

• Ian Patterson, Stephen Abel and Paul Connelly (The OBSE Team) – For keeping up the Oblivion Modding spirit and providing the modding community with TES4 Oblivion's Elixir of Immortality. And for the API.
  
• LHammonds – For his Readme generator
  
• Speedo – For releasing the first console logger
  
• Scruggsywuggsy the ferret – For lots of stuff
  
• Kyoma - For spamming in the discussion thread

The Entire Community around the TES Construction Set Wiki – For making such an exhaustive resource catering to ES Modding.
The Folks at the Construction Set Forums – For all their help, rum and fish.
The Rest of the Modding Community – For the inspiration I needed to start modding and all the wonderful mods which I use.
Bethesda – For providing a great game, with enough flaws to keep us busy.



Change Log



Mods that use ConScribe

• http://www.gamesas.com/index.php?/topic/1088059-relz-refscope-20/
  
• http://www.gamesas.com/index.php?showtopic=1068205

http://github.com/shadeMe/ConScribe

Oh god, it's like a flood of useful mods and utilities! D:

This should prove useful whenever... things go... drastically wrong.

IMMEDIATE add on. without much thought.

May be why i NEED this addon, but meh....

Ahem, the omod conversion data doesn't work. I do have OBSE 18beta3, but somehow OBMM doesn't accept it.

1. Extract this archive to any folder and then copy the contents to Oblivion's Data folder. You can delete the "omod conversion data" folder.

2. Configure the INI file

3. Start Oblivion Launcher, click Data Files, and enable ESP added by the mod.


Err, there's no ini nor esp on the package only 1 dll file.

Congratulations ShadeMe, this sounds Fantastic!

Downloading now!

a

Edit: Just tried it and I love it. What I missed with Console Logger was the ability to see what I typed into the console. This utility even logs that which I type. Fantastic Utitily ShadeMe!

a

There was an extra period in the script. Fixed now.

I'm sorry - I copied the readMe from another mod of mine Ignore the INI bit and the Launcher bit. Fixed.

Thanks to scruggs

Hi ShadeMe,

for my mod, FormID Finder, an consistent request is to write out the results to a log. Since my mod already writes everything out to the console, would you mind if I recommended your mod on my thread so that people know that they can use the ConScribe utility to save off the results of any FormID Finder results?

thanks
a

excellent work, shadeMe!
thanks!

:woot:

..We folks at craftybits appreciate this... very much.. you have.. no idea.
..
..
...I love you.. :hug:

I just realized something, with this plugin it is no longer required to make a screenshot of the console text. Now....we can make a screenshot of the log file.....

Not at all.

No ! I've heard of this radical new method that poses to supersede that technique. It's called the Copy/Paste technique ( yeah, silly name, I know ) and it lets you replicate the text to any compatible destination. Fascinating, isn't it ?

Well, you folks got any ideas/functions I can add to the plugin ?

Could make it record console messages from specific mods. Like if your running DR and UV...and only record console messages from UV

Not yet. The hook's a direct one to the game code, so there isn't a way to get that info from it. I'll need a link to the console output functions to get the calling script. Nevertheless, OBSE 19 should allow creating logs specific to mods intrinsically.

Thanks ShadeMe, i've updated my OP!

thanks again for this tool, it is wonderful!
a

Wow, that's amazing. I never even heard of such a technology.

Awesome!

I missed downloading Console Logger for a day or two and, recently, I started using the OBSE log during my tests. But this would still need A LOT of converting.

ConScribe works like a charm and will save me some/a lot of debugging time.

But I have a request for you (pestering users . . . never satisfied!!): any chance of a (third) mode that keeps the same filename?
Reason is: Notepad++ has a handy feature of updating the file contents on the fly. While using the OBSE log for the last week or two, I kept it open in Notepad++ and when I exit the game (or even without exiting) I just alt-tab to Notepad++ and the new log is already there.
Quite handy when you do this every 5-10 minutes.
But not a big deal, anyway. ConScribe is great as is.

Thanks . Things will go faster, now.

Done !

http://www.tesnexus.com/downloads/file.php?id=26510

Version 2.0 is out !

Change Log

Hey, thanks! Even better, now.

To grab and wreck a big company's slogan --> Sense in simplicity , this will help tracing potential bugs.

Thanks for the tool!

I understand you are looking for new features to add? :hehe: How about the option to use 24-hour clock instead of the current AM/PM stuff? It makes finding the most recent file rather annoying.

:icecream: