Hud Console Readout Activated
Welcome to Hud Console Readout Activated Mod!
UPDATE 18/03/16:
Wolfpack has created a similar mod which is much more advanced than this and looks pretty awesome. You can find it here:
http://www.nexusmods.com/witcher3/mods/934
I'll leave my mod up for a couple of days before closing it outright as it effectively is doing the same thing.
Cheers!
V
=============================================================================================
Phew! That was a mouthful! Apologies, I'm trying to make the title sound meaningful!
This mod activates and makes useable the built in hud console readout which is intended to show realtime text-based information about what is going on in the world. In the vanilla game this flashes up for less than a second, displaying a couple of lines of messages which disappear far too quickly to be of any use.
No longer.
The readout now displays 10 lines of data for 5 seconds in a stream which gives players more than enough time to analyse what is going on.
In the vanilla game the amount of info displayed is fairly limited, however where this tweak really comes into its own is by providing modders with the information they need to display their own realtime telemetry data onscreen. An added bonus is that it's flexible and extremely easy to use!
The 2 key uses for this are:
1 - Giving players realtime, dynamic and verbose information about what is going on at any point in time during the game.
2 - A tool for providing feedback onscreen for debugging - I can't stress how handy this is for coders. One of my personal bugbear's was trying to mod 'blind' as to what is actually going on.
Anyway, I hope folks find this a useful addition to their mod list!
Enjoy!
Vahndaar**NOTE: When the readout gets backed up with more than 10 messages, it'll pause before continuing. This is known behaviour and I'm not planning on changing it. I've tested various different settings and there's a trade off between having a pause and messages zipping past too quick. I opted to give users slightly more time to see what's going on.
COMPATIBILITY NOTE: This mod was built using V1.12 of the game. I can't vouch for backwards compatibility.****=============================================================================================**Installation
=============================================================================================
- Select and download the package(s) you want from the 'files' tab
- Open the .rar file and find the folder beginning 'mod' (lowercase)
- Copy this folder to the 'mods' directory in your Witcher 3 root folder
=============================================================================================
**=============================================================================================**Change Log
=============================================================================================
UPDATE V0.1 - Initial Release****Initial release with core mod and test mod.
**=============================================================================================Packages=============================================================================================**There are 2 components which I've uploaded:
modActivatedConsoleReadoutThis is the core mod. This will 'activate' the hud console readout so that players and users can actually see information that is displayed by the game. This information is primarily combat related but nonetheless it enables the proper functionality needed for anyone to use the console readout.
modActivatedConsoleReadoutTESTOk, so I wanted to show the kind of thing that the readout can be used for. So I did a bit of digging and enabled the ingame logging which CDPR had already implemented, however I redirected the telemetry output for combat to the hud console readout. Now, I know that this is complete overkill and that your readout will be completely bombarded with stats which show, in detail, each and every step and calculation the game is going through when performing combat calculations. But I indended this to be a bit of a demo for modders to show what can be done. So it's not supposed to be functional.
However, the data junkie in me quite likes this kind of stuff, so I may consider doing a version which tones the detail back a bit if folks want it.
**=============================================================================================Usage - For Modders & Tweakers=============================================================================================**Basic mod usage is the same as any other mod, but if you want to use the console readout in your code, then you need the following simple magic functions:
IN CODE:
theGame.witcherLog.AddMessage("YOUR_MESSAGE_HERE")
**IN DEBUG CONSOLE:**HudConsoleMsg ('YOUR_MESSAGE_HERE')
The beauty of these is that CDPR already implemented them and they just work! Just note that the debug console uses single inverted commas - ' -, not double - ".
**=============================================================================================**ModCompatibility
=======================================================================================
This mod alters the following files, so users will need to script merge where mods share these files:
r4Game.ws
hudModuleConsole.ws
It also modifies hud.redswf, which is often modified by any other mod which touches the hud or GUI; however I haven't experienced any conflicts.