Improved TOEE Console output

This will interest the hard-core Modder. :rock:

Through a little detective work (OK, make that a *LOT* of detective work), I found out how to "fix" output of all the python "print" statements in all the scripting in TOEE to output to the console, as one MIGHT expect it to work in the first place.

I was in such a hurry to share this that, rather than create an entirely new patcher, I upgraded the PC Count patcher to add the functionality.

Just download http://files.co8.org/patch/TOEE_PCCount_Patcher_2.0.zip
then unzip the .exe and run it
You must click on Read PC Count, and navigate to the temple.dll
Then use the bottom two buttons to enable and disable "print" output to the console. (you need to "Read PC Count" every time you run the app, before choosing a bottom button, otherwise the buttons at the bottom won't do anything).

PLEASE NOTE: Having these enabled means LOTS of output (no wonder they turned it off ), and that means a slower running game. You should keep this output disabled for playing, and only enable it for development and debugging work.


Enjoy :doublethu


-- dulcaoin

 

Hm, that sounds very promising. Good stuff, dulcaoin! :doublethu

This will surely help the hardcore modders among us to find out a little bit more about how the game works.

I would prefer it if this functionality was available as a seperate download, though, to avoid confusion.

 

It's more than "how the game works", it will allow us (Liv) to output script values, output debugging info; it's a really powerful development tool for all scripting.

I'm at a crossroads, whether I want to issue myriad "small" patchers, or have one "Whole Enchilada" with all patches in the same app; one-stop-shopping basically. Admittedly, the existing app needs some UI work if I'm going the latter route; once I decide which way to go; I'll either move the functionality to a new app, or to a separate tab; I'll include lots more documentation in either case. Right now, I'm heading for "Whole Enchilada". There are ENOUGH places to look for patches as it is. I may try working out a way to switch this functionality (within temple.dll, not within the patcher) dependent on registry settings; that's the best route I think. We'll see...

-- dulcaoin


Edit: Also, need to mention: I kept both the older "1.2" version and the new "2.0" version present in the ftp area, so anyone patching for PC count via the "Fixed PC Count" thread will get a version that doesn't even mention this new functionality, and only "modders" following this thread will get the "new" version.

 

Yup, tell me about it. It's a crutial fix to helping scripters do better work.

 

So how does this wonder work?
All the noob modder sees when installed this patch is some obscure numbers being spammed in the in-game console.

That's the general problem - lack of detailed documentation about console and debugging features of ToEE. People who know a bit keep all to themselves, sometimes dropping a crumb as just to say "hah, I know and you don't, that makes me so l33t" and others just wander in darkness. Doing search about these things in this forum using different keywords produce some results, but mostly it is same things repeated over and over that everyone knows about - those basic cheat commands and so on.
For example, it might seem that some guys do know about debug output window and debug.txt, even if it isn't enabled by default, yet I haven't found anything to describe it directly.
I understand that peoples who find out something are too busy modding the game themselves to post faqs and stuff here, but you might wonder which would benefit everyone more.

 

Wow, Drifter. You're one of the more accomplished modders here; I'm surprised you're complaining about this. There's no need to be confrontational or insulting.

The python "print" command is sprinkled throughout the different scripts that have been supplied, especially the AI scripts. Up to now, those prints have gone into the "ether", because they were disabled en masse in the code to keep all that output processing from slowing down the application.

By using the patch, you direct all output from "print" to the console. Which means, while you're working on a given script, you can add your own print commands and use them to debug what you're doing. In most cases, you'd want to go back and comment out those commands in the end to reduce the "noise" to the console. In fact, it would not be a bad idea for "someone" to go out and disable most of the prints in most of the scripts, for the benefit of everyone -- note I said "disable", NOT remove.

If I knew what that series of numbers was (output from some script or other), I'd tell you. We're all still learning and working towards further knowledge. Up to now, this has been met with "excellent! let's keep up the fight!" rather than bemoaning that the knowledge isn't coming fast enough.

I would challenge YOU to doc the specific changes you've made in your patchers, in order to further the cause you're mentioning.

-- dulcaoin

 

Sorry if I sounded like I was bemoaning about the progress or even insulting, as I didn't mean that. I guess I should choose words more carefully, as english is not my native tongue. (Sometimes I wonder what's up with the people here, me included, who all get confrontational, as you say, at the mere sight of feedback which doesn't involve pointless hyping-up).

But I think the lack of documentation on modding stuff is a big problem, and that's what I meant. For beginners (me included) it usually means reinventing the bicycle over and over again (if that beginner is even lucky or skillful enough to suceed in that, otherwise he's discouraged to continue modding)... Even if one doesn't know it all, just some bits, sharing with others helps in solving puzzle from all these tiny pieces of knowledge everyone has.
Note that I don't necessarily direct all this at you personally. Nor do I blame anyone.

Thanks for clarification about the printing to console. Now I see there's more to this than those weird numbers

No. I know zilch about python and ToEE data structures, even if I know a thing or two about assembly. So definitely not accomplished and not even a modder to be honest Besides, maybe I wasn't speaking on my behalf, just expressing opinion of the average newb to ToEE scripting.

Well, that is a different matter, in most cases. If these changes are not customisable (as it is the case with bugfixes), or customisation only involves turning on/off within the patcher (MaxHP or NPC stuff - besides, these are really easy, and basically involves only simple nop'ing of code, so anyone familiar with ASM would know what is what after doing fc /b), what good would be these detailed descriptions of the code changes, especially when most people do not know ASM anyway?

 

Btw, you probably know this, but maybe most do not, as my search on this forum and web didn't return any exact results... so I guess I'll just post it in case anyone would be interested.

There is a Debug Output console window, with option to dump everything to debug.txt. It is not enabled by default of course. To enable, change system registry:

Code:

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Troika\TIG\Debug Output]
"console"=dword:00000001
"debugger"=dword:00000000
"file"=dword:00000001
"mono"=dword:00000000

Changing "console" flag to 0/1 turns off/on Debug Output window. Run game in window mode to see it. Lots of output really, including some from python scripts - return results of game flag and variables querries and stuff. Changing "file" flag turns off/on dumping of debug output to debug.txt file in gamedir. Not sure what "debugger" is for and no idea about "mono".

 

I think the main issue here is that those who have come before us have left, without leaving a trail of documentation; and I'm in complete agreement with you that that is a problem.

By doc'ing your ASM code changes (BTW, "a thing or two about assembly" is NOT trivial, especially these days), you leave a trail for those who follow you to continue your work, should you ever become discouraged or too busy, and drift away. I guarantee you, there are and will be asm-level modders to come (I am one of the current crop, obviously), and them knowing what you've done, and using your work to build it, will help the cause immensely. The asm job is huge, and you having found the locations that do the things that you patch will save someone else from having to find those locations again.

Finally -- and I don't mean to create further dischord here, but I want you to know what I meant by "insulting" -- I guess I was a bit irritated by your comment that people here have acted "elite", since I've found just about everyone involved in this effort to be open, helpful, and contributory to the cause; I admit that I've seem plenty of elitism on other projects in the past; but I don't feel that's overly true here.

All that said, it's been my interest and intention to better document the issues here; and I've worked up the ability to moderate, and therefore sticky and edit the main lists, so that I can accomplish that goal. I would encourage everyone to document, as well as you can, the work you're doing, so that the knowledge grows, and doesn't need to be reinvented over and over.

-- dulcaoin

 

Oh, nuts! I totally forgot to post about this.

I guess you caught me, Drifter. I had knowledge I didn't share <blush>

debugger, set to 1, sends all that output to your "system" debugger. if you're debugging using IDA, it goes there, if via Delphi, there, etc.

mono goes WAY back to Hercules graphics days. It outputs to monochrome monitor memory.

Also, all this stuff works under Aracanum, in case anyone cares ;-)

-- d

 

To me, if I see the elitism (I must say, none has been pointed at me), and I get ready to knee-jerk to it, I just repeat to myself the thought that all this work has been done for free, and shared with all. It's hard work, and so I think modders have a modicom of right to feel a TAD BIT proud of their accomplishments, as long as we keep the spirit of sharing and teamwork alive.

We don't have .mobs down yet; still progressing. The other stickies, I plan to upgrade and improve over time (and it's a time thing, not an elitism thing)

-- d