v2 area header notes.txt

New #AREA Section Format
I created a new #AREA format on an experimental basis. I created it with two ideas in mind. First, I wanted something that would be easier to add content to (such as an installation date). I also wanted to try a format that was more flexible (element order largely unimportant), and more language based (avoid numbers). Obviously, Muditor would have kittens upon seeing this. I'm not going to wiki it just yet. I'd like feedback.

Two areas have been "converted:" The guild and Aerie Volant.

In general, the element is listed first, followed by one or more values, depending on the type. As usual, string values end with a tilde (~). Elements not provided in the #AREA section are defaulted.

The current recognized elements:
FORMAT <number> e.g. Format 2 - Specifies the format "version." In order to maintain compatibility with the standard #AREA header, the FORMAT element must be first.
* - literal asterisk. Line comment.
AUTHOR <string name name [...]> e.g. Author Tynian Maurice IvoryTiger~ - Lists one or more author names. Among other things, the area command will search for authors. For example, Pitt is credited as a go-author for Volant, and AREA PITT will show Volant.
DESCRIPTION <string> e.g. Description This sample area is admired by none.~
END - Ends the #AREA block
FLAGS <text> <text> [...] - e.g. Flags manmade city forest 16 End - Provides one or more area flags. Will also accept numerical flag numbers. Must end with 'End'.
HIGHLEVEL <num> - e.g. Highlevel 50 - Provides the recommended highest level for the area.
INSTALLED <YYYY-MM-DD> - e.g. Installed 2014-07-01 - Installation date.
LOWLEVEL <num) e.g. Lowlevel 1 - Provides the recommended lowest level for the area.
REVISION $Revision$ - The value must be this exact format. The source control program will substitute the file 'version' for $Revision$, which the game parses.
UPDATED $Date$ - The value must be this exact format. The source control software will substitute the file last "check in" time for $Date$, which the game parses.

Examples:

#AREA
Format 2
Name Adventurer's Guild~
Revision $Revision: 1.72 $
Updated $Date: 2014/07/01 03:21:50 $
Author Maurice~
Flags Manmade End

End

[Note that since the file was checked in, the source control software has inserted the appropriate text, and will update it for each subsequent check in.]

#AREA
Format 2
Name Aerie Volant~
Installed 2014-03-22
Revision $Revision: 1.11 $
Updated $Date: 2014/07/01 03:21:50 $
Author Cordir Pitt Kerriariadne~
Description
The Aerie Volant is an Aara racial home town for the Outland Frontier,
carved out of a white stone cliff that overlooks the Maelmordian Sea.
It is open to all levels, but be warned - the guards are protective and
those of other races may find there is no welcome for them here. Young
aarakocrans living in the Aerie can frolic in the pool at the base of the
cliff or soar high above the cliffs in the strong breezes. The abundant
food found in the Sava River is not far away.
~
Flags City End

End


========================================================================

I feeling is that it would be easier to code by hand. If someone gets around to creating a new area building tool, this structure is also less finicky, since the order of the statements is (largely) unimportant.

This is how it looks in game:

> area guild
{ ALL } Maurice Adventurer's Guild 
Author(s): Maurice.
Install date: Unknown.
Revision: 1.72.
Updated: Mon Jun 30 14 20:21:50.

> area volant
{ ALL } Various Aerie Volant
Author(s): Cordir Pitt Kerriariadne.
Install date: Sat Mar 22 2014.
Revision: 1.11.
Updated: Mon Jun 30 14 20:21:50.
Description:
The Aerie Volant is an Aara racial home town for the Outland Frontier,
carved out of a white stone cliff that overlooks the Maelmordian Sea.
It is open to all levels, but be warned - the guards are protective and
those of other races may find there is no welcome for them here. Young
aarakocrans living in the Aerie can frolic in the pool at the base of the
cliff or soar high above the cliffs in the strong breezes. The abundant
food found in the Sava River is not far away.