NOTE: This is a work in progress.
In Fatewright, pages are the smallest coherent units through which the story is presented to the player. Each choice the player makes in the story, leads them to another page. These pages have story content, instructions for Fatewright, and finally, information about the options to be presented to the player. Pages are created through files with the extension .fwpg, which stands for Fatewright page.
Comments are supported within story text. However, each Fatewright instruction handles the text following it in a unique manner, so comments are not guaranteed to consistently work in instruction lines.
Line comments begin with //, and are recognised only if not immediately preceded by a non-whitespace character.
This is visible text.//This will NOT be recognised as comment
This is visible text. //This WILL be recognised as comment
Once a line comment is encountered, the entire rest of the line (including the line break) is skipped by Fatewright.
This is line 1. //This is a line comment
This is still line 1.
This property of line comments is also useful when blank lines are required for the readability of the source, but not meant to be part of the displayed text.
Block comments begin with /* and end with */, and should not be immediately preceded or followed by a non-whitespace character. If immediately preceded by a non-whitespace character, the beginning of the block comment is not recognised.
This is visible text./*This will NOT be recognised as comment*/
This is visible text. /*This WILL be recognised as comment*/
They must not be immediately followed by a non-whitespace character either. Otherwise, Fatewright cannot recognise the end of the comment.
/*This is a comment that ends properly*/ This is visible text.
/*This comment never ends */because the ending sequence is missed.
If a block comment is followed by a line break, the line break is not ignored because it is not considered a part of the comment.
This is line 1. /*This is a block comment*/
This is line 2.
$> BIO: human
"Finally, a fellow human," the woman said, shedding her annoyed expression.
$< $!>
"I could use some help over here," the woman said, looking thoroughly annoyed.
$<
$> STAT: appearance>3 && combatskill>2
"And you look like you may be able to handle yourself as well," she added approvingly, measuring you with an experienced eye, "With these little ones, you might end up needing to."
$<
"Urghh, $case:gender he/she/this one/- smells even worse. Prithee, do not breathe on me," one of the children remarked, taking a step back from you. Then, turning to the woman, added, "Could you perhaps continue your conversation outside?"
The woman rolled her eyes and asked you, "Do you speak spoilt? Can you convince these brats that I am only trying to help them?"