#177 Global flags list and autonotes

[Dominik Reichardt]

Currently we "maintain" two lists with the global flags for each game.
In /content both in the bgkeyring and SIfixes and in /data/bg/si/autonotes.txt.
The ones in content are very technical and the autonotes.txt is not at all, aimed at given a light text in the notebook if possible.
Also the autnotes save the text from the autonotes.txt in the user savegame completely.

I propose:

• One master global flags list which does list both hex and dec number, the short global flag name, technical notes and a nice autonotes text.

• The autonotes shouldn't record the whole global flag text (as ist does now) but only track which flag was set/unset and when you open the notebook show the appropriate autonote text.

• With a cfg setting show the full "line": flag number, short name, tech notes and nice text in the notebook.

example of such a global flag entry:

0x303/771:HOLDING_ERINONS_AXE {Set when equipped with the Axe, unset when unequipped.} "You've equipped Erinon's Axe"

[Dominik Reichardt]

Knight Captain has made an xml in this fashion. So far only for the SI autonotes, but one can see the possibilities.
He is using XML comments which we might not yet support in our xml parsing.
Attached is an updated SI autonotes.txt in the xml format by Knight Captain.

His notes:
I [Knight Captain] started writing an XML-based version of the AutoNotes file for SI, it is attached here. It looks like I started this without getting anyone's opinion of implementing this in Exult, so wanted your thoughts on this.

The format I'm using is:

< gFlag number="n"> Using the decimal per Google's suggestions. 0x is only a comment.
< flagName> Friendly title of the notebook entry, does not need to match si_gflags.uc.
< flagNote> The body of the note.
< flagTech> The body of the technical details, which can be optional in Exult.

With info would appear as:

< gFlag number="0">
< flagName>The Hound of Doskar tracked Cantra's wooden sword.
< flagNote>After the summoning of the Hound of Doskar, you have asked him to track Cantra's scent as found on her wooden practice sword.
< flagTech>When set, this flag removes the magical barriers to Shamino's Keep. Otherwise you can enter the Castle but not the keep itself. Text reflects that the Forest Master can summon the Hound as well as the whistle he provides.

[Dominik Reichardt]

I'm thinking that along with the autonotes exult.cfg setting (<gameplay><allow_autonotes>yes/no) we could add a <debug><autonotes>yes/no tag that when set shows all information of a set flag. Flag number in both decimal and hex, the flagname, flagnote and flagtech. When not set, only show the flagNote.</autonotes></debug></allow_autonotes></gameplay>

I'm assigning this to Jeff, maybe he wants to take a look. I'll also ask Marzo for input on the file format.

[Dominik Reichardt]

tracking in https://github.com/exult/exult/issues/399